Enabling Data Sets Using a JSON File

To enable a data set, perform the following steps:

1. Get the APS token of the provider:
   1. Log in to the Operations PCP.
   2. Go to System > Settings > User APS tokens > admin.
   3. Copy the text displayed and paste it to the newly created APS_token_file_name.token file.
2. Create two files with the following contents:
   

   Note: You can use a respective JSON file from this archive.

   1. JSON_file_name.json

      {
      "aps": {
          "type": "http://www.odin.com/rde/global-data-set/1.0"
        },
      "dataSetType": "data_set_name",
      "title": {
      	"en_US": "tile_title_en",
      	"de_DE": "tile_title_de"
      },
      "description": {
      	"en_US": "tile_description_en",
      	"de_DE": "tile_description_de"
      }
      
      }

      Where:
      - dataSetType is a data set type.
      - title is a data set name that is displayed in the UX1 (in all required languages).
      - description is a data set description that is displayed in the UX1 (in all required languages).

      Note: The English and German text is used for the tile's title and description in this example.

   2. script_file_name.sh

      rde_json="`cat JSON_file_name.json`"
      aps_token="`cat APS_token_file_name.token`"
      cmd="curl -v -X POST   -H \"Content-Type: application/json\" -H \"APS-Token: $aps_token\"  --data-binary '"$rde_json"'  \"https://brand_domain/aps/2/resources\" "
      echo $cmd
      eval $cmd
      printf '\n'

      Where:
      - rde_json is a name of the JSON file.
      - aps_token is a name of the APS token file.
      - brand_domain is the branded domain name, for example: brand.com

3. Save these three files on the CloudBlue Commerce management node, for example, in the /usr/local/bin directory.
4. Run the script_file_name.sh script to enable the additional data set.

Available Data Sets

The following additional data sets are currently available:

Data set	dataSetType for JSON file	Suggested JSON file	Suggested description
Payments	payments	payments.json Note: You can use the respective JSON file from this archive.	All payment and refund transactions with the associated information of customer accounts, payment methods, and transactions.
Accounts	accounts	accounts.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about a user account and all sub-accounts under that user, for a chosen period.
Login history	loginhistory	loginhistory.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about log-in events that occurred in a chosen period.
Subscriptions	subscriptions	subscriptions.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all subscriptions of a user and the user's sub-accounts that were created in a chosen period.
Service users	serviceusers	serviceusers.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all service users of a user and the user's sub-accounts that were created in a chosen period.
Staff members	staffmembers	staffmembers.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all staff members of an account and its sub-accounts created in a chosen period.
Non-provisioned orders	orders	non-provisioned-orders.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all orders that belong to a user and user's sub-accounts for a chosen period that have not been provisioned yet: New, Failed, and In Progress.
Subscription resources	subscriptionresources	subscription-resources.json Note: You can use the respective JSON file from this archive.	The report provides detailed information about the resources of subscriptions and the related subscriptions belonging to the user and the user’s sub-accounts.
AR Documents	ardocuments	ar-documents.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all AR documents, including Credit and Debit Memos, created in a chosen period.
Invoices	invoices	invoices.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about invoices created in a chosen period.
Service plans	serviceplans	service-plans.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all service plans created in a chosen period.
Service plan resource rates	serviceplanresourcerates	service-plan-resource-rates.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about all resource rates for service plans created in a chosen period.
Audit trail	audittrail	audittrail.json Note: You can use the respective JSON file from this archive.	This report provides detailed information about activities that a user performs in the system.