How To Load Usage Data

Overview

After configuring your usage data collectors, you can now start loading usage data into the org. This can be done in a number of ways:

  1. Manual upload of a collector data record, Usage file, in the form of a CSV file via the UI.
  2. Configuring the usage collector profile to pick up Usage files from a remote server via FTP.
  3. Upload usage by creating COLLECTOR_FIELDS records via API.

Large volume of usage data is normally handled using option # 2 while real-time but infrequent usage data can be done either by option # 1 if there will be manual intervention or # 3 if the usage data is prepared and sent to the platform via a remote system/application.

Procedures for Manual Upload

Step 1. Navigate to the collector profile that will be used to load the data.

Upon logging into the org, go to Setup > Metered Usage > Usage Collectors and then select/click the collector profile that will be used. This will open the collector profile details.

Step 2. Upload the Usage file.

From the previous, click the Upload Usage File child node. This will bring up the wizard that will allow you to select a file from a local folder/directory or a mapped network folder/directory.

When done, click Save to start the loading process.

Step 3. Check and monitor the loading process.

After saving the new history record in the previous step, you will be redirected to the history child node where you can see the status of the load request that was created. The page will display information that is very similar to the example below. Details on what the different fields represent are listed in the table after the example below.

Field Definition

Field Description
Activity Collector Id Unique identifier of the collector profile used.
History Id Unique identifier of the loaded activity. This is used when troubleshooting and investigating possible alerts.
Activity Date Date when the file was uploaded.
File Status

Indicates the status of the load. It can be one of the following. Clicking the Refresh button allows you to refresh the UI to get the latest status:

  • DOWNLOADED - File has been downloaded and waiting to be processed.
  • STAGED - File has been processed.
  • ERROR - File has been processed but the entire load process ended in an error. Check the alerts for the error encountered.
  • PENDING REPROCESS - This is used when the collector activity history is triggered for reprocessing.
File Name Filename of the Usage file loaded. This is blank if the Usage is loaded via API.
File Size Size of the file that was loaded. 
Records in File # of records contained in the loaded file. This includes the header row. 
Records Loaded # of records loaded from the file. 
Records Invoiced When invoicing is enabled for the collector profile, this shows the number of records from the load file that landed in invoices. 
Records Rejected # of records that were rejected. This corresponds to the number of records in the Rejected Records File quicklink. The error messages can be found at the end of each row on this rejected records file. 
Records in rating queue Indicates the interim processing status of records. When this is non-zero, it means that there are records in the load file that are queued for rating and eventually will land in invoices.
Rejected Records File  

Procedures for FTP Load

Loading the Usage via FTP automates steps 1 and 2 of the Manual Load procedures above. Assuming that the remote server is up and running and the collector profile is properly configured for FTP, history records will be generated in the platform automatically. To check and monitor, simply go to the Collector Activity History child node under the collector profile and open the history record that was generated via FTP.

Validation will be the same as Step 3 of the manual load.

Procedures for API Load

Loading the Usage via API will create individual records via REST or SOAP. For more details on how to push data into the platform, refer to the COLLECTOR_FIELDS reference data in the data model documentation.

Related Topics

Have more questions? Submit a request

Comments

Powered by Zendesk