Integrating PrintReleaf with Xerox XSM
PrintReleaf offers an automated software integration with Xerox XSM to securely and reliably synchronize customer paper consumption data from your XSM account to PrintReleaf. Whether you use XDA or XDM, or if you use XSM directly, PrintReleaf can integrate to sync your data.
On a nightly basis, PrintReleaf performs a data collection process that connects to your XSM account via the Xerox MPS API. PrintReleaf retrieves and processes paper consumption metrics for each of your customers and deposits the data into the customer’s PrintReleaf account.
At the end of each month, PrintReleaf totals each customer’s paper consumption for that month, equates it to forest impact measured in trees, and issues a Certificate of Reforestation to the customer certifying that their paper consumption has been reforested.
Configuring the Integration
At a high-level, setup of the PrintReleaf/XSM integration involves connecting a customer feed to map XSM data to its respective account in PrintReleaf.
You will need the following credentials to connect a customer feed in PrintReleaf:
- XSM Account ID: Your XSM Account ID (ex:
- Chargeback Code: (Optional) Provide the name of a specific chargeback code to limit the devices PrintReleaf should sync. If left blank, PrintReleaf will sync all devices within your XSM account.
- Operations Center: The operations center where your XSM account is located. The PrintReleaf integration is currently available in the following operations centers: CMPSOC, EUOC, NAOC, and GOC.
Prior to connecting your first customer feed, PrintReleaf needs to gain access to your XSM account by submitting a change request form to Xerox on your behalf.
To complete this step, please submit a ticket to our support team. In your ticket, please include the name of your XSM account and your operations center.
To connect a customer feed, you provide your XSM Account ID, optionally provide a Chargeback Code, select the correct Operations Center from the dropdown menu, the Activation Date, and Sync Settings.
The XSM Account ID and Chargeback Code are used by PrintReleaf to identify the matching devices in XSM.
The Activation Date is the date PrintReleaf should begin synchronizing data for this customer; if it is set to a date in the past, PrintReleaf will automatically sync historical data back to that date.
In Sync Settings, you have the option to synchronize paper consumption from all of the customer’s devices, or only devices marked as ‘managed’.
For complete step-by-step configuration instructions, please view the Xerox XSM Integration Setup Guide.
Data Collection & Flow
PrintReleaf’s data collectors will attempt to connect to your XSM account on a nightly basis to retrieve and process customer paper consumption data. Individual customers are batched and synchronized one after another in a serial fashion.
The duration of a data collection is dependent on a number of factors, including the number of customers to be synchronized and network latency due to geographic distance to your operations center. Most individual customer data collections finish in between 1 and 2 seconds.
Customer data only flows from XSM to PrintReleaf; PrintReleaf never writes new data to your XSM server.
XSM Customer Data provided to PrintReleaf
PrintReleaf uses the Xerox MPS API to securely connect to your server and retrieve customer paper consumption data. When performing a customer data collection, PrintReleaf calls three API endpoints: ChargebackCodeGetList, AssetGetList, and RawMeterGetLatestList. Devices returns data about the management status of the device and Meters returns data about the current lifecount on the device meter. PrintReleaf synchronizes the meter data with its own database, calculates the daily deltas, and deposits the page counts to the customer’s account.
XSM device data fields stored by PrintReleaf:
- DeviceID: Unique identifier for this device supplied by XSM
- Managed: Device management status
- InitialCount: The initial lifecount on the device recorded the first time it was synced with PrintReleaf
- LatestCount: The most recently recorded lifecount on the device PrintReleaf
- LifeCount: The number of pages since syncing with PrintReleaf (LatestCount–InitialCount)
PrintReleaf does not store any other data about the customer or their devices.
Integration Health Checks
PrintReleaf actively monitors the health of your XSM integration by periodically attempting to connect to your XSM account using the credentials provided during registration. Failed attempts to connect will immediately mark the feed as unhealthy and will pause data collection until the health check passes again.
PrintReleaf also monitors the flow of inbound paper consumption data. If the feed has not received new data from XSM in 3 business days, the feed is marked as unhealthy. This often indicates the DCA is stale. When a feed becomes healthy again, PrintReleaf automatically synchronizes data back in time to when the feed became unhealthy, ensuring paper consumption data is never missed.
In transit, all network traffic to and from PrintReleaf’s web servers, data collectors, and APIs is transmitted via HTTPS. HTTP requests are not permitted. At rest, sensitive data (e.g. server credentials) are encrypted using industry standard hashing functions and ciphers.
Personal Data Security & PII
Still have questions?
Can't find the answer you're looking for? Get in touch with us.
Ready To Make A Difference?
As a Managed Print Services provider, you understand the significance of paper usage, and embracing more sustainable printing practices is becoming a vital part to doing business. Your customers rely on you to ensure smooth operations. Let's explore how PrintReleaf can support your business, deliver added value to your customers, and help you contribute to a greener planet.Start the conversation