Version 23.3.8698

• Settings Tab
  • Connector Configuration
  • Mappings
• Automation Tab
  • Automation Settings
    • Performance
• Advanced Tab
  • Advanced Settings
    • Message
    • Logging
    • Miscellaneous

This section outlines all of the configurable connector properties.

Settings Tab

Connector Configuration

Settings related to the core operation of the connector.

• Connector Id The static, unique identifier for the connector.
• Connector Type Displays the connector name and a description of what it does.
• Connector Description An optional field to provide a free-form description of the connector and its role in the flow.
• Source File A file that represents the XML structure of input documents. Any files processed by the connector should have a matching XML structure. Elements in input documents can be repeated in ways that differ from the source file as long as the structure of nested elements is the same.
• Destination File A file that represents the structure of output documents. Files produced by the connector have a matching XML structure. Elements in the output document can be repeated or omitted in ways that differ from the destination file according to the mapping; however the structure of nested elements remains the same.

Mappings

Defines the mapping relationship between input and output files. See Using the Designer for more details.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

• Send A toggle that instructs the connector to automatically send files when they are ready.

Performance

Settings related to the allocation of resources to the connector.

• Max Workers The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Settings > Automation page.
• Max Files The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Settings > Automation page.

Advanced Tab

Advanced Settings

Advanced file processing settings.

• Processing Delay The amount of time (in seconds) by which the processing of files placed in the Input folder is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.
• Local File Scheme A scheme for assigning filenames to messages that are output by the connector. You can use the following macros to reference contextual information:
  %ConnectorId%, %Filename%, %FilenameNoExt%, %Ext%, %ShortDate%, %LongDate%, %RegexFilename%, %DateFormat%, %Header%.
  For example: %FilenameNoExt%_%ShortDate%%Ext%
• XML Declaration Specify whether to include the XML declaration in generated XML files.
• XML Streaming Specify whether the connector should drop the Document Object Model (DOM) for the current iteration of the top-most Foreach in the mapping after completing the loop. This can improve performance significantly for large XML documents. However, it can also prevent the connector from being able to resolve XPaths that reach outside of the current level of the document being iterated over (../SomeOtherXPath).

Message

Message settings determine how the connector searches for messages and manages them after processing. You can save messages to your Sent folder or you can group them based on a Sent folder scheme, as described below.

• Save to Sent Folder A toggle that instructs the connector to keep a copy of sent messages in the Sent folder.
• Sent Folder Scheme Instructs the connector to group files in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the Sent folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.

Logging

Settings that govern the creation and storage of logs.

• Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
• Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
• Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

• Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.