Creating File Resources

To create a File Resource, go to Setup β†’ File Resources and click the NEW button.

Fill in these fields:

  • Select Actor: select the Actor to which the File Resource will be applied.

  • Name: assign a unique name of the File Resource. These characters are accepted / ! * + ? = " | Blanks are not accepted.

  • Description: enter a description for the File Resource.

  • Reject File: YES or NO (default). Select if a file matching the File Processing Rule associated with this File Resource will be accepted (NO, default) or not (YES).

  • Local Settings have two different configurable platforms where they can operate, with different properties: WINDOWS / UNIX LIKE and zOS. The Remote Settings configuration has the same properties and definitions as the Local Settings.

Windows / Unix Like

FILE FORMAT – CONTENT TYPE

This is the mime type associated with the file; mime is used only to determine if the file is text or binary. Possible values:

APPLICATION_EDI_CONSENT APPLICATION_EDIFACT APPLICATION_EDI_X12 APPLICATION_GZIP APPLICATION_HTTP APPLICATION_JSON APPLICATION_MP4 APPLICATION_MPEG4_GENERIC APPLICATION_MPEG4_IOD APPLICATION_MPEG4_IOD_XMT APPLICATION_PDF APPLICATION_PGP_ENCRYPTED APPLICATION_PGP_SIGNATURE APPLICATION_PKCS7_MIME APPLICATION_PKCS7_SIGNATURE APPLICATION_VND_MS_EXCEL APPLICATION_VND_MS_EXCEL_ADDIN_MACROENABLED_12 APPLICATION_VND_MS_EXCEL_SHEET_BINARY_MACROENABLED_12 APPLICATION_VND_MS_EXCEL_SHEET_MACROENABLED_12 APPLICATION_VND_MS_EXCEL_TEMPLATE_MACROENABLED_12 APPLICATION_VND_MS_POWERPOINT APPLICATION_VND_MS_POWERPOINT_SLIDE_MACROENABLED_12 APPLICATION_VND_MS_POWERPOINT_SLIDESHOW_MACROENABLED_12 APPLICATION_VND_MS_POWERPOINT_TEMPLATE_MACROENABLED_12 APPLICATION_VND_MS_PROJECT APPLICATION_VND_MS_WORD_DOCUMENT_MACROENABLED_12 APPLICATION_VND_MS_WORD_TEMPLATE_MACROENABLED_12 APPLICATION_ZIP APPLICATION_OCTET_STREAM TEXT_CSS TEXT_CSV TEXT_CSV_SCHEMA TEXT_HTML TEXT_JAVASCRIPT TEXT_RTF TEXT_XML TEXT_PLAIN

FILE FORMAT – RECORD FORMAT

The record format:

UF – Windows/”Unix like” Fixed length

The file consists of fixed-length records

UV – Windows/”Unix like” delimited with EOL

The file consists of variable-length text records delimited by a line end an end of line

UVL – Windows/”Unix like” length prefixed variable record (big-endian)

The file consists of records of variable length, and each record is preceded by its length (4 big-endian binary bytes)

NONE – Not Set (default)

The file does not consist of any records

