Download Reports
- Ivo Rocha
- Antonio Filho
- Fernando Vicente
Download partner client service consumption reports
In order to download the monthly consumption reports, you will need to press the download icon on the “Actions” column of the target report or access “Reports > Detail” and press the “Download content” button on the second details card.
Report content mapping
The provided report contains a set of information in CSV (Comma Separated Values) format, and organized by partner > issuer > client service
In the foollowing table all the column definitions are described.
Name | Data Type | Description |
|---|---|---|
Partner Country | String | Partner country as provided in the subscription form. Formatted with ISO 3166-1 alpha-3. |
Partner VAT | String | Partner VAT number as provided in the subscription form. |
Partner Name | String | Partner Name as provided in the subscription form. |
Issuer Country | String | Issuer country as provided in the subscription form. Formatted with ISO 3166-1 alpha-3. |
Issuer VAT | String | Issuer VAT number as provided in the subscription form. |
Issuer Name | String | Issuer Name as provided in the subscription form. |
Client Service ID | Int | Internal ID (unique) of the client service related to the issuer that has processed the reported consumptions. |
Client Service Alias | String | External Alias (unique) of the client service related to the issuer that has processed the reported consumptions. This is the alias used by the client service to authenticate itself in Sign’Stash API. |
Processed documents count | Int | Total sum of documents signature request received by the client service. Only applicable to client services that are using Sign’Stash SaaS integration. |
Standard custody period documents count | Int | Total sum of documents to custody (simple storage) after the signature is processed by the client service. The signed document custody will be held for the period configured for the client service (by default 10 years). |
Standard preservation period documents count | Int | Total sum of documents to preserve (full storage) after the signature is processed by the client service. The signed document custody will be held and preserved by a secure audit log for the period configured for the client service (by default 10 years). |
Sum of Document Additional size (in KiloBytes) | Int | Total sum (in Kilobytes) of the processed documents that exceeds the configured limit (currently 200KB). This sum will only take into account the extra size above the configured limit of the document to process. Ex 1: if document to process has 190KB, then 0KB are added to this sum. Ex 2: if document to process has 210KB, then 10KB are added to this sum. |
Sum of Document Additional preservation period (in Months) | Int | Total sum (in months) of additional preservation for the document (current default is 120 months ). This sum will only take into account the additional months above the configured period limit. Ex 1: if document to process is to be preserved for 100 months, then 0 months are added to this sum. Ex 2: if document to process is to be preserved for 200 months, then 80 months are added to this sum. |
Processed hashes count | Int | Total sum of sign hash request received by the client service. Only applicable to client services that are using Sign’Stash Proxy. |
Successfully Processed documents count | Int | Total sum of documents signature request successfully handled by the client service. Only applicable to client services that are using Sign’Stash SaaS integration. |
Successfully Processed hashes count | Int | Total sum of sign hash request successfully handled by the client service. Only applicable to client services that are using Sign’Stash Proxy. |
Bundle | String | States the type of service subscribed for this client service:
|
How to calculate extra size of the documents
Extra value will be calculated for processed documents that exceed the configured size limit (currently 200KB). To calculate these packages, will be necessary to sum the values in the Sum of document additional size field in the report (this sum will only take into account the extra size above the configured limit of the document to process). In this way, extra values of processed documents that have exceeded 200 KB (200.000 bytes) will be aggregated in 100KB packets.
For example:
If the exceeded value is 1739542 bytes, then the value will be calculated as follows:
1739542 / 1000 = 1739,542KBto get how many KB were consumed;1739,542 / 100 = 17,39542a new division will be made to calculate how many packets were consumed, with the standard rounding;
For this example 17 additional packets of 100KB would be calculated;