The Function Configuration dialog

ClosedTo access this dialog:

  1. Using the XBOUND Management Center, open a console containing the Process Designer.

  2. Select Tools > Collectors > XBOUND Collector for IMAP.

  3. Click +. Or click in the Edit column of an existing source. The XBOUND Collector for IMAP dialog is displayed.

  4. Under Document structure, select Document per email or Document per attachment.

  5. Click Edit settings. The Structure Template Settings dialog is displayed.

  6. For one of these three settings, click :

    • Root document name

    • Sub-document name

    • Medium name

In certain cases it is also accessed by clicking in the Custom Structure Settings dialog.

This tool makes it possible to choose from a large variety of functions to generate a customized string in XBOUND. Most commonly it is used to configure names for the root documents, sub-documents, and media in the Collector for IMAP.

Drag modules from the left pane to the top right pane to insert them. In some cases a configuration dialog is displayed. You can also click and/or adjust settings in the middle right pane.

Recommended: Try different settings and check the result in the lower right pane.

Left pane

Text

  • Text – A custom text.

Date & Time

  • Date – The current system date. Select a format in the middle right pane.

  • Time – The current system time. Select a format in the middle right pane.

  • Time stamp – A continuous, unique, accurate-to-the-millisecond timestamp. The format is fixed and cannot be changed.

Counter

  • GUID – A Globally Unique Identifier. Specify one of the following formats in the Format setting:

    • N – 32-digit hexidecimal GUID.

    • D – 32-digit hexidecimal GUID with groups separated by hyphens.

    • B – 32-digit hexidecimal GUID with groups separated by hyphens, enclosed in curly brackets.

    • P – 32-digit hexidecimal GUID with groups separated by hyphens, enclosed in parentheses.

    • X – 32-digit hexidecimal GUID, displayed in hexidecimal.

  • Simple Counter – A counter that you configure in this tool and that is reset after each batch. In the Format setting in the middle right pane, enter 0 for each digit to be included in the string. For example, enter 00000 for a five-digit counter.

  • XBOUND Counter – The current value of a counter that was previously defined in XBOUND. In the middle pane, in the CounterName setting, select the counter whose value is to be used in the string.

XBOUND

  • Barcode – The value of a barcode that was extracted. In the MediumFormat setting in the middle right pane, select which medium to get the barcode from.

  • Client name – The name of the current client.

  • Count documents – The number of documents that meet conditions that you specify.

  • Count media – The number of media with properties that you specify.

  • Database ID – The ID of the XBOUND database (main database). This is useful in distinguishing between test and production systems, for example.

  • Document field value – The value of a field in the document. In the right middle pane, click FieldName and select an email field name in the dropdown list.

  • Document index – The position of the current document within the root document.

  • Document name – The name of the current document.

  • Document type – The document type of the current document.

  • Document type name – References a specific document type. If it is changed later, the type is adjusted automatically here.

  • Medium field value – The value of a medium field.

  • Medium index – The position of the medium within the document.

  • Medium info – The value of a medium attribute/property that you select.

  • Medium length – The file size of the medium.

  • Medium name – The name of the medium.

  • Process name – The name of the current process.

  • Root document name – The name of the current root document.

Misc.

  • Calculation – The result of a mathematical calculation that you specify.

  • Computer name – The name of the workstation. The format is fixed and cannot be changed.

  • Conditional function – The result of a specified conditional expression. Useful for data transformation. The Conditional Function Editor is displayed when you drag this to the right pane.

  • Regular expression – The result of a regular expression.

Top right pane

Shows which elements will be included in the character string.

These columns are available:

  • Name – The technical name of the function.

  • Sample – An output sample for the individual element.

  • Config. – Click to adjust the settings, depending on the function.

  • Delete – Click to delete the function from the character string.

Click the arrows ( and ) to change the order of the functions.

Middle right pane

Settings tab

Here you can adjust the settings of the function that is selected in the upper right pane.

Global Settings tab

Here you can adjust settings that apply to the string as a whole.

Lower right pane

Displays a description of the setting that is selected in the middle right pane.

At the bottom you see an example of the resulting string as a whole.

The Structure Template Settings dialog

The Custom Structure Settings dialog

Configuring custom document structures for the Collector for IMAP

Adding a collector

XBOUND collectors: Overview