The Workflow Studio IDE is where you develop EmpowerID workflows. It comprises four user interface components that work together to provide developers with a visual design environment. Through friendly drag-and-drop operations, depictions of business processes can be translated quickly into workflow logic without the need for extensive code. This can be as simple as dragging predefined activities onto the design surface of the IDE and connecting those activities with flow lines. Code editors allow C# code to be injected into the process when desired to create a complete package.
The below image shows what the Workflow Studio IDE looks like with a Flow Chart workflow opened in the Workflow Designer.
...
As depicted by the above image, the Workflow Studio IDE is comprised of four components—the Ribbon, the Solution Explorer, the Document Space, and the Toolbox—each of which combine to create a rich, interactive environment for workflow development. Expand the sections below for details about that particular component.
...
| title | Workflow Studio Ribbon |
|---|
The Workflow Studio ribbon provides immediate access to a variety of tools and application-specific development tabbed toolbars. The toolbars are dynamic in that the number of tabs and commands available on the ribbon at any given time is determined by the number and types of designers and editors opened in the IDE.
Common Toolbar
The Common toolbar contains a number of command buttons that allow you to perform general tasks when working in the IDE.
...
Command Button
...
Purpose
...
Save
...
Saves a new or edited package item.
...
Save As
...
Opens a dialog that allows you to name an open package item and choose the package to which you wish to save it.
...
Deployment Services
...
Provides options for opening and creating new manifests, building solutions and packaging development items for deployment to the local file system.
...
Refresh Toolbox
...
Forces a refresh of the toolbox. If any recent changes have occurred you can elect to have those reflected in the update.
...
Object Browser
...
Displays the Workflow Studio class library.
Build Toolbar
The Build toolbar contains a number of commands relevant to publishing projects created in Workflow Studio.
...
Command Button
...
Purpose
...
Compile
...
Compiles the open workflow, activity, form or lookup.
...
Publish
...
Publishes workflows to the designated workflow server.
...
Deployment
...
Provides options for opening and creating new manifests, building solutions and packaging development items for deployment to the local file system.
Tools Toolbar
The Tools toolbar contains commands for performing a number of Workflow Studio maintenance tasks.
...
Command Button
...
Purpose
...
View Assemblies
...
Opens a list of all Workflow Studio assemblies by version number, allowing you to add or remove any from your copy of Workflow Studio.
...
Activity Templates
...
Opens a dialog that allows you to view and delete any activity templates from Workflow Studio.
...
Event Viewer
...
Opens an Event Viewer that allows you to view any workflow events that have occurred on a selected machine.
...
Isolate Workflow Versions
...
Allows you to select an existing workflow and save it as different version.
Workspace Toolbar
The Workspace toolbar contains commands relevant to the Workspace, which is a local copy of the Workflow Studio Source Control. The workspace can be individualized with selected packages and package items.
...
Command Button
...
Purpose
...
Build Log
...
Opens the Build log, if one exists.
...
Cancel Build
...
Cancels any batch build operations that exist in your workspace.
...
Program Files
...
Opens the Program Files folder on the local machine.
...
Program Data
...
Opens the ProgramData folder on the local machine.
...
Compile Temp
...
Opens the ProgramData > CompilerTemp folder on the local machine.
...
Dyna Local Temp Dll
...
Opens the ProgramData > DynaLocalTempDll folder on the local machine.
...
Intelli Cache
...
Opens the ProgramData > Cache folder on the local machine.
...
Workflow Templates
...
Opens the ProgramData > UserWorkflowTemplates folder on the local machine.
Options and Settings Toolbar
The Options and Settings toolbar contains commands that allow you to perform various actions.
...
Command Button
...
Purpose
...
Alert Receivers
...
Opens a window displaying a list of the current Alert Event Receivers configured in your environment.
...
STS Claims Extensions
...
Opens the STS Claims Extensions dialog with a list of extensions and related assemblies in your environment.
...
SSO Extensions
...
Opens the SSO Extension editor displaying a list of extensions and related assemblies.
...
C# Code Editor Font
...
Opens the Editor Style dialog, which allows you to style how text appears in the C# Code Editor.
Workflow Editing Toolbar
The Workflow Editing toolbar contains commands related to designing workflows and activities. This toolbar only appears when a workflow is open in the Workflow Designer or an activity is open in the Activity Designer.
...
Command Button
...
Purpose
...
Add New Property
...
Opens the Add New Property dialog, which allows you to add a new property to the workflow or activity. Once added, the new property can be used for data binding.
...
Delete Property
...
Allows you to delete a selected property. You must select a property to delete it.
...
Promote
...
Promotes the selected property.
...
Bind Property
...
Opens the Data Binding Shortcut dialog, which allows you to create a new workflow or activity property bound to another property in the same workflow or activity.
...
Bind Wokflow
...
Opens the Shortcut Workflow Association wizard, which allows you to call an external workflow to return a property from that external workflow to the current workflow or workflow activity.
...
Copy
...
Copies an item selected in the designer.
...
Cut
...
Cuts an item selected in the designer.
...
Paste
...
Pastes a previously copied item into the designer.
...
Delete
...
Deletes a selected item from the designer.
...
Zoom In
...
Allows you to magnify the designer.
...
Zoom Out
...
Allows you to decrease the magnification level of the designer.
...
Pointer
...
Releases the mouse from the Zoom In and/ Zoom Out control.
...
Print Setup
...
Opens the Page Setup dialog, which allows you to configure print options.
...
Print Preview
...
Displays a preview of what the workflow or activity will look like when printed.
...
...
Prints the workflow or activity to the printer selected in the Page Setup dialog.
...
Add Reference
...
Opens the GAC Assembly Reference dialog, which allows you to add an assembly reference to the project.
Form Designer Toolbar
The Form Designer toolbar contains commands related to designing forms. This toolbar only appears when a form is open in the Form Designer.
...
Command Button
...
Purpose
...
New Tab
...
Adds a new tab to the form that is actively being edited in the Form Designer.
...
New Section
...
Adds a new section to the form that is actively being edited in the Form Designer.
...
Mask
...
Opens the Add New Mask dialog, which allows you to add a new Mask to the Components tree of the form that is actively being edited in the Form Designer.
...
Validation
...
Opens the Add New Validation dialog, which allows you to add a new Validator to the Components tree of the form that is actively being edited in the Form Designer. Validators force users to enter data in the format specified by the Validation Expression of the Validator.
...
Data Source
...
Opens the Add New Data Source dialog, which allows you to add a new Data Source object to the Components tree of the form that is actively being edited in the Form Designer. Data Source objects allow you to bind form controls to objects in the EmpowerID Identity Warehouse.
...
Add Object
...
Opens the Add Object dialog, which allows you to add Primitives (Strings, Booleans, DateTime, etc) and Rbac Components (Account, AccountStore, Person, etc) to the Components tree of the form that is actively being edited in the Form Designer. Once added to the Components tree, these objects can be dropped onto a form as properties for use in data binding.
Lookup Designer Toolbar
The Lookup Designer toolbar contains commands related to Lookup Control design. This toolbar only appears when the Lookup Designer is open.
...
Command Button
...
Purpose
...
New Column
...
Adds an empty column to the currently open lookup
...
Set Grid Type
...
Allows you to set the grid type for the currently open lookup. Grid types can be set to custom, default or that of a current EmpowerID component. The selected grid type determines the initial columns of the lookup. For example, if you set the grid type for a lookup to the Account component, Workflow Studio adds the columns that appear in the default Account Lookup to the lookup in the designer.
...
| title | Solution Explorer |
|---|
The Solution Explorer is comprised of several tabbed views that provide access to the Workflow components in your development environment.
Server Explorer Tab - Provides a view of the EmpowerID servers and EmpowerID services in your environment.
Solution Explorer Tab - Provides a view of the workflow objects in your development environment.
Windows Form Toolbox Tab - Provides access to common Windows Form objects that can be used when developing Windows Forms in Workflow Studio.
Each of these is discussed in further detail below.
Servers Tab
Select the Servers tab to display a tree view of EmpowerID servers and their status in your environment. Expand a server node to display the EmpowerID services installed on that server. Right-click a node to open a context menu that allows you to select various options for that node.
...
Menu Item
...
Function
...
Refresh
...
Refreshes the list of services running on the server.
...
Create EmpowerID Azure Web Jobs
...
Opens the Azure Web Job Packages dialog where you can view web job dependencies and their statuses, create new Azure WebJob Scheduler and WebJob Engine packages, and deploy Azure.
...
Deploy Existing EmpowerID Azure WebJobs
...
If you elected not to deploy Azure when creating the Azure WebJobs, use this option to deploy them.
...
Deploy EmpowerID Azure WebJobs...
...
Opens a dialog where you can select a Publisher Settings file from your Workflow Exports folder.
...
Enable WCF Service
...
Enables an WCF service on the WCF Service Bus Agent. This menu item is only enabled when right-clicking on a Web service hosted by the EmpowerID Service Bus Agent.
...
Force Enable WCF Service
...
Enables an WCF service on the WCF Service Bus Agent. This menu item is only enabled when right-clicking on a Web service hosted by the EmpowerID Service Bus Agent.
...
Disable WCF Service
...
Disables an active WCF service on the WCF Service Bus Agent. This menu item is only enabled when right-clicking on a Web service hosted by the EmpowerID Service Bus Agent.
...
Generate <System.ServiceModel> Configuration
...
Generates the XML configuration data for a given service on the EmpowerID Service Bus Agent. This menu item is only enabled when right-clicking on a Web service hosted by the EmpowerID Service Bus Agent.
Solution Explorer Tab
The Solution Explorer tab provides access to the workflow applications and other objects that exist in the EmpowerID Identity Warehouse. It is comprised of three sub-tabs for managing these applications: the Workspace tab, which gives you access to all the objects you develop in Workflow Studio; the Search tab, which allows you to search for objects by name and type; and the SharePoint tab, which allows you to work with your SharePoint objects. Of the three, the Workspace Tab provides the greatest functionality for working with and managing the objects developed in Workflow Studio.
Using the Workspace Tab
In Workflow Studio, the workflow applications and other objects that you develop are classified as or solution items and placed in folders you create on your local development machine. These folders are simply containers for holding the items you are developing and are represented as nodes in the Source Control tree visible from the Workspace tab of the Solution Explorer. Each time you create a new workflow, activity, user interface element, or other object, Workflow Studio prompts you for the folder in which the object should be placed and then places that within a Source Control folder underneath the selected folder. While Workflow Studio gives you some freedom in placing folders and folder items, Source Control folders are predetermined by their content and cannot be moved or deleted. If a Source Control folder does not exist for a particular package item being created, Workflow Studio will create that Source Control folder at the time the item is created and then place the item in the folder.
Workflow Studio allows you to determine which folders and folder items you want to appear in your Workspace. You can opt to have all folders and folder items that exist in the Identity Warehouse appear in your Workspace or pick and choose only those items with which you are working. When you start Workflow Studio for the first time, your Workspace will contain no workflow items and you will be prompted by the Workspace dialog to add items.
If you click No, the dialog closes, allowing you to proceed. If you click Yes, the Source Control dialog opens. The Source Control dialog contains two panes, the Team Source Control pane on the left and the Workspace Source Control pane on the right. The Team Source Control pane displays the Source Control tree populated with every folder and folder item that exists in the EmpowerID Identity Warehouse. The Workspace Source Control pane displays every folder and folder item that exists in your personal Workspace.
To add folders and folder items to your Workspace, you simply locate the folders and/or folder items in the Source Control tree of the Team Source Control pane and then click the button with the right arrow to move them to the Workspace Source Control pane.
Source Control folders exist for each item type that can be created in Workflow Studio and encompass the following:
...
Source Control Folder
...
Folder Purpose
...
Adaptive Auth Rules
...
Provides a location for organizing Adaptive Auth Rules you create in Workflow Studio
...
Alert Receivers
...
Provides a location for organizing Alert Receivers you create in Workflow Studio
...
APIs
...
Provides a location for organizing APIs you create in Workflow Studio
...
Azure Functions V1
...
Provides a location for organizing Azure Functions V1 apps
...
Azure Functions V2
...
Provides a location for organizing Azure Functions V2 apps
...
Azure Functions V3
...
Provides a location for organizing Azure Functions V3 apps
...
Business Rules
...
Provides a location for organizing Business Rule apps
...
Class Libraries
...
Provides a location for organizing Class Library apps
...
Console Applications
...
Provides a location for organizing Console Apps
...
Microservice V1
...
Provides a location for organizing Microservice V1 apps you create in Workflow Studio
...
Microservice V2
...
Provides a location for organizing Microservice V2 apps you create in Workflow Studio
...
Microservice V3
...
Provides a location for organizing Microservice V3 apps you create in Workflow Studio
...
OAuth Extensions
...
Provides a location for organizing OAuth Extensions you create in Workflow Studio
...
SAML Extensions
...
Provides a location for organizing SAML Extensions you create in Workflow Studio
...
SCIM Microservices V2
...
Provides a location for organizing SCIM Microservices V2 apps you create in Workflow Studio
...
STS Extensions
...
Provides a location for organizing STS Extensions you create in Workflow Studio
...
UMA Extensions
...
Provides a location for organizing UMA Extensions you create in Workflow Studio
...
User Interface > Forms
...
Provides a location for organizing Forms you create in Workflow Studio
...
User Interface > Lookup Controls
...
Provides a location for organizing Lookup Controls you create in Workflow Studio
...
User Interface > UI Pages
...
Provides a location for organizing UI Pages you create in Workflow Studio
...
Workflows > Activities
...
Provides a location for organizing Workflow Activities you create in Workflow Studio
...
Workflows > Applications
...
Provides a location for organizing Workflow Applications you create in Workflow Studio
...
Workflows > Composites
...
Provides a location for organizing Composite Workflows you create in Workflow Studio
...
Workflow Rules
...
Provides a location for organizing Workflow Rules you create in Workflow Studio
These Source Control folders ensure consistent project structure and placement of objects within the Source Control tree for every Workspace. If you or another team member create a new form, it will always be placed in the User Interface/Forms Source Control folder and never the Workflow Applications folder, which is reserved for workflow applications only.
Additionally, the Workspace tab in Solution Explorer gives you ready access to the commands associated with folder and folder items. These commands are accessible from a context menu that appears when right-clicking an object in the Workspace Source Control tree. The number of commands available from the context menu depend on the particular object that has been right-clicked. Commands relevant to that object are enabled, while commands not relevant are grayed out and not selectable.
The following image shows the commands menu that appears when right-clicking on one of the nodes in the Workspace Source Control tree. The commands available depend on the particular node selected.
...
...
Command
...
Purpose of Command
...
New Folder
...
Creates a new top-level folder with a specified child folder on the file system of the local machine, such as MyDevFolder > Workflow Rules
...
Add Item Folders
...
Creates a new folder of a selected item for organizing development work. For example, if you select APIs, Workflow Studio creates a new APIs folder
...
Open in File Explorer
...
Opens the specified folder in File Explorer
...
New Workflow
...
Opens a new workflow in the designer
...
New Workflow Activity
...
Opens a new workflow activity in the designer
...
New Operation Activity
...
Opens a new operation activity in the designer
...
New User Interface
...
Opens a new form, lookup or UI page in the designer
...
New Extension or Library
...
Opens a new instance of the selected object in the designer
...
New Console Application
...
Opens a new console app
...
New Adaptive Authentication
...
Opens a new adaptive authentication workflow or adaptive auth rules class library in the designer
...
Remember my Login
...
Retains your login so that when you exit and restart Workflow Studio you do not need to reauthenticate
...
Set Local Repository Path
...
Sets the path bound to the repo for your organization
...
Delete Folder [Current Folder Name]
...
Deletes the currently selected folder from your file system
...
Refresh
...
Refreshes the source control tree
Windows Form Tab
The Windows Form Toolbox contains common Windows Forms controls that can be dragged onto a Windows Form that you are designing in Workflow Studio. Once a control has been added to a Windows Form, you can manipulate the properties and write event-handling code as you would with Visual Studio.
...
...
| title | Document Space |
|---|
The Document Space is reserved for Workflow Studio designers and editors. Most of the work you do in Workflow Studio is accomplished through one or more designers and editors, which are commonly referred to as development tools. In Workflow Studio, designers provide for rapid visual application development, enabling you to organize and present application content at design time. Editors provide intellisense-enabled C# and XML language support for editing code and appear in the Document Space as a tab when that feature is relevant to the object you open in the Document Space. For example, the C# Editor appears for workflows, activities, lookup controls, and forms are open in the Document Space, but does not appear for reports, menus, and pages. In those cases, the editor that appears is the XML Markup Editor.
As a workflow developer, the designers most relevant to you include the following:
...
The Workflow Studio IDE is where you develop EmpowerID workflows. It comprises four user interface components that work together to provide developers with a visual design environment. Through friendly drag-and-drop operations, depictions of business processes can be translated quickly into workflow logic without the need for extensive code. This can be as simple as dragging predefined activities onto the design surface of the IDE and connecting those activities with flow lines. Code editors allow C# code to be injected into the process when desired to create a complete package.
The below image shows what the Workflow Studio IDE looks like with a Flow Chart workflow opened in the Workflow Designer (also known as the Document Space.
As depicted by the above image, the Workflow Studio IDE is comprised of four components – the Toolbar, the Solution Explorer, the Document Space, and the Toolbox – each of which combines to create a rich, interactive environment for workflow development.
Workflow Studio Toolbar
The Workflow Studio toolbar provides immediate access to a variety of tools and application-specific development commands. The commands are dynamic in that the number of commands at any given time is determined by the number and types of designers and editors opened in the Workflow Studio IDE.
Toolbar Commands
Command | Purpose |
|---|---|
Exit Application | Closes Workflow Studio. |
Common > Save | Saves the currently open item. |
Common > Save As | Opens a dialog that allows you to name an open folder item and choose the folder to which you wish to save it. |
Common > Deployment Services | Provides options for opening and creating new manifests, building solutions and packaging development items for deployment to the local file system. |
Common > Refresh Toolbox | Forces a refresh of the toolbox. If any recent changes have occurred you can elect to have those reflected in the update. |
Common > Object Browser | Displays the Workflow Studio class library. |
Build > Compile | Compiles the open workflow, activity, form or lookup. |
Build > Publish | Publishes workflows to the designated workflow server. |
Build > Deployment | Provides options for opening and creating new manifests, building solutions and packaging development items for deployment to the local file system. |
Tools > View Assemblies | Opens a list of all Workflow Studio assemblies by version number, allowing you to add or remove any from your copy of Workflow Studio. |
Tools > Activity Templates | Opens a dialog that allows you to view and delete any activity templates from Workflow Studio. |
Tools >Event Viewer | Opens an Event Viewer that allows you to view any workflow events that have occurred on a selected machine. |
Tools > Isolate Workflow Versions | Allows you to select an existing workflow and save it as different version. |
Workspace > Build Log | Opens the Build log, if one exists. |
Workspace > Cancel Build | Cancels any batch build operations that exist in your workspace. |
Workspace > Program Files | Opens the Program Files folder on the local machine. |
Workspace > Program Data | Opens the ProgramData folder on the local machine. |
Workspace > Compile Temp | Opens the ProgramData > CompilerTemp folder on the local machine. |
Workspace > Dyna Local Temp Dll | Opens the ProgramData > DynaLocalTempDll folder on the local machine. |
Workspace > Intelli Cache | Opens the ProgramData > Cache folder on the local machine. |
Workspace > Workflow Templates | Opens the ProgramData > UserWorkflowTemplates folder on the local machine. |
Options and Settings > Alert Receivers | Opens a window displaying a list of the current Alert Event Receivers configured in your environment. |
Options and Settings > STS Claims Extensions | Opens the STS Claims Extensions dialog with a list of extensions and related assemblies in your environment. |
Options and Settings > SSO Extensions | Opens the SSO Extension editor displaying a list of extensions and related assemblies. |
Options and Settings > C# Code Editor Font | Opens the Editor Style dialog, which allows you to style how text appears in the C# Code Editor. |
Workflow Studio Workflow Editing Commands – The following commands only appear when a workflow is open in the Workflow Designer or an activity is open in the Activity Designer. | |
Add New Property | Opens the Add New Property dialog, which allows you to add a new property to the workflow or activity. Once added, the new property can be used for data binding. |
Delete Property | Allows you to delete a selected property. You must select a property to delete it. |
Promote | Promotes the selected property. |
Bind Property | Opens the Data Binding Shortcut dialog, which allows you to create a new workflow or activity property bound to another property in the same workflow or activity. |
Bind Wokflow | Opens the Shortcut Workflow Association wizard, which allows you to call an external workflow to return a property from that external workflow to the current workflow or workflow activity. |
Copy | Copies an item selected in the designer. |
Cut | Cuts an item selected in the designer. |
Paste | Pastes a previously copied item into the designer. |
Delete | Deletes a selected item from the designer. |
Zoom In | Allows you to magnify the designer. |
Zoom Out | Allows you to decrease the magnification level of the designer. |
Pointer | Releases the mouse from the Zoom In and/ Zoom Out control. |
Print Setup | Opens the Page Setup dialog, which allows you to configure print options. |
Print Preview | Displays a preview of what the workflow or activity will look like when printed. |
Prints the workflow or activity to the printer selected in the Page Setup dialog. | |
Add Reference | Opens the GAC Assembly Reference dialog, which allows you to add an assembly reference to the project. |
Workflow Studio Form Designer Commands – The following commands only appear when a form is open in the IDE. | |
New Tab | Adds a new tab to the form that is actively being edited. |
New Section | Adds a new section to the form that is actively being edited. |
Mask | Opens the Add New Mask dialog, which allows you to add a new Mask to the Components tree of the form that is actively being edited. |
Validation | Opens the Add New Validation dialog, which allows you to add a new Validator to the Components tree of the form that is actively being edited. Validators force users to enter data in the format specified by the Validation Expression of the Validator. |
Data Source | Opens the Add New Data Source dialog, which allows you to add a new Data Source object to the Components tree of the form that is actively being edited. Data Source objects allow you to bind form controls to objects in the EmpowerID Identity Warehouse. |
Add Object | Opens the Add Object dialog, which allows you to add Primitives (Strings, Booleans, DateTime, etc) and Rbac Components (Account, AccountStore, Person, etc) to the Components tree of the form that is actively being edited. Once added to the Components tree, these objects can be dropped onto a form as properties for use in data binding. |
Workflow Studio Lookup Designer Commands – The following commands only appear when a lookup is open in the IDE. | |
New Column | Adds an empty column to the currently open lookup |
Set Grid Type | Allows you to set the grid type for the currently open lookup. Grid types can be set to custom, default or that of a current EmpowerID component. The selected grid type determines the initial columns of the lookup. For example, if you set the grid type for a lookup to the Account component, Workflow Studio adds the columns that appear in the default Account Lookup to the lookup in the designer. |
Solution Explorer
The Solution Explorer tab in Workflow Studio is an essential tool for organizing, accessing, and managing your workflow applications and other objects within the development environment. The three sub-tabs within the Solution Explorer provide different functionality to help you efficiently work with your projects:
Workspace tab: The Workspace tab displays all the objects you develop in Workflow Studio, organized into folders on your local development machine. These folders act as containers for holding and organizing your workflow applications, activities, user interface elements, and other objects. You can create new folders, add objects to existing folders, and manage the contents of your workspace through this tab. As you develop new objects, Workflow Studio prompts you to select the folder where the object should be placed, ensuring that your workspace remains organized and easy to navigate.
Search tab: The Search tab allows you to search for objects by name and type, making it easy to quickly locate specific items within your workspace. This functionality is especially useful when working with large projects or searching for objects across multiple folders.
SharePoint tab: The SharePoint tab enables you to work with your SharePoint objects, integrating them into your EmpowerID workflows as needed. This functionality allows for seamless collaboration and integration between your EmpowerID projects and SharePoint resources.
Overall, the Solution Explorer tab in Workflow Studio provides a comprehensive and user-friendly interface for managing your workflow applications and objects. By organizing your projects in folders and providing easy access to search and integration features, the Solution Explorer helps you maintain an efficient and streamlined development process.
Source Control folders exist for each item type that can be created in Workflow Studio and encompass the following:
Source Control Folder | Folder Purpose |
|---|---|
Adaptive Auth Rules | Provides a location for organizing Adaptive Auth Rules you create in Workflow Studio |
Alert Receivers | Provides a location for organizing Alert Receivers you create in Workflow Studio |
APIs | Provides a location for organizing APIs you create in Workflow Studio |
Azure Functions V1 | Provides a location for organizing Azure Functions V1 apps |
Azure Functions V2 | Provides a location for organizing Azure Functions V2 apps |
Azure Functions V3 | Provides a location for organizing Azure Functions V3 apps |
Business Rules | Provides a location for organizing Business Rule apps |
Class Libraries | Provides a location for organizing Class Library apps |
Console Applications | Provides a location for organizing Console Apps |
Microservice V1 | Provides a location for organizing Microservice V1 apps you create in Workflow Studio |
Microservice V2 | Provides a location for organizing Microservice V2 apps you create in Workflow Studio |
Microservice V3 | Provides a location for organizing Microservice V3 apps you create in Workflow Studio |
OAuth Extensions | Provides a location for organizing OAuth Extensions you create in Workflow Studio |
SAML Extensions | Provides a location for organizing SAML Extensions you create in Workflow Studio |
SCIM Microservices V2 | Provides a location for organizing SCIM Microservices V2 apps you create in Workflow Studio |
STS Extensions | Provides a location for organizing STS Extensions you create in Workflow Studio |
UMA Extensions | Provides a location for organizing UMA Extensions you create in Workflow Studio |
User Interface > Forms | Provides a location for organizing Forms you create in Workflow Studio |
User Interface > Lookup Controls | Provides a location for organizing Lookup Controls you create in Workflow Studio |
User Interface > UI Pages | Provides a location for organizing UI Pages you create in Workflow Studio |
Workflows > Activities | Provides a location for organizing Workflow Activities you create in Workflow Studio |
Workflows > Applications | Provides a location for organizing Workflow Applications you create in Workflow Studio |
Workflows > Composites | Provides a location for organizing Composite Workflows you create in Workflow Studio |
Workflow Rules | Provides a location for organizing Workflow Rules you create in Workflow Studio |
Additionally, the Workspace tab of Solution Explorer gives you ready access to the commands associated with folder and folder items. These commands are accessible from a context menu that appears when right-clicking an object in the Workspace Source Control tree.
Command | Purpose of Command |
|---|---|
New Folder | Creates a new top-level folder with a specified child folder on the file system of the local machine, such as MyDevFolder > Workflow Rules |
Add Item Folders | Creates a new folder of a selected item for organizing development work. For example, if you select APIs, Workflow Studio creates a new APIs folder |
Open in File Explorer | Opens the specified folder in File Explorer |
New Workflow | Opens a new workflow in the designer |
New Workflow Activity | Opens a new workflow activity in the designer |
New Operation Activity | Opens a new operation activity in the designer |
New User Interface | Opens a new form, lookup or UI page in the designer |
New Extension or Library | Opens a new instance of the selected object in the designer |
New Console Application | Opens a new console app |
New Adaptive Authentication | Opens a new adaptive authentication workflow or adaptive auth rules class library in the designer |
Remember my Login | Retains your login so that when you exit and restart Workflow Studio you do not need to reauthenticate |
Set Local Repository Path | Sets the path bound to the repo for your organization |
Delete Folder [Current Folder Name] | Deletes the currently selected folder from your file system |
Refresh | Refreshes the source control tree |
Document Space
The Document Space in Workflow Studio is where you work with various designers and editors to develop and edit workflow applications, activities, forms, and lookup controls. The designers and editors offer visual design capabilities, making it easy to create and modify your workflow components without extensive coding. Some of the key designers and editors in Workflow Studio include:
Workflow Designer – The Workflow Designer allows you to visually design workflow applications and
...
...
...
...
...
When you open a workflow
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Source Code — This tab allows you to view source code of the workflow application.
...
...
Activity Designer — In Workflow Studio, an activity represents the logic for a step within the workflow. The Activity Designer opens whenever a new activity is created or an existing activity is being edited. The Activity Designer allows you to visually design workflow activities and gives you access to all the commands and editors necessary to build a complete workflow activity that can then be associated with a workflow. Opening an activity gives you access to virtually the same tabs available to you when designing a workflow in the Workflow Designer.
...
...
...
...
a workflow. It offers virtually the same tabs as the Workflow Designer.
Form Designer: The Form Designer
...
...
...
...
...
...
, allowing you to use the form within a workflow.
Lookup Designer: The Lookup Designer is used to create and edit Lookup controls, which are searchable grids for looking up and selecting objects
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
The following image shows the Activity Toolbox with the User Interface category selected from the Category drop-down list. This narrows the activities that are displayed in the toolbox to those with their ToolboxPath property set to User Interface.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Right-clicking on a node in the Code Tree allows you to access commands relevant to the files represented by that node, as well as the type of object open in the Document Space. The following table
...
...
...
...
...
...
...
...
...
...
...
...
This command allows you to add your own methods to a project.
...
Add New Custom Method (Duplicate Signature)
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Deletes a selected item from the project.
The Code Snippets Tab — The Code Snippets tab displays any Code Snippets that you have added to a project or other team members have published. The Code Snippets tab behaves as a toolbox. Thus, as with the activities in the Activities Toolbox, you can drag a code snippet from the Toolbox and drop it into an open project to incorporate it. However, code snippets must be dropped onto an open Code Editor. They cannot be dropped onto the design surface of an object.
The Properties Tab
The Properties Tab provides immediate access to the browsable properties of the currently selected object or document in the Document Workspace. Changes made to property values shown in the property grid are committed immediately to the object.
The following image shows property grid displaying browsable properties for the SelectGroups activity.
...
Deletes a selected item from the project. |
The Properties Tab
The Properties Tab in Workflow Studio displays the browsable properties of the currently selected object or document in the Document Workspace. This tab provides a convenient way to view and edit the properties of the selected item directly without having to navigate to another interface. The property grid typically displays properties in a two-column layout, with the property names on the left and their corresponding values on the right.
For example, if you select the "SelectTargetGroups" activity within a workflow, the Properties Tab will show all the relevant properties for that activity, such as its name, description, execution order, input and output properties, and any other configurable settings. You can modify these properties directly in the property grid, and the changes will be applied to the object immediately.
The following image shows the property grid displaying browsable properties for the SelectTargetGroups activity.
The visibility of a property in the property grid can be controlled using the Browsable attribute. When you create dependency properties for activities, you have the option to choose whether to display the property in the property grid by selecting or deselecting the "Show in property grid" checkbox. This allows you to determine which properties are easily accessible and editable within the grid.
It's important to note that public properties without the Browsable attribute are displayed in the property grid by default. If you want to hide a public property from the property grid, you can explicitly set the Browsable attribute to false. This can be useful when you want to limit the visibility of certain properties to maintain a clean and organized property grid, or when you want to prevent users from accidentally modifying properties that should remain constant throughout the workflow design process.
| Tip |
|---|
For more information on the relationship between properties and activities, see Common Workflow Activities. |
...