Subscription Setup
Describes how to set up a subscription for scheduling connector uploads and downloads.
A subscription consists of two parts – the configuration/scheduler, which is referred to as the subscription, and the transfer method details (host, username, and so forth), which are referred to as the end point. The subscription contains the details of when the data transfer must run between SAP Fieldglass and the end point. The end point defines the properties of the server that SAP Fieldglass must communicate with to push or pull connector files.
The following tasks explain how to create a new subscription and how to use an existing subscription, as well as how to test a subscription.
Create a New Subscription
-
At the bottom of the page, choose Create New.
The Setup Subscription dialog box opens.
-
Enter/select the following details:
-
In the End Point list, choose the target end point for the subscription. A value is required.
-
In the Subscription Class field, the default value is insite.subscription.WebserviceUploadSubscription. You can leave the default value or enter any special subscription class value provided by your SAP Fieldglass representative.
-
In the Parameters field, enter one or more parameters to pass in the subscription. Valid for uploads and downloads. If only one parameter is required, specify that value. If multiple parameters are required, specify the values separated by a comma with no space in between. For example, if parameters are Start Date and End Date in mm/dd/yyyy format, then specify the values as: 01/01/2020,12/31/2020.
Parameters are used by some integration connectors to disposition objects in SAP Fieldglass. For example, the Invoice Buyer Download requires a parameter be set to disposition the invoice record to 'Payment Pending' or 'Paid' when the download runs. The parameter indicates what status the invoice should be changed to after downloading so it's not downloaded again – parameter 33 sets the status to ‘Payment Pending’; parameter 52 sets the status to ‘Paid’. To determine if a connector requires parameters, see the connector specification documents in the SAP Fieldglass Connector Library.
-
In the Subscriber field, click in the drop-down list and then choose a username. This is an optional field.
-
In the Notify On Missed Run, check yes, if you want to be notified if a subscription fails to run. This is an optional field that's only visible if your company code has been added to the FG_SUBSCRIPTION_ALERT Feature Toggle.
-
In the Notification Email field, enter an optional email address to send transfer status notifications (success or failure).
-
In the Delivery Time section, choose values for Minute, Hour, Date, Month, and Day to schedule the delivery of the subscription. Values are required.
As you choose options, a description of the runtime displays in an information box. For example:
At minute 0 past hour 2 on day-of-month 5 and on Sunday in every month
As you change the delivery time, the description changes in real time.
-
In the Time Zone list, choose the time zone where the subscription runs. A value is required.
-
Choose a Status option. The subscription and end point must be active to test or run.
-
-
Do either of the following:
-
To create the subscription, choose Save.
The subscription is added to the system. After the Setup Subscription page refreshes, the new subscription displays in the Select Subscription list. Choose Next Step. The Finished step opens. To continue, go to Finished Step.
-
To cancel the action and return to the previous page to select an existing subscription, choose Cancel. In the Confirmation dialog box, choose OK.
-
Use an Existing Subscription
Existing subscriptions display by name in a list on the Setup Subscription page. The subscription status also displays.
-
To select an existing subscription, choose the subscription name hyperlink.
The Setup Subscription dialog box opens.
-
Change the values for End Point, Parameters, Subscriber, Notification Email, Delivery Time, and Time Zone as needed. For a description of the fields, see Create a New Subscription above.
-
Do one of the following:
-
To activate the subscription, choose Enabled (only displays for disabled subscriptions), and then choose Save.
The subscription is activated in the system. The Setup Subscription page refreshes, and the active subscription displays in the list. Choose Next Step. The Finished step opens. To continue, go to Finished Step.
-
To deactivate the subscription, choose Disabled (only displays for enabled subscriptions).
The subscription is deactivated in the system. The Setup Subscription page refreshes and the inactive subscription displays in the list.
-
To use the selected subscription, choose Submit. The Finished step opens. To continue, go to Finished Step.
-
To cancel the action and return to the previous selection page without saving details, choose Cancel. In the Confirmation dialog box, choose OK.
-
Test Subscription and End Point
-
On the dashboard, choose View Connector. The Connector List page opens.
-
Choose the connector. The connector Integration page opens.
-
Choose the Connectivity tab. All subscriptions defined for the connector display by name in the list.
-
Choose the subscription you want to run. The subscription details display in the preview pane below.
-
Choose Run Now. The Confirmation dialog box opens.
-
Choose OK to run the subscription now. The following message should display:
The subscription run was triggered successfully. Please check the Integration Audit Trail for more details.
You can also view subscription activity from the Monitor Activity tile on the dashboard, which displays all activities for the selected subscription. For more information, see Monitor Activity.
From this point forward, the subscription runs based on the delivery time established.