Nino Crudele's Blog

Tab

Setting

Usage

General

Display Code

The Partner Interface Process (PIP) display code. This can correspond either to the RosettaNet PIP designation or to the name for a custom schema. It is recommended that you use a standard naming convention, such as a name including the process code and the version, for example, "STD_3A2_R02.00.00A". This will make it easier for you to maintain different versions of the same PIP.

Required field.

General

Process Code

The three-digit PIP code. For example, "3A2".

Required field.

General

Version

The version of the PIP. For example, "V02.02" or "R02.00.00A".

Required field.

General

Process Name

The name of the PIP. For example, "Price and Availability Request Action".

Required field.

General

Description

A description of the messages that conform to the PIP.

General

Standard

The type of standard.

Possible values: RosettaNet (the default) or CIDX

General

(Non-RosettaNet content area)

Message standard

For non-RosettaNet content, the name of the non-RosettaNet standard. Use this setting if you are not using a RosettaNet PIP, but have defined a custom schema. Use this setting for RNIF 2.0 only, not for RNIF 1.1 or CIDX.

General

(Non-RosettaNet content area)

Standard version

For non-RosettaNet content, the version of the non-RosettaNet standard. Use this setting if you are not using a RosettaNet PIP, but have defined a custom schema. Use this setting for RNIF 2.0 only, not for RNIF 1.1 or CIDX.

General

(Non-RosettaNet content area)

Payload binding ID

For non-RosettaNet content, the identification number of the payload content. Use this setting if you are not using a RosettaNet PIP, but have defined a custom schema. The party implementing the custom PIP should define this value. Use this setting for RNIF 2.0 only, not for RNIF 1.1 or CIDX.

Activity

(Acknowledgement of Receipt area)

Non-Repudiation Required

Determines whether signal messages must be signed (with a message digest included in the acknowledgement message) and stored in their original form by the receiving party in the MessageStorageIn or MessageStorageOut table of the BTARNArchive database, for non-repudiation purposes. The receiving party must store the signals for the period designated in the Non-Repudiation of origin property in the partner configuration.

Possible values: True (the default) or False

If False, signal messages will not be stored for non-repudiation purposes. Signal messages can be signed or not.

If True, inbound signal messages will be stored in their original form in the MessageStorageIn table. Outbound signal messages will be stored in their original form in the MessageStorageOut table. Signal messages must be signed.

For more information, see Authorization and Non-Repudiation Properties.

Activity

(Acknowledgement of Receipt area)

Time To Acknowledge (seconds)

The time in seconds by which the initiator must receive the acknowledgement. If the initiator does not receive it by this time, the initiator will retry if the retries have not exceeded the Retry count (in the Behavior section of this tab).

BTARN measures the Time To Acknowledge value from the time the initiator sent out the action message successfully. The value is included in the delivery header. The value cannot be less than zero or greater than the Time To Perform value that is set on the same page.

You use this setting for signal messages (application acknowledgements) returned in RNIF 1.1 and 2.01 processing. You also use this setting for acceptance acknowledgements returned in RNIF 1.1 processing.

The default value is 7200 seconds (two hours).

Activity

(Behavior area)

Is Authorization Required

Determines whether any incoming Action or Signal message must be signed. BTARN will not accept a business document if the individual/role is not authorized to perform the activity.

Possible values: True (the default) or False

If False, outbound action and signal messages will not be signed. Inbound action and signal messages may be signed. If they are not signed, the system will authorize the partner using the delivery header.

If True, incoming messages must be signed. Outgoing messages may be signed. Outgoing messages are signed only if Non-Repudiation of Origin and Content is set to True.

For more information, see Authorization and Non-Repudiation Properties.

Activity

(Behavior area)

Is Persistent Confidentiality Required

Determines whether encryption is required.

Possible values: None (the default) indicates that no encryption is required. Payload indicates that encryption of the service content and attachments is required. Payload Container indicates that encryption of the service content, attachments, and service header is required.

