OFTP2 Connector Record object

OFTP2 Connector Records correspond to the document and trading partner details of the Process Reporting page. Processes send OFTP2 messages using the OFTP2 Client connector and receive OFTP2 messages using the OFTP2 Server connector. The OFTP2 Connector Record object contains OFTP2-specific document information and user-defined tracked field informtaion along with other fields.

Structure

<OFTP2ConnectorRecord>
    <sfiddsn/>
    <sfiddate/>
    <sfidtime/>
    <sfiddest/>
    <initiator_ssidcode/>
    <responder_ssidcode/>
    <sfidorig/>
    <sfidsec/>
    <sfidcomp/>
    <sfidciph/>
    <sfiddesc/>
    <sfidsign/>
    <sfidosiz/>
    <sfidenv/>
    <objecttype/>
    <status/>
    <account/>
    <executionId/>
    <atomId/>
    <dateProcessed/>
    <id/>
    <actionType/>
    <connectorType/>
    <connectorName/>
    <operationName/>
    <documentIndex/>
    <successful/>
    <size/>
    <customFields>
      <field1>value</field1>
      .
      .
      .
      <fieldN>value</fieldN>
    </customFields>
    <ticker/>
    <nareas/>
    <nareast/>
</OFTP2ConnectorRecord>

Field	Type	Description
sfiddsn	string	The dataset name of the virtual file being transferred.
sfiddate	string	The date when the virtual file was created. The format is yyyy-MM-dd, for example 2023-06-07.
sfidtime	string	The time when the virtual file was created. The format is HH:mm:ss.SSSX, where X is the ticker, for example 10:06:46.2389.
sfiddest	string	The destination Odette ID for the virtual file.
initiator_ssidcode	string	The Initiator's Identification Code.
responder_ssidcode	string	The Responder's Identification Code.
sfidorig	string	The originator of the virtual file.
sfidsec	numeric	Indicates whether the file has been signed or encrypted before transmission. The following values are possible: -00 - No security services -01 - Encrypted -02 - Signed -03 - Encrypted and signed
sfidcomp	numeric	Indicates whether an algorithm was used to compress the file. -0 - No compression -1 - Compressed with an algorithm.
sfidciph	numeric	Indicates which cipher suite was used to sign or encrypt the file. The cipher suite in this value should also be used when a signed EERP or NERP is requested. -00 - No security services -01 - 3DES_EDE_CBC_3KEY -02 - AES_256_CBC
sfiddesc	string	The description of the virtual file.
sfidsign	string	Whether the EERP returned for the file must be signed. -Y - the EERP must be signed -N - The EERP must not be signed
sfidosiz	numeric	The size of the original file.
sfidenv	numeric	The enveloping format used in the file. -0 - No enveloped -1 - File is enveloped using CMS
status	stringg	Whether the file transmission is pending an acknowledgment, acknowledged as a success or an error.
account	string	The ID of the account from which you ran this record.
executionId	string	The ID of the execution run.
atomId	string	The ID of the Runtime that processed this record.
dateProcessed	string	The processing date and time of this record. The format is yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2013-08-08T15:32:00Z.
id	string	The ID of this record.
actionType	string	The type of action with which this record corresponds - Send, Get or Listen.
connectorType	string	The type of connector to which this record corresponds- oftp for OFTP2 Client or oftpserver for OFTP2 Server.
connectorName	string	For the OFTP2 Client, the value is oftp Connector and for the OFTP2 Server, the value is oftpserver Connector.
operationName	string	The name of the operation component that processed this record.
documentIndex	int	The numerical index of this record in the run.
successful	boolean	Whether the record is a success or error.
size	long	The size, in bytes, of the document that corresponds to this record.
customFields	string	Custom fields based on the fields configured on the Setup page's Document Tracking tab. The names of the fields are dependent on your account setup.
nareas	int	Only displays if the transmission failed. The reason numeric code for the failure.
nareast	string	Only displays if the transmission failed. The reason text for the failure.

For more information about start file fields, see the OFTP2 documentataion.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not supported	Supported	Not supported	Not supported	Not supported	Not supported

You can use the fields defined in the previous section as QUERY filters for the OFTP2 Connector Record object.

To filter by a custom field, use the format customFields/fieldName as the filter property, where fieldName is the element name of the custom field in the OFTP2 Connector Record structure. To get a list of the available custom fields, see Custom Tracked Field object.

The operators allowed for the OFTP2 Connector Record object filters are:

• EQUALS
• STARTS_WITH
• BETWEEN
• GREATER_THAN
• GREATER_THAN_OR_EQUAL
• LESS_THAN
• LESS_THAN_OR_EQUAL

However, it is important to note that the STARTS_WITH operator accepts only values that do not include spaces.

For general information about the structure of QUERY filters and how to handle the paged results, see Query filters and Query paging.

Sorting of the QUERY results are by the dateProcessed field value, from the oldest to the newest.