Usage metering initialization
Local installations of Flow Production Tracking are no longer offered. This documentation is intended only for those with existing instances of Shotgun Enterprise Docker. Click here for a list of our current offerings.
Your installation of Flow Production Tracking must be initialized with a database index, to allow for usage metrics to be queried by an authorized Admin user.
Indexing may take a long time to complete, depending on the size of your event_log_entries table. We strongly suggest to create the index a few days in advance of the first required metrics reporting date.
Separate to these setup instructions, reporting instructions will be provided by your CSM. Your organization should appoint a responsible party to perform these usage queries at appropriate periods.
For versions of Flow Production Tracking 8.13.0.3681 and above and Flow Production Tracking
Setup can be performed simply by having an authenticated Flow Production Tracking Admin visit the following URL:
<FLOW PRODUCTION TRACKING_URL>/metering/create_index
A JSON file will be generated upon completion. The filename will include an indication of success or failure:
| filename pattern | interpretation |
|---|---|
| *--success.json | index successfully created |
| *--skipped.json | index exists; no action performed |
| *--failure.json | index creation failed |
In case of failure, please supply the resulting json file to assist with troubleshooting.
For versions of Flow Production Tracking prior to 8.13.0.3681
Autodesk will provide standalone scripts for setup and generation of usage reports. Installations must be done with shell access to the Flow Production Tracking server. For Dockerized Flow Production Tracking, this means within the running Docker container.
Periodic access to the Flow Production Tracking server will be necessary to generate usage reports from the shell script.
Getting shell access to the Flow Production Tracking server/container is outside the scope of this document. Your SysAdmin or DevOps team should be able to complete these tasks.
- Request a standalone version of the scripts to enable metering if you have not already been supplied them by your CSM.
- Copy scripts to the Flow Production Tracking server/container. Destination should be the root of the Flow Production Tracking code base hierarchy. Verify that a
scriptsub-directory exists at this location, containing a file namedrunner.Important:When updating Flow Production Tracking to a version prior to 8.13.0.3681, be sure to re-copy or link these scripts into the new version's directory.
- Execute the following commands, or container equivalent, from the root of the Flow Production Tracking code base:
# make the files executable. If you copied the scripts elsewhere, you will need to adjust these commands
# accordingly.
% chmod -v +x metering_*.rb
# Create the index, use -q as we do not need to collect the output.
% ./metering_create_index.rb -q