In RNIF 2.0, the preamble and delivery header are never encrypted. In RNIF 1.1, no message parts are encrypted. They are only signed.

Activity

(Behavior area)

Is Secure Transport Required

Determines whether HTTPS transport is required.

Possible values: True (the default) or False

Activity

(Behavior area)

Is Single Action

Determines whether messages are single-action or double-action.

Possible values: True (the default) or False

Single-action messages are Information Distribution or Notification. Double-action messages are Business Transaction, Request Confirm, Request/Response, or Query/Response.

If the standard is CIDX, Is Single Action must be True.

Activity

(Behavior area)

Is Synchronous

Determines whether trading partners will exchange action messages synchronously or asynchronously.

Possible values: True or False (the default)

Not used for RNIF 1.1.

Activity

(Behavior area)

Non-Repudiation of Origin and Content

Determines whether action messages must be signed and stored by the receiving party in their original received form in the MessageStorageIn or MessageStorageOut table of the BTARNArchive database, for non-repudiation purposes. The receiving party must store the action messages for the period designated in the Non-Repudiation of origin property in the partner configuration for non-repudiation purposes. If required, the action messages must be signed.

Possible values: True (the default) or False

If False, action messages will not be stored for non-repudiation purposes. Action messages can be signed or not.

If True, inbound action messages will be stored in their original form in the MessageStorageIn table. Outbound action messages will be stored in their original form in the MessageStorageOut table. Action messages must be signed.

For more information, see Authorization and Non-Repudiation Properties.

Activity

(Behavior area)

Retry Count

The number of times that the process should retry the activity if transport or processing fails. If the retry count is 3, then the process will attempt the activity four times.

The default value is 3.

If communication is synchronous, then BTARN does not use this field, because retries do not apply in synchronous transactions.

Activity

(Behavior area)

Time to Perform

The period (in seconds) within which the process must complete the activity. The period begins when the initiator sends the first document. The initiator (not the responder) must make sure that the activity completes within this period. This value is in the delivery header.

The default value is 86400 seconds (24 hours).

The Time To Perform value must be greater than the Time To Acknowledge value that is set in the Acknowledgement of Receipt section of the same page.

Activity

(General area)

Type

Determines the type of the activity.

Possible values: Business Transaction, Information Distribution (the default), Notification, Query/Response, Request/Confirm, or Request/Response

Initiator

(Business Document area)

Description

A description of the initiator action's business document.

Initiator

(Business Document area)

Name

The name of the initiator action's business document. For example, "Price and Availability Request".

Initiator

(Business Document area)

Version

The version of the business document. For example, "V02_02_00" or "R02.00.00A".

You can find this version number at the beginning of the RosettaNet XML Message Guidelines .htm file that you download with the PIP specification .doc file and the PIP DTD from the RosettaNet organization.

Initiator

(General area)

Action

A description of the initiator action. For example, "Synchronous Test Query Action".

Initiator

(General area)

Role

The role of the initiator. For example, "Buyer" or "Payer".

The default value is "Initiator".

Initiator

(General area)

Role Description

A description of the role of the initiator. For example, "The party issuing the payment".

Initiator

(General area)

Role Type

The type of role of the initiator.

Possible values: Organizational, Employee, or Functional (the default)

Initiator

(General area)

Service

The initiator service. For example, "Buyer Service" or "Payer Service".

Initiator

(General area)

Service Classification

The type of initiator service. For example, "Business Service".

Responder

(Business Document area)

Description

A description of the responder action's business document. For example, "Formally confirms the status of line items in a purchase order".

Responder

(Business Document area)

Name

The name of the responder action's business document. For example, "Purchase Order Confirmation".

Responder

(Business Document area)

Version

The version of the business document. For example, "V02.02.00" or "R02.00.00A". You can find this version number at the beginning of the RosettaNet XML Message Guidelines .htm file that you download with the PIP specification .doc file and the PIP DTD from the RosettaNet organization.

