Connect File rules - Completing the Service tab

Complete the Service tab to identify the file name, location, and other characteristics of the connector.

Note: Connect File rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect File rules does not follow Pega development best practices. Consider other implementation options instead.

File system

Field Description
Destination path Enter a full path to an existing output directory. For example, if the Pega Platform server is hosted on Windows, you can enter C:\temp. If the server is hosted on UNIX-based operating system, you can enter /tmp.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). For more information, see Using the Global Resource Settings feature.

File name Enter a file name and optionally a file type that is valid for the server platform.

Leave the File name blank when the Connect File rule downloads a work item file attachment. The output file has the same name as the work item attachment.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). For more information, see Using the Global Resource Settings feature.

If file already exists Select to control runtime results when a file already exists:
  • Fail — To end the connector operation.
  • Append — Append output to the end of the existing file.
  • Overwrite — Replace the existing file.
EnableBOM Select to to insert a BOM (byte order mark) at the start of the text file. A BOM is recommended if CSV file data are intended to be exported by Excel.

File connection handling

Field Description
Keep file open Your application can create the contents of the output file with a single execution of the Connect-File method, or with multiple executions. See Connect-File method.

Select this check box to allow the file to remain open for additional output. Include in the processing sequence a final use of the Connect-File method that closes the file.

Error handling

Field Description
Status value property Identify a property to hold the outcome status rule. You can use a default property @baseclass.pyStatusValue or another Text mode Single Value property. The literal value Good identifies success.
Status message property Identify a property to hold an outcome status message. The default value is @baseclass.pyStatusMessage.
Test connectivity After you save the Connect file form, click to confirm that the server hostin Pega Platform has write access to the directory. No files are written by this operation.