Onboarding users documentation
Follow the steps in this section to onboard your metrics to the OPERAS metrics system.
Key terms used in this documentation:
- User: Customer of the OPERAS Metrics service.
- Provider: Organisation hosting and maintaining the OPERAS Metrics service.
- Drivers: List of drivers.
- Identifiers: Identifier Translation Service.
- Measures: Different types of measures.
- Simulation Test: First run of the OPERAS Metrics to verify it works.
Technical and personnel/skill requirements for becoming a full user of OPERAS Metrics:
- Basic bash knowledge.
- Postgres installation and creation of user and database.
- Basic data structures knowledge.
Services/Apps used in this documentation:
- Services that must be setup Locally by the user:
- Metrics-drivers-wrapper
- Identifier Translator Service
-
Services that will be managed by the provider:
- AltMetrics Service
- Metrics-API
Steps for onboarding a User
- User provides information about how views + downloads are being recorded.
1.1. If views + downloads are not being recorded via Google Analytics, or Matomo (or another Measure already supported):
1.1.1. Provider creates a new Measure in the Metrics API database.
1.1.2. Provider adds definition for new Measure to public website listing measures (or to this data: [Measures API response] [2] and have the public website run off that data).
1.1.3. User defines the yaml configuration with the correct data, i.e for the [Access Logs driver] [15].
- User registers an account on the AltMetrics Service.
2.1. Provider approves account to allow User to post metrics to Metrics API.
2.2. User registers Identifiers on the Alt Metrics service for all existing content.
2.3. User sets up periodic tasks to register Identifiers on the Alt Metrics Service for new content - EITHER:
2.3.1. Use the existing method.
2.3.2. Create new local method and post to API.
- User installs and sets up Identifier Translation Service
3.1. User creates a local database
3.2. User registers Identifiers on the Identifier Translation Service for all existing content
3.3. User sets up periodic tasks to register Identifiers on the Identifier Translation Service for new content - EITHER:
3.3.1. Use existing method
3.3.2. Create a new local method and post to the API.
- User installs and sets up Metrics Drivers Wrapper
4.1. User creates a local database
4.2. User selects and configures the Drivers
4.2.1. Refer to the drivers list above or the driver's page [Drivers][7] to select the drive(s) needed.
4.3. User sets Metrics Drivers Wrapper tasks to run periodically
4.4. Provider sets up RabbitMQ virtual host for this User and sends settings
- Tests are run
5.1. Provider gives instructions on how to run the Simulation Test
5.2. User runs Simulation Test and sends output to Provider
5.3. Provider explains the output to User
5.4. User confirms if this is the output that was expected
- User installs and configures the metrics widget.
- User arranges a schedule for manually refreshing metrics.
- Be prepared to make software updates at the Provider’s request (for performance, quality, or security improvements, or to extend the functionality)
- Please contact Rowan Hatherley or Cristian Garcia for any enquiries or issues.
Process diagram for onboarding user
Follow up
Once the system is working as expected to add the new metrics to the OPERAS system, follow the next documentation: Onboarding metrics