Transflo DMS Workflow Studio

TRANSFLO® Workflow Studio is a powerful tool that can be used to model any business process in your organization. It contains tools to create forms, define data elements and tie these to your processes. With minimal code a process model can be tested and deployed throughout your organization.

This topic describes the basic elements of a Workflow Studio Project. You can create a project and process and then add Fields, Parameters, Participants, Processes and Forms to it.

Included with your installation CD are sample processes that you can use as templates to model your own processes. TRANSFLO® Workflow Studio can be installed on your desktop or laptop computer. You don’t have to be connected to your corporate network to model a process. When you are ready to deploy your process, you can connect to your network and publish it.

Define Data Fields

For data to be used in your Process you will need to define Data Fields and Parameters.

A data field is the name of a placeholder for data.

A Parameter defines data that is passed along from step to step.

Data Fields can be defined in the context of the Process you are working on.

In other words, these fields cannot be used by other Processes.

Data Fields can also be defined at a global level in your Project.

Global Data Fields can be used in all Processes in your project.

Parameters can be mapped to Data Fields and therefore can only be defined in the Process context.

Note: All TRANSFLO® process definitions must have the following required fields from the case initiation perspective:

KEYFIELDS

DOCCLASS

To create Data Fields for your Process (i.e. in the Process context) perform the following:

1. In the Project Explorer, under Hiring Process, right-click on Data Fields.

Select New > Data Field from the context menu.

2. In the New Data Field dialog box, type in “Applicant Name” in the Label box.

Note: Since the Applicant’s Name is a string we accepted the default of Basic type =Text with a Length of 50 characters.

3. Click Finish.

The field is added to the tree prefixed with a symbol to show that it is an alphanumeric string.

Note: When you type a name in the Label box the name is repeated in the Name box without spaces. The Label appears in the Project Explorer and is followed by the Name in the parentheses.

  1. Repeat this Process for the following fields:

    • Applicant Age (Integer Number, Length=3)

    • Accepted (Boolean)

Add Conditional Sequence Flow Script

The Boolean Data Field Accepted is used to determine if applicant will be scheduled for an interview.

To do this,

1. Select the Sequence flow that connects Accept Applicant? Exclusive Data-Based Gateway to the Interview Applicant User Task in the Hiring Process.

Trouble Shooting:

If JavaScript is not in the Script Defined As: drop-down ensure that:

  • You have Solution Design enabled.

  • Your Process’ Destination Property is set to iProcess.

  1. Select JavaScript from the Script Defined As: drop-down on the Properties tab.

  2. Type “Accepted;” in the Describe Sequence Flow Condition box.

Note: Once you select “iProcess” as the Destination Property for your Process, Workflow Studio will show problems in the Problems tab.

Objects on your Process with errors will have an icon in the top right corner.

Hover your mouse over the icon to view the error message and any quick fix suggestions that may be available.


Create Participants

Note: Participants can be of Type: ROLE, HUMAN, ORGANIZTIONAL UNIT and SYSTEM.

It is recommended that you use ROLE rather than HUMAN to define a Participant for a User Task.

Trouble Shooting: All ROLE, HUMAN and SYSTEM Participants must be defined in the TRANSFLO® Workflow Workspace.

To add Participants to your Process,

1. In the Project Explorer right-click on Participants under the Hiring Process.

Select Participant from the New context sub-menu.

2. In the New Participant dialog box opens.

Type the name of your Participant’s Role (in this case “Hiring Manager”) in the Name box, and select the ROLE radio button.

Click Finish.

3. Repeat this to create the Participant Role “Administrator”.

Adding Participants to User Tasks

All User Tasks must have Participants who will interact with a Form make decisions that can affect routing in subsequent Tasks.

To add Participants to your user tasks do the following:

1. Select the Review Application User Task.

2. In the Properties tab, click on the ellipsis button next to the Participants box.

3. The Select Participants dialog opens.

Select both the Administrator and the Hiring Manager, and click the Add button.

Click OK.

4. The Participants are listed in the Participants box.

5. Repeat for the Interview Applicant User Task.

6. Save your work.

Creating Forms

User Tasks are performed by people, so they require user interfaces.

Workflow Forms provides user interfaces to User Tasks.

To create a Workflow form perform the following steps:

1. Right click on the Review Application task in the Hiring Process and select Form> Generate from the context menu.

2. The Task Parameter Selection Page opens.

Since all three Fields are going to be used click Finish.

3. A Form hierarchy is created in the Project Explorer with the name of the Package and Process that it belongs to.

Below these is a folder with the same name as the step the Form belongs to.

This folder contains the files required to define the Form.

4. TRANSFLO® Workflow Studio generates a Form for you with three Panes.

The top Pane has data entry fields corresponding to the Data Fields and the corresponding data types that you created above.

The second Pane has the default Navigation buttons and the third Pane is a place holder for validation error messages.

5. Click on the outer edge of the Validation Pane and drag it above the Data Entry Pane.

When a solid horizontal line appears above the Review Application label drop the Validation Pane there.

