Page Comparison

This document provides guidelines you can follow while The guidelines provided in this document aim to assist you and your developer team in developing new components and extending the existing EmpowerID functionality using Workflow Studio. These guidelines are about the include naming conventions and tips that to help you avoid known issues while developing components using the Workflow Studioduring development.

General Tips

1. Always

1. create package folders

1. within the Workflow Studio Source control. A project folder

1. serves as a container that

1. offers a logical

1. organization for workflow applications and

1. their associated components.

1. Avoid using the stock packages folder

1. provided by the EmpowerID product.

2. When

1. modifying a stock workflow, it is a best practice

1. to

1. create a copy of the workflow and then modify the copied

1. version.

1. Modifying stock workflows

1. directly may result in future EmpowerID product upgrades overwriting the modified workflows. Consider following the naming conventions provided

1. in the below Naming Conventions section of this article.

2. When modifying a stock workflow, it is recommended to create a copy of the workflow and make changes to the copied version. Directly modifying stock workflows may result in them being overwritten during future EID product upgrades. Adhering to the naming conventions outlined in the Naming Conventions section is also advised.

3. Not

1. only for workflows, but it's also important to follow the same approach when extending or altering any stock components

1. . Create a copy, save it with a

1. suitable name

1. according to the Naming Conventions

1. , and then make your modifications.

2. Customizing and extending EmpowerID components

1. involves inheriting and referencing stock libraries

1. , such as classes and interfaces. You can find the instructions

1. for doing so in the Extend EmpowerID topic.

Anchor
NamingConventions NamingConventions

Naming Conventions

We While developing components in Workflow Studio, you will work with various items while developing components in Workflow studio. A . Following a standard naming convention followed properly will help read, understand and maintain the code betterhelps improve readability, understanding, and maintenance of the code. This section discusses how we can to sensibly name the WFS items like Workflow, FormWorkflow Studio items such as Workflows, Forms, and Properties within those items.

Workflow

The table below outlines the naming conventions for workflows and activities, providing pattern examples and guidance for specific use cases.

Component	Pattern	Example	Description
Workflow	{CompanyInitial}{Verb}{TargetResourceType}	CICreateMailbox, CIEditMailbox, CIDeletePerson, CIUpdatePerson	To name When naming a workflow, start begin with the company initials and be preceded , followed by the verb, and then the target resource type. For In the case of the CICreateMailbox workflow called CICreateMailboxexample, "CI is " represents the company initialinitials, "Create is the Action" denotes the action being performed, and "Mailbox is " signifies the target resource type.
	{CompanyInitial}{Verb}{TargetResourceType}	CIUpdatePerson	Some For workflows execute that perform multiple actions against the on a single resource type, e.g., such as add and remove. To name such workflows with multiple actions start with , begin the name with the company initials and preceded by the Verb like update and , followed by a verb that encompasses both actions, like "update," and then the target resource type. For In the example of the CIUpdatePerson workflow CIUpdatePerson, "CI is " represents the company initialinitials, "update indicates " signifies the Actioncombined actions, and Mailbox "Person" is the target resource type. Always Be sure to choose a verb that makes sense of both actionsaccurately reflects the multiple actions being performed.
	{CompanyInitial}{Verb}{TargetResourceTypeAbbrevation}	CIDeleteMRMembership	Microsoft Windows allows only has a file path character limit of 255-260 characters for a file path. Shortening the name using abbreviations will overcome the limitation and increase the code readability. Some examples of abbreviations are MR for Management Roles, BRL for Business Roles, and Locations. To name such . Using abbreviations in workflow names can help overcome this limitation and improve code readability. For example, "MR" can represent Management Roles, and "BRL" stands for Business Roles and Locations. When naming workflows with multiple actions, start begin with the company initials and preceded , followed by the Verb verb and an abbreviation of for the target resource type. For In the case of the CIUpdateMRMembership workflow, "CI" represents the company initials, "Update" is the company initialaction performed, and Delete is the Action Done against MR "MRMembership" is the abbreviated target resource type for Management Role Membership.
	{CompanyInitial}{Verb}{TargetResourceType1}{TargetResourceType2}	CIAddAccountToGroup, CIRemoveAccountFromGroup	To name a workflow executing Action against that performs actions on multiple objects, start with the company initials, preceded followed by the Verb verb and the name names of both target resource types. For CIAddAccountToGroup, CI is the company initial, and Add is the Action Done against Management Role MembershipIn the case of the CIAddAccountToGroup workflow example, "CI" represents the company initials, "Add" is the action performed, and "AccountToGroup" indicates that the action is being done on both Account and Group resource types.
