Indicating a File Path or File Name

Some of the system background processes use extra parameters to indicate a File Path and/or File Name for an input file or an output file. For example, most extract processes use File Path and File Name parameter to indicate where to place the output file.

For the file path parameter, refer to Referencing URIs for several points related to populating the file path and the supported syntax.

For the file name parameter, there are extract processes that support defining a file name that ends in ".zip" or ".gz", which will automatically result in writing the file with zip or gzip compression (based on the suffix). Similarly, there are upload processes that support decompression of files using the appropriate method based on the file name ending in ".zip" or ".gz". If the extract or upload process supports compression / decompression, it should be indicated accordingly in the description of the File Name parameter. If a batch control doesn't explicitly indicate that it supports compression or decompression in its description, the assumption should be that it is not supported.

In addition, there are extract and import processes that support automatic signing, encryption and decryption of the file content using PGP standards. File names ending in .pgp will be parsed to determine whether encryption, signing, compression or a combination of the three applies. If the file has a .pgp extension and requires decryption or signature verification, a run time error will be issued if no encryption or signing key ring parameters are supplied.

Note:

File name / extension validation. The system ensures that the file name for any file being uploaded does not contain special characters and uses only standard UTF-8 supported characters. In addition, the system validates that the file's extension is referenced in the base delivered allow list F1-FileExtensionAllowList, defined as a managed content record.

Note:

Custom file extensions. If your implementation has defined custom file extensions that are not found in the base product delivered allow list, you may create a custom managed content record to define your additional valid extensions. To do this, duplicate the F1-FileExtensionAllowList record and give it the name CM-FileExtensionAllowList. Change the description as desired. Remove the base delivered extensions and add your valid extensions using the <extension></extension> tags.