ISDS - Outgoing Changes Reader
[ | version 3.0]
You are viewing outdated version, see the latest version
Connector
The connector is permitted for use of the platform background agent.
Connector processing type: Row by row!
Connector allows you to retrieve a list of sent messages whose statuses have changed within a specified time interval.
Configuration
ISDS Connection
Username
Defines the login name that is used for CPost messagebox authentication.
A placeholder can be used for input data.
Password
Defines the password that is used for CPost messagebox authentication.
A placeholder can be used for input data.
Credentials
Supported credential types:
- ManualInput - login credentials are taken from this configuration properties
UserNameandPassword. - TakeFromInput - login credentials are taken foreach input row from input data properties
UserNameandPassword.
ISDS Environment
Testing Environment
When set to true messages are send to testing environment.
ISDS Messagebox
Recipient ID
ID of message box. Input data can be referred by using placeholders, ie. ${input.ObjectID} will be replaced by value in ObjectID property.
ISDS Outgoing Changed Messages Reader configuration
From
Date with time from which take the messages.
(format: 2022-02-07T15:30:24.914Z for UTC or 2022-02-07T15:30:24.914 for local)
To
Date with time from which take the messages.
(format: 2022-02-07T15:30:24.914Z for UTC or 2022-02-07T15:30:24.914 for local)
Anchors Created During Record Generation
When listing records in this step, it's important to remember that each run creates a new anchor from which the records will be read.
Each run starts reading from a new anchor point, ensuring that previously read messages are not duplicated in subsequent runs.
The location where the anchor is created is displayed in the Data Checkpoint Overview(more here). You can also delete the anchor from this overview if necessary.
Input & Output Schema
Input
Data schema is optional
The connector does not expect a specific schema. The required data structure can be achieved by correct configuration. Although the selected connector doesn't require a schema generally, the individual integration task step may need to match the output data structure of the preceding task step and use a data schema selected from the repository or create a new input schema.
Output
ISDS Outgoing Changed Message (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| ID | String | No | The ID of the data message. |
| MessageStatus | Integer | Yes | Code representing the message status - see below. |
| MessageStatusName | String | Yes | Description of the message status - see below. |
| DeliverySignedFileName | String | Yes | Name of the delivery receipt file. |
| DeliverySignedFileContent | Base64 | Yes | Content of the delivery receipt file encoded in Base64. |
| DeliveryEvents | ISDS Delivery event 1.0.0 |
Yes | Complex schema. |
Message Status
| Status | Description |
|---|---|
| 1 | Data message was submitted. |
| 2 | Data message including documents signed with a submission timestamp. |
| 3 | Data message failed AV (Antivirus) check - message not delivered, final status before deletion. |
| 4 | Data message has been delivered to the recipient's mailbox (delivery time recorded), accessible to the recipient. |
| 5 | 10 days have passed since the message delivery, which has not yet been retrieved, assumed delivered by logging in. |
| 6 | Authorized person logged in to read this message - message was delivered by login. |
| 7 | Message has been read (downloaded) by the recipient. |
| 8 | Message was not marked as undeliverable because the recipient's mailbox was inaccessible. |
| 9 | Message content was deleted, the envelope moved to the archive. |
| 10 | Message was moved to the data vault. |
ISDS Delivery Event (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Time | DateTime | Yes | Delivery time of event |
| Description | String | Yes | Description of the event |
Release notes
3.0.7
- Fixed loading dependant libraries.