Workflow > Workflow Activity	{CompanyInitial}{Verb}{TargetResourceType}Activity {CompanyInitial}{Verb}{TargetResourceTypeAbbrevation}	CIResetPasswordActivity CIUpdateMRActivity	To name an activity, start begin with the company initials and be preceded , followed by the Verbverb, target resource type, and the word "Activity. At last, to denote it as " to indicate it's a workflow activity. For example, in CIResetPasswordActivity, "CI is " represents the company initialinitials, and "Reset" is the Action Done against Password. You can also use a Verb-like update when the activity is performing multiple actionsaction performed, and "Password" is the target resource type. When the activity performs multiple actions, you can use a verb like "update" to reflect the various actions being carried out.

Form and Controls

This section will discuss the patterns to name the Form and its controls like data source and LookupThe table below presents the naming conventions for forms, as well as their associated controls, such as data sources and lookups.

Class Libraries & Connectors

This section will discuss the patterns to name the connector and the The table below presents the naming conventions for connectors and class libraries.

Component	Pattern	Example	Description
Class Library Project	{CompanyInitial}Connector	CIHRConnector	To name a class library, use a friendly descriptive name to describe represent the class library, preceded followed by the word connector at last"Connector" at the end. For CIHRConnector, CI stands for the company initials, and HR connector HRConnector indicates the connector used to connect to an HR system. A custom connector would also be developed inside a class.
CustomConnector	{ObjectName}Connector	CustomConnector	To name a Custom Connector, use a friendly descriptive name to describe represent the connector and add append the word connector at last"Connector" at the end. A connector would be a class inside within the class library. For example, in CustomConnector, "Custom would describe " describes the type of connector, with a word connector at lastthe word "Connector" following it. You can create a custom connector by adding a new implementation of the connector in Workflow Studio as shown in the below image. Image Added
Class Name			Follow any accepted naming convention consistently.

Folder Structure

Tracing

Developers can build a tracing system using the class provided by EmpowerID. The implementation of TdnfTrace class will log the In Workflow Studio, the workflow applications and other objects you develop are classified as solution items and placed in folders you create on your local development machine. These folders act as containers for holding and organizing the items you are developing and are represented as nodes in the Source Control tree. Whenever you create a new workflow, activity, user interface element, or other objects, Workflow Studio prompts you for the folder in which the object should be placed, placing it within a Source Control folder underneath the selected folder.

Source Control folders exist for each item type that can be created in Workflow Studio:

Tracing

Developers can construct a tracing system utilizing the TdnfTrace class provided by EmpowerID. Implementing the TdnfTrace class allows for logging information into the Windows event log. The TdnfTrace logger logs the information inside EventViewer → records information within the Event Viewer under the path: Application and Services Logs → EmpowerIDEmpowerID.

Developers can creatively formulate customize the logging information as per requirement and better understand the to suit their requirements and gain a better understanding of errors. A sample code snippet of for using the TdnfTrace class is provided below.:

if (ex.Message.Contains("Timeout"))
TdnfTrace.Current.TraceData(TraceEventType.Warning, 9900, "Rbac refreshing resource role review compiled operation took too long refreshing but will resume: " + Environment.NewLine + ex.ToString());
else
TdnfTrace.Current.TraceData(TraceEventType.Error, 10000, "Rbac refreshing resource role review compiled operation: " + Environment.NewLine + ex.ToString());