This tutorial demonstrates how to create a simple EmpowerID workflow that can be deployed in your environment to update the attributes of an EmpowerID Person. The purpose of this tutorial is to guide you through the steps for completing a fully functional workflow comprised of common workflow components. In this tutorial, these components include the following:
A Lookup Control — Lookup Controls are User Interface elements that can be placed in a workflow to allow users to search for EmpowerID objects. In this tutorial, we will create a Lookup that can be used to search for a person.
A Form — Forms are User Interface elements that you place in a workflow to allow users to provide information to the workflow. In this tutorial, we will create a form that allows users to enter information about the person they searched for in the Lookup.
An Operation Activity — Operation activities are protected workflow shapes that you place on the workflow to perform the actions of the workflow. Workflows can contain multiple Operation activities, depending on their complexity. In this tutorial, we will use a single Operation activity that when executed updates an attribute on a person. In EmpowerID, this person is known as the "target person."
When you have completed this tutorial, you should have foundational understanding of the various components and principles involved with creating EmpowerID workflows that can be used as a basis for creating more complex workflows.
To create the workflow, we will do the following:
Create a project folder. In Workflow Studio, a project folder is a container that provides a logical structure through which you can manage workflow applications and all the components associated with them.
Create and publish a Lookup Control that allows users to search for a person
Create and publish a form with fields bound to an EmpowerID Person
Build the workflow, adding to it the Lookup Control and form, as well as a Multi-Operation Operation Activity that verifies whether the current person attempting to edit the person has the appropriate access to do so.
Bind the appropriate properties of the workflow activities to one another to ensure that the workflow data remains consistent throughout its lifecycle.
Publish and test the workflow.
Create project folders
In Workflow Studio, click on select the Solution Explorer tab to the left of the IDE.
Right click the parent source control node and select New Folder from the context menu.
Enter a name for the folder and click OK.
In the Folders dialog that appears, select Workflow>Applications and then click OK.
The Workflow Studio Source Control updates to show the new folder in the Source Control tree.
Right click the new folder node and select Add Item Folders.
Select User Interface>Forms and User Interface > Lookup Controls and then click OK.
After Source Control updates, you should see the folders in your tree.
the following subfolders to organize the items you create in this tutorial:
User Interface > Forms
User Interface > Lookup Controls
Workflows > Activities
Workflows > Applications
Click OK to add the subfolders and close the dialog.
The Workflow Studio Source Control updates to show the new folder in the Source Control tree.
Create and publish a lookup for the workflow
Expand the New folder > User Interface folders.
Right-click on the Lookup Controls folder you just created and select select New User Interface > Lookup Control.
This opens the new Lookup Control in the Workflow Studio Lookup Designer.
In the Properties grid, set the Title property to Hello World Person Lookup and the Description property to Search for a Person.
In the Properties grid, set the Type property to Single. Setting the Type to Single allows users to select only one person.
Next, we need to bind the Lookup Control to the PersonView component object to allow us to add grid columns related to that component.In the Lookup Control Data Pane located at the bottom of the designer, do the following to set the Lookup Control to return a list of people.
Click the Component Object drop-down list and select PersonView. The Component Object drop-down list contains a list of class definitions that relate to the objects EmpowerID protects, and the PersonView object provides a consolidated view of all the data fields associated with EmpowerID people.
Click the Data Method drop-down list and select the GetAllSearch(string columnsToSearch, string textToSearch) method. This method returns all people contained in the EmpowerID Identity Warehouse to the Lookup Control.
The following image shows what the Lookup Control Data Pane looks like with the above selections made.
Now that the component object for the Lookup Control has been set, click the Set Grid Type button in the Lookup Designer ribbon to set the grid type for the designer.
In the Set Grid Type window that appears, select Person from the drop-down and click OKIn the Properties grid, set the GridType property to Person. Setting the grid type for Lookup Controls in this way automatically adds the columns associated with the component object you are binding to the Lookup Control. This allows you to provide a consistent look to your Lookups and makes it easier for localization as the default grid type columns are already localized.
In the Confirm dialog that appears, click Yes to continue.
Click the Save button above the designer and browse to the User Interface > Lookup Controls folder.
Enter HelloWorldPersonLookup as the file name and then click Save.
Next, publish the Lookup to your local file system by following the below steps. When you publish the Lookup, Workflow Studio converts it to an activity that can be placed within the workflow.
From the toolbar located above the Workflow Studio Designer, click the Compile and Publish button.
In the Lookup Publishing wizard that appears, click the Next button.
Select the server to which you want to publish the Lookup and click Next.
Click OK to close the Publishing action completed successfully! messagebox.
Select Yes when prompted to restart Workflow Studio.
Select Yes to save changes to any opened files.
Now that the Lookup has been created and published, the next step is to create and publish the workflow form.
Create and publish a form for the workflow
Right-click the Forms folder you created earlier and select Add New Item > User User Interface > EmpowerID Form.
This opens the form with the default tab in the Workflow Studio Form Designer.
Edit the caption in the form tab by double-clicking directly on the caption text.
Change the caption from Tab1 to Person.
Repeat the process for the form section text, changing it from Tab1 Section1 to Name Information.
The tab and section caption should look like those depicted shown in the below image.
When a user runs the Hello World workflow, we want the form to have certain fields populated with attribute data, such as the target person's name information. This is accomplished through adding Form Data components to the form. To do this, click the Workflow Studio Form Designer Commands tab and select Add Object button in the Form Designer ribbon.
In the Add Object window that appears, click the Rbac Components tab, select the Person component and then click the Add button.
This adds a component, named Person1, to the Components tree located to the left of the form. The Components tree contains bound objects and other types that can be used when designing forms. The Person1 component contains attributes and properties related to the EmpowerID people in your environment.
Double-click the Person1 component text and change the name to TargetPerson.
Expand the TargetPerson node to reveal the attributes available for the Person component.
From the TargetPerson node in the Components tree, scroll to the FirstName object and drag it onto the design surface of the form. When you are dragging the object, notice that FirstName becomes outlined by a green rectangle and the mouse cursor icon changes, indicating that you are performing a drag-and-drop operation. The blue rectangle indicates where you are dropping the FirstName object.
From the TargetPerson node in the Components tree, drag the LastName attribute onto the form. You should see both fields on the form.
On the form, double-click directly on the field names and edit them to read First Name and Last Name, respectively.
Add an new section to the form by clicking the Workflow Studio Form Designer Commands button and selecting New Section button in the Form Designer ribbon.
Double-click the new section caption and edit it so that it reads Address Information
From the TargetPerson node in the Components tree, drag the following components onto the Address Information section of the form:
StreetAddress
City
State
PostalCode
Add spacing to the StreetAddress and PostalCode field names. Your form should look like the following image.
Click the Save button above the designer and browse to the User Interface > Forms folder you created earlier.
Enter HelloWorldEditPerson as the file name and then click Save.
Next, publish the form by following the below steps. When you publish the form, Workflow Studio converts it to an activity that can be placed within the workflow.
Click the Compile and Publish button located above the Form Designer.
In the Form Publishing wizard that appears, click the Next button.
Select the server to which you want to publish the form and click Next.
Click OK to close the Publishing action competed successfully! messagebox.
Wait for the toolbox to load and then select Yes when prompted to restart Workflow Studio.
Select Yes to save changes to any opened files.
Now that the Lookup and form have been created and published, we can begin building the workflow.
Build the workflow
In Workflow Studio, right-click the Workflows > Applications folder you created earlier and select New Workflow > Flow Chart Workflow.
Workflow Studio creates the workflow and opens it in the Workflow Studio Designer.
On the Source Control tree, expand the User Interface > Lookup Controls folders you created earlier and locate the Person Lookup activity you just created.
Drag the Person Lookup activity onto the Workflow Designer and drop it below the Start activity.
Click the Start activity to activate its drawing points and then draw a line connecting the Start activity to the Lookup activity.
Next, drag the HelloWorldEditPerson form activity onto the Workflow Designer and drop it below the Lookup activity.
Click the Lookup activity to activate its drawing points and then draw a line connecting the Lookup activity to the form activity.
Insert excerpt IL:Operation Activity Snippet IL:Operation Activity Snippet nopanel true From Solution Explorer, search for EditPersonMultiOperations.
Drag the Operation activity from Solution Explorer onto the Workflow Designer, placing it directly below the form activity. Note that the activity shows as Operation Base Activity.
Click the form activity to activate its drawing points and then draw a line connecting the activity to the Operation Base activity.
Next, click the Operation Base activity to activate its drawing points and then draw a line from the activity to the End activity. This ensures that the workflow exits after the Operation activity executes.
Next, to ensure that the Multi-Operation Activity executes the desired operation, we need to enable that operation for the workflow by doing the following:
Right-click on the Multi-Operation Activity and select Enable/Disable Executing Operations from the context menu.
In the Enable/Disable Resource Operations dialog that appears, select Edit Address from the Disabled Operations columns and move it to the Enabled Operations column by clicking the Right Arrow button.
Click Close to close the Enable/Disable Resource Operations dialog.
Finally, to use the Multi-Operation Activity in the workflow, we need to add to the workflow project a reference to the OperationBaseActivity assembly:
On the Workflow Studio toolbox to the right of the Workflow Designer, click the Solution tab and in the Code Tree right-click the project name and select Add Reference > Add Assembly Reference from the context menu.
In the GAC Assembly Reference window that appears, select the OperationBaseActivity assembly and then click the Add selected items button.
From the Code Tree, expand the Reference > Assemblies nodes. You should see the OperationBaseActivity assembly.
Next, we need to bind some workflow and activity properties to each other to pass the right data values to the various components of our workflow.
Bind workflow properties
From the Workflow Designer, click the Bindings tab.
You should see two identical columns, each with a Workflow Properties node, as well as nodes for each of the activities in the workflow. These nodes provide access to the properties of the workflow and the activities of the workflow. These properties are categorized by type, such as Input and Output, allowing you easily pass the output of one activity to the input of another and so on.
For this tutorial, we want to pass the person selected in the lookup on the form, and the from the form to the Operation activity. As mentioned earlier, this person is the target of the workflow.In the left column of the Bindings tab, expand the Lookup activity and then expand the Output node for that activity. You should see three properties, Comments, SelectedValue and SelectedValueAsComponent. The property we are interested in is SelectedValueAsComponent. The property represents the EmpowerID Person selected in the lookup.
In the right column of the Bindings tab, expand the Form activity and then expand the Input/Output node for that activity. You should see a TargetPerson property. As indicated by the type (Input/Output), the target person is passed to the form, where edits are made to the available attributes and then passed to the Multi-Operation activity.
From the left column of the Bindings tab, drag the SelectedValueAsComponent property onto the TargetPerson property. This binds the person selected in the lookup to the form.
Collapse the nodes in both columns. This makes it easier to make the next binding.
In the left column of the Bindings tab, expand the form activity and then expand the Input/Output node for that activity. You should see the TargetPerson property.
In the right column of the Binding tab, expand the Multi-Operation activity (OperationBaseActivity) in our example, and then expand the Input node. You should see a number of properties prefixed with Form_. The property we are interested in is the Form_TargetPerson property.
From the left column of the Bindings tab, drag the form TargetPerson property onto the Multi-Operation activity Form_TargetPerson property.
| Tip |
|---|
Now that we have completed the bindings, we are ready to deploy the workflow. |
Deploy and test the workflow
Click the Save button above the designer and in the Save As dialog that appears, enter HelloWorld as the file name and click Save.
Next, click the Compile and Publish button above the Workflow Designer.
In the Workflow Publishing wizard that appears, click the Next button.
Select the appropriate workflow server(s) and click Next.
Click OK to close the Publishing action completed successfully! dialog.
Workflow Studio adds the .pub file for the workflow to the WFS > _PublishedItems folder on your local file system.
. You should also see .pub files for the lookup and form you published earlier.
Insert excerpt IL:Deploy WF Message IL:Deploy WF Message nopanel true Log in to the EmpowerID web application as a user with the appropriate access to run the PublishWorkflowStudioItem workflow.
On the navbar, expand Object Administration > Workflows and click the Publish Workflow Studio Item action link.
Click Choose File, navigate to the _PublishedItems folder and select HelloWorld.pub.
Click Submit.
Reset IIS.
In the address bar of your browser, append
#w/HelloWorldto the base URL for the workflowyour site. The URL should be full URL should look similar tohttps://YourEmpowerIDWebServersso.empoweriam.com/UIui/#w/PublishWorkflowStudioItem.
Click Choose File, navigate to the _PublishedItems folder and select HelloWorld.pub.
Click Submit.
After the publishing operation completes,
HelloWorldwheresso.empoweriam.comis the FQDN of your EmpowerID server.
EmpowerID starts the workflow. You should see the Person Lookup for the workflow.
Search for a person, click the record returned and then click Submit.
In the Address Information section of the Update Person Form that appears, type an address in the Street Address field and click Submit.
Finally, verify the change by searching for the person whose address you updated. You should see your change beside the Street Address label.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Div | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
IN THIS ARTICLE
|