Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Some of the hookpoint used most commonly are listed here, along with the the context provided to the workflow.

...

Hookpoint keyDynamic key(s)InvocationNotes
SUB_CAN_TERMINATE Invoked by customer care and other workflows to resolve if a subscription can be terminated. 
TERMINATE_SUBSCRIPTION Handling the scheduled termination of subscriptions. Can be invoked by all areas of the system. 
SUB_REACTIVATE Invoked by customer care and other workflows to resolve if a subscription can be re-activated. 
SUBSCRIPTION.TERMINATION.CHARGE_ITEM Invoked when terminating the subscription 

...

Hookpoint keyDynamic key(s)InvocationNotes
PRODUCT_OPTION_CAN_MODIFY<OPTION_KEY> = The key value of the product optionInvoked from customer care when determining if a product option and be subscribed or unsubscribed. 
PRODUCT_OPTION_SUBSCRIBE<OPTION_KEY> = The key value of the product optionInvoked when the specific product option with the OPTION_KEY is subscribed from any part of the system 
PRODUCT_OPTION_UNSUBSCRIBE<OPTION_KEY> = The key value of the product optionInvoked when the specific product option with the OPTION_KEY is unsubscribed from any part of the system 
PRODUCT_OPTION_SUBSCRIBE Invoked any product option is subscribed to from any part of the system 
PRODUCT_OPTION_UNSUBSCRIBE Invoked any product option is unsubscribed to from any part of the system 
PRODUCT_OPTION_SWITCH<OPTION_KEY> = The key value of the new product optionInvoked when changing between product options that are exclusive. I.e. the parent option marked the sub options as exclusice or the option is part of an exclusive group 

...

Hookpoint keyDynamic key(s)InvocationNotes
<ALERT_HOOKPOINT>

<ALERT_HOOKPOINT>

e.g. "ALERT_HOOKPOINT = myAlertWorkflowHookpointKey"

Invoked when specific configurable alert levels have been crossed. The levels are defined on the PARAMETERS of the bundle configuration and is a comma separated list of numbers (percentages), e.g. "ALERT_LEVEL=25, 50, 75, 100"

The alert hookpoint for bundles is fully configured in the bundle configuration and has no static part.

(see documentation for Campaign and bundle configuration: The RestrictActive Framework)

Not supported by all campaigns types

CAMPAIGN.ASSIGN.IS_ALLOWED<CAMPAIGN_KEY>Invoked when attempting to assign a campaign. The result of the workflow will tell if assigning is allowed or not. Not supported by all campaigns types
CAMPAIGN.ASSIGN.GENERATE_OBJECTS<CAMPAIGN_KEY>Invoked when an campaign is assigned and the activation is not activated yet.

A workflow linked to this hookpoint is intended to generate the objects used by the hookpoint: CAMPAIGN.ASSIGN.PERSIST_OBJECTS

Not supported by all campaigns types

CAMPAIGN.ASSIGN.PERSIST_OBJECTS<CAMPAIGN_KEY>Invoked when an assigned campaign is assign and saved Not supported by all campaigns types
CAMPAIGN.ACTIVATE.IS_ALLOWED<CAMPAIGN_KEY>Invoked when attempting to assign a campaign. The result of the workflow will tell if activation is allowed or not. Not supported by all campaigns types
CAMPAIGN.ACTIVATE.GENERATE_OBJECTS<CAMPAIGN_KEY>Invoked when an assigned campaign is activated and the activation is not saved yet.

A workflow linked to this hookpoint is intended to generate the objects used by the hookpoint: CAMPAIGN.ACTIVATE.PERSIST_OBJECTS

Not supported by all campaigns types

CAMPAIGN.ACTIVATE.PERSIST_OBJECTS<CAMPAIGN_KEY>Invoked when an assigned campaign is activated and saved     Not supported by all campaigns types
CAMPAIGNONASSIGN / ONACTIVATE / ONEXPIRE / ONTERMINATEInvoked when a campaign is assigned, activated, expires or terminatedNot supported by all campaigns types

 

Fees

 
Hookpoint keyDynamic key(s)InvocationNotes   
FEE_CALC_NEXT_CHARGE_DATE<SUBSCRIPTION_FEE_CODE>Invoked when the next charge date of a fee is calculated. Usually on the charge date.Not supported by all fee types

Invoices

Hookpoint keyDynamic key(s)InvocationNotes
    

...