VPL Console Action (Managed Package)

This custom metadata type is used to manage the actions displayed in the Actions menu on the agent console and the subscriber workflows displayed in the customer portal. All the records in this custom metadata type have a similar set of fields. Here's how this custom metadata type is structured:

Managed Package Icon This feature is part of the Communications Cloud managed package.

Field Name

Description

Action Category

Specifies the subheading under which an action is displayed on the agent console. The values used by default are Service, Plan, SIM, and Number. If any text is entered here that doesn't correspond to an existing category, a new category is created.

Action Context

Specifies if the action should be displayed in the Actions menu of the subscription card or in the Actions menu of the account on the agent console. This field can contain only one value, either Account or Subscription. For actions that must be listed in both Actions menus, you'll find two records, one for the account and another for the subscription.

Applicable Journey

Specifies that the action is valid for prepaid journeys. Enter Prepaid.

Applicable View

Specifies if the action should be displayed on the agent console, the customer portal, or both. Valid values are: Community, Console. Both values can be specified, separated by a comma.

OmniScript Display Name

Contains the text that is displayed on the agent console or in the customer portal. This is usually the workflow name. For example: Manage features.

OmniScript URL

Provides the URL for the OmniScript that should be launched by this action. To specify the URL of an OmniScript in the appropriate format:

  1. Go to the OmniScript that you want to link to.

  2. In the Actions menu, click How To Launch.

  3. In the Lightning section, copy the link.

    For example:

    https://marketing-industry-80291.lightning.force.com/lightning/cmp/vlocity_cmt__vlocityLWCOmniWrapper?c__target=c:vplActivateDeactivateServiceEnglish&c__layout=lightning&c__tabIcon=custom:custom18&c__tabLabel=Manage Features

  4. Delete the initial part of the URL, upto and including vlocityLWCOmniWrapper?.

  5. Append &c__ContextId= at the end.

The resulting string has the OmniScript URL in the appropriate format. For example:

c__target=c:vplActivateDeactivateServiceEnglish&c__layout=lightning&c__tabIcon=custom:custom18&c__tabLabel=Manage features&c__ContextId=

The VPL Console Action custom metadata consists of the following records:

  • Buy_add_ons

  • Buy_add_ons_subscription

  • Cash_top_up_subscription

  • Manage_features_subscription

  • Manage_features

  • Manage_lost_or_stolen_device

  • Manage_lost_or_stolen_device_subscription

  • Number_change_request_subscription

  • Number_change_request

  • Request_SIM_replacement_subscription

  • Request_SIM_replacement

  • Request_SIM_Unlock_Code

  • Request_SIM_unlock_code_subscription

  • Top_up_via_voucher

  • Top_up_via_voucher_subscription