6. Repeat this for the Navigation Buttons Pane.

Click on the outer edge of the Navigation Buttons Pane and drag it above the Validation Pane.

The default Navigation Button actions are listed in the table below:

Button Action

Cancel

The Cancel button closes the form, does not save the changes made on the Form, and keeps the Case in the current Queue (User Task).

Close

The Close button closes the form, saves the changes made on the Form, and keeps the Case in the current Queue (User Task).

Submit

The Submitbutton closes the form, saves the changes made on the Form, and moves the Case to the next step in the Process.

7. To clarify the action of the Close button you will change the label to make it more descriptive.

Click on the Close button control in the Form to select it.

In the Properties view change the Label property text to “Keep”.

8. The button label is changed.

9. The meaning of the label “Accepted” is also unclear.

Click on the Accepted control in the form to select it.

In the Properties view change the Label property text to “Accept Application for Interview”.

10. The label has changed but part of it is not visible.

Hover over the end point to the right until it becomes a double arrow and drag it to the right to re-size it to the width of the Data Entry Frame.

11. The contents of the form should look something like the diagram below.

Notice that the label still seems to be hidden.

12. Save your work.

Note: To change the Data Field populated by a control, click on the button and select a Data Field from the list.

13. Next, change the check box to two radio buttons.

In the Properties View under the Generaltab change the Control Type property to Radio Group.

14. In the Properties tab of the properties view change the following properties:

Property Value

Choice Layout

columns

Columns

2

Choices

Specify Static Choices

Label = Yes; Value = True. Label = No; Value = False.

15. Your Form design has changed as shown below:

16. Save your work.

17. To preview what your form will look like, click on the GI Preview tab on the bottom left edge of the Form Design View.

Note: You can test your form in GI Preview mode by entering values in your Form Fields.

The System Log pane will show the Data Fields that are being populated by the Form Fields and the values for each.

18. The Form opens as it would for an end user.

Notice that all of the text for the Accept radio button control is visible.

Using Custom Scripts

Note: This section is intended for advanced Users.

TRANSFLO® Workflow allows you to use VBScript to write custom scripts and insert them in your Workflow Processes.

Custom scripts use the TRANSFLO® Scripting Agent that is packaged in the TRANSFLO® System Agent during TRANSFLO® Server installation.

To insert a custom script in your Process do the following:

1. Place a Manual Task in your Process.

2. Change the label Manual Task, and select a Participant.

3. Log in to your TRANSFLO® Administration Tool, and click Agent Configuration in the tree view menu.

4. The Workflow Agent Configuration page opens in the right frame.

5. Click the Add button to configure a new script.

The Workflow Agent Configuration opens.

  • Select the Workflow Agent type from the Agent Type drop-down.

    The available Workflow Agent types are: DListAgent, MDPAgent, and ScriptingAgent.

  • Type “TFLOWF” in the Node Name box.

  • Type the name of the Workflow Process in the Procedure Name box.

  • Type the name of the Workflow Queue that the script will interact with in the Queue Name box.

  • The Script Name box is only available if you selected ScriptingAgent from the Agent Type drop-down.

    Type the script file name in the Script Name box.

  • Type the Username that will be used by the Workflow Agent to connect to work flow and execute the script in the Username box.

    This user must have access to the Workflow Queue you specified above.

  • Type the Password for the Username in both the Password and Confirm Password boxes.

  • Ensure that the script is enabled by checking the Enabled check box.

  • Click Save.

6. Your new script appears in the Workflow Agent Configuration list.

7. Repeat this process for all scripts used by your procedures.

8. To filter the list enter search text using * or % as wild cards in the Find Procedure Name box, and click the Find Procedure Name button.

9. To revert back to the unfiltered list, click the Reset button.

10. To edit an existing script click the Edit button.

11. To delete and existing script click the Delete button.

Scripting Agent Methods and Properties

The TRANSFLO® Scripting Agent support the following standard TRANSFLO® Logging Levels:

1 = Log Errors only

2 = Log Errors and Warnings

3 = Log Errors, Warnings and Processing Information

4 = Log Errors, Warnings, Processing Information and Trace

The Scripting Agent supports various methods, classes and properties as listed below:

Methods

Definition Description

LogInfo(string msg)

Writes the argument msg to the log file when system agent log level is set to 3 or 4.

LogWarning(string msg)

Write the argument msg to the log file when system agent log level is set to 2, 3 or 4.

LogError(string msg)

Writes the argument msg to the log file when system agent log level is set to any value.

GetCaseFieldValue(string

FieldName)

Returns the Case Field value for the FieldName parameter that is passed in.

SetCaseFieldValue(string FieldName, object FieldValue)

Sets the Case Field value.

To modify any Case Field you can use this method by specifying the Field name and value.

Class

Name Description

CaseField

string Name

Name of the Workflow Field.

object Value

Value of the Workflow Field.

CaseFieldType Type

Type of workflow field, possible types are: Bool, Int, Double, String, and DateTime.