Some of the hookpoint used most commonly are listed here, along with the the context provided to the workflow.
...
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| 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 | ||
| GET_DEFAULT_TERMINATION_DATE | Invoked when the termination date need to be calculated in Customer Care |
...
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| PRODUCT_OPTION_CAN_MODIFY | <OPTION_KEY> = The key value of the product option | Invoked 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 option | Invoked 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 option | Invoked 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 option | Invoked 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 key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| <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 |
| CAMPAIGN | ONASSIGN / ONACTIVATE / ONEXPIRE / ONTERMINATE | Invoked when a campaign is assigned, activated, expires or terminated | Not supported by all campaigns types |
...
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| 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 |
| FEE.PRIOR | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | This hookpoint is invoked when you bill or refund a fee, before it is done | Not supported by all fee types |
| FEE.AFTER.BILL | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | Invoked after the fee is billed | Not supported by all fee types |
| FEE.CHARGE_ITEM | This hookpoint is invoked when you bill a fee. The hookpoint returns the charge item to be used in the billing process. | Not supported by all fee types | |
| FEE.CALCULATE.PRICE | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | invoked when you bill a fee. The hookpoint returns the price for billing the given fee with the given context. | Not supported by all fee types |
...
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| INVOICE.BEFORE.CLOSE | Invoked before the invoice is closed | ||
Dunning
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| <INVOICE.FLOW.STEP> | The hookpoint is defined on the database table field: INVOICE_FLOW_STEP_DEF_METHOD.META_DATA: E.g. {"values":{"HOOKPOINT_KEY":"INVOICE.FLOW.REMINDER"}} | Invoked for every defined step on the invoice flow. | Part of the Invoice Flow Engine |
| INVOICE.FLOW.CANCEL | <INVOICE_FLOW_CANCEL_STEP_NUMBER> | Invoked when an invoice or a billing group is no longer in an invoice flow | Part of the Invoice Flow Engine |
...
| Hookpoint key | Dynamic key(s) | Invocation | Notes | |
|---|---|---|---|---|
| RECHARGE_TICKET.CALCULATE_RECHARGE_AMOUNT | Dynamic hookpoint key provided by the RechargeTicketType's meta data | Invoked when the recharge ticked is used to perform a top-up | Not available in all recharge ticket implementations | |
| RECHARGETICKET.BEFORE.DELETE | Invoked before the recharge ticked is deleted | Not available in all recharge ticket implementations |
Other
| Hookpoint key | Dynamic key(s) | Invocation | Notes | |
|---|---|---|---|---|
| GET_PHONE_NUMBER_FOR_SMS | Invoked when an SMS message needs to be sent to the customer and the phone number on the on the service should not be used | |||
| GET_LONG_DESCRIPTION_SERVICE_XXXX | <SERVICE_CODE> | Invoked when adding or replacing information shown on the Subscription tab in Customer Care | ||
| CHANGE_RATEPLAN | Invoked when starting a Rate Plan Change (by clicking the OK button in ChangePricePlan Dialog or when the change is done by the RatePlanChangeEngine) | |||
| CAN_DELETE_LOCKIN | Indicates if a subscription lockin may be deleted | |||
| CANCEL_NP_FLOW | Invoked when a canceling of a number porting flow has been requested via Customer Care | |||
| CAN_CANCEL_NP_FLOW | Invoked when determining if the button for canceling of the number porting flow is available. |