In this topic:

Agreement Actions

Agreement actions are part of Gotransverse's Action Framework. You can customize renewal notifications as a customer's service nears the expiration date with agreement actions. Agreement actions result in an event that occurs outside Gotransverse. For example, an agreement action could be configured to send an email when the customer reaches the end of an agreement.

Agreement actions are optional. For details on how to create an agreement, see Agreements.

Gotransverse has one default agreement action type called Days to Agreement End. You can configure the action to do the following operations:

  • HTTP Request Operations - This agreement action executes an API call. A URL can be configured with User ID and password to enable integration to external web services sending agreement-specific information from Gotransverse to an external system. The HTTP Post occurs when the agreement action is triggered by reaching the specified number of days before the agreement ends.
  • Email Operations - An agreement action email is sent automatically to a specific email address. See Notification Templates for instructions on how to set up the agreement email template.

The Actions section enables you to create an agreement action for future use. This feature saves time when you set up your agreement actions.

Accessing Agreement Actions

For agreement actions, go to Products >> Agreements. Select the agreement name to open the Agreement Details page, where you can add, change, or delete one or more agreement actions.

Adding Agreement Actions

Before you add one or more agreement actions, determine whether or not the action will be enabled at this time.

To add an agreement action, perform the following steps:

  1. Navigate to Products >> Agreements. Select the agreement name to open the Agreement Details page.
  2. On the Agreement Details page, in the Actions pane, click the Agreement Action Type. The Action Configuration page opens showing the following three areas:
  • Action Details
  • HTTP Request Operations
  • Email Operations
  1. In the Actions Details pane, click Edit.
  2. In the window that opens, enter the following information:

Friendly Name An easily recognizable name, if needed. Enter a name more descriptive to you than the category name provided in Gotransverse. Maximum 40 characters.
Enable Action Indicates whether to execute the action. This agreement action can be enabled at any time. Select or deselect to enable or disable this action as follows:
  • Check mark - Enabled, the agreement action occurs.
  • No check mark - Disabled, the agreement action does not occur.
Description Enter a description if needed besides the friendly name. Maximum 40 characters.
  1. Click Finish. The Configure Action Details window closes. Continue to the next steps as needed.

Configuring HTTP Request Operations

  1. In the HTTP Request Operations area, click Add.
  2. In the Configure HTTP Request window that opens, enter the following information:
Enable Operation Indicates whether to execute the operation. This HTTP request can be enabled at any time. Select or deselect the check box to enable or disable this operation as follows:
  • Check mark - Enabled, the HTTP request is performed.
  • No check mark - Disabled, the HTTP request is not performed.
Days to Agreement End Required. The number of days before the agreement ends, when the agreement action is started. Enter a number of days.
End Action Required. The outcome from the action that occurs automatically when the Days to Agreement End is reached. Select one of the following choices:
  • Change Service - Update or change the service used by the customer.
  • Change Agreement - Update or change the agreement.
  •  Deactivate Service - Service ends when the agreement ends.
    • Service Only - Begins a month-to-month service with no agreement.
    • Renew Agreement - Starts a new agreement of the same agreement duration and configuration.
    • All - Uses the Renew Action specified in the agreement. See Agreements for details.
URL Required. The URL of the website to access. Enter the URL.
Application This selects an application login that you have already entered in Gotransverse under Admin >> Applications. See Applications for more information.
Post Type The type of call this action makes. In the drop down menu, select POST or GET.
  • POST
    • Content Type- Change the provided content type if needed.
    • Date Format - Change the provided format if needed.
    • Payload - Select from the Palette on the right.
  • GET
  1. Click Finish.
    The HTTP request is configured.

Configuring Email Operations

  1. In the Email Operations area, click Add.
  2. In the Configure Email window that opens, enter the following information:
Enable Operation Indicates whether to execute the Email Operation. This can be enabled at any time. Select or deselect as follows:
  • Check mark - Enabled, the email operation occurs.
  • No check mark - Disabled, the email operation does not occur.
Days to Agreement End Required. The number of days before the agreement ends, when the agreement action is started. Enter a number of days.
End Action Required Specifies the action to take when the agreement action is triggered. Select one of the following:
  • All - Performs the Renewal Action specified in the agreement setup. That is, the action set here is triggered by the Days to Agreement End instead of when the agreement expires. Refer to Agreements for additional information.
  • Renew Agreement - Automatically renews the service subscription, and the subscription rolls over to repeat the length of time period and conditions. For example, if the expiring subscription was for six months, then it would renew for another 6-month time period.
  • Service Only - Continues the subscription at the same price and the same billing period. No agreement is in effect and the customer can cancel the product at any time with no termination fee.
  • Deactivate Service - The subscription ends and Gotransverse no longer bills for the subscription.
  • Change Agreement - The subscription changes to a different agreement.
  • Change Service - The subscription changes to a different service.
Email Template Select a template to use for the email sent to customers. See Notification Templates for more information.
Use Account Email

Indicates whether to use the email associated with the customer's billing account.

  • Check mark - Yes, use the email address of the billing account.
  • No check mark - No, do not use email address of the billing account.
Enable Email Override Indicates whether to use an email address other than the one associated with the customer's billing account.
  • Check mark - Yes, use another email address than the one in the billing account. Instead, use the email address that was entered when the agreement was set up with the customer. Refer to Agreements for additional information.
  • No check mark - No, use the billing account email address.
Recipient Email Enter the email address if you select Enable Email Override. This is different from the billing account email address.
Template Required. The drop down menu containing email agreement action templates. See the Notifications Templates page for more information.
  1. Click Finish.
    Email action is configured.

Changing Agreement Actions

You can change agreement actions as needed.

To change or update an agreement action, do the following:

  1. In the Actions pane, find the agreement action that you want to change or update. Click the name of the agreement action. The Action Configuration page opens showing the following three areas:
  • Action Details
  • HTTP Request Operations
  • Email Operations
  1. Select the area that has the agreement action you want to update, and click Add.
  2. In the window that opens, update the information. For description of the options, see Adding Agreement Actions.
  3. Click Finish.
    The action configuration is updated.

Deleting Agreement Actions

Agreement actions can be deleted by clearing the information in the agreement action. Deleted agreement actions cannot be retrieved. If you want to use an agreement action at a later time, instead of deleting it, deselect the Enabled check box to disable the agreement action.

To delete an agreement action, do the following:

  1. In the Actions pane, click the name of agreement action category that has the agreement action that you want to delete. The Action Configuration page opens showing the following three areas:
  • Action Details
  • HTTP Request Operations
  • Email Operations
  1. Select the area that has the agreement action you want to delete. Click Edit.
  2. In the Details window that opens, delete the information.
  3. Click Finish.
    The Action Configuration page is updated and the agreement action is no longer available for use.

Top