A Usage>Monthy Report page under the Admin menu allows administrators to download monthly transaction/usage reports. The page provides dropdown menus for selecting calendar year and month, and a download button. Combined, this gives administrators a self-service option to retrieve usage data on demand.
Transactions are defined as a unit used to measure customer usage of Cleo Integration Cloud. See Related Topic below for more information.
Notes
- The page is restricted to Admins only; non-admins cannot access it. Reporting is by calendar month, with no contract details shown.
- Downloads are only available for months where report data exists, with appropriate error messaging if a download can't be initiated.
Column Headers
Most reports contain these column headers:
| Column | Definition | Examples |
|---|---|---|
| Date | Reporting period; the month/year the transactions occurred. | Apr-26 |
| Count Type | Categorizes the transaction as either Payload or Message. A Message is the business-level representation of a document flowing through CIC (with transformation), while a Payload is the physical data being moved between endpoints. A single payload file could contain multiple messages (e.g., an EDI interchange with several transaction sets). |
Payload or Message
|
| Message or Payload Type |
The document/flow type. Indicates whether data was transformed (message) or passed through without transformation (payload). A passthrough creates a payload (Status Transaction), while a transformation creates messages (Business Transactions) that appear as Message Tiles in the Cockpit. |
|
| If column Count Type = Message, this field will show the document type. |
850,810, etc. |
|
| If column Count Type = Payload, this field displays Passthrough/API/Others | Passthrough/API/Others |
|
| Source Endpoint Name | Name of the originating endpoint that is sending the data. | BigLots Server |
| Source Endpoint Type | Protocol used by the source endpoint. |
SFTP, FILE_SYSTEM, PARTNER_MAILBOX
|
| Destination Endpoint Name | Name of the receiving endpoint. | Atmos |
| Destination Endpoint Type | Protocol used by the destination endpoint. |
PARTNER_MAILBOX, FILE_SYSTEM
|
| Direction | Inbound (Receive) or Outbound (Send), relative to tenant. |
Not populated for Payload flows. |
| Partner ID | Trading partner unique identifier. | Populated for EDI/Message type rows. |
| Partner Name | Trading partner. | |
| Transaction Count | Number of individual transactions (payloads/messages) processed in the period; the primary billable metric. | 1, 20, 5000.... |
| Job Count | Number of Jobs (integration runs) that produced those transactions; one Job can generate multiple transactions. | 1, 20, 5000.... |
Related Topic:
What is a Transaction?
A Transaction is a unit used to measure customer usage of Cleo Integration Cloud.
Each of the following counts as one transaction:
- EDI-based document:
- Each ST/SE fragment within an ANSI X12 document which is delivered as part of an integration. For example, an 850 or 810 transaction set.
- Each UNH-UNT fragment within an EDIFACT document which is delivered as part of an integration. For example, an ORDERS or INVOIC transaction set.
- Each MHD/MTR fragment within an Tradacoms document which is delivered as part of an integration. For example, an ORDHDR or INVFIL transaction set.
- Non-EDI-based document: A non-EDI fragment which is delivered as part of an integration. For example, an Order or Invoice in a non-EDI format.
- Payload-based document: A payload which is delivered via any protocol (file transfer, API, cloud storage or database).
- A secondary delivery associated with processing of a document such as:
- A document generated from the same source data being delivered to multiple destinations.
- An outbound process generates both an outbound document and an update via any protocol to a secondary source such as a visibility platform, final mile logistics application or other endpoint.
- An inbound document updating more than one internal system or SaaS service, such as both an ERP and a data lake. (Each additional system updated counts as one transaction.)
Non-counted towards chargeable usage:
- Functional Acknowledgment (997 for X12)
- EDIFACT CONTRL
- API or database calls made during the processing of a transaction to validate or augment data
- API or database calls to the customer’s own systems or SaaS services that are used to track the status of integrations
Comments
0 comments
Please sign in to leave a comment.