Manual upload reporting

On-premises products can support subscription usage data that is manually uploaded or entered. For products that support manual upload, you use a command-line interface (CLI) command to have the Edge Agent generate a usage report. Once generated, you can log on to the platform and upload it. This is an alternative to the recommended best practice of enabling automated reporting.

The prerequisites for manually uploading subscription usage data are:

  • The Edge Agent has been deployed and configured properly for your on-premises product. See Edge Agent setup and configuration.
  • Your product has deployed the input and report configuration files, as described in the user documentation for your product.
  • The agent is running. See Agent operations.

Generate the report

Use the following information to write a CLI command for generating a report manually.

The command has the following structure:

amplify-edge-agent-cli query <from> <to> --configurationName=<report_configuration_file_name>


CLI argument Description Example value
from Begin date for the report in yyyy-MM-DD format. 2020-01-01
to End date for the report in yyyy-MM-DD format. 2020-01-07
report_configuration_file_name Name of the report configuration file that is stored in the agent at  /opt/edge_agent/conf/agent/report. MFT.json

The following is an example of a complete CLI command with argument values.

/opt/edge_agent/amplify-edge-agent-cli query 2020-01-01 2020-01-07 --configurationName=MFT.json

To generate the report

  1. Use your command to generate the report.
  2. Copy the report file from the agent server to your local computer.

Upload the report

Follow these steps to upload usage files for any timeframe excluding the current month.

  1. Log on to the Amplify platform.
  2. Select  <User Name> | Organization  at the top right. The Organization page is displayed.
  3. Click the  Usage  tab.
  4. Click the Actions ( ... ) menu, and then select  Upload Usage. A pop-up window for uploading the file is displayed.
  5. Browse to the file and click  Upload. The file is uploaded unless a message is displayed that prompts you to type the name of a new platform environment for your organization. This is because the platform doesn't recognize the environment ID in the report file. The environment ID  is the identifier of your on-premises product environment. The ID is set in the configuration of your agent.  If the prompt is displayed, go to the next step. If the prompt is not displayed, the platform recognizes that the environment ID already is associated with a platform environment belonging to your organization.
  6. If prompted, type the name of a new environment to associate with the environment ID in the file and with your organization. This can be any name you want, but should be meaningful in relation to your on-premises environment. For example,  MFT Phoenix. Click  Create  to add the environment on the platform and complete the file upload.
  7. Once the file has been uploaded successfully you can browse the data on the Usage page.

Related Links