SECURITY – SECURITY TYPE (#)

NONE (default) ENVELOPE OPEN SIGN_AND_ENVELOPE SIGN

COMPRESSION – COMPRESSION TYPE (#)

Compression type where:

SPAZIO2_RUN_LENGTH

Spazio2 compression, only the repeated bytes are compressed

SPAZIO2_ZLIB

zlib Spazio2 compression

LOCATION – FILE POSITION

Flag to set the file as internal or external:

INTERNAL (default)

Create the file as internal file

EXTERNAL

Create the file as external file

LINK

When applicable, the file is the one provided by the user and the Virtual File System refers directly to it

DISPOSITION RULES – PUT DISPOSITION

The disposition applicable only to the external file:

REJECT_IF_EXIST

Create a new file. This operation fails if the file already exists

OVERRIDE (default)

Replace or create a new file if it does not exist

NEW_VERSION

Same as OVERRIDE, it can reuse the space allocation for zOS dataset

REPLACE_NO_CREATE

Replace an old file. This operation fails if the file does not exist

DISPOSITION RULES – GET DISPOSITION

When the platform works as a server, the file can remain on the VFS or can be removed automatically once it is successfully pulled by a client. When the platform works as a client, the file can remain on the VFS or can be removed automatically once it is successfully read to be pushed via a Client Connection. The configuration occurs choosing the option:

LEAVE

The file remains in the VFS

REMOVE (default)

The file is removed from the VFS

In the previous table, fields marked with (#) trigger the following options depending on the value chosen:

SECURITY TYPE:

NONE

No more properties to configure

OPEN

1. Security format: select the encrypted file format: PKCS7 (default) PGP CMS PKCS7_SP2 S_MIME

SIGN

1. Security format: same as OPEN When selecting PGP, the add extension (.pgp) checkbox will appear. 2. Signature key: The key ID to be used for signature operations 3. Signature hash algorithm: select the hash algorithm to be used for signature operations: MD2 MD5 SHA1 SHA256 (default) SHA384 SHA512

ENVELOPE

1. Security format: same as OPEN When selecting PGP, the add extension (.pgp) checkbox will appear. 2. Encryption Cipher Algorithm: select the cipher algorithm to be used for the encryption operations: DES DES_EDE3 (default) AES128 AES192 AES256 RC2 3. Encryption Recipient

SIGN_AND_ENVELOPE

1. Security format: same as OPEN When selecting PGP, the add extension (.pgp) checkbox will appear. 2. Signature key: the key ID to be used for signature operations 3. Signature hash algorithm: same as OPEN 4. Encryption Cipher Algorithm: the cipher algorithm used for the encryption operations; same as ENVELOPE 5. Encryption Recipient

COMPRESSION TYPE:

SPAZIO2_RUN_LENGTH

No more properties to configure

SPAZIO2_ZLIB

1. Compression 64 Mode: ALWAYS (default) NEVER 2. Strategy Level, Zlib compression strategy level: DEFAULT (default) FILTERED HUFFMAN_ONLY 3. Compression Level: Zlib compression level (0-9), (default: 5).

zOS

FILE FORMAT – CONTENT TYPE

The mime type associated with the file; mime is used only to determine if the file is text or binary (see paragraph of Windows/Unix like for values).

FILE FORMAT – RECORD FORMAT

The record format: ZVBM – z/OS Variable, blocked, machine print-control codes ZVS – z/OS Variable, standard ZVSA – z/OS Variable, standard, ASA print-control, characters ZVSM – z/OS Variable, standard, machine print-control codes ZVBS – z/OS Variable, blocked, standard ZVBSA – z/OS Variable, blocked, standard, ASA print-control characters ZVBSM – z/OS Variable, blocked, standard, machine print-control codes NONE – Not Set (default) NOTE: Zxxxx -> where xxxx is the z/OS dataset record format.

FILE FORMAT – RESOURCE BLOCK SIZE

The block size (used when the record format is zOS type).

FILE FORMAT – RECORD LENGTH

Record length: this is mandatory if the record format is ZFxx/ZVxx

FILE ALLOCATION SETTINGS – SPACE TYPE

Use the SPACE parameter to request space for a new data set on a direct access volume: B Byte KB Kilo byte MB Mega Byte GB Giga Byte CYL Cylinders TRK Tracks BLK Blocks

FILE ALLOCATION SETTINGS – PRIMARY SPACE

Specifies the number of tracks, cylinders, blocks, or records to be allocated.

FILE ALLOCATION SETTINGS – SECONDARY SPACE

Specifies the number of additional tracks, cylinders, blocks, or records to be allocated, if more space is needed.

FILE ALLOCATION SETTINGS – UNIT

Use the UNIT parameter to specify a device for an SMS-managed data set.

FILE ALLOCATION SETTINGS – VOLUME LIST

Use the VOLUME parameter to identify the volume or volumes where a data set resides or will reside. Each volume must be separated by commas [ , ].

FILE ALLOCATION SETTINGS – DATA CLASS

Use the DATACLASS parameter to specify a data class for a new data set. The storage administrator at your installation defines the names of the data classes you can code on the DATACLASS parameter.

SECURITY – SECURITY TYPE (#)

NONE (default) OPEN SIGN ENVELOPE SIGN_AND_ENVELOPE

COMPRESSION – COMPRESSION TYPE (#)

SPAZIO2_RUN_LENGTH SPAZIO2_ZLIB

LOCATION – FILE POSITION

INTERNAL (default) EXTERNAL LINK

DISPOSITION RULES – PUT DISPOSITION

REJECT_IF_EXIST

Create a new file; this operation fails if the file already exists.

OVERRIDE (default)

Replace or create a new file if it does not exist.

NEW_VERSION

Same as OVERRIDE, it can reuse the space allocation for zOS dataset.

REPLACE_NO_CREATE

Replace an old file; this operation fails if the file does not exist.

DISPOSITION RULES – GET DISPOSITION

When the platform works as a server, the file can remain on the VFS or can be removed automatically once it is successfully pulled by a client. When the platform works as a client, the file can remain on the VFS or can be removed automatically once it is successfully read to be pushed via a Client Connection. The configuration occurs choosing the option:

LEAVE

The file remains in the VFS.

REMOVE (default)

The file is removed from the VFS.

The SECURITY and COMPRESSION fields are marked with (#) because they trigger additional options that are detailed just before the zOS section.

During the definition of the File Resource, some checks are performed against local and remote settings to assure data consistency. These are the basic rules:

  • Local and Remote content types must both refer to binary or text files. In other words, a binary local content type and a text remote content type cannot be defined.

  • If the content type is text, the Charset name definition is mandatory.

  • If the record format is UV, the content type needs to refer to a text file, and the resource End of Line is mandatory.

  • If the record format refers to a fixed or variable length record, the record length is mandatory, and the resource End of Line is forbidden.

  • If the content type is binary, text-specific attributes cannot be specified, e.g., charset name and resource End of Line.

Once you have created the File Resource, click Save.

File Resources can be created without being associated with an Actor by going to Setup β†’ File Resources β†’ NEW.

Last updated