/AWS1/CL_TRN=>CREATEAGREEMENT()

About CreateAgreement

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

Method Signature

IMPORTING

Required arguments:

IV_SERVERID TYPE /AWS1/TRNSERVERID /AWS1/TRNSERVERID

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

IV_LOCALPROFILEID TYPE /AWS1/TRNPROFILEID /AWS1/TRNPROFILEID

A unique identifier for the AS2 local profile.

IV_PARTNERPROFILEID TYPE /AWS1/TRNPROFILEID /AWS1/TRNPROFILEID

A unique identifier for the partner profile used in the agreement.

IV_BASEDIRECTORY TYPE /AWS1/TRNHOMEDIRECTORY /AWS1/TRNHOMEDIRECTORY

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.

IV_ACCESSROLE TYPE /AWS1/TRNROLE /AWS1/TRNROLE

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/TRNDESCRIPTION /AWS1/TRNDESCRIPTION

A name or short description to identify the agreement.

IV_STATUS TYPE /AWS1/TRNAGREEMENTSTATUSTYPE /AWS1/TRNAGREEMENTSTATUSTYPE

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

IT_TAGS TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS

Key-value pairs that can be used to group and search for agreements.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_TRNCREATEAGREEMENTRSP /AWS1/CL_TRNCREATEAGREEMENTRSP