Skip to main content
Mitratech Success Center

Active Directory Custom Tasks

These custom tasks use data from Active Directory to use in Process Director.

Fill Fields from Active Directory

This custom task allows you to fill eForm fields using data from Active Directory.

image

Configuration Options

OPTION

DESCRIPTION

AD Root Path

The root path of the Active Directory

AD Username

A valid AD user with permissions to read AD data.

AD Password

AD User's password

Connection Options

A list of check boxes that display connection options. Defaults to select a secure, ServerBind connection.

Where

Query filter to select specific AD fields that match a text value.

Or specify custom filter

A custom text filter to apply.

Message to display if no results

A text message to display if the AD query does not return any results.

Controls to populate

You can select which form controls to populate with fields from the active directory. Simply click the Add Field Mapping button to add another field to map.

In the Controls to Populate section, the Dropdown Object on the left side will display the standard fields from Active Directory. You can also alter the fields that are displayed in this dropdown, in order to include custom fields.

In the content list, navigate to the Active Directory subfolder of the [Custom Tasks] directory. In this folder, there is a Drodown object named Active Directory Attributes. You can alter the list of fields displayed in this dropdown object in order to display any custom Active Directory fields you desire.

image

Content Actions Custom Tasks

These custom tasks perform a variety of operations on Process Director objects.

Attach Document

This custom task will attach a document from the content list to a specific eForm or Process instance.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Choose file by

Content Picker

Content List path string

The document to attach can be selected via a Content Picker control, or the user may type in the Content List Path to the document.

Group Name to Assign to File

 

The desired Group Name for the attached file.

Attach To

eForm Process

Select the appropriate option to attach the document in the Content List to the process instance, or the current instance of the default eForm.

Email Import

This Custom Task allows you to import text from an email and map it to a field in an eForm. To do so, you will need to identify the container form in the Custom Task Workflow step or Process Timeline activity.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Copy Attachments to

None, Timeline References, Workflow References, Form References.

Determines how email attachments will be stored.

Destination Form Control

Form fields on the container eForm

The data field to which you'd like to map the data.

Source Email Data

From, From (Display Name), Date, Subject, Single Header, Entire Header, Keyword, Regular Expression

The various email sections where the data you'd like to extract is located in the email.

If you select the Keyword, Single Header, or Regular Expression items as the Source Email Data, additional text boxes will appear automatically that enable you to identify the items to search for.

  • Keyword: Two text boxes will appear. In the first text box you can place a starting keyword, while the second text box will accept an ending keyword. Process Director will return all text between the keywords.
  • Single header: A single text box will appear that accepts the name of an email header field.
  • Regular Expression: A single text box will appear that accepts a regular expression to use to parse the email body.

Export Files to Filesystem

This Custom Task allows a user to export Objects from Process Director to outside file systems.

Export Tab

image

Advanced Tab

image

Configuration Options

OPTION ATTRIBUTES DESCRIPTION
EXPORT TAB

Source Objects

Form, Workflow, Timeline

Reference types to export.

ADVANCED TAB

Item Type

All

Documents, Forms.

Item type to export.

Group Name

All, Objects with no group only, Specify

The Group Name of the items to export. Choosing Specify will reveal a text box into which you can type a specific Group Name, or a System Variable that returns a Group Name.

Group Name

Export forms in format

XML, CSV

The export format of the exported item.

Export forms in format

DESTINATION TAB

  
 

Available file systems

The file system in which to export the object. This should be a Datasource object that uses the Windows File System as the Datasource Type. For more information on data sources, please see the Implementer's Reference Guide section entitled Datasource Objects.

File system

External ID Handling

Use External Links if Available, Require External links (Error if no Link), Do Not Use External Links (Ignore)

How to handle external IDs from the chosen file system.

External ID Handling

Destination Folder

 

If you select the "Do Not Use External Links (Ignore)" option, you can enter the file path for your export in the Destination Folder textbox.

Destination Folder

Export Items

This custom task exports items (Documents, Forms, Form Data, etc.) to the Content List or File System. Ensure the folder has full permission to write the data.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Export Object Types

Process Timeline References Workflow References Form References

Type of object(s) to export. Multiple objects can be selected.

Export Object Data Types

All Objects Documents eForms

Type of object data type to export.

Only export objects in specific Group

 

Specify a Group Name, or a System Variable that returns a Group Name, to export objects that belong to that group

Export Forms Type

XML CSV

Decides format of exported object: XML or Comma Separated Values

File System Path

 

Location to export the file. Can be set to your local drive.

File Name

 

New name of the exported file

XML Format

When the XML option is selected, form instances are exported to an XML file of the following format. The XML file stores information about the state of each field in the form instance.

<!-- Export Items XML Format --> 
<?xml version=”1.0” encoding=”utf-8”?>
<FormDataXML xlmns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
<!-- each form field’s information is contained inside a
<FormFieldsList> tag -->

<FormFieldsList>
<Name>someName</Name><!-- the name of the form field --> <Value>someValue</Value><!-- this form instance’s value for the
field -->
<Text>someText</Text><!-- the text of the form field (if
applicable) -->
<!-- Array Tags: these tags only appear if the field is part of
an array -->
<ArrayName>someName</ArrayName><!-- the array containing this
field -->
<ArrayNum>0</ArrayNum><!-- the number of the row this field is in
-->
to
        ensure future compatibility -->

        <FormField_V1 />
    </FormFieldsList>

</FormDataXML>

CSV Format

When the CSV option is selected, form instances are exported to a CSV file of the following format. The CSV file stores information about the state of each field in the form instance.

