Section |
---|
Column |
---|
| Panel |
---|
borderStyle | solid |
---|
title | Table of Contents |
---|
| |
|
Column |
---|
Panel |
---|
borderStyle | solid |
---|
title | Purpose |
---|
| Excerpt |
---|
This document outlines the following use cases for the "Subscription Management" tab of the Data Access GUI: - View existing subscriptions
- Create a new subscription
- Create a subscription from an existing request
- Edit an existing subscription
- Cancel a subscription
|
|
|
|
Requirements
- COTS Installations: npm, node.js, loki.js
- S4S must be installed in the target mode (use S4S mkcfg).
- Start the S4S service (S4SStart)
- Required information:
- The port associated with this mode's instance of S4S (usually 30XX)
Configuring S4S
Section |
---|
Column |
---|
| There are 2 application configuration variables in the Data Access GUI that govern its interactions with the S4S database: - SUBSCRIPTION_ENDPOINT_URL
- DEFAULT_FULFILLMENT_FREQUENCY
![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%202.42.18%20PM.png?version=1&modificationDate=1507229118412&api=v2)
SUBSCRIPTION_ENDPOINT_URL (xs:string) allows the Data Access GUI to perform database operations using HTTP requests. The format of this value is http://x5oml01:30XX/todos DEFAULT_FULFILLMENT_FREQUENCY (xs:integer) allows the operator to generate subscriptions without having to specify the fulfillment frequency each time. It is specified in seconds. Note: the minimum period between subscription fulfillments is 1 hour (3600 seconds). The maximum period between them is 68 years (2,147,483,647 seconds). |
Column |
---|
|
![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%202.43.10%20PM.png?version=1&modificationDate=1507229124073&api=v2) |
|
Use Cases
Viewing Subscriptions
The "Subscription Management" tab allows an operator to view existing subscriptions.
...
When no subscriptions are present in the database, a message like this might be received:
![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%204.45.15%20PM.png?version=1&modificationDate=1507236367704&api=v2)
Creating a Subscription
Section |
---|
To add a subscription, click the [Add New Subscription] button on the "Subscription Management" tab. A dialog box will appear containing several empty fields. Section |
---|
Column |
---|
| In the "Add New Subscription Dialog" fill in the required fields "Email" and "CMR Query" (see programmatic access or CMR pages for details on creating CMR queries). ![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%204.50.45%20PM.png?version=1&modificationDate=1507236765112&api=v2)
|
Column |
---|
| Clicking on an item in the requests table will populate the processing options fields below with the details of the request. ![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%204.52.10%20PM.png?version=1&modificationDate=1507236765338&api=v2)
|
|
Expected Result ![](/download/attachments/89593207/Screen%20Shot%202017-10-05%20at%204.52.28%20PM.png?version=1&modificationDate=1507236765464&api=v2)
|
Edit Existing Subscriptions
Section |
---|
To edit an existing subscription, select a subscription, then click the [Edit Subscription] button on the "Subscription Management" tab. A dialog box will appear–populated with the information from the existing subscription. Image Added Note that the old processing options can be overwritten with those from another request. When a subscription is edited, its ID will change. |
Cancel
...
a Subscription
Section |
---|
Cancelling a subscription is done by selecting a subscription from the default view, then clicking the [Cancel Selected Subscription] button. Image Added Image Added
|
Tips & Warnings
- If unable to connect to the database or retrieve subscriptions, relevant error messages will be shown in the table.
- When troubleshooting, use both the firefox webpage debugger and the Data Access GUI log file (DA_Gui.log).
Related
- See the FormUpload.rb and DataAccess GUI Form Upload pages for further guidanceprogrammatic access documentation for CMR query details.