General properties

These properties are displayed in the Trading Partner UI when you view or edit envelope properties. Not all properties can be edited.

Basic properties

Type

Type for the envelope. Varies by standard. Example for TRADACOMS: STX.

Name

Envelope name. Required.

Sender Id

Coded identifier of the sending company or division. Required.

Valid values: * (asterisk) as wildcard, 15 standard characters.

Receiver ID

Coded identifier of the receiving company or division. Required.

Valid values: * (asterisk) as wildcard, 15 standard characters.

Tenant Id

An ID that is assigned to a tenant (customer or organization). In order for a tenant to access data, the tenant ID must match the tenant ID that is assigned to the data. This ensures that tenants access authorized data only. Required.

Valid values: DEFAULT (default), or select an available tenant.

User

User for the envelope.

Description

Your description of the envelope. Optional.

Valid value: string

Comments

Any comments that you care to note. Optional.

Valid value: string

Create Date

The date and time that the envelope was created.

Standard

Standard for the envelope.

Direction

Direction of data flow. Required.

Valid values: Inbound (default), Outbound.

Envelope version

Version for this envelope.

Control number properties

The following properties are displayed in the "Control Numbers" section of the General page when an envelope is selected for editing:

Control Number

An incrementing series of numbers, mutually agreed upon by sender and receiver, that establishes a verifiable sequence-checking process for transmitting and receiving data. Control numbers help keep track of transmitted data and help guarantee that control code is unique.

Valid value: Integer (increments). Initial default: 1

Control Number Type

Type of control number.

Valid values: Local (default), Global. Might vary by standard.

Local: (Default) A numeric value that is assigned when the envelope is created or edited.
Global: A numeric value that increments after each use. You can create your own global control numbers and multiple envelopes can use the same global control number.