Import files from Filesystem

This Custom Task allows a user to import objects from outside file systems to Process Director.

Import/Destination Tabs

image

Advanced Tab

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

IMPORT TAB

File System

 

The file system data source from which you'd like to import items. This should be a Datasource object that uses the Windows File System as the Datasource Type. For more information, see the section of the Implementer's Reference entitled Datasource Objects.

Import Folder

 

The folder path to the item to import.

Recurse folder structure

 

Allow recursive folders.

DESTINATION TAB

Import Destination

Form, Workflow, Timeline, Folder

Object type of the imported item.

If File Already Exists

Skip import, Create New Version, Create New Object

Select how to handle files that already exist in Process Director.

ADVANCED TAB

Maximum Number of Files to Handle

 

The maximum number of files to import during the operation.

Maximum Size of Files

 

The maximum file size of handled files. Larger files are excluded from the operation.

Match Filter

 

A text filter to specify the files to import

Date Filter (Minimum Date)

 

This is a two-part option. The Textbox allows you to specify a mimimum file date to import, while the dropdown enables the selection of how to populate the minimum date field.

Delete File in Filesystem on Successful Import

 

This checkbox enables you to select whether or not to delete the original file in the file system after the import.

 

Item Actions

This Custom Task allows you to move, delete, or rename an item from within a process.

image

Configuration Options 

OPTION ATTRIBUTES DESCRIPTION

Item Types

Timeline References, Workflow References, Form References.

The type of items upon which you'd like to run the action.

Item Data Types

All Object Types, Documents, eForms

The data type of the items upon which you'd like to run the action.

Limit items to a Specific Group

 

The Group Names, separated by commas, of the items upon which you'd like to run the action.

Move

None: Do not move the object.

Move: Move the object to a specified Content list Path.

Copy: Copy the object to a specified Content list Path.

Ensure only a Single Reference remains to Object: Remove all references to the object except for the object that resides in the specified Content List Path.

The desired move actions, if any.

Content List Path

 

The path in the Content List to which the Move actions are applied.

Optional Postfix

 

This is the name of a subdirectory you'd like to create in the content list folder specified in the Content List Path. Process Director will create the subfolder for you automatically.

Rename

New Object Name

Enables you to specify a new object name for the item by entering it into the New Object Name text box.

Change Group

New Group Name

Enables you to specify a new group name for the item by entering it into the New Group Name text box.

Delete

None, Delete (from parent only), Delete Binary (Applicable to documents only), Delete all references to the object

The desired delete actions, if any.

Example

Let us assume that there is an uploaded document in a Group called "Attach" that is attached to a Timeline, and that you'd like to rename the document and copy it to the content list. You could configure the Item Actions Custom task as shown below:

image

In this case, the uploaded document will be copied into the Item Actions Test folder by creating a subfolder that incorporates a unique sequence number as part of the folder name. The document will be renamed "ImportedDocument", and placed into a group named "Imported. In the content list, after the Custom Task runs, you will see the new folder and the copied document it contains, as shown below:

image

Please note that this example renames the attachment object with a new name. While the document is stored in process Director, this will not cause a problem, because Process Director will store the proper file document type. But, this may cause a conflict with the Export Files to Filesystem CT at a later time. The Export Files to Filesystem CT does not track the document types that are exported, but will simply use the object's name as the file name during the export. So, if the object name of the renamed document is missing the file extension, or is renamed to a different file extension, then once the Export Files to Filesystem CT is run, the exported document will not have the proper file extension when it is stored on your local file system.

Run Report

The Custom Task enables you to export a Report to a specific file format (PDF, PNG, etc.).

Report Data/Output Options Tabs

image

Advanced Tab

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

REPORT DATA TAB

Report

 

Select the report to run using the Report picker control

OUTPUT OPTIONS

Output Name

 

The name of the exported report object.

Select Format

PDF, JPG, PNG, DOCX, XLSX, PPTX

The output file format of the exported report.

ADVANCED TAB

Group Name

 

The group name of the exported object.

Database Connectors Custom Tasks

Custom tasks in this section perform operations on a live database to Select, Update, Insert, or Delete data. Any operation you specify with these custom tasks will run on the database you select. As such, you should exercise caution using custom tasks that alter the underlying data.

Advanced Fill Dropdown from DB

This Custom eForm Task will automatically fill a dropdown field on the eForm with values from an external database using a more free-form SQL command.

image

Configuration Options

OPTION VALUES DESCRIPTION

DB Connection

Manual Connection, [List of Available Connections]

Allows you to select a preconfigured Data Source object.

Data Provider

 

If using a manual connection you must specify a data provider.

Connection String

 

String to connect to external database.

Database Type

SQL Server, Oracle, Other

Type of database connection.

SQL Query

 

SELECT clause from external database.

DB Field for Dropdown Text

 

Required column name from database table to fill dropdown.

DB Field for Dropdown Value

 

Optional dropdown value to use with text.

If Previous Value Not In List

Leave value alone Clear the value in the form Add value to the dropdown

Specify what to do with previous value.

Execute Query only when Dropdown is empty

 

Execute Query only when Dropdown is empty.

Execute Query only under this condition

 

Execute Query only under this condition.

Dropdown to Fill

 

Required dropdown field on form to fill.

First Entry in Dropdown

 

Optional first entry in the dropdown (this is not a value).

Fill Dropdown Only When Control Changes

 

Specify a control that changes to fill the dropdown.

Max number of dropdown entries

 

Use “0” for unlimited.

Advanced Fill Fields from DB