Responder

(General area)

Action

A description of the responder action. For example, "Purchase Order Confirmation Action".

Responder

(General area)

Role

The role of the responder. For example, "Seller".

The default value is "Responder".

Responder

(General area)

Role Description

A description of the role of the responder. For example, "The party receiving payment".

Responder

(General area)

Role Type

The type of role of the responder.

Possible values: Organizational (the default), Employee, or Functional

Responder

(General area)

Service

The responder service. For example, "Seller Service".

Responder

(General area)

Service Classification

The type of responder service. For example, "Business Service".

Process Configuration setting

Information in the PIP specification

Process Code

Subheading on the title page, for example, "PIP3A4"

Version

PIP Version Identifier subheading on the title page, for example, "02.02.00"

Process name

Subheading on the title page, for example, "Request Purchase Order"

Description (General tab)

Section 3.1, Business Process Definition

Non-Repudiation Required

Table 3-3: Business Activity Performance Controls

Time to Acknowledge (Seconds)

Table 3-3: Business Activity Performance Controls

Is Authorization Required?

Table 3-3: Business Activity Performance Controls

Is Persistent Confidentiality Required

(No reference from the PIP specification)

Is Secure Transport Required?

Table 4-3: Message Exchange Controls

Is Single Action

Section 4.3, Business Transaction Dialog Specification

Non-Repudiation of Origin and Content

Table 3-3: Business Activity Performance Controls

Retry Count

Table 3-3: Business Activity Performance Controls

Time to Perform

Table 3-3: Business Activity Performance Controls

Name

Table 3-3: Business Activity Performance Controls (Activity Name)

Type

(No reference from the PIP specification - for future use)

Description (Initiator and Response tabs)

Table 3-4: PIP Business Documents

Name (Initiator and Response tabs)

Table 3-4: PIP Business Documents

Role (Initiator and Response tabs)

Table 3-1: Partner Role Descriptions

Role Description (Initiator and Response tabs)

Table 3-1: Partner Role Descriptions

Role Type (Initiator and Response tabs)

Table 3-1: Partner Role Descriptions

Service

Table 4-1: Network Component Specification

Service Classification

Table 4-1: Network Component Specification

Tab

Setting

Usage

General

Name

The name for the home organization.

Required field.

Maximum length: 255

General

GBI

The Global Business Identifier for the home organization. This must be nine digits in length, and must correspond to the DUNS number.

Required field.

General

Description

A description that will help identify the home organization.

General

Home organization classification

The nature of the organization.

Can be End User, End User Government, Financier, Manufacturer, Retailer, Shopper, Freight Forwarder, or Marketplace.

You can enter another value for the home organization classification in the service header of a message, overriding this property, by entering an HPCC custom property in the Custom Properties tab of the agreement. For more information, see Creating or Editing an Agreement.

Contact Properties

Contact name

The name of the contact at the home organization.

Required field.

Contact Properties

E-mail address

The e-mail address of the contact at the home organization.

Required field.

Contact Properties

Telephone number

The telephone number for the contact at the home organization.

Required field.

Contact Properties

Fax number

The fax number for the contact at the home organization.

Required field.

Contact Properties

Supply chain code

The supply chain code for the home organization.

Required field.

Tab

Setting

Usage

General

Name

The name for the trading partner.

Required field.

Maximum length: 255

General

GBI

The Global Business Identifier for the partner. This must be nine digits long, and must correspond to the DUNS number.

Required field.

General

Description

A description that identifies the partner.

General

Hold until

The date on which BTARN will submit a message to the MessagesFromLOB table. BTARN will not deliver this message until the Hold until date. Partners must agree on this date, based on when the receiving partner will be ready to receive the message. This setting may be useful if a partner will not be available to process messages, for example, during a holiday.

The default value is the current date.

General

Partner classification

The type of the partner organization.

Can be Carrier (the default), Distributor, End User, End User Government, Financier, Manufacturer, Retailer, or Shopper.

