Versions Compared

Old Version 7

changes.mady.by.user user-01f8a

Saved on

compared with

New Version Current

changes.mady.by.user user-01f8a

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width50%
Panel
borderStylesolid
titleTable of Contents
Table of Contents
Column
Panel
borderStylesolid
titlePurpose
Excerpt

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)

...

Section
Column
width50%

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. 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
width50%

 

Use Cases

Viewing Subscriptions

...

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
width50%

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

Column
width50%

Clicking on an item in the requests table will populate the processing options fields below with the details of the request.

 


Expected Result

Edit Existing Subscriptions

...

  • 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 guidanceprogrammatic access documentation for CMR query details.