Sample Data Subscriptions
Sample Data Subscriptions
- Navigate to the users tile
- Click on the user to edit their sample data subscriptions
- Select the Pencil icon to edit the Sample Data Subscriptions panel (hover over the upper right hand corner to display the icon).
- Complete the details:
- Subscription Name - Free text naming of the sample subscription
- Export Data - multi select field to choose what type of data to receive in the sample subscription
- Summary -
- Sample Results -
- Comments -
- Format - choose one of the available formats to receive the sample subscription in
- CSV - comma-separated values file which is a delimited text file that uses a comma to separate values
- XLSX - Microsoft Excel spreadsheet
- JSON - text file written with JavaScript object notation
- XML - An XML file is an XML (Extensible Markup Language) data file. It is formatted much like an .HTML document, but uses custom tags to define objects and the data within each object. XML files can be thought of as a text-based database.
- Start Date - Date to start receiving the sample data subscriptions. Start date may be in the past – historical data will be delivered based on the scheduled ‘Interval’
- Interval - choose one of the following intervals to receive the sample subscription
- Daily
- Weekly
- Monthly
- Quarterly
- Accounts - At least one account must be selected to receive data for
- A search can be performed in Available Accounts by typing in the search bar above.
- Selecting Add All will add all displayed accounts to Assigned Accounts.
- Select the checkboxes next to each account name to add an account to Assigned Accounts.
- Selecting Remove Selected will remove all checked accounts to Assigned Accounts.
- Select the "x" next to each account name to remove an account from Assigned Accounts.
- A search can be performed in Available Accounts by typing in the search bar above.
- Communication Preferences
- Email addresses - can enter in one or multiple email addresses to receive the selected sample subscription. If sending to multiple emails, separate them with a comma.
- API Hook - MSLA can send data to an API hook that is setup to receive files. Users should work with their IT to setup or get the open API hook.
- The API hook must be an open API, as no credentials are required
- Once the API hook URL is entered in, click 'test connection'. User will get a success or error message.
- SFTP Address - FTP is a folder held on the internet that MSLA can send files to. Username, password and file domain name are all required. SFTP uses port 22 as a default ,unless the subscription sends another endpoint to use.
- Exceptions - Check off desired options
- Do not send scheduled results file when no new results are available - If this is checked off, and no new results have been published since the last ran interval, then no sample subscription file will be sent.
- Include reported only - If this is checked off, then the sample subscription file will only include samples with a status of 'reported'
- Select Save