BTARN includes the value of this field in the Service header.

You can enter another value for the partner classification in the service header of a message, overriding this property, by entering a PPCC custom property in the Custom Properties tab of the agreement. For more information, see Creating or Editing an Agreement.

General

Non-Repudiation of Origin

The number of days BTARN will hold the wire format of a message in the MessageStorageIn or MessageStorageOut database for non-repudiation (to prove legally that it has received it). BTARN will stamp this date on each incoming or outgoing message.

The default value is 2485 days.

However, BTARN will not delete a message from the database upon expiration of this period. If you want to delete these messages, develop an SQL script to delete old messages based on this date/time stamp.

General

(Public key certificates area)

Signature

The public key certificate that BTARN will use to verify the partner's signature on an incoming message. This certificate must be stored in the Other People certificate store in the Certificate (Local Computer) node in the BTARN Management Console.

The default value is <none>.

General

(Public key certificates area)

Encryption

The public-key encryption certificate that BTARN will use to encrypt outgoing messages to a partner. This certificate must be stored in the Other People certificate store in the Certificate (Local Computer) node in the BTARN Management Console.

The default value is <none>.

Contact Properties

Contact name

The name of the contact at the partner.

Required field.

Contact Properties

E-mail address

The e-mail address of the contact at the partner.

Required field.

Contact Properties

Telephone number

The telephone number for the contact at the partner.

Required field.

Contact Properties

Fax number

The fax number for the contact at the partner.

Required field.

Contact Properties

Supply chain code

The supply chain code for the partner. For example, "Information Technology" or "Electronic Components".

Required field.

Tab

Setting

Usage

General

Name

A unique name for the agreement, such as Fabrikam_To_Contoso_3A2.

Required field.

General

Process configuration

The identifier for the PIP.

This number identifies which process configuration is associated with this agreement.

The default value is the first in the list of the process configurations. The drop-down list includes all previously entered process configurations.

Required field.

General

My Organization

The home organization, selected from a drop-down list.

Required field.

General

Partner organization

The partner organization, selected from a drop-down list.

Required field.

General

Description

A description of the trading partner agreement.

General

RNIF version

The version of the RNIF that BTARN will use for agreement communications.

Can be V01.10.00 or V02.00.01 (the default).

Must be V01.10.00 for CIDX.

General

Home role

The role of the home organization.

Can be initiator role or responder role.

General

0A1 agreement

Whether BTARN will return a Notification of Failure message (0A1 PIP) when a failure occurs.

Can be No 0A1 (the default) or 0A1.

Must be No 0A1 for CIDX.

General

Usage

Indicates the type of scenario that the agreement will use.

Can be Test (the default) or Production.

General

(Application adapter area)

Assembly Name

The file name of the ApplicationAdapter that you can select from the file system.

The default value is an empty string.

General

(Application adapter area)

Class name

The name of the class that BTARN will use from the ApplicationAdapter.

The default value is <none>.

General

(Validation adapter area)

Assembly Name

The file name of the ValidationAdapter that you can select from the file system. The default value is an empty string.

General

(Validation adapter area)

Class name

The name of the class that BTARN will use from the ValidationAdapter.

The default value is <none>.

Ports

Action URL

The URL to which the home organization will transmit an action message. For example, http://FabrikamServer/BTARNApp/RNIFReceive.aspx.

This is a required field if the following are all true:

• The Is Synchronous process-configuration setting is False.
• The Is Single Action process-configuration setting is True.
• The Home role agreement setting is Initiator.

This is also a required field if the following are true (in which case, the Signal URL field is also required):

• The Is Synchronous process-configuration setting is False.
• The Is Single Action process-configuration setting is False.
• You must enter a valid URI in this field, one that starts with either "http://domain" or "https://domain".

Ports

Signal URL

The URL to which the home organization will transmit a signal message. For example, http://FabrikamServer/BTARNApp/RNIFReceive.aspx.

This is a required field if the following are true:

