Skip to main content
Skip table of contents

Commands in OFTP2

STROFTP2 (START OFTP2)

This command allows you to prepare files for sending and establish a connection for exchanging files.

Example command for sending the file testfile.txt to the partner with the profile ‘oftp2partner’ using your own profile with the sequence number 10. The transfer mode *BOTH allows both sending and receiving.

CODE
STROFTP2 TRANSMODE(*BOTH) PARTNER(oftp2partner) PROFILE(10) FRMPATH('/tmp/testfile.txt')

Press F4 to display the parameters of the command, F9 to expand the list, and F11 to display the parameter names

parameters

Permissible values

values

description of the command

TRANSMODE

  1. *BOTH

  2. *SEND

  3. *RECEIVE

  1. Files are sent and can be received.

  2. Files are only sent.

  3. Files are only received.

Specifies whether files may be sent and/or received during the OFTP connection.

PARTNER

  1. <int>

  2. *NONE

  3. *FRMFILE

  1. At this point, refer to a partner profile created in the master data under menu item 50

  2. No recipient partner ID is assigned. The information required for the recipient must then be specified in additional parameters of this command.

  3. The partner alias is taken from the EDIFACT data (recipient in segment UNB), for example.

PROFILE

  1. <int>

  2. *NONE

  1. At this point, refer to a communication profile created in the master data under menu item 52.

  2. No communication profile is assigned. The information required for the remote system must then be specified in additional parameters of this command.

ORIGINATOR

  1. <int>

  2. *NONE

  1. At this point, refer to a sender created in the master data under menu item 51.

  2. No sender is assigned. The information required for the sender must then be specified in additional parameters of this command.

ORIGOID

  1. <iso646>

  2. *DEFAULT

  1. Free text in ISO 646 subset format

  2. The Odette ID of this instance is used. This is either stored in the profile or, if the special value *NONE was used, specified in the PROFOID parameter.

SFID sender (ORIGOID) – only for ORIGINATOR(*NONE). The Odette ID for the sender for use in the SFID. (ISO 646 subset)

FS

  1. *IFS

  2. *DB2

  3. *NONE

  1. The input file is located in the IFS (Integrated File System).

  2. The input file is located in the DB2 file system.

  3. A connection is established. Only files and messages that have already been provided are sent. Files and messages can also be received.

File system of the input file(s).

FRMPATH

Input path (FRMPATH) - only for FS(IFS). Specify the path to the IFS input file here. Use ‘*’ as a wildcard character for a generic selection of input files.

FRMFILE

  1. *ALL

All files in the source directory/source library will be sent.

Input file (FRMFILE) – only for FS(DB2). Enter the input file to be sent here. Use ‘*’ as a wildcard character for a generic selection of input files.

subfile

  1. *ALL

All source subfiles of the DB2 input file are sent.

Die Teildatei im DB2-Dateisystem.

library

TRANSTYPE

  1. *ACTIVE

  2. *PASSIVE

  1. When this command is executed, an active connection to the specified partner is established and the file is actively sent to the remote station.

  2. The file to be sent is made available for the partner system. To do this, the data is stored together with the necessary information in a temporary directory. As soon as a connection to or from the partner is established, the prepared data is transmitted.

Data can be sent via OFTP2 in two different ways.

DESTIN

  1. <iso646>

  2. *PARTNER

  1. ISO 646 subset

  2. This special value can be used if the destination of the files matches the partner with whom communication is being established.

This is the Odette ID of the destination, which is used for every file transfer. It may differ from the Odette code of the physical partner if, for example, the recipient is a service provider and forwards data to other receiving locations. (ISO 646 subset)

DATASET

  1. *FRMFILE

The virtual file name is formed from the physical name of the sent file.

The virtual name of the transfer file. The content is agreed with the partner. This name is transmitted to the remote station during the transfer. The physical name on the source system is not transmitted to the remote station unless the special value *FRMFILE is selected.

USRDTAFILE

  1. <iso646>

  1. SFID user data in ISO 646

Depending on the agreement between you and your partner, it may be necessary to enter specific data in this SFID user data field. (ISO 646 subset)

FVUT

  1. *FIX

  2. *VARIABLE

  3. *UNSTRUCT

  4. *TEXT

  1. Records with fixed record length.

  2. Records with variable record length.

  3. Unstructured data.

  4. Text data.

Specifies the basic structure of the data to be sent. The selection influences the way line separators are processed and used on the receiving end.

FILEDESCR

Text field encoded in UTF-8. The content is determined by mutual agreement.

DELETE

  1. *NO

  2. *YES

  1. The source file is not deleted after successful transmission.

  2. The source file is deleted after successful transmission.

Specifies whether the transferred source file should be deleted after sending.

FILECOMPR

  1. *NONE

  2. *ZLIB

  1. No compression

  2. Compression using the Deflate algorithm by zlib.

Defines the compression method.

SIGNNOTIF

  1. *YES

  2. *NO

  1. Requires signature.

  2. No signature required.

Specifies whether the notification request (EERP/NERP) should be signed by the end point.

SECLEVEL

  1. *NONE

  2. *ENCRYPT

  3. *SIGN

  4. *BOTH

  1. The file has not been signed or encrypted.

  2. The file has been encrypted.

  3. The file has been signed.

  4. The file has been encrypted and signed.

Select whether the file was signed and/or encrypted before transmission.

