Skip to content
background-image background-image

ISDS - Outgoing Reader

[ | version 3.2]

Connector

The connector is permitted for use of the platform background agent.

Connector processing type: Row by row!

Connector allows you to download a list of sent messages that have not been deleted. The list can be filtered by a specified time interval and message status


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 UserName and Password.
  • TakeFromInput - login credentials are taken foreach input row from input data properties UserName and Password.

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 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)

Status

  • All statuses
  • Message passed
  • Message signed
  • Message not validated by antivirus
  • Message sent to recipient
  • Elapse 10 days from delivery
  • Message delivered by signing-in
  • Message read
  • Message marked as undeliverable
  • Message content deleted
  • Message moved to safe

Number of messages to process

Maximum number of messages which will be processed in one task run. When empty, all messages are processed

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.

Example

If you set up the Outgoing Message Reader from January 1 and 3 messages to process, the first three received messages from January 1 will be displayed. If you run it again, these three messages will no longer be displayed, and the connector will list the next three messages, and so on.

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.

Include ZFO format

Include ZFO format of signed message

Longer timeout for large volume messages

When sending or receiving large messages, it's recommended to increase the Timeout duration for each step, such as setting it to 2-3 minutes per step.


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 Message (ver. 1.2.0)

Column Data type Allow null Description
ID String No The ID of the data message.
IDSender String Yes The sender's data box ID.
Sender String Yes The sender's name or title.
SenderAddress String Yes The sender's composite address.
SenderType String Yes The sender's type.
SenderOrgUnit Integer Yes Optional auxiliary address information.
SenderRefNumber String Yes File number related to the sender, optional, max length 50 characters.
SenderIdent String Yes Case number related to the sender, optional, max length 50 characters.
IDRecepient String Yes The recipient's data box ID.
RecepientAddress String Yes The recipient's composite address.
RecepientOrgUnit String Yes Optional auxiliary address information.
RecepientOrgUnitNum Integer Yes Optional auxiliary address information.
RecepientRefNumber String Yes File number related to the recipient, optional, max length 50 characters.
RecepientIdent String Yes Case mark related to the recipient, optional, max length 50 characters.
ToHands String Yes Has no further procedural significance. Do not confuse with PersonalDelivery!
Annotation String Yes Important textual information describing the data message. Maximum length 255 characters. Appears on the Portal as the "message description".
LegalTitleLaw Integer Yes Together with all "LegalTitle" they form the Authorization.
LegalTitleYear Integer Yes Together with all "LegalTitle" they form the AuthorizatiAn.
LegalTitleSect String Yes Together with all "LegalTitle" they form the AuthorizatiAn.
LegalTilePar String Yes Together with all "LegalTitle" they form the AuthorizatiAn.
LegalTilePoint String Yes Together with all "LegalTitle" they form the AuthorizatiAn.
PersonalDelivery Bool Yes Indicates the data message is for personal delivery. Only a user with higher authorization can read this.
AllowSubstDelivery Bool Yes Flag indicating whether the message is allowed to be delivered by fiction after 10 days from delivery.
DeliveryTime DateTime Yes The date and time of delivery.
AcceptanceTime DateTime Yes The date and time of acceptance (first acceptance, thus in the case of fictional delivery and subsequent delivery by reading, the time of fictional delivery will be here)
MessageStatus Integer Yes The status of the data message. See below.
MessageStatusName String Yes Empty.
AttachmentSize Integer Yes The rounded size of all attachments (entire message) in kilobytes.
SignedFileName String Yes The name of the delivery note (in the format: .zfo)
SignedFileContent Base64 Yes The content of the delivery note
Files ISDS File 1.1.0 Yes Complex schema.
DeliverySignedFileName String Yes Name of the delivery receipt file.
DeliverySignedFileContent Base64 Yes Content of the delivery receipt file in Base64 encoding.
DeliveryEvents ISDS Delivery Event 1.1.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 File (ver. 1.1.0)

Column Data type Allow null Description
Name String Yes Name of file
MimeType String Yes File mime type
MetaType String Yes Meta type
Data Base64 Yes File content

MetaTypes:

  • main - the first document file
  • enclosure - attachment file
  • signature - digital signature file
  • meta - specific XML data formated file

ISDS Delivery Event (ver. 1.1.0)

Column Data type Allow null Description
Time DateTime Yes Delivery time of event
Description String Yes Description of the event

Release notes

3.1.2

  • Fixed step timeout propagation.

3.1.2

  • Fixed loading dependant libraries.