• The Is Synchronous process-configuration setting is False.
• The Is Single Action process-configuration setting is True.
• The Home role agreement setting is Responder.

This is also a required field if the following are true (in which case, the Action URL field is also required):

• The Is Synchronous process-configuration setting is False.
• The Is Single Action process-configuration setting is False.

You must enter a valid URI in this field, one that starts with either "http://domain" or "https://domain".

Ports

Sync URL

The URL that the home organization will use to establish a connection through the HTTP adapter. For example, http://FabrikamServer/BTARNApp/RNIFReceive.aspx.

This is a required field if the following are true:

• The Is Synchronous process-configuration setting is True.
• The Home role agreement setting is Initiator.

You must enter a valid URI in this field, one that starts with either "http://domain" or "https://domain".

Protocol

Digest method

The protocol used to calculate the digest of incoming messages for non-repudiation purposes.

Can be MD5 or SHA-1 (the default).

The BTARN receive pipeline will receive and decrypt a message even if the protocol used to encrypt the message and the Encoding setting on this tab of the agreement do not match. Therefore, BTARN will receive messages encrypted in either RC2-40 or 3DES.

All outgoing signed messages will have a digest of SHA-1.

Protocol

Encode all parts

Whether the system will encode all parts of the multipart message together.

Can be True or False (the default).

When True, all parts of the multipart message will be encoded together using the method indicated by the Encoding property.

When False, the system will only encode attachments using the method indicated by the Encoding property. (Attachments are always encoded by the send pipeline using the method indicated by the Encoding property.) By default, when you set this property to False, BTARN encodes the other parts of the message (four parts in RNIF 2.01, three parts in RNIF 1.1) in quoted-printable format.

Protocol

Encoding

The protocol used to encode all parts (if the Encode all parts box is True) or the attachment (if the Encode all parts box is False).

Can be 8 bit, base 64 (the default), or quoted-printable.

Protocol

Encryption algorithm

The algorithm used to encrypt incoming and outgoing messages.

Can be RC2-40 (the default) or 3DES.

The encryption algorithm only takes effect if you have set the Is Persistent Confidentiality Required property to either Payload or Payload Container in the corresponding process configuration.

Protocol

Encryption direction

Whether the system will encrypt the incoming message or the outgoing message, or both.

Can be Inbound, Outbound, or Inbound/Outbound (the default).

The encryption direction setting only takes effect if you have set the Is Persistent Confidentiality Required property to either Payload or Payload Container in the corresponding process configuration.

Custom Properties

Name

Name of the custom property.

You can set custom properties on a per-agreement basis. If you create a new custom private process, you can use these custom properties in processing different agreements.

You can use the RuntimeConfig.GetTPACustomConfigValue method in the BTARN SDK to retrieve custom properties from the BTARN configuration.

The Name property must be unique and not empty.

You can enter the following custom values:

• AAR. This is the Acceptance Acknowledgment Required custom property. This applies to RNIF 1.1 only. Set this to false (which is not case-sensitive) to require only a receipt acknowledgment, not an acceptance acknowledgment. If AAR is set to anything other than false, then the responder public process must send an acceptance acknowledgment, and the initiator public process will expect an acceptance acknowledgment. If AAR is set to false, the public processes will complete after the receipt acknowledgment.
• HPCC. This is the Home Partner Classification Code. This applies to RNIF 1.1 only. This enables you to set the GlobalPartnerClassificationCode element for the home partner in the service header of an outgoing message to the entry in the Value column. This value overrides the Home organization classification property in the Home Organization configuration. Use this custom property when the home organization can have more than one classification.
• PPCC. This is the Partner Profile Classification Code. This applies to RNIF 1.1 only. This enables you to set the GlobalPartnerClassificationCode element for the partner in the service header of an outgoing message to the entry in the Value column. This value overrides the Partner classification property in the Partner configuration. Use this custom property when the partner can have more than one classification.

Custom Properties

Value

Value of the custom property.