CIPHER

  1. *NONE

  2. *ENCRYPT

  3. *SIGN

  4. *BOTHFiles are sent and can be received.

    Files are only sent.

    Files are only received.

  1. The special value *DEFAULT uses the cipher suite specified in the partner profile.

  2. *C01        3DES_EDE_CBC_3KEY, RSA_PKCS1_15, SHA-1

  3. *C02        AES_256_CBC, RSA_PKCS1_15,  SHA-1

  4. *C03        3DES_EDE_CBC_3KEY,  RSA_PKCS1_15,  SHA-256

  5. *C04        AES_256_CBC, RSA_PKCS1_15,  SHA-256

  6. *C05        3DES_EDE_CBC_3KEY,  RSA_PKCS1_15,  SHA-512

  7. *C06        AES_256_CBC, RSA_PKCS1_15,  SHA-512

The cipher suite used when signing and/or encrypting the file. A signed end-to-end response is also expected in this format.

The following information in the following order:

ALGORITHM_SYMMETRIC

ALGORITHM_ASYMMETRIC

HASHING

List of parameters for the instance if no server profile (*RECEIVE) was specified.

parameters

description

PROFOID

Username sent to the partner for authentication (ISO 646 subset)

PROFOPASS

Password sent to the partner for authentication purposes.

BASEPATH

Partner base directory in which subdirectories are created for partners. The directory name corresponds to the Odette ID and contains a work folder, a receive folder and a send folder (ISO 646 subset).

SSLUSE

Connection with SSL encryption, which determines whether the connection should be encrypted. In addition, the server must authenticate itself to the client.

SSLCLTAUT

Client authentication, determines whether authentication is required from the client during connection establishment.

SSLTSPATH

trust store path

SSLTSPASS

Password to open the trust store

SSLTSIMP

Import unknown certificates

List of parameters for the partner profile if none were specified in the master data.

parameters

description

PRTPROFILE

Partnerprofil

OFTP2CRTX (OFTP2 CERTIFICATE EXCHANGE)

This command allows you to provide certificates for automatic exchange and establish a connection for file exchange.

parameters

permissible values

values

description of the command

PARTNER

  1. <Text>

  2. *NONE

  1. At this point, refer to a partner profile created in the master data under menu item 50.

  2. No recipient partner ID is assigned. The information required for the recipient must then be specified in additional parameters of this command.

PRTPRF

  1. <int>

  2. *NONE

  1. At this point, refer to a communication profile created in the master data under menu item 52.

  2. No communication profile is assigned. The information required for the remote system must then be specified in additional parameters of this command.

DESTIN

  1. <iso646>

  2. *PARTNER

  1. ISO 646 subset

  2. This special value can be used if the destination of the files matches the partner with whom communication is being established.

This is the Odette ID of the destination, which is used for every file transfer. It may differ from the Odette code of the physical partner if, for example, the recipient is a service provider and forwards data to other receiving locations. (ISO 646 subset)

PROFILE

At this point, refer to a communication profile created in the master data under menu item 52.

This is your own server profile. It is required to determine your own Odette ID with password, as well as your private keys.

TRANSTYPE

  1. *ACTIVE

  2. *PASSIVE

  1. When this command is executed, an active connection to the specified partner is established and the file is actively sent to the remote station.

  2. The file to be sent is made available for the partner system. To do this, the data is stored together with the necessary information in a temporary directory. As soon as a connection to or from the partner is established, the prepared data is transmitted.

Data can be sent via OFTP2 in two different ways.

TYPE

  1. *DELIVER

  2. *REQUEST

  3. *REPLACE

  1. Transfers the certificate to the partner. It can then be used.

  2. Transfers the certificate to the partner and expects the certificate from the partner.

  3. Transfers the certificate to the partner and instructs them to no longer use the previous certificate.

Select the OFTP2 command used to transfer the certificate.

ALIASOLD

  1. *CURRENT

  2. <Text>

  3. *NONE

  4. *FILE

  1. Instead of the alias, specify the purpose in the next parameter to automatically determine the certificate.

  2. Specify the alias of the certificate or key pair in the keystore.

  3. No information about the previous certificate is sent.

  4. Specify the previous certificate as a file path.

Specify the alias of the certificate to be exchanged at the remote station. Please note that older software ignores this information.

USAGEOLD

  1. *OFTPAUTH

  2. *OFTPEERP

  3. *OFTPFILSI

  4. *OFTPFILEN

  1. Secure OFTP authentication when establishing a connection

  2. Used to sign the EERP/NERP

  3. Used to sign the file

  4. Used to encrypt the file

Select the intended use of the certificate to be exchanged at the remote station. If you are only using one certificate, select any intended use.

The SSL certificate cannot be selected because it must be available at the remote station to establish the connection.

PATHOLD

  1. <Text>

  1. Specify the full path to the previous certificate

ALIASNEW

  1. *CURRENT

  2. <Text>

  3. *FILE

  1. Instead of the alias, specify the purpose in the next parameter to automatically determine the certificate.

  2. Specify the alias of the certificate or key pair in the keystore.

  3. Specify the new certificate as a file path.

Specify the alias of the certificate to be sent to the remote station.

USAGENEW

  1. *OFTPAUTH

  2. *OFTPEERP

  3. *OFTPFILSI

  4. *OFTPFILEN

  1. Secure OFTP authentication when establishing a connection

  2. Used to sign the EERP/NERP

  3. Used to sign the file

  4. Used to encrypt the file

Select the intended use of the certificate to be sent. If you are only using one certificate, select any intended use.

The SSL certificate cannot be selected because it must be available on the other side to establish the connection.

PATHNEW

  1. <Text>

  1. Enter the full path to the new certificate.

STREFFSBS (START IEFFECT SUBSYSTEM)

Start of the i-effect subsystem *OFTP2

CODE
STREFFSBS SUBSYSTEM(*OFTP2)

ENDEFFSBS (START IEFFECT SUBSYSTEM)

Stopping the i-effect subsystem *OFTP2

CODE
ENDEFFSBS SUBSYSTEM(*OFTP2)
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.