This custom tasks allows you to fill in an eForm's fields either during a process or workflow, or from within the eForm itself. Because this is an advanced custom task, you will need to use SQL to request data from the database. Under the “DB Connection” dropdown menu, select the name of the database that you wish to access. Using the “SELECT” SQL command, select the data that you wish to set the field with from the database.

image

Under “Controls to Populate”, you can also select which Database Field you wish to take the information from, as well as which Form Field you can set using that information. Configure the display results to your liking: you can set the number of results returned, the number displayed, etc.

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

DB Connection

Manual Connection (List of Available Connections)

Allows you to select a preconfigured Data Source object.

Data Provider

 

If using a manual connection you must specify a data provider.

Connection String

 

String to connect to external database.

Database Type

SQL Server Oracle, Other

Type of database connection.

SQL Command

 

SELECT clause from external database.

Execute Query only under this condition

 

Execute Query only under this condition.

Controls to populate

 

Database column name and corresponding control to populate

Message to display if no records are found

 

Message to display if no records are found

Do not clear existing data if no records are found

 

Keeps existing field data if no records are returned.

Fill Array with results

 

Use with array. Fills array with results returned

Only return first result

 

If the query returns multiple records, only return the first (control sorting with ORDER BY clauses

Convert System Variables in results

 

If the query returns system variables, convert them to their values.

Fill DropDown from DB

This custom task allows you to fill a dropdown in an eForm with data from a database without having to use SQL. From the “DB Connection” dropdown, select the database that you wish to gather data from. In the “Database Table” dropdown, select the desired table from which you wish to extract data. This dropdown gives you a list of all tables in all databases. The following dropdowns allow you to select specific fields from the database to gather data from.

image

You can also set the conditions under which the Query is executed. Make sure to test your SQL command to make sure it returns results and is properly formatted, if you chose to add a filter. In the Form Details, you can select the dropdown you want filled, as well as other options governing the target dropdown field.

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

DB Connection

Manual Connection (List of Available Connections)

Allows you to select a preconfigured Data Source object.

Data Provider

 

If using a manual connection you must specify a data provider.

Connection String

 

String to connect to external database.

Database Type

SQL Server Oracle Other

Type of database connection.

Prepend Schema Name

 

An optional text string to add to the beginning of the database schema name.

Database Table

 

Connect to a database table that contains the info

DB Field for Dropdown Text

 

Select the database column to use as the item name in the dropdown.

DB Field for Dropdown Value

 

Select the database column to use the optional item value.

SQL Filter Condition

 

Specify additional SQL commands like a WHERE or ORDERBY clause.

If Previous Value Not In List

Leave value alone Clear the value in the form Add value to the dropdown

Specify what to do with previous value.

Execute Query only when Dropdown is empty

 

Execute Query only when Dropdown is empty.

Execute Query only under this condition

 

Execute Query only under this condition.

Dropdown to Fill

 

Required dropdown field on form to fill.

Add empty entry to dropdown with this text

 

Optional first entry in the dropdown (this is not a value).

Fill Dropdown Only When Control Changes

 

Specify a control that changes to fill the dropdown.

Max number of dropdown entries

 

Use “0” for unlimited.

Select value automatically if query returns a single result

 

If only one record is returned from the database, select it automatically.

Fill Fields from DB

This custom task allows you to set the data in eForm fields from a database without the use of SQL.

image

Configuration Options

OPTION ATTRIBUTES DESCRIPTION

DB Connection

Manual Connection (List of Available Connections)

Allows you to select a preconfigured Data Source object. When the manual connection option is chosen, additional configuration fields will appear.

Data Provider

 

If using a manual connection you must specify a data provider.

Connection String

 

String to connect to external database.

Database Type

SQL Server Oracle Other

Type of database connection.

(Optional) Prepend Schema Name

 

Prepend the schema name. This is case sensitive.

Query source tables

(List of tables)

List of database tables from the selected data source. Additional tables can be added by clicking the Add Table button.

Use Alias

 

Allows you to rename the tables using an alias. The text box enables you to write the desired alias name.

Remove Duplicate Entries

 

Removes duplicates.

Where Filter

 

Allows you to select a WHERE clause

Additional Filter

 

ORDERBY clause from external database.

Execute Query only under this condition

 

Execute Query only under this condition.

Controls to populate

 

Database column name and corresponding control to populate. Additional controls can be added by clicking the Add Mapping button.

Message to display if no records are found

 

Message to display if no records are found.

Fill Array with results

 

Use with array. Fills array with results returned.

Max number of results to return

 

Use “0” for unlimited.

Only return first result

 

If the query returns multiple records, only return the first (control sorting with ORDER BY clauses

Convert System Variables in results

 

If the query returns system variables, convert them to their values.

SQL Command

This Custom Task will execute a custom SQL command on an external database. This is a very advanced custom task that allows your workflow, eForm, or process to submit any kind of SQL query to a database. You can also test the query by clicking the “Execute SQL Command” button, but note that this will actually run the SQL Operation on the live database.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

DB Connection

Manual Connection (List of Available Connections)

Allows you to select a preconfigured Data Source object.

Data Provider

 

If using a manual connection you must specify a data provider.

Connection String

 

String to connect to external database.

Database Type

SQL Server Oracle Other

Type of database connection.

Description of command

 

Brief description of what the command does.

SQL Command

 

T-SQL statement to run on the external database.

Execute Query only under this condition

 

Execute Query only under this condition.

Documents Custom Tasks

These custom tasks enable you to perform a variety of tasks on documents stored in Process Director.

Fill Fields from Excel

This custom task allows you to fill in form fields from data in an Excel sheet. This Excel sheet can exist either as an object in the Content List, or as a reference attached to the Process Timeline, Workflow, or Form associated with this custom task. You can also specify that the Excel sheet be specified by a Form Control if you check the “Form Control” radio button option.

Template Documents Source/Mappings Tabs

image

Advanced Tab

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

TEMPLATE DOCUMENTS SOURCE TAB

Content Object

 

Select the Excel template object using the picker control

Form Control

(List of Form Controls)

Select the form control from the dropdown.

References

Workflow References, Timeline References, Form References

The type of reference to use as a template source.

MAPPINGS TAB

Form Control (List of Form Controls) The form control to map. Mapping can be done to a cell or named range in the excel spreadsheet. . If you specify a field that is part of an array, you must specify an Excel column from which the array must be filled. Additional controls can be added by clicking the Add mapping button.

ADVANCED TAB

 

Data has headers

 

Select if the Excel spreadsheet uses column headers in the first row. This will skip the first row when reading the data.

Do not clear rows when filling Array (append rows instead)

 

Select to append new data to existing data. The default is to overwrite the existing data.\

Transform Form to Word

This custom task allows you to transform a form instance into a Microsoft Word document. You can specify how data from the form instance is mapped to the Word document by describing how each field in the form instance maps to each field in the Word document, and you can have all fields in the form instance map to fields with the same names in the Word document.

You can create a Word document to use as a template, and place field markers into the document to contain field values. For instance, if you have an eForm field named "FirstName", you can place a field marker into the document in the format:

<<FirstName>>

During the conversion process, the field marker will be overwritten by the actual value in the FirstName field on the container eForm. Essentially, this is an operation that is very similar to Word's MailMerge function.

Fields contained in an array cannot be transferred to field markers in a Word document.

Standard Tabs

image

Advanced Tab

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

TEMPLATE DOCUMENTS SOURCE TAB

Content Object

 

Select the Word template object using the picker control

Form Control

(List of Form Controls)

Select the form control from the dropdown.

References

Workflow References, Timeline References, Form References

The type of reference to use as a template source.

MAPPINGS TAB

Fill Document fields with data from Form Controls with the same name

 

If the Word document has form fields, this option will automatically match field names to transfer eForm fields into Word form fields with the same names as the eForm fields.

Form Control

(List of Form Controls)

The form control to map. You map eForm fields to Word Document fields. Additional controls can be added by clicking the Add mapping button.

ADVANCED TAB

Save Form before creating new Document

 

Save the eForm to preserve any edited data prior to creating the Word Document.

Use all References in Process to search for fields with similar names

 

In addition to using eForm fields, this option tells Process Director to search all of the process references for fields.

Form Custom Tasks

These custom tasks perform various eForm operations.

Get geolocation

This Custom Task allows a user to fill Form data from location (latitude/longitude) data from a browser. The fields selected must not be hidden using rules in Process Director. If you do not want the text fields visible, add “display:none;” to the style on the text input control either in the eForm builder in the Formatting tab, or with the Set Style Options in the form field properties on the eForm Controls tab for the eForm. You can combine this with the style “display:inline;” to conditionally make the fields visible.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Latitude

(List of Form Controls)

Select the control that stores the latitude of the location.

Longitude

(List of Form Controls)

Select the control that stores the longitude of the location.

Show Alert

This custom task will show a javascript alert on an eForm. The configuration for the alert custom task is very simple: on the configuration page, simply enter text the javascript alert will display in the “Alert Text” field, then click “OK” to save changes.

image

Show Map on Form

This Custom Task will place a map on a Form from a set of coordinates. For the map to persist on the Form, you must map this Custom Task to [eForm Display] Event.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Latitude

(List of Form Controls)

Select the control that stores the latitude of the location.

Longitude

(List of Form Controls)

Select the control that stores the longitude of the location.

Address

(List of Form Controls)

Select the control that stores the address of the location.

Map

(List of Form Controls)

The field on the Form which will contain the map to show. This control should have the ability to contain other controls (e.g. a Section).

Height

 

The map's desired height.

Width

 

The map's desired Width.

Validate Form

This Custom Task allows a user to run Form validation before attempting to submit the Form. You maych

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Skip Validation Rules (Validate Controls only)

 

Skip all of the form validation rules.

Validate only the Event Control which runs this Custom Task

 

Validate on the control that runs the Custom task.

Choose field to save the number of errors

(List of Form Controls)

Select the control that stores the number of validation errors that are thrown.

Validate Form Field

This Custom Task will allow you to validate a form field using a regular expression

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Form Control

(List of Form Controls)

The form control to validate

Regular Expression

 

The Regular expression to use to validate the form control.

Convert SysVars in Regular Expression

 

Convert any SysVars used in the Regular Expression to their values prior to validating the form field.

Error message

Error if the text does not match the regular expression, Error if the text does match the regular expression

Choose whether the message displays when the regular expression matches or not.

Enter the optional error message

 

A customized error message to display.

Add Javascript to eForm

This Custom Task will allow you to add Javascript to run a client-side script in the eForm.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Allow System Variables in JavaScript?

 

When this check box is selected, Process Director will parse the Javascript for System Variables.

Actual JavaScript (do not use <Script> tags)

 

The JavaScript code to be run by the Custom Task. Only the actual JavaScript code is inserted into this box. HTML <script> tags should not be included.

Additionally, this Custom Task solves an issue with Internet Explorer where the browser looses focus on the eForm after a Set Form Data Custom task is run. Simply insert the following Javascript line in the Javascript text box:

bpSetWindowFocus();

Set this Custom Task to run immediately after the Set Form Data Custom Task to reapply focus to the eForm.

Form Data Mapping Custom Tasks

These custom task enable you to copy data from, or set data values in, an eForm.

Copy Form Data

This custom task allows you to copy data from one eForm to an instance of another.

image

Under the “” field, select the form template that you want to copy the data into. To select the fields you want to add to, click on the “Add Mapping” button and select destination and source form control fields. Alternatively, you can tell the Custom Task to map to all eForms except ones that you specify. This will automatically copy data from the source form to the corresponding fields in the destination form.

Other options can be set to specify how the form is displayed and under what groups and instance types it is created. You can specify the group name of the new form, and what kind of reference it will be classified as. You can click on the “Attach Source” checkbox to attach the source form as a reference to the destination form, specifying a new group name for the attachment.

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Form to Create

 

Select the form to which the data should be copied from the picker control.

Add new Instance as

Child under Form Definition ONLYForm Reference, Workflow Reference, Timeline Reference

The object reference to which to attach the new form.

Group Name

 

The Group Name for the new form.

Attach Source

 

Attach the source form as a reference to the new form instance.

Group for Source Form

 

The Group Name for the source form.

Attachment Type(s)

Workflow References, Timeline References, Form References

Attachments to copy to the new form instance.

Attachment Group

All, Objects with no Group only, Specify

Group name of the attachments. Selecting "Specify" will enable you to add the desired group name in the text box.

(ADD AS PENDING)

 

Add the attachments as pending process references instead of form references.

Map to ONLY the following fields

 

Restrict form field mapping to the field mappings you add by clicking the Add mapping button.

Map to ALL fields EXCEPT the following fields

 

Restrict form field mapping to exclude the field mappings you add by clicking the Add mapping button.

Open new Form in same Window

 

Replaces the source form in the browser window.

Open new Form in new Window

 

Opens the destination form in a new window.

Close source Form after copy

   

Save source Form before close/open of new Form

 

Save the source form before copying to ensure the most current data is copied.

Set Form Data

This Custom Task will set control data on a Form. Select the Form Fields to receive the data and the Sysvar- enabled string which will determine the data to set.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Data Source Form

 

Picker control to select a form containing the data source, if any.

Form Control

 

The form control to set data (Container Form must be configured)

Set Data To

 

Data to set to Form Control

Meta Data Custom Tasks

These custom tasks enable you to manipulate Meta Data from Process Director.

Copy Meta Data

This custom task allows you to copy meta data from one object to another.

image

Configuration Options

Both the Data Source and Data Destination sections of the configuration screen allow you to configure the same three fields.

OPTION

ATTRIBUTES

DESCRIPTION

Object Type

Workflow References, Timeline References, Form References

The type of object reference from which to copy the meta data.

Object Data Type

All, Documents, Forms

The type of objects from which to copy the meta data.

Object Group

 

Group Name of the objects from which to copy the meta data.

In the Meta Data to Copy section, you can click the Add Category or Add Attribute buttons to add specific categories or attributes, respectively, to be copied.

Set Meta Data

This Custom Task assigns Categories and sets Attributes on a set of objects.

image

Configuration Options

Both the Data Source and Data Destination sections of the configuration screen allow you to configure the same three fields.

OPTION

ATTRIBUTES

DESCRIPTION

Item Type

Form Only, Form References, Workflow References, Timeline References

The type of object reference for which you wish to set meta data.

Object Types to Set

All, Documents, Forms

The type of objects to which to set the meta data.

Item Group

 

Group Name of the objects to which to set the meta data.

Clicking “Add Category” and “Add Attribute” displays a picker that allows you to select a category or attribute that you want to apply to the objects. Clicking “Add Category to Remove” displays a picker that allows you to select a category that you want to remove from the objects.

MS Dynamics Custom Tasks

These custom tasks enable the transfer of data to and from Microsoft Dynamics.

Fill DropDown from Dynamics CRM

This Custom eForm Task will automatically fill a dropdown field on the eForm with values from a Dynamics CRM. Choose the eForm dropdown field and the column in the CRM table that should be used to fill the dropdown. This Custom Task should be mapped to the [View State Init] event to ensure the dropdown values are always populated. If the dropdown you are filling is inside an array it is best to use the [eForm Display] event.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Dynamics CRM Connection

List of Data Sources

The data connection to Microsoft Dynamics

CRM Table

List of Dynamics Tables

The table from which the data will be retrieved.

CRM Field for Dropdown Text

List of table fields

The table field that will be displayed as the text in the dropdown control.

CRM Field for Dropdown Value

List of table fields

The table field that will be used as the value of the dropdown control.

Dynamics Filter Condition

 

Text filter that will be used as the WHERE condition of the SQL statement that returns the Microsoft Dynamics data.

If Previous Value not in List

Leave value alone, Clear the value in the form, Add the value to the dropdown

How the dropdown value will be altered if the previous value is not in the list of data returned from Dynamics.

Execute Query only when Dropdown is not set

 

This prevents the query from being re-run if the dropdown has already been populated.

Execute Query only under this condition

 

Enables you to set a condition for running the query that populates the dropdown.

Dropdown to Fill

List of eForm fields

The name of the dropdown control that will be filled with Dynamics data.

Add empty entry to Dropdown with this text

 

Text value for null entries. The default is [Select Field].

Fill Dropdown Only When Control Changes

List of eForm fields

Prevents the query from running unless this field changes. This is often used for a field whose value will be used as a filter to limit the data that is returned.

Max number of dropdown entries

 

Maximum number of items that will be placed in the dropdown control.

Select value automatically if query returns a single result

 

If there is only one record returned from the query, then automatically select the value.

Fill Fields from Dynamics CRM

This Custom eForm Task can automatically fill multiple fields on the eForm with values from MS Dynamics CRM. Choose the eForm fields and the columns in the CRM tables that should be used to fill them. You can also configure the input fields will be used to select the appropriate information from the source data.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Dynamics CRM Connection

List of Data Sources

The data connection to Microsoft Dynamics

Query Source Tables

List of Dynamics Tables

The table from which the data will be retrieved. Additional tables can be added by clicking the Add Table button.

Use Alias

 

An alias name to use for the table.

Remove Duplicate Entries

 

Do not repeat duplicate items in the returned data. This option will cause errors if you use it with any database fields of the text data type (e.g. BLOB, Text, etc.

 

OPTION

ATTRIBUTES

DESCRIPTION

Dynamics CRM Connection

List of Data Sources

The data connection to Microsoft Dynamics

Query Source Tables

List of Dynamics Tables

The table from which the data will be retrieved. Additional tables can be added by clicking the Add Table button.

Use Alias

 

An alias name to use for the table.

Remove Duplicate Entries

 

Do not repeat duplicate items in the returned data. This option will cause errors if you use it with any database fields of the text data type (e.g. BLOB, Text, etc.

Where Filter

Lists of Tables, operators, and form controls

Enables you to filter data by comparing a Dynamics field value to an eForm field value.

Comparison Type

Text, Number

The type of comparison the filter will make

Additional Filter (optional)

 

Text filter that will be used as the WHERE condition of the SQL statement that returns the Microsoft Dynamics data.

Execute Query only under this condition

 

Enables you to set a condition for running the query that populates the dropdown.

Controls to populate

Lists of tables and eForm fields

Field mappings between Dynamics fields and eForm fields. Additional mappings can be added by clicking the Add Mapping button.

Message to display if no records are found

 

Text message to display if no data is returned.

Do not clear existing data if no records are found

 

Make no changes to the existing values if no data is returned.

Fill Array with results

 

Fills an array with the values returned from Dynamics. With this option set, each mapping field must exist in the same array.

Check " Append data to existing array" to add the new data to the array rather than overwriting it.

Max number of results to return

 

The maximum number of results to return from the query.

Only return first result

 

If the query returns multiple records, only return the first (control sorting with ORDER BY clauses).

Convert System Variables in results

 

Convert system variables to their values in the returned results.

OData Custom Tasks

These custom tasks return data from any OData source to fill dropdowns or other eForm fields.

Fill DropDown from OData

This Custom eForm Task will automatically fill a dropdown field on the eForm with values from an OData server. Choose the eForm dropdown field and the column in the OData table that should be used to fill the dropdown. This Custom Task should be mapped to the [View State Init] event to ensure the dropdown values are always populated. If the dropdown you are filling is inside an array it is best to use the [eForm Display] event.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

OData Connection

List of Data Sources

The data connection to Microsoft OData

OData Table

List of OData Tables

The table from which the data will be retrieved.

OData Field for Dropdown Text

List of table fields

The table field that will be displayed as the text in the dropdown control.

OData Field for Dropdown Value

List of table fields

The table field that will be used as the value of the dropdown control.

OData Filter Condition

 

Text filter that will be used as the WHERE condition of the SQL statement that returns the Microsoft OData data.

If Previous Value not in List

Leave value alone, Clear the value in the form, Add the value to the dropdown

How the dropdown value will be altered if the previous value is not in the list of data returned from OData.

Execute Query only when Dropdown is not set

 

This prevents the query from being re-run if the dropdown has already been populated.

Execute Query only under this condition

 

Enables you to set a condition for running the query that populates the dropdown.

Dropdown to Fill

List of eForm fields

The name of the dropdown control that will be filled with OData data.

Add empty entry to Dropdown with this text

 

Text value for null entries. The default is [Select Field].

Fill Dropdown Only When Control Changes

List of eForm fields

Prevents the query from running unless this field changes. This is often used for a field whose value will be used as a filter to limit the data that is returned.

Max number of dropdown entries

 

Maximum number of items that will be placed in the dropdown control.

Select value automatically if query returns a single result

 

If there is only one record returned from the query, then automatically select the value.

Fill Fields from OData

This Custom eForm Task can automatically fill multiple fields on the eForm with values from an OData source. Choose the eForm fields and the columns in the OData tables that should be used to fill them. You can also configure the input fields will be used to select the appropriate information in the OData Source.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

OData Connection

List of Data Sources

The data connection to the OData source.

Query Source Tables

List of OData Tables

The table from which the data will be retrieved. Additional tables can be added by clicking the Add Table button.

Use Alias

 

An alias name to use for the table.

Remove Duplicate Entries

 

Do not repeat duplicate items in the returned data. This option will cause errors if you use it with any database fields of the text data type (e.g. BLOB, Text, etc.

Where Filter

Lists of Tables, operators, and form controls

Enables you to filter data by comparing a OData field value to an eForm field value.

Comparison Type

Text, Number

The type of comparison the filter will make

Additional Filter (optional)

 

Text filter that will be used as the WHERE condition of the SQL statement that returns the Microsoft OData data.

Execute Query only under this condition

 

Enables you to set a condition for running the query that populates the dropdown.

Controls to populate

Lists of tables and eForm fields

Field mappings between OData fields and eForm fields. Additional mappings can be added by clicking the Add Mapping button.

Message to display if no records are found

 

Text message to display if no data is returned.

Do not clear existing data if no records are found

 

Make no changes to the existing values if no data is returned.

Fill Array with results

 

Fills an array with the values returned from OData. With this option set, each mapping field must exist in the same array. Check " Append data to existing array" to add the new data to the array rather than overwriting it.

Max number of results to return

 

The maximum number of results to return from the query.

Only return first result

 

If the query returns multiple records, only return the first (control sorting with ORDER BY clauses).

Convert System Variables in results

 

Convert system variables to their values in the returned results.

PDF Custom Tasks

The PDF custom tasks are used to create PDF files from eForms, and convert other file types to PDF documents. The following file types can be converted to PDF:

Document Type

File Extension

Microsoft Word Document

.DOC .DOCX

Microsoft PowerPoint Presentation

.PPT .PPTX

Microsoft Excel Spreadsheet

.XLS .XLSX

Text Files

.TXT .CSV

Image Files

.JPG .GIF .PNG

Convert to PDF

This Custom eForm Task will output Forms and other objects to PDF Documents.

Item Details/Output Object Items Tabs

image

PDF Output Options Tab

image

Advanced Tabs

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

ITEM DETAILS TAB

Item Types

Workflow References Process Timeline References Form References

The type of items to be converted to PDF.

Item Data Types

All Object Types Documents eForms

The type of object.

ADVANCED TABS

Limit Items to Specific Group

 

Convert only a group of objects.

Include Routing Slip

 

Include Routing Slip.

Save Form before Conversion

 

Saves the form prior to the conversion to ensure the most recent data is included on the PDF.

Group Name

 

Assign a name to group objects.

Merge all Items into one PDF

 

Merge all objects to one PDF

Merged Object Name

 

Give the merged objects a name.

PDF OUTPUT OPTIONS TAB

This tab consists of PDF Page formatting options, most of which are self-explanatory.

   

Landscape Orientation

   

HTML Page Width (pixels)

 

Used for eForms. Leave empty for system default, or 0 to let engine automatically set width based on content

Page Size

List of print page sizes

 

Open in New Window

   

Show Header

 

Open the PDF in a popup window after conversion. (Note: only use when conversion results in a single PDF object, e.g. merge or current Form only operations.)

Show Header Line

   

Header Height (pixels)

   

Header Text (can include HTML)

   

Show Footer

   

Show Footer Line

   

Footer Height (pixels)

   

Footer Text (can include HTML)

   

Make PDF Rendition of Documents

This custom task displays all attached documents as PDFs.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Item Types

Workflow References Process Timeline References Form References

The type of items to be converted to PDF.

Limit Items to Specific Group

 

Convert only a group of objects with the Group name you enter here.

Overwrite Existing

 

Overwrite web-viewable version (of document) if it exists

Sign PDF

This custom task allows you to place a text or image of a user’s signature on a PDF document.

PDF Source/Signature Options Tabs

image

Advanced Tabs

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

PDF SOURCE TAB

Attachment Types

Workflow References Timeline References Form References

The type of items to be converted to PDF.

Document Groups

All, Objects with no group only, Specify

"Specify" will convert only a group of objects with the Group Name you enter into the text box that appears when you select this option.

SIGNATURE OPTIONS TAB

Place Signature by

Coordinates (all units in Points), Field in PDF.

You can set the signature's location and size in the document by setting the Left, Top, Height, and Width properties. A simpler, yet equally effective method, is to place a field in the PDF document to contain the signature.

Signature Source

Text Only, User Picture, user Signature, Image (Content Object), Signature Control, Digital Signature

The source type of the signature that'll be placed on the PDF document.

ADVANCED TABS

Overwrite Document

 

Overwrite the existing PDF document.

Output Parent

Form, Workflow, Timeline

The object type to which the PDF file should be attached.

Output Group

 

The Group name to be applied to the PDF file.

Output Document Name

 

The file name of the signed PDF file.

Page Number

 

Page number where the signature will appear.

Opacity

 

100% opacity means the signature will be completely opaque. 0% opacity means the signature will be completely transparent.

Text for signature

 

Additional text to displayed in the signature area.

Transform Form to PDF

This Custom Task will populate the fields on a Template PDF form from a source eForm. To create a template PDF, you will need a copy of Adobe Acrobat. The process of making a template PDF document is not covered in this documentation.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Template File

 

Picker control to select the PDF template file.

Refresh PDF Field List

 

Refresh the list of fields found in the PDF template file.

Save Form data before PDF output

 

Saves the form prior to the conversion to ensure the most recent data is included on the PDF.

Automatically populate PDF fields with Form Controls of the same name

   

Use all workflow Form Instances to populate PDF fields

   

Form Control

Lists of eForm controls and PDF template fields

Map fields from the form to the PDF template file. Additional field mappings can be made by clicking the Add Row button.

Output Type

Workflow Reference, Timeline Reference, Form Reference

The reference type to which to attach the PDF output file.

Output name

 

The name of the exported PDF file.

Output Group

 

The Group Name to apply to the exported PDF file.

Process Custom Tasks

These custom tasks are used to initiate processes or process steps.

E-mail Action

This Custom task will parse an email and extract values to use in an eForm or process. You can determine the appropriate value by finding it using one of three methods:

  1. Line: On a specific line of the email,
  2. Keyword: Identified by a following a Keyword in the format "Keyword: KeywordName",
  3. Value: A static value manually entered into the field on the Custom task, i.e., specifying a value on receipt of an email, without parsing the email itself.
    image

Configuration Options

Data From message

The message values you wish to extract.

OPTION

ATTRIBUTES

DESCRIPTION

Validate that email was sent from an email address belonging to a user to whom the task was assigned

 

This option will validate the email address of the user who sent the email against the email address of the user to whom the user task was assigned. This ensures that a person who possesses the user task notification email but was not assigned to the task cannot complete the task.

Results

Line Keyword Value

The Result of the task, which corresponds to the Workflow branch or Process Timeline Activity result.

Comments

Line Keyword Value

Comments that can be added to a Workflow Task or Process Timeline Activity.

[A Mapped eForm field]

Line Keyword Value

An eForm field that can be mapped to the Line, Value, or Keyword. You can click the Add Mappings button to map additional eForm fields.

Ignore Text part of multipart message

 

Sometimes, retrieving information from a message formatted in Rich Text can be difficult. Checking this option may resolve the issue.

Append Data to an Array

 

This checkbox can only be selected if the mapped field is in an array. If checked, this option will add a new row to the array, setting the specified field to the value retrieved. If not checked, but the mapped field is in an array, the entire specified column (that is, the specified field in every row of the array) will be set to the value returned.

Append Data to Form Field

 

If checked, this option will add the retrieved data to the existing contents of the specified form field with a comma separator. If not checked, the existing contents of that form field will be replaced.

Reply on Error

Used to send a generic response when an error occurs when processing the email.

OPTION

ATTRIBUTES

DESCRIPTION

Subject

 

The subject of the email response sent to the user who sent the email.

Body

 

The body text of the email response sent to the user who sent the email.

Reply on Successful Task Completion

Used to notify the email sender when a task has been successfully completed after the email is received and parsed.

OPTION

ATTRIBUTES

DESCRIPTION

Subject

 

The subject of the email response sent to the user who sent the email.

Body

 

The body text of the email response sent to the user who sent the email.

Jump to Step

Allow a Workflow to jump from the current Step to a different Step in the Workflow.

imageConfiguration Options

OPTION

ATTRIBUTES

DESCRIPTION

Jump to step name

 

The name of the process step to which you want to jump.

[Post-jump actions]

Do not close Form, Save and close Form, Close Form only (no save)

Directs what to happen to the open eForm when the task is run.

Post

This Custom Task will post a value to a Wait task in a process to complete the Wait task and wake the process.

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Process Instance ID:

 

The Instance ID of the process instance that is stopped on a Wait task that you wish to complete.

Post String:

 

The string value that will complete the wait task.

Run Process

This custom task allows you to launch a new process. You can either specify the process within the custom task configuration, or have the process specified by a form field or an array of form fields. The Launch Data tab allows you to specify a form control that will specify the process to be launched. Alternatively, you can specify the process to be launched right in that tab.

Launch Data/New Form/Attachments Tabs

image

Array Binding Tab

image

Advanced Tabs

image

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

LAUNCH DATA TAB

   

Launch Process

  Picker control to choose the process to launch.

NEW FORM TAB

   

New Form

 

Picker control to select the new form to attach to the process. Multiple forms can be added by clicking the Add Mapping button.

ATTACHMENTS TAB

   
Reference Type(s) Workflow References, Timeline References, Form References The reference types for new attachments associated with this process.

ARRAY BINDING TAB

   

Array Field

List of eForm arrays

Launch a process for each row in an array

For each row, launch new Process only under the following condition.

 

When checked, a list of fields, list of operators, and a text box appear to allow you to set a condition that must apply for each row in the array before that row initiates the process.

ADVANCED TABS

Launch as Sub-Process of Current Process

   

Launch Process as Current User (instead of Object Creator)

   

Save current Form data before starting Process

 

Saves the form data before the process is initiated. Using this option on a new form instance that has not yet started a workflow will save the Form, but will not start the default workflow for that Form.

After Process Starts

List of form handling options

Determines what should happen with the parent eForm after the process started by the custom task is initiated.

After Successful Launch

List of actions

Enables you to make changes to form fields to reflect the start of the process.

Copy the data from all fields which the Source Form and the New Form share (all Fields with the same name)

 

Copies form data to the new form.

Set Form as Default Form Instance for Process

   

Group name for the new Form in the new Process

 

Sets a group name for the new form.

Attach new Form to parent Process

   

Group name for the new Form in the parent Process

 

Sets a group name for the new form.

Attach source Form to new Process

   

Group name for the source Form in the new Process

 

Sets a group name for the source form.

Item Type

All, Documents, Forms

Types of attachments

Group Name

All, Objects with no Group only, Specify

Group name for attachments, optionally limiting which are attached by group.

Schedule Process

The Custom Task extracts information from an eForm to start processes at specific instances as defined in an eForm. The Custom task depends on the Scheduler module, and a more complete explanation of the functionality of the module and Custom task can be found in the Scheduler Module documentationimage

Configuration Options

OPTION

ATTRIBUTES

DESCRIPTION

Schedule Form

 

The eForm that contains the scheduling information.

Process Field

 

The eForm field that identifies the process to start.

Schedule Field

 

The eForm Schedule field that identifies the schedule or interval for the process to run.

Next Run Time Field

 

The eForm field that identifies the next time when the process will run, according to the schedule defined in the previous field. Generally this does not need to be edited by the user.

Audit Form

 

An eForm that contains auditing data.

Audit Field Prefix

 

The prefix used to identify the fields, usually columns in an array, containing the audit data.

  • Was this article helpful?