In order to process usage using printing as a service stream with metering, you must create meter type (product you want to meter) and meters (bucket to measure the usage per customer for the product). This step is usually done using an APIs which are called from the external system. For convenience, there has been additional streams provided which can be executed to do this configuration.
Here is a step by step guide on how you can provision meters and meter types for an example stream - printing as a service.
The helper streams can be copied from the links and can be imported using Usage Engine CE UI:
Provisioning Meter Types - This stream helps to creates a meter type (Pay-per-print) which is a product definition for measuring prints done by each printer. It uses the aggregation type SUM and has reset interval set as Monthly ie, golden record is sent once the month has ended.
Provisioning Meters - This stream provision the meters for printers with printer id as a key (user Id).
Purge Meters - This is additional stream to clean-up meters post processing.
Step 1
Create a new application access for your account. This is needed for authenticating with the Usage Engine APIs.
Step 2
Create a new secret in secrets wallet of type OAuth 2.0 containing your applications credentials. Select authentication type “Client credentials“ and add client ID and client secret which is being created in previous step.
Step 3
Import all helper streams using the above links.
Step 4
Update the authentication in all streams with your new secret. Ensure that the audience and access token URL of the OAuth2 authentication is configured to match your Environments API base URL.
Step 5
Run stream 1. Provisioning Meter Types. After the stream has completed you will have a new meter type named "Pay-per-print" in the Usage metering section.
Step 6
Navigate to "Usage metering" and copy the ids of the meter type with category "Printing" for later.
Also, open the stream configuration of 2. Printing As A Service with Metering and copy the meter key from the Meter processor for later.
Step 7
Open the stream configuration of 3. Provisioning Meters and open the script named "Prepare Meters". Paste in the meter type ids and meter key that you got from the previous step.
Step 8
Run stream 3. Provisioning Meters. After the stream has completed, you will have 5 meters across your newly created meter type.
Step 9
The meters you created in the previous step is now associated with the Meter Processor in the 2. Printing As A Service with Metering stream.
Run 2. Printing As A Service stream. After its completion, you will be able to see the aggregated values from the input records in the inspection tab.
Step 10 (Optional)
If you want to delete your meters. Navigate to the stream configuration of 4. Purge Meters. Paste the meter type ids and meter key into the script "Prepare Filter". Run the stream. Now all meters related to Printing As A Service with Metering have been deleted.