You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Table of Contents
Purpose

This document outlines the following use cases for the "Subscription Management" tab of the Data Access GUI:

  1. View existing subscriptions
  2. Create a new subscription
    1. Create a subscription from an existing request
  3. Edit an existing subscription
  4. 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

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

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.

 

Use Cases

Viewing Subscriptions

The "Subscription Management" tab allows an operator to view existing subscriptions.

Clicking on a subscription will reveal the details of its processing instructions in the lower half of the window in a readable format.

When no subscriptions are present in the database, a message like this might be received:

Creating a Subscription

To add a subscription, click the [Add New Subscription] button on the "Subscription Management" tab. A dialog box will appear containing several empty fields.

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).

Expected Result

Edit Existing Subscriptions

Cancel a Subscription 

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).
  • See the FormUpload.rb and DataAccess GUI Form Upload pages for further guidance.
  • No labels