ultimus_docs
stringlengths
52
24.9k
Save The Save menu option (CTRL-S shortcut) saves the content of the active editor. Since it is the Preview mode and none of the editors are displayed, this option is not available.
Save All The Save All menu option (CTRL-SHIFT-S shortcut) saves the entire business process. Since it is the Preview mode and none of the editors are displayed, this option is not available.
Exit The Exit menu option closes Ultimus BPM Studio.
Object Items under the Object menu may be accessed with the keyboard shortcut ALT-E. The options available under the Object menu become active depending upon the currently selected node in the Repository window. The following functions are accessible under the Edit menu when working in the Preview mode: • Repository • Edit • Edit (Model) • Simulate • Security • New • Add Existing • Delete • Rename • Create Copy • Create Folder • Generate Documentation • Notes... • Publish • Save Offline • Save to Disk... • Import from XML... • Export as XML... • Properties Each of these functions is described below.
Repository The Repository menu option is used to check in/check out a selected object from the Repository window, view the history of the selected object or undo any changes made during the last check out.
Edit The Edit menu option is used to open the selected object in the Build editor mode.
Edit (Model) The Edit (Model) menu option is used to open the selected object in the Modeling editor mode.
Simulate The Simulate menu option is used to simulate a selected process from the Repository window. Simulation is a powerful tool which is helpful in thoroughly testing the business process before publishing it to Ultimus BPM Server.
Security The Security menu option allows the process designer or Ultimus system administrator to control who can edit, delete, lock, and publish objects; only such an individual can define object security on all object types in Ultimus BPM Studio. Tip: User access rights for process repositories is controlled through Ultimus BPM Studio Configuration. For more information, refer to Configuring Studio Configuration Access Rights section in Ultimus BPM Studio Configuration Help.
New The New menu option allows creating a new object in the currently selected repository. This is a context sensitive menu option and depends upon which folder is selected from the Repository window. For example, if Processes folder is selected, a new process node is created under the Processes folder. However, if a Form Objects node is selected, then an form object subnode is created in the Repository window.
Add Existing The Add Existing menu option adds pre-defined objects to the currently selected repository.
Delete The Delete menu option deletes the currently selected object from the Repository window, provided the deletion conditions are met.
Rename The Rename menu option allows to rename the selected object from the Repository window.
Create Copy The Create Copy menu option creates a copy of the currently selected object. When a copy is created, it is given a name automatically in the following format: Copy [number] of [object name], where • [number] is the ‘serial’ number of the copy (you can create more than one copies) • [objectname] is the name of the selected object in the Repository window.
Create Folder The Create Folder menu option creates a new folder under the currently selected folder in the Repository window.
Generate Documentation The Generate Documentation menu option opens the Generate Documentation dialog box. The Generate Documentation dialog box is used to design documentation templates relating to design, functionality, and specifications for the business process. This information may then be used to develop the business process in Build mode. For more information about generating documentation, refer to Generating documentation section.
Notes... The Notes... menu option opens a comprehensive text editor, where detailed notes for the currently selected object from the Repository window can be entered. The Notes dialog box
Publish The Publish menu option allows publishing the currently selected object from the Repository window, to the Ultimus BPM Server.
Save Offline The Save Offline menu option allows saving the currently selected object from the Repository window as an offline object. This allows process participants to work on objects on their local computers, without having to connect to the process repository. The Save Offline menu option is active and available only in Ultimus BPM Studio Client only mode. This is because an offline repository can be only be accessed in that mode. Note: In order to save an object as an offline object, it must first be checked out.
Save to Disk... The Save to Disk... menu option allows saving the currently selected object from the Repository window to a local computer’s hard disk.
Import from XML... The Import from XML option is used to import an XML file into Ultimus BPM Studio from third-party or custom applications which include an XML data model. Once imported, this content can be saved as a new .WFL file for further development. This is useful to import content from BPA or other BPM tools for development in Ultimus BPM Studio. Ultimus provides the XML definition which must be followed for Ultimus BPM Studio to properly import XML as a business process. To download this XML definition, go to https://internal.ultimus.com/ultdownloads/downloads.aspx?file=Ultimus2021/Samples/ProcessSchema.xsd.   To import an external XML file as a business process, follow these steps: 1. From Preview mode, select the Processes node in the Repository window. 2. Select Object»Import from XML.... 3. Browse for the XML file to import as a business process. 4. Select the Open button. A new business process is created under the Processes node, and the Event Log window displays that the business process has been successfully added to the repository. The default name given to this new business process may be renamed. The following attributes of a business process are imported into Ultimus BPM Studio (where applicable): • Process properties: The following process properties are imported: a. Business process name b. Business process description c. Process-level Help URL (if specified) • Process-level business rules: The following process-level business rule attributes are imported: a. Process-level business rules b. Defined aliases • Process XML schema: The following process XML schema attributes are imported: a. The process XML schema b. Defined aliases • Step properties: The following step properties and attributes are imported: a. Name b. Recipient type c. Step recipient d. Default form (which form type is used in the step) e. Completion time f. Coordinates in the process map • Step-level business rules: The following attributes regarding step-level business rules are imported: a. Activate event step-level business rules b. Completed event step-level business rules c. Returned event step-level business rules d. Late event step-level business rules e. Recipient step-level business rules f. Resubmit even step-level business rules
Export as XML... The Export as XML... function is used to export a business process to an XML file. The business process may be checked in or checked out in Preview mode for this option to be available. Customers who utilize third-party BPM tools can export the Ultimus business process into an external XML file so that a third-party BPA tool can subsequently import the resulting XML file back in for further modeling analysis. The ability to freely import and export business processes into and out of Ultimus BPM Studio to utilize those processes in other applications enables customers to employ a continuous process improvement methodology across disparate BPA and BPM applications. The following attributes of a business process are exported into the XML file (where applicable): • Process properties: The following process properties are exported: a. Business process name b. Business process description c. Process-level Help URL (if specified) • Process-level business rules: The following process-level business rule attributes are exported: a. Process-level business rules b. Defined aliases • Process XML schema: The following process XML schema attributes are exported: a. The process XML schema b. Defined aliases • Step properties: The following step properties and attributes are exported: a. Name b. Recipient type c. Step recipient d. Default form (which form type is used in the step) e. Completion time f. Coordinates in the process map • Step-level business rules: The following attributes regarding step-level business rules are exported: a. Activate event step-level business rules b. Completed event step-level business rules c. Returned event step-level business rules d. Late event step-level business rules e. Recipient step-level business rules f. Resubmit even step-level business rules Ultimus provides a sample of XML output from Ultimus BPM Studio. To download this sample XML, go to https://internal.ultimus.com/ultdownloads/downloads.aspx?file=Ultimus2021/Samples/ProcessSchema.xsd. To export a business process to an external XML file, follow these steps: 1. Select a business process in which to export as an external XML file. 2. Select Object»Export as XML.... The Open dialog box displays. Saving an Ultimus business process as an external XML file 3. Specify a directory in which to save the external XML file. 4. In the File name: combo box, enter a name for the external XML file. 5. Click the Open button. The business process is exported.
Properties The Properties menu option displays the Properties window for the currently selected object from the Repository window.
View Items under the View menu may be accessed with the keyboard shortcut ALT-V. The following unique functions are accessible under the View menu when working in the Preview mode: • Toolbars • Windows Each of these functions is described below.
Toolbars The Toolbars menu option contains one submenu options: Standard. This option is used to display or hide specific toolbars in the Ultimus BPM Studio interface. The Standard submenu option is a toggling menu option that makes the Standard toolbar appear and disappear on the Ultimus BPM Studio interface. The Standard toolbar offers convenient access to common functions. When the icon beside the Standard submenu option is highlighted, the Standard toolbar is visible. For more information about the Standard toolbar, refer to The Standard toolbar section.
Windows The Windows menu option contains five submenu options: • Properties • Event Log • Connectors • Repository • Publish Log These options are used to display or hide specific windows in the Ultimus BPM Studio user interface. Each of these submenu options is discussed below.
Properties The Properties submenu option displays the Properties window. The Properties window displays properties for any selected object in the business process or editor workspace. When the icon beside the Properties submenu option is highlighted, the Properties window is visible.
Event Log The Event Log submenu option displays the Event Log window. The Event Log window displays event logs, information, caution, and warnings from Ultimus BPM Server as it performs functions. When the icon beside the Event Log submenu option is highlighted, the Event Log window is visible. For more information about the Event Log window, refer to The Event Log window section.
Connectors The Connectors submenu option displays the Connectors window. The Connectors window displays information regarding configured connections to databases, Web services, and mail servers in the Ultimus BPM environment. When the icon beside the Connectors submenu option is highlighted, the Connectors window is visible. For more information about the Connectors window, refer to The Connectors window section.
Repository The Repository submenu option displays the Repository window. The Repository window displays repositories, business processes, and process objects. It is used to organize business processes and objects within repositories.When the icon beside the Repository submenu option is highlighted, the Repository window is visible. For more information about the Repository window, refer to The Repository window section.
Publish Log The Publish Log submenu option displays the Publishing Process window. The Publishing Process window displays the log information generated while publishing the selected object from the Repository window.
Tools Items under the Tools menu may be accessed with the keyboard shortcut ALT-T. The following unique functions are accessible under the Tools menu when working in the Preview mode: • Change Repository... • Import Offline Object... • Add External Editor... Each of these functions is discussed below.
Change Repository... The Change Repository... menu option is used to change the current working repository. When selected, the Change Repository dialog box appears. The Change Repository dialog box From the Repository: list box, select a repository and click the OK button. For information on how to reference a repository, refer Configuring process repositories section in Ultimus BPM Studio Configuration Help.
Import Offline Object... The Import Offline Object... menu option is used to import an offline object to the currently selected repository. When this menu option is selected, the Import Offline Object dialog box appears. The Import Offline Object dialog box To import an offline object, follow these steps: 1. From the Select object(s) to import: list, select the offline object(s) to be imported to the current repository. An offline object can be created while working in an offline repository in Ultimus BPM Studio Client only. 2. Click the Import button. The selected object(s) is thus imported.
Add External Editor... The Add External Editor... menu option allows adding an external editor as a plug-in under the currently opened repository. External code and content can easily be edited using external editors in Ultimus BPM Studio. When this menu option is selected, the Add External Editor dialog box appears. The Add External Editor dialog box To add an external editor, follow these steps: 1. In the Name: text box, enter the name for the external editor. This name appears in the Repository window. 2. In the Extension: text box, specify the file type that is to be edited. Examples include DOCX, PDF, TXT, etc. Inclusion of a wildcard operator as part of the extension type value is not necessary. 3. Select the Use External Editor check box to use the external editor by default. If this check box is selected, the Host Application: browse button becomes available. 4. Click the browse button beside the Host Application: edit box, then select the executable for the external editor. 5. Click the OK button to save changes. Otherwise, click the Cancel button.
The Standard toolbar For information on options available in the Standard toolbar when working in the Preview mode, refer to The Standard toolbar section.
This section introduces the menu bar and the Standard toolbar options, common to all editors in the Ultimus BPM Studio environment. Refer to the following sections: • The menu bar • The Standard toolbar
The menu bar This section describes the common menu bar options in all editors. These are as follows: • File • Edit • View • Tools • Help Functions within each of these items are described below.
File Items under the File menu may be accessed with the keyboard shortcut ALT-F. The following functions under the File menu are common to all Ultimus BPM Studio editors: • Close • Close All • Save • Save All • Exit Each of these functions is discussed below.
Close The Close menu option closes the displayed editor. If contents within that editor have been revised since it was opened, a prompt to save changes is displayed.
Close All The Close All menu option closes all editors associated with the business process. If any editor(s) within the business process has been revised since it was opened, a prompt to save changes is displayed.
Save The Save menu option (CTRL-S shortcut) saves the content of the active editor.
Save All The Save All menu option (CTRL-SHIFT-S shortcut) saves the entire business process.
Exit The Exit menu option closes Ultimus BPM Studio. If an opened business process has been revised since it was opened, a prompt to save changes in the business process is displayed before Ultimus BPM Studio closes.
Edit Items under the Edit menu may be accessed with the keyboard shortcut ALT-E. The following functions under the Edit menu are common to all Ultimus BPM Studio editors: • Undo • Redo • Cut • Copy • Paste • Delete Each of these functions is discussed below.
Undo The Undo menu option (CTRL-Z shortcut) is used to undo the last action. Ultimus BPM Studio keeps track of all actions performed since the editor was opened. The Undo function is only available once an action has been executed which may be undone. Note: The Undo function does not work in the Modeling Rules window, process map properties, or step properties.
Redo The Redo menu option (CTRL-Y shortcut) is used to redo the action if the undo function was just performed. The redo function may be used as many times as the undo function was just used. The Redo function is only available once the Undo function has been used.
Cut The Cut menu option (CTRL-X shortcut) deletes a selected object. In doing so, that object is also saved in Windows Clipboard, so it may be pasted. The Cut function is only available when an object is selected.
Copy The Copy menu option (CTRL-C shortcut) copies a selected object. In doing so, that object is saved in Windows Clipboard, so it may be pasted. The Copy function is only available when an object is selected.
Paste The Paste menu option (CTRL-V shortcut) pastes an object which has been saved in Windows Clipboard. Once the Paste function is used, move the mouse to the desired location for the object, then left-click the mouse to place the object. The Paste function is only available when an object has been cut or copied into Windows Clipboard.
Delete The Delete menu option deletes a selected object. The Delete function is only available when the selected object can be deleted.
View Items under the View menu may be accessed with the keyboard shortcut ALT-V. The following functions under the View menu are common to all Ultimus BPM Studio editors: • Status Bar • Large Icons • Toolbars • Windows • Color Scheme • Switch View Each of these functions is discussed below.
Status Bar The Status Bar menu option is a toggling menu option that makes the Status bar appear and disappear on the Ultimus BPM Studio interface. When the icon beside the Status Bar menu option is highlighted, the Status bar is visible.
Large Icons The Large Icons menu option is a toggling menu option that makes icons in the Ultimus BPM Studio interface appear larger. When the icon beside the Large Icons menu option is highlighted, large icons are displayed.
Toolbars The Toolbars menu option contains different submenu options depending upon the editor that is currently selected. These options are used to display or hide specific toolbars in the Ultimus BPM Studio interface. For further details, refer to the respective editor section.
Windows The Windows menu option contains different submenu options depending upon the editor that is currently selected. These options are used to display or hide specific windows in the Ultimus BPM Studio user interface. For further details, refer to the respective editor section.
Color Scheme The Color Scheme menu option contains two options: Blue and Green. Each of these options is discussed below.
Blue Displays the Ultimus BPM Studio user interface with the blue color scheme. When the icon next to the Blue submenu option is highlighted, the Ultimus BPM Studio user interface displays using the blue color scheme.
Green Displays the Ultimus BPM Studio user interface with the green color scheme. When the icon next to the Green submenu option is highlighted, the Ultimus BPM Studio user interface displays using the green color scheme.
Switch View The Switch View menu option contains two options: BPMN view and Ultimus Standard view. Each of these submenu options is discussed below.
BPMN view Displays the visible process map in BPMN view. This view uses a set of symbols inspired by the symbols of the Business Process Modeling Notation (BPMN). If the process map is already displayed in BPMN view, this option is disabled.
Ultimus Standard view Displays the visible process map in Ultimus standard view. If the process map is already displayed in Ultimus standard view, this option is disabled.
Tools Items under the Tools menu may be accessed with the keyboard shortcut ALT-T. This menu option provides configuration support. The following functions under the Tools are common to all Ultimus BPM Studio editors: • Disable Windows Authentication • Enable AutoSave • Verify on Check In Each of these functions is discussed below.
Disable Windows Authentication The Disable Windows Authentication menu option is used to disable Windows Authentication if that feature is enabled. If disabled, the next time the Ultimus BPM Studio process designer logs on, he or she must use proper user name and password credentials to log on to Ultimus BPM Studio. Tip: Windows Authentication is enabled by selecting the Use Windows Authentication check box in the Ultimus BPM Studio log on dialog box. For more information, refer to Starting Ultimus BPM Studio section.
Enable AutoSave The Enable AutoSave menu option is a toggling menu option that automatically saves any changes made while working on the business process. When the icon beside the Enable AutoSave menu option is highlighted, changes are saved automatically when any editor within Ultimus BPM Studio is closed; the process designer is not prompted to save changes. When the icon beside the Enable AutoSave menu option is not highlighted, the process designer must save changes using the Save or Save All functions.
Verify on Check In The Verify on Check In menu option, when enabled, verifies consistency and validity of business process objects when the business process is checked in to the process repository. When the icon beside the Verify on Check In menu option is highlighted, the Ultimus engine performs its consistency and validation tests. For a description of those consistency and validation checks, refer to Operations performed when a business process is checked in section.
Help Items under the Help menu may be accessed with the keyboard shortcut ALT-H. This menu option provides access to Ultimus BPM Studio Help and version information. The following functions under the Help menu are common to all Ultimus BPM Studio editors: • Ultimus BPM Studio Help • About Ultimus BPM Studio Each of these functions is discussed below.
Ultimus BPM Studio Help The Ultimus BPM Studio Help menu option accesses the Ultimus BPM Studio Help.
About Ultimus BPM Studio The About Ultimus BPM Studio menu option displays information about Ultimus BPM Studio, such as its build and version number.
The Standard toolbar This section describes the Standard toolbar button options available in all editors. Below is a description of buttons on the Standard toolbar: Save button • Save (): The Save button saves the content of the active editor. Save All button • Save All (): The Save All button saves the entire business process. Undo button • Undo (): The Undo button is used to undo the action. Ultimus BPM Studio keeps track of all actions performed since the editor was opened. Note: The Undo function does not work in the Modeling Rules window, process map properties, or step properties. Redo button • Redo (): The Redo button is used to redo the last action if the undo function was just performed. The redo function may be used as many times as the undo function was just used. Refresh Process XML Schema button • Refresh Process XML Schema (): The Refresh Process XML Schema button is used to refresh the XML schema for the business process. This refreshes both global and step XML schemas. Note that this button is only available when the business process is in Build mode. A warning message is displayed in the Ultimus BPM Studio log if the XML schema must be refreshed. This button is disabled when the business process is in Modeling mode. Help button • Help (): The Help button opens the Ultimus BPM Studio Help. Switch View button • Switch View (): The Switch View button toggles between BPMN view and Ultimus Standard view. For more information about BPMN, refer to Switch View section.
This section introduces the Repository window. The Repository windowis a dockable window which can be detached from the workspace and moved to other areas on the screen or attached at other borders of Ultimus BPM Studio. The Repository window The Repository window is used for browsing and manipulating processes, process objects, and external process objects in the currently selected Ultimus BPM Studio repository. Context-sensitive options associated with tree nodes enable the process designer to perform a variety of functions on objects by right-clicking these object folders. The process designer can change the currently selected repository and view the properties at any time from the Repository window. The Repository window consists of the following two folders: • Processes folder: The Processes folder stores all processes made under the current Ultimus BPM Studio repository. For more information about the Processes folder, refer to Processes folder section. • Documentation Templates folder: The Documentation Templates folder stores all the templates used for generating technical documents for business processes. For more information about the Documentation Templates folder, refer to Documentation Templates folder section.
The Repository window toolbar This section describes the Repository window toolbar. The Repository window toolbar Below is a description of buttons on the Repository window toolbar: New button • New (): Selecting the New button creates a new object under the currently highlighted folder in the Repository window. For example, if the Processes folder is highlighted when the New button is selected from the toolbar or from the Object»New menu option, a new business process is created under that folder. If the Documentation Templates folder is highlighted, selecting the New button creates a new documentation template under the Documentation Templates folder. To create a new object, follow these steps: 1. From the Repository window, select the folder under which a new object is to be created. 2. Perform one of the following: a. Click the New button () from the Repository window toolbar. b. Right-click on the folder and select the New option. c. Select Object»New from the menu bar. A new object is created under the selected folder. Note: The New button is not available for external objects accessed through the Custom editor. These objects must be created outside of Ultimus BPM Studio, then may be added to Ultimus BPM Studio through the Add function (described below). 4. Rename the newly created object, if desired. Note: The object name can contain the following characters only: a-z, A-Z, 0-9, _, . and space. In addition to this, the object name must contain one alphanumeric character and must not end at “.” character. Delete button • Delete (): Selecting the Delete button deletes the currently selected object. In order to delete an object, two conditions must be met: a. The Delete object security privilege must be enabled for that object. b. The object must be checked in. To delete an object, follow these steps: 1. From the Repository window, select the object to be deleted. 2. Perform one of the following: a. Click the Delete button from the Repository window toolbar. b. Right-click on the object and select the Delete option. c. Select Object»Delete from the menu bar. The currently selected object is deleted from the repository. Add Existing... button • Add Existing... (): Selecting the Add Existing... button adds pre-defined objects to the repository currently selected and displayed in the Repository window. To add an existing object, follow these steps: 1. From the Repository window, select the folder to add an object. Only the relevant objects can be added under the selected folder. For example, if the Processes folder is selected, only workflow (WFL) files can be added under it. 2. Perform one of the following: • Click the Add Existing... button from the Repository window toolbar. • Right-click on the folder and select the Add Existing... option. • Select Object»Add from the menu bar. The Open dialog box appears. The Open dialog box to add an existing pre-defined objects  3. Browse and select the object, then click Open (as shown above). The selected object is added to the repository. If working offline, the Add Existing... button adds the object to an offline process repository on the local client computer. Note: If the imported object uses a name for a corresponding business process (or object within a business process) which already exists in the repository, Ultimus BPM Studio functions in the following ways, depending on whether the same-named object currently in the repository is checked out or checked in: • The same-named object currently in the repository is checked out: If same-named business process (or object) currently in the repository is checked out, then Ultimus BPM Studio displays a dialog box to determine whether the imported object should be added as a new version of the existing (checked out) object, or if the imported object should not be imported at all. • The same-named object currently in the repository is checked in: If the same-named business process (or object) currently in the repository is checked in, then Ultimus BPM Studio displays a notification to check out the business process (or object) before importing the object. If the object is imported as a new version of the existing same-named object, then it is recorded in the process history. Edit button • Edit (): Selecting the Edit button opens the object editor of the currently highlighted folder or object in the Repository window. In order to edit an object, following two conditions must be met: a. The Edit object security privilege must be enabled for that object. b. The object must be checked out. To edit an object, follow these steps: 1. From the Repository window, select the object to be edited. 2. Perform one of the following: • Click the Edit button from the Repository window toolbar. • Right-click on the node and select the Edit option. • Select Object»Edit from the menu bar. The object editor opens where the object can be edited and saved. Refresh button • Refresh (): Selecting the Refresh button refreshes the display of the currently selected repository in the Repository window. Check out button • Check out (): Selecting the Check out button allows the currently highlighted object to be checked out for editing. If an object is checked out, no one else can work on that object. In the Repository window, objects with red checkmarks () shows that the user has checked out an object, whereas check mark in a red circle () shows that another user has checked the object out. All child objects of the checked out node are automatically checked out when the parent object is checked out. To check out an object, follow these steps: 1. From the Repository window, select the object to be checked out. 2. Right-click on the object and select Repository»Check Out or select Object»Repository»Checkout from the menu bar. 3. The selected object is checked out. A red check mark () appears next to the object name in the Repository window. Check in button • Check in (): Once changes are made to an object, selecting the Check in option allows checking the object back into the currently selected process repository. When this happens, the version number of the object automatically increments in the currently selected process repository. To check in an object, follow these steps: 1. From the Repository window, select the object to be checked in. 2. Right-click on the object and select Repository»Check In or select Object»Repository»CheckIn from the menu bar. 3. The Comments dialog box appears. The Comments dialog box at check in time In the Comments text box, enter any comments or description. Select the Label check box to save the current version of the business process to the history database. Tip: The Label option is useful to track important changes to the business process and makes it easy to return to a previous state of the process if necessary. 4. Click the OK button. The selected object is now checked in. • Publish (): Selecting the Publish button begins the procedure to publish a selected repository object to Ultimus BPM Server. The selected object must be checked in to possibly publish. If the selected object is not checked in, the Publish button is disabled. For more information about how to publish objects, refer to the Publish option in Selected process level options section. • Import object from an XML file (): The Import object from an XML file button is used to import an XML file into Ultimus BPM Studio as an orchestration or a business process. This is useful to import content from BPA or other BPM tools for development in Ultimus BPM Studio. For more information how to import an object from an XML file, refer to Import from XML... section. • Export selected object as XML (): The Export selected object as XML button is used to export a business process to an XML file. Customers who utilize third-party BPM tools can export the business process into an external XML file so that a third-party BPA tool can subsequently import the resulting XML file back in for further modeling analysis. The ability to freely import and export business processes into and out of Ultimus BPM Studio to utilize those processes in other applications enables customers to employ a continuous process improvement methodology across disparate BPA and BPM applications.
Processes folder The Processes folder is where all published business processes are organized. The process designer can add, edit, create, delete and rename processes along with a number of other actions while working in this folder. For information on how to perform actions in the Processes folder, refer to Processes folder options section. Within each business process are the following subnodes: • Map Properties • Rules • Process XML Schema • Global XML Type Definitions • Form Objects • Steps • Actions Each of these subnodes is described below.
Map Properties The Map Properties subnode accesses general properties information for the entire process. Information regarding incident level e-mail notifications, Completion Time and Help URL is saved in the Map Properties and can be modified through the Map Properties editor. To design or edit Map Properties, check out the Map Properties node, then right-click and select the Edit option. Alternatively, select the Edit button () from the Repository window toolbar or select Object»Edit from the menu bar. The Map Properties editor appears, where the process designer can set the incident level e-mail notification messages and give other information like the process Completion Time and Help URL. For more information about the Map Properties editor, refer to The Properties window section. To view the properties of the Map Properties node, right-click on the Map Properties node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version and modification date of the Map properties. The properties for the Map Properties node in the Properties window For more information, refer to The Repository window properties section.
Rules The Rules node allows the management and viewing of all process-level business rules. To design or edit the process-level business rules, check out the Rules node, then right-click and select Edit. Alternatively, select the Edit button () from the Repository window toolbar or select Object»Edit from the menu bar. For more information how to design business rules, refer to Designing business rules section. To view the properties of the process-level business rules, right-click on the Process Rules node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version and modification date of the process-level rules properties. The properties for the Rules node in the Properties window For more information, refer to The Repository window properties section.
Process XML Schema The Process XML Schema node is used to define an XML schema for the business process, thereby defining what, where, and how data is routed in the business process. To edit the process XML schema, check out the Process XML Schema node, then right-click and select Edit. Alternatively, select the Edit button () from the Repository window toolbar or select Object»Edit from the menu bar. For more information how to define XML schema, refer to The Process XML Schema editor section. To view the process XML schema properties, right-click on the Process XML Schema node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version, and modification date of the process XML schema. The properties for the Process XML Schema node in the Properties window For more information, refer to The Repository window properties section.
Global XML Type Definitions The Global XML Type Definitions node displays global elements and data types that are used throughout the process. A data type is a schema type that is common throughout a business process and can be used to create process and step XML schemas. Types defined here are available for subsequent use in the process-level and the step-level XML schemas. Any change made in these types is automatically reflected in the XML schemas where these types are referred. There are three categories of types. These are briefly outlined below: • Built- in: A Built-in data types is based on base types, or simple elements (such as a text string, an integer, or a date). • Complex: A complex data type consists of a set of simple and/or complex element declarations, element references, and attribute declarations. Any type with one or more elements within it is considered as a complex type. • Imported: Imported data types are those that are imported by process designers and saved as process types. Element types can be imported from sources such as XSD files, Web Services assemblies. To edit/define types in the XML schema, check out the Global XML Type Definitions node, then right-click and select Edit. Alternatively, select Edit button () from the Repository window toolbar or select Object»Edit from the menu bar. For more information how to define an XML schema, refer to Creating Global XML type definitions section. To view the properties of the Global XML Type Definitions node, right-click on the Global XML Type Definitions node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version and modification date of the schema elements. The Global XML Type Definitions node in the Properties window For more information, refer to The Repository window properties section.
Form Objects Ultimus BPM Studio may be used to create and save reusable “form objects” in a library. The Form Objects node is used to define a standard set of form controls which can be grouped and saved for insertion into any Ultimus Form of a process. Objects created under the Form Objects node retain their positioning, links, and formatting properties when inserted into Ultimus Forms. This allows process designers to create consistent forms. Any change to an object is propagated to all other objects in all Ultimus Forms. To define the Form Objects, check out the Form Objects node, then right-click and select New. Alternatively, select New button () from the Repository window toolbar or select Object»New from the menu bar. For more information how to define Form Objects, refer to Working with form objects section. To view the properties of the Form Objects, right-click on the Form Objects node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version and modification date of the object(s) properties. The properties for the Form Objects node in the Properties window For more information, refer to The Repository window properties section.
Steps The Steps node stores the steps defined in the business process. The Steps node has additional subnodes for managing business rules for each step, properties for each step, and other step-related settings that are dependent on the step type. For information on how to design steps, refer to Working with the Process editor in Build mode section. Subnodes of the Steps node: • The Properties subnode is used to view the step properties in the business process. For information on step properties, refer to Context menu options section. • The Rules subnode enables management and viewing of all tasks related to rule management at the step level, thus providing the facility to carry out different rule management activities. For instructions see The Step Rules editor workspace. • The Step XML Schema subnode is used to define a schema for the step in a business process, thus defining what, where, and how data routes in and out of the step in the business process. See section The Step XML Schema editor. • The Attachments subnode is used to add attachments. See Creating step level attachments. • Forms: For users and process participants, forms represent the business processes. They use the created forms to receive, input, and send information, to make decisions based on the content, and also to review the work of other users. Forms may be unique for each step of a business process. Ultimus Digital Process Automation (DPA) Suite supports the following types of forms: Ultimus CPS Form, Ultimus Form, Ultimus WebForm, Custom Form. For more information on forms, refer to the respective forms section. • Flobot Trainer: Before Flobots (or Automated Activities, as they are called in BPMN view) can be used in a business process, they must be trained using the Flobot Trainer editor in Ultimus BPM Studio. This allows complete development and testing of the Flobots. For further information about the topic, refer to The Flobot Trainer editor section. To view the properties of the Steps node or any of the subnodes, right-click on that node, then select Properties. Alternatively, select View»Windows»Properties from the menu bar. The Properties window appears and shows the properties such as the owner, status, version and modification date of the selected object. The properties for the Steps node in the Properties window For more information, refer to The Repository window properties section.
Actions The Actions node stores all the actions defined for the business process.The Actions node has two additional subnodes: • .Net Code: .NET Code custom actions may be created and stored under the Actions node. The .NET Code custom actions execute .NET Code in Ultimus Director. When rules evaluate for a particular condition, .NET Code may be called. .NET Code custom actions are only for use in Ultimus Director; they do not have any explicit functionality in Ultimus BPM Studio. • Web Services: Web Service custom actions may be created and stored under the Actions node. Web Service custom actions are used in Ultimus Director to call Web services when rules evaluate for a particular condition. Web Service custom actions are only for use in Ultimus Director; they do not have any explicit functionality in Ultimus BPM Studio. For information on how to define actions, refer to Creating User-defined actions section.
Documentation Templates folder Ultimus BPM Studio provides the capability to take the process design and produce an electronic document that describes the model, its objects, and requirements. The Documentation Templates folder stores multiple document templates used as a foundation to generate technical documentation for different processes. Ultimus BPM Studio uses a zero-footprint, HTML-based process documentation. For more information how to define documentation templates, refer to Generating documentation section.
Context menu options The context menu for each node in the Repository window must be according to which features are available for that node. The context menu presents various options through which the majority of design features in Ultimus BPM Studio can be performed. The context menu options depend on the node currently selected in the Repository window. The available options are described in the following categories: • Processes folder options • Selected process level options • Documentation Templates folder options • Selected documentation template level options Options within each category are described below.
Processes folder options This section describes the options available when right-clicking on the Processes folder. The Processes folder context menu Following is the list of context menu options for the Processes folder: New • New (): Selecting the New option creates a new business process. To create a new business process, refer to New button section. Add Existing... • Add Existing...(): Selecting the Add Existing... option allows adding pre-defined processes to the repository currently selected and displayed in the Repository window. To add an existing process, refer to Add Existing... button section. Create Folder • Create Folder (): Selecting the Create Folder option creates a new folder under the currently selected folder. Folders provide a convenient way to organize objects. Objects can then easily be moved to that folder by dragging and dropping them into that folder. By pressing the CTRL key while selecting an object, the object can be dragged-and-dropped into the folder. To create a new folder, follow these steps: 1. From the Repository window, select and right-click on the Processes folder, then select Create Folder (or select Object»Create Folder from the menu bar). A new folder is created under the currently selected folder in the Repository window. Creating a new folder in the Processes folder 2. Enter a name for the newly created folder and click to save the folder by that name. Properties • Properties (): Selecting the Properties option displays the properties of the selected folder. For more information, refer to The Repository window properties section. To view the properties of the selected node, follow these steps: 1. From the Repository window, select and right-click on the Processes folder. 2. Select Properties (or select Object»Properties from the menu bar). The Properties window shows the properties of the Processes folder. The properties for the Processes folder in the Properties window
Selected process level options This section describes the options available at the selected process level. The process folder context menu when the selected process is checked in Following is the list of context menu options when the selected business process is checked in: Repository • Repository: The Repository option has three submenu options. These are explained below: a. Check In/Check Out: The Check Out option is used to open the selected object for editing. The Check In option saves all changes made to the currently selected object in the repository. To check in a process, refer to Check in button section. To check out a process, refer to Check out button section. b. Undo Checkout: The Undo Checkout option is used to undo all changes made while the selected process was last checked out for editing. Selecting the Undo Checkout option reverses the check out process without creating a new version of the object. Checking an object’s history c. History: Ultimus BPM Studio supports full object versioning and rollback capabilities. When an object is published, checked out, edited, and checked back in, the version number for that object increments automatically. Selecting the History sub option allows viewing any changes made to an object. To view the history of the selected object, follow these steps: 1. From the Repository window, expand the Processes folder. 2. Select the required object subnode, right-click and select Repository»History (or select the Object»Repository»History menu option). 3. The Ultimus BPM Studio-ObjectName History dialog box appears, where ObjectName represents the name of the currently selected object. The History dialog box The History - ObjectName dialog box displays the following information: • Version: The Version column specifies the version number of the process object, the latest version number being the most current. This column is not available at process level. • Branch: The Branch column specifies the branch number or the minor version number of the object. This column is not available at the process level. The Branch column is useful for objects like Rules (process-level and step-level) and Schema (process-level and step-level) in which its properties can be modified and then published by the process experts through Ultimus Director. • Label: The Label column specifies the label assigned to the process at the time of publishing. • User: The User column provides the name of the user who made the change to that particular version. • Date: The Date column specifies the date on which the change was made. • Comments: The Comments column provides any comments that may have been added to the process or object when making the change. If an object is checked out to the current user, the following options are available: • Retrieve: Selecting the Retrieve button to retrieve a selected version of the object and overwrite the checked out (latest) version of that object. • Create Copy: This menu option creates a copy of the currently selected object. When a copy is created, it is called Copy_number_Of_objectname, where number is the number of the copy (you can create more than one copy), and objectname represents the name of the selected object in the Repository window. This option is not available for process objects (such as Map Properties, XML schema, and steps). 4. Select the Close button to close the dialog box. Simulate • Simulate (): Simulation is a powerful tool which is helpful in thoroughly testing the business process before publishing it from Ultimus BPM Studio. To simulate a process, follow these steps: 1. From the Repository window, expand the Processes folder. 2. Perform one of the following options: • Right-click on a process node, then select Simulate. • Select the object, then select the Object»Simulate menu option. Selecting the Simulate context menu option When simulation is selected at this level, it can be performed on a process that is either checked in or checked out. Simulation at this level is limited such that the Simulation Watch feature is not available. This is supported when simulation takes place when the process is edited in the Build mode. For more information about simulating a business process, refer to Working in the Simulation environment section. Security • Security: The Security option allows the process designer or Ultimus system administrator to control who can edit, delete, lock, and publish objects; only such an individual can define object security on all object types in Ultimus BPM Studio. Tip: User access rights for process repositories is controlled through Ultimus BPM Studio Configuration. For more information, refer to Configuring process repositories section in Ultimus BPM Studio Configuration Help. Assigning object security rights Object security rights are those rights that can be explicitly defined for a specific object. Whenever security is defined for a parent object, all child objects below a parent object automatically receive the same rights. Individual security rights for child objects can then be overridden by selecting the object in the Repository window and defining the security rights for that object. To assign object access rights, follow these steps: 1. From the Repository window, select the object in which its access rights are to be defined. 2. Right-click, then select Security»Assign Access (or select Object»Security»Assign Access from the menu bar). The Assign Access dialog box appears. The Assign Access dialog box When the dialog box is opened for the first time, no restrictive access rights are assigned to any of the process designers (added in Ultimus BPM Studio Configuration), hence an icon () is shown to imply that the object is not secure. 3. From the Users combo box in each row, select a user against whom the object rights are to be assigned. This list includes only those users who are given access to the currently selected process repository in Ultimus BPM Studio (user access rights for process repositories is controlled through Ultimus BPM Studio Configuration). The number of rows in the Security dialog box varies depending upon the number of users who have been granted access rights. 4. Select the Edit, Delete, Lock or Publish check boxes in the selected row to define the object security rights for the user selected from the Users combo box. Following is a brief description of each of the object access types: • Edit: If the Edit check box is selcted, the specified user can check out and edit the currently selected object. For information on how to edit objects, refer to Edit button section. • Delete: If the Delete check box is selected, the selected user can delete the currently selected object. For information on how to delete objects, refer to Delete button section. • Lock: If the Lock check box is selected, the specified user can lock the currently selected object without having to check out the object. This functionality is useful if it is required to prevent other users from changing an object without having to check out that object, and in doing so, creating a new version of that object. For more information on how to lock objects, refer to Locking an object section. In order to lock an object, the following conditions must be met: a. The object must be checked in. b. The “lock” object security privilege must be enabled for that object and granted for the individual who wants to lock the object. • Publish: If the Publish check box is selected, the currently selected object may be published to Ultimus BPM Server. For information on how to publish objects, refer to the Publish option in this section, below. 5. Select the OK button to save these changes or select the Cancel button. Note: Click the Clear All button to clear all the security attributes for the selected object. When clicked, a dialog box appears asking for confirmation before clearing the security attributes. Select the OK button. Locking an object To lock an object, follow these steps: 1. From the Repository window, select the object which is to be locked. 2. Perform one of the following: • Right-click, then select Security»Lock. • Select Object»Lock from the menu bar. Locking an object The object is locked from any sort of editing if it is checked in and the “lock” object security privilege is enabled. The following guidelines apply to object security: • By default no object security is active for new objects that are created in, or added to, Ultimus BPM Studio. This applies to all object types. Thus, any user can perform any action (such as edit, delete, publish, or lock) on these objects initially. Security for these objects can be activated by explicitly setting security for that object through the Security dialog box. • When object security is set on a parent object, the security rights are automatically applied to all child objects within that parent object. Thus, if a “publish” privilege is set for a process, all objects in that process (such as map properties and steps) implicitly inherit the “publish” privilege. • As a rule for processes, a child object can only be explicitly assigned security once security has been set for the process itself. As an example, to assign security explicitly for a step the security for the process must first be activated by assigning some level of security rights to that business process. • When object security is explicitly set on child objects, the security rights set for the child are additive to security rights set for all parent objects above it. As an example, if a process has the “publish” privilege, the Steps subnode below it has the “lock” privilege explicitly defined for it, and a form for a particular step explicitly has the “delete” privilege set for it, then the form inherits all three security rights assigned to it - “publish,” “lock” (through inheritance), and “delete.” Delete • Delete (): Selecting the Delete option deletes the currently selected object. In order to delete an object, the following conditions must be met: a. The “delete” object security privilege must be enabled for that object and granted for the individual who wants to delete the object. b. The object must be checked in. To delete a node from the Processes folder, refer to Delete button section. Create Copy • Create Copy (): The Create Copy menu option creates a copy of the currently selected object. When a copy is created, it is given a name automatically in the following format: Copy [number] of [object name], where • [number] is the ‘serial’ number of the copy (you can create more than one copies) • [objectname] is the name of the selected object in the Repository window. In order to make a copy of an object, the following conditions must be met: • The “edit” object security privilege must be enabled for that object and granted for the individual who wants to edit the object. • The object must be checked in. Generate Documentation • Generate Documentation (): Selecting the Generate Documentation option generates a documentation report for the selected process. To generate a documentation report for a process, follow these steps: 1. From the Repository window, expand the Processes folder. 2. Select and right-click on the process node, then select the Generate Documentation option (or select Object»Generate Documentation from the menu bar). 3. The Generate Documentation dialog box appears. From the list of all existing documentation templates, select a template. The report for the selected process is based upon the documentation template selected. The Generate Documentation dialog box 4. Click on OK to display the Save As dialog box. By default, the current working directory is selected. Enter the path to save the process documentation report ( as .html). Click on Save to save and close the window. The Save As dialog box Publish • Publish (): Selecting the Publish option publishes the selected object on Ultimus BPM Server. The rules and guidelines for publishing a business process are as follows: a. Publishing is possible for processes, individual process objects, and external objects referenced in processes. b. Processes or objects must be checked in before publishing. c. Ultimus BPM Studio users can only publish processes and objects if they have access rights via the “publish” object security privilege. To learn more about configuring object-level security privileges, refer to Assigning object security rights section. d. Ultimus BPM Studio Client users can only publish processes to Ultimus BPM Servers as defined in Ultimus BPM Studio Configuration. e. If Ultimus Director is installed, it is not necessary to specify the recipient for User or Flobot/Automated Activity steps to publish a business process; it is only necessary to specify the recipient of the Begin step. To publish a process, follow these steps: 1. From the Repository window, expand the Processes folder. 2. Select, then right-click on the business process, then select Publish. Alternatively, select Object»Publish from the menu bar. The Ultimus BPM Studio - ProcessName Publish dialog box appears where the ProcessName is the name of the selected business process. The Publish process dialog box 3. In the Target Server: combo box, specify the Ultimus BPM Server to which the business process is being published. 4. In the Label: text box, add a label for the process. By default, it is set to the current date and time. The following options are available in the Ultimus BPM Studio - ProcessName Publish dialog box: • Install New Version: Selecting the Install New Version option publishes a new version of the object or process to the target Ultimus BPM Server. Note if a change is made to an individual process object, and this object is selected for publishing, then the entire process version is incremented on the target Ultimus BPM Server. When publishing individual objects, Ultimus BPM Studio automatically optimizes client to server communication in that it only sends the necessary object changes to Ultimus BPM Server (and not the entire business process). • Upgrade Existing Version: The Upgrade Existing Version option is active if a process of a similar name is already published on Ultimus BPM Server. Selecting this option updates the latest version of the business process without incrementing the version number on Ultimus BPM Server. The major benefit of this functionality is that it is possible to take advantage of changes made to the business process immediately in live incidents (without having to initiate incidents against the new process version to see the change). The rules regarding the Upgrade Existing Version option are as follows: a. Modifications to the step XML schema of a business process are automatically used by live incidents, if the step associated with the step XML schema has not yet activated for the live incident. b. Modifications to the step XML schema of a business process are automatically used by live incidents, if the active step associated with the step XML schema is returned and reactivated. c. Modifications to the process XML schema of a business process are not used by live incidents. Rather, only new incidents of the upgraded process contain the updated process XML schema elements. Caution: Process designers are advised to save processes with major changes as new versions rather than using the Upgrade Existing Version option. Examples of major changes include addition or removal of steps and/or changing the schema.Additionally, when a step is deleted or the schema is changed, upgrade is not allowed by default, in order to avoid data corruption. 5. Select the Cancel button to exit the publishing window without publishing the business process or object or select the OK button to publish the business process at the specified target Ultimus BPM Server. It is possible to publish external objects (such as .NET Code, images, or PDF files) by similar means used for processes. However, the Publish dialog box which appears for external objects is different. The Publish dialog box for external objects For example, .NET Code would go to the Resources folder on the target Ultimus BPM Server, images used in forms would go to the UltWeb directory, or a custom location can be specified in the Custom Path text box which becomes active when the Custom Path option is selected. A new folder is created at the specified location if one does not exist already. Note: The process publisher is also designated as the process owner. When publishing the business process in Ultimus BPM Studio, log on as the domain user account that is to be designated as the process owner. This ensures that the correct process owner value is recorded against the published process.Once the business process is published from Ultimus BPM Studio, the process owner can be changed (and additional process owners can be specified) through Ultimus Process Administrator. For further details on modifying the process owner, refer to Assigning process-level access rights section in Ultimus Process Administrator Help. Save to Disk... • Save to Disk... (): Selecting the Save to Disk... option allows exporting the entire process from Ultimus BPM Studio as a standalone WFL file. To save a process to disk, follow these steps: 1. From the Repository window, expand the Processes folder and select the process to be saved (exported). 2. Right-click on the process subnode, then select Save to Disk.... The Save As dialog box appears. By default, the current working directory is selected. Browse and save the process to disk with the .WFL extension. The Save As dialog box • Import from XML: The Import from XML option is used to import an XML file into Ultimus BPM Studio. Once imported, this content can be saved as a .WFL file for further development. This is useful to import content from BPA or other BPM tools for development in Ultimus BPM Studio. For more information how to import an object from an XML file, refer to Import from XML... section. • Export as XML: The Export as XML option is used to export a business process to an XML file. Customers who utilize third-party BPM tools can export the business process into an external XML file so that a third-party BPA tool can subsequently import the resulting XML file back in for further modeling analysis. The ability to freely import and export business processes into and out of Ultimus BPM Studio to utilize those processes in other applications enables customers to employ a continuous process improvement methodology across disparate BPA and BPM applications. • Properties (): Selecting the Properties option displays the properties of the selected node. For more information, refer to The Repository window properties section. To view the properties of the selected object, follow these steps: 1. From the Repository window, select, then right-click on the object in which its properties are to be viewed. 2. Perform one of the following: • Select Properties from the context menu. • Select Object»Properties from the menu bar. The Properties window shows the properties of the selected object. The properties for the Documentation Templates folder in the Properties window Note: Since the individual objects within a process can be checked out separately, their context menu options relate to the options available at the process level. Context menu options when the process is checked out The context menu options are slightly different when the currently selected business process is checked out. The process folder context menu when the selected process is checked out Following is the list of context menu options when the business process is checked out, unique to those options which are available when the business process is checked in: Edit • Edit (): Selecting the Edit option allows for processes and objects to be edited. If Edit is selected for a process, it opens the Build editor, where the entire processes can be automated. If this option is selected for an individual process object, the object can then be edited in its individual editor. If however this option is selected for an external object, the custom editor associated with that object opens (for more information on setting up a custom editor, refer to Add External Editor... section). In order to save and close an object being edited, select the Close button () from the Ultimus BPM Studio toolbar, or the File»Close option from Ultimus BPM Studio menu bar. For further information, refer to Working with the Process editor in Build mode section. In order to edit an object, the following conditions must be met: a. The object must be checked out. b. The “edit” object security privilege must be enabled for that object and granted for the individual who wants to edit the object. To open a process for editing in the Build editor, follow these steps: 1. From the Repository window, select and expand the Processes folder to expose the process that is to be edited. 2. Check out the process. To do so, do one of the following: a. Select and right-click the process name’s node, then select Repository»Check Out. b. From the menu bar, select Object»Repository»Checkout. 3. Take the process into Build mode. To do so, do one of the following: a. From the Repository window, select and right-click the process name’s node, then select Edit. b. From the menu bar, select Object»Repository»Edit. c. From the Repository window, select the process, then drag and drop it in the Preview editor. The selected process is in Build mode. Edit (Model) • Edit (Model): Selecting the Edit (Model) option opens the Modeling editor and allows the process to be modeled. The Edit (Model) function is only available at the process level; it is not accessible for individual process objects. In order to save and close an object being modelled, select the File»Close option from Ultimus BPM Studio menu bar. For further information, refer to Working with the Process editor in Build mode section. In order to model an object, the following conditions must be met: a. The object must be checked out. b. The “edit” object security privilege must be enabled for that object and granted for the individual who wants to edit the object. To open a process for editing in the Modeling editor, follow these steps: 1. From the Repository window, expand the Processes folder to expose the process that is to be modeled. 2. Check out the business process. To do so, do one of the following: a. Select and right-click the process name’s node, then select Repository»Check Out. b. From the menu bar, select Object»Repository»Checkout. 3. Take the process into modeling mode. To do so, do one of the following: a. Select and right-click the process name’s node, then select Edit (Model). b. From the menu bar, select Object»Repository»Edit (Model). The selected business process is in Modeling mode. Rename • Rename: Selecting the Rename option allows to rename the selected node. In order to rename an object, the following conditions must be met: a. The “edit” object security privilege must be enabled for that object and granted for the individual who wants to edit the object. b. The object must be checked out. To rename a subfolder in the Processes folder, follow these steps: 1. From the Repository window, expand the Processes folder to expose all the subfolders. 2. Perform one of the following: • Right-click the subfolder name, then select the Rename option. • Select the subfolder, then select Object»Rename from the menu bar. • Click once on the subfolder. Renaming a subfolder in the Processes folder 3. The subfolder name becomes editable. Enter the new name of the subfolder; the subfolder is now renamed. Note: In order to avoid errors, any special characters (including non-printable ASCII characters) should not be used in the name. Notes • Notes: Selecting the Notes option opens a comprehensive text editor where detailed notes for a process or object can be entered. The Notes editor dialog box These descriptive notes can be added to all object types for reference purposes, which can be later viewed by other process designers to assist them in designing the process. To add notes to an object, follow these steps: 1. From the Repository window, select the object subnode in which its notes are to be edited. 2. Right-click on the subnode and select Repository»Check Out. 3. Right-click on the object subnode again and select Notes. The Notes editor appears. 4. Add descriptive notes in the editor. Click the OK button to save the edits, click the Cancel button to discard the changes or select the Reset button to switch to the default settings. Since the individual objects within a process can be checked in separately, their context menu options relate to the options available at the process level.
Documentation Templates folder options This section describes the options available when the Documentation Templates folder is right-clicked on. The Documentation Templates folder context menu Following is the list of context menu options for the Documentation Templates folder: New • New (): Selecting the New option creates a new document template. To create a new document template, refer to New button section. Properties • Properties (): Selecting the Properties option displays the properties of the selected node. For more information, refer to The Repository window properties section. To view the properties of the Documentation Templates folder, follow these steps: 1. From the Repository window, select the Documentation Templates folder. 2. Perform one of the following: • Right-click on the Documentation Templates folder, then select Properties. • Select Object»Properties from the menu bar. The Properties window shows the properties of the Documentation Templates folder. The Properties window for the Documentation Templates folder
Selected documentation template level options This section describes the options available at the selected documentation template level. The context menu of a documentation template when it is checked in Following is the list of context menu options when a specific documentation template is checked in: Repository • Repository: The Repository option has three sub menu options: Check In/Check Out, Undo Checkout and History. These are explained below: a. Check In/Check Out: The Check Out option is used to open the selected object for editing. The Check In option saves all changes made to the currently selected object in the repository. To check in a process, refer to Check in button section. To check out a process, refer to Check out button section. b. History: Ultimus BPM Studio supports full object versioning and rollback capabilities. When an object is checked out, edited, and checked back in, the version number for that object increments automatically. Selecting the History suboption allows viewing any changes made to an object. To view the history of the documentation template, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. Perform one of the following: • Right-click the template subnode, then select Repository»History. • Select the object, then select Object»Repository»History from the menu bar. 3. The History - TemplateName dialog box appears, where TemplateName represents the name of the currently selected template. The History - TemplateName dialog box The History - TemplateName dialog box displays the following information: • Version: The Version column specifies the version number of the template, the latest version number being the most current. • Branch: The Branch column specifies the branch number or the minor version number of the object. This column is useful for objects in which its properties can be modified and then published by the process experts through Ultimus Director. Since documentation templates are created and published in Ultimus BPM Studio, this column always displays a zero value for the documentation templates. • Label: The Label column specifies the label assigned to the process at the time of publishing. • User: The User column provides the name of the user who made the change to that particular version. • Date: The Date column specifies the date on which the change was made. • Comments: The Comments column provides any comments that may have been added to the process or object when making the change. If an object is checked out to the current user, the following option is also available: • Retrieve: Selecting the Retrieve button retrieves the selected version of the object and overwrites the checked out (latest) version of the object. 4. Select the Close button to close the dialog box. Security • Security: The Security option allows the BPM Manager to control who can edit, delete, lock, and publish objects. Only the BPM Manager can define object security. The BPM Manager can define object security on all object types in Ultimus BPM Studio. Object security rights are those rights that can be explicitly defined for a specific object. Tip: User access rights for process repositories is controlled through Ultimus BPM Studio Configuration. For more information, refer Configuring Studio Configuration Access Rights section in Ultimus BPM Studio Configuration Help. Assigning object security rights To assign object access rights, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. From the Documentation Templates folder, select the document template subfolder in which its access rights are to be defined. 3. Perform one of the following: • Right-click on the Documentation Templates folder, then select Security»Assign Access. • Select Object»Security»Assign Access from the menu bar. The Assign Access dialog box appears. The Assign Access dialog box By default, the object security is not active for new objects that are created in, or added to, Ultimus BPM Studio. This logic applies to all object types. Thus initially, any user can perform any action (edit, delete, publish, lock) on these objects. Security for these objects can be activated by the explicit setting done through the Security dialog box. Since no access rights are defined initially, an icon () is shown to imply that the object is not secure. 4. From the Users combo box in each row, select a user whom the object rights are to be assigned. This list includes only those users who are given access to the currently selected process repository in Ultimus BPM Studio. The number of rows in the Security dialog box varies depending upon the number of users who have been granted access rights. 5. Select the Edit, Delete, Lock or Publish check boxes in the selected row to define the object security rights for the user selected from the Users combo box. Following is a brief description of each of the object access types: • Edit: If the Edit check box is selected, the specified user can check out and edit the currently selected object. For information on how to edit objects, refer to Edit button section. • Delete: If the Delete check box is selected, the specified user can delete the currently selected object. For information on how to delete objects, refer to Delete button section. • Lock: If the Lock check box is selected, the specified user can lock the currently selected object without having to check out the object. This functionality is useful if it is required to prevent other users from changing an object without having to check out that object, and in doing so, creating a new version of that object. For more information on how to lock objects, refer to Locking an object section. 6. Select the OK button to save these changes or select the Cancel button. Note: Click the Clear All button to clear all the security attributes for the selected object. When clicked, a dialog box appears asking for confirmation before clearing the security attributes. Select the OK button. Locking an object   The Lock option is used to lock an object without having to check out the object. This function is useful if it is required to prevent other users from changing an object without having to check that object out, and in doing so, creating a new version of that object. In order to lock an object, the following conditions must be met: a. The object must be checked in. b. The Lock object security privilege must be enabled for that object and granted for the individual who wants to lock the object. To lock an object, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. From the Documentation Templates folder, select the document template subfolder to be locked. 3. Perform one of the following: • Right-click on the document template subfolder, then select Security»Lock. • Select Object»Lock from the menu bar. Locking an object The object is locked from any editing if it is checked in and the Lock object security privilege is enabled. Delete • Selecting the Delete option deletes the currently selected documentation template object. To delete a documentation template from the Documentation Templates folder, refer to Delete button section. Create Copy • Selecting the Create Copy button creates a copy of a selected version of the template as a new object. Save to Disk... Properties • Selecting the Properties option displays the properties of the selected node. For more information, refer to The Repository window properties section.To view the properties of the selected object, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. From the Documentation Templates folder, select the document template subfolder in which its properties are to be viewed. 3. Perform one of the following: • Right-click on the selected document template subnode, then select Properties. • Select Object»Properties from the menu bar. The Properties window shows the properties of the selected object. The properties for the Documentation Templates folder in the Properties window Context menu options when the selected documentation template is checked out The context menu options are slightly different when the currently selected documentation template is checked out. The context menu of a documentation template when it is checked out Following is the list of context menu options when the document template is checked out (unique to those options when the document template is checked in): Edit • Edit (): Selecting the Edit option allows editing the documentation templates. For further information, refer to Generating documentation section. Rename   • Rename: Selecting the Rename option renames the selected documentation template. In order to rename a template, the following conditions must be met: a. The Edit object security privilege must be enabled for that documentation template and granted for the individual who wants to edit it. b. The object must be checked out. To rename a documentation template in the Documentation Templates folder, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. Perform one of the following: • From the Documentation Templates folder, select the document template node which is to be renamed, then check it out. Right-click on the folder, then select Rename. • Select Object»Rename from the menu bar or click once on the node. Renaming a node in the Documentation Templates folder 3. The template name becomes editable. Enter a new name of the template; the documentation template is now renamed. Note: In order to avoid errors, any special characters (including non-printable ASCII characters) should not be used in the name. Notes • Notes: Selecting the Notes option opens a comprehensive text editor where detailed notes for a process or object can be entered. The Notes editor These descriptive notes can be added to all object types for reference purposes which can be later viewed by other process designers to assist them in designing the business process. To add notes to an object, follow these steps: 1. From the Repository window, expand the Documentation Templates folder. 2. From the Documentation Templates folder, select and right-click the document template node, then select Repository»Check Out option. 3. Right-click on the document template node again and select Notes. The Notes editor appears. 4. Add descriptive notes in the editor. Click the OK button to save the edits, click the Cancel button to discard the changes or select the Reset button to switch to the default settings.
The Repository window properties This section discusses the properties of the objects accessible in the Repository window. All objects possess the same common properties showing the current status. Following is the list of these properties (All properties are listed by their category): • Name: The Name property displays the name of the selected object. • Owner: The Owner property displays the name of the person who owns the selected object. The name is presented in the domain/shortname format for example, MyCompany.com/manthony. • Status: The Status property displays whether the selected object is checked out or is checked in. • Version: The Version property displays the version number of the selected object. • Creation Time: The Creation Time property displays the date and time when the selected object was created. • Modification Time: The Modification Time property displays the date and time when the selected object was last modified. If the object is newly created or has not been modified since it was created, the Modification Time is the same as the Creation Time. • Comments: The Comments property shows any comments added at the time that the selected object was last checked in. Note: All properties are uneditable. The Properties window when the Processes folder is selected
Connectors make it easier to interact with all databases, Web services, CPS Solutions, or mail server connections used in the Ultimus environment. A connector may be defined in Ultimus System Administrator, then another connector with the same name and properties needs to be defined in Ultimus BPM Studio: the database Administrator defines the database log on information for any database used in the Ultimus BPM environment. The Process Designer then uses the same name to reference that database connection in Ultimus BPM Studio for each of the Database Flobots. If the log on information to access a database is changed, this information needs only be changed in Ultimus System Administrator by the system administrator (for live processes), while the referenced connector in Ultimus BPM studio only needs to be updated (by the process designer) when working in Ultimus BPM Studio. The process definition does not need to be changed, as the database log on information is retrieved from the referenced connector. Connectors are available in the Connectors window in Ultimus BPM Studio. The Connectors window may be accessed by View»Windows»Connectors menu item. The Connectors windowhas a Connectors window toolbar and a grid with two columns. The first column displays the names of each connector while the second column displays the description of the connector. The Connectors window
Types of connectors There are different types of connectors: • Database connectors: Database connectors are used for making connections to database repositories accessed in the Ultimus DPA environment. Database connectors support Microsoft SQL Server, Oracle and IBM DB2 data sources. For information on how to create Database connectors, refer to the Creating a Database connector section. • E-mail connectors: E-mail connectors are used to make connections to any IMAP or SMTP e-mail server accessed in the Ultimus environment. For information on how to create E-mail connectors, refer to the Creating an E-mail connector section. • Web service connectors: Web service connectors are used to make connections to any Web service accessed in the Ultimus BPM environment. For information on how to create Web service connectors, refer to the Creating a Web service connector section. • Custom connectors: Custom connectors can be defined to make custom connections to any type of data that can be reused in Ultimus Digital Process Automation (DPA) Suite, for example, numeric values, character stings, etc. Custom connectors can be encrypted. Custom connectors can be read through the GetConnectorList and GetConnectorInformation EIK methods. For more information on these EIK methods, see the Methods in the ConnectorInformation class section in the Enterprise Integration Kit Manual. For information on how to create a Custom connector, refer to the Creating a Custom connector section. • CPS connectors are used to make connections to CPS. For information on how to create CPS connectors, refer to the Creating a CPS connector section.
The Connectors window toolbar Below is a description of buttons on the Connectors window toolbar. • New (): The New list is used to create a new connector. It has the following options to select from: Database, E-Mail, Web Service, Custom and CPS. • Edit (): The Edit button is used to edit the properties of a selected connector. • Delete (): The Delete button is used to delete a selected connector.
Creating a Database connector To create a Database connector, follow these steps: 1. Click the New () button from the Connectors window toolbar, then select the Database option (). The Database Connector dialog box appears. The Database Connector dialog box using SQL Server 2. In the Name: text box, enter the name for the new Database connector. Note: A connector configured in Ultimus BPM Studio is not updated automatically if a corresponding connector in Ultimus System Administrator is changed; if there is a change in connection properties, the connector defined in both Ultimus System Administrator and Ultimus BPM Studio must be updated. Both connectors should be defined with the same name. Once this name has been committed to the connector (by selecting the OK button), it cannot be changed. 3. From the Database Type: combo box, specify which database application is to be accessed in the Ultimus BPM environment using one of the following options: • Select the SQL Server option if the database application to be accessed is a supported Microsoft SQL Server application. • Select the Oracle option if the database application to be accessed is a supported Oracle Server application. • Select the DB2 option if the database application to be accessed is a supported IBM DB2 database. 4. If accessing a Microsoft SQL Server database, the Server: text box is displayed. In the Server: text box, enter the name of the computer hosting the Microsoft SQL Server database. If accessing an Oracle database, the Service Name: text box is displayed. In the Service Name: text box, enter the Oracle service name installed on the computer hosting Ultimus BPM Studio. The Database Connector dialog box using Oracle If accessing an IBM DB2 database, the Database Name: text box is displayedEnter the name of the DB2 database installed on the computer hosting Ultimus BPM Studio. The Database Connector dialog box using DB2 5. In the User ID: text box, enter the user name to connect to the specified database. 6. In the Password: text box, enter the password to access the specified database. 7. If accessing a Microsoft SQL Server database, the Catalog Name: text box and the Use Trusted Connection check box are displayed. In the Catalog Name text box, enter the name of the SQL Server database to which the Database connector is to connect. Select the Use Trusted Connection check box if using a secure connection. 8. In the Description: text box, enter a description about the Database connector. For example, specify that the Database connector connects to the Accounting database. 9. Click the Test Connection button to test the connection to the specified database. Upon a successful connection, the Test Connector dialog box appears. If the connection is not successful, an error message is displayed. The Test Connector dialog box on successful connection 10. Click OK. The Database connector appears in the result window.
Creating an E-mail connector To create an E-mail connector, follow these steps: 1. Open View » Windows » Connectors Click the New () button in the Connectors window toolbar. Select the E-Mail to display the E-Mail Connector dialog box Creating an SMTP connection in E-Mail Connector dialog box 2. In the Name: text box, enter the name for the new E-mail connector to be created. Note: A connector configured in Ultimus BPM Studio is not updated automatically if a corresponding connector in Ultimus System Administrator is changed.If there is a change in connection properties, the connector defined in both Ultimus System Administrator and Ultimus BPM Studio must be updated. Both connectors should be defined with the same name. Once this name has been committed to the connector (by clicking OK), it cannot be changed. 3. SMTP Settings: Enter the following information: a. Server: In the Server: text box, enter the name of the e-mail server or use the browse button beside the Server: text box to browse the network for it. b. Authentication Type: Select one of the following options: • No Authentication: Select the No Authentication option so the e-mail server sends notifications without authentication. • Authentication using SMTP: Enter the following information: • In the SMTP port: text box, enter the SMTP port for the e-mail server. • In the From: text box, enter from whom the e-mail notification is to come. For example, this may be an individual, an administrator, or the name of a Flobot/Automated Activity. • In the User ID: text box, enter a valid log on name for authentication. • In the Password: text box, enter the corresponding password for authentication. • The Secure checkbox has been added to support applications using Microsoft® Exchange Online as part of Office365. If this checkbox is checked, communication between the client and the Exchange Online server is encrypted. Users can define a port that will execute the encrypted communication. 4. In the Description: text box, enter a description and/or the properties about the E-mail connector. 5. Click the Test Connection button to test the connection. Upon a successful connection to the configured e-mail server, the Test Connector dialog box appears. If the connection is not successful, an error message is displayed. The Test Connection dialog box on successful connection 6. Click OK. The connection is now established.
Creating a Web service connector To create a Web service connector, follow these steps: 1. Click the New () button from the Connectors window toolbar, then select the Web Service option (). The Web Service Connector dialog box appears. The Web Service Connector dialog box 2. In the Name: text box, enter the name for the new Web service connector to be created. Note: A connector configured in Ultimus BPM Studio is not updated automatically if a corresponding connector in Ultimus System Administrator is changed; if there is a change in connection properties, the connector defined in both Ultimus System Administrator and Ultimus BPM Studio must be updated. Both connectors should be defined with the same name. Once this name has been committed to the connector (by selecting the OK button), it cannot be changed. 3. In the Web Service URL: text box, enter the URL of the Web service that is to be used in the connector. 4. Select the Secure Web Service check box if connecting to a secure Web service. 5. If connecting to a secure Web service, enter the user name and password to access the secure Web service in the User ID: and Password: text boxes, respectively. 6. In the Timeout: text box, specify how long (in seconds) a Web service connection is maintained with no activity before the connection session is terminated. 7. In the Description: text box, enter a description and/or the properties about the Web service connector. 8. Click the Test Connection button to test the connection to the specified Web service. Upon a successful connection, the Test Connector dialog box appears. If the connection is not successful, an error message is displayed. The Test Connector dialog box on successful connection 9. Click OK.
Creating a Custom connector To create a Custom connector, follow these steps: 1. Click the New () button on the Connectors window toolbar, then select the Custom Connector option. The Custom Connector dialog box appears. Custom Connector dialog box 2. In the Name text box, enter the name for the new Custom connector. 3. Click under the Name field and enter the name of the record. 4. Click in the Value column and enter the value of the record. If required, you may add further records to the Custom connector. Note: If you select the Encrypt option for a record, its value is shown with asterisks (*) and will not be visible to users. 5. In the Description text box, enter a short description of the Custom connector if needed. 6. Click OK.
Creating a CPS connector CPS connectors are used to connect to any CPS Form or CPS Service. Caution: Custom Form URLs are not supported with for CPS Forms. Therefore, when defining the Default Forms for Process Steps using Ultimus CPS, use CPS connectors. To create a CPS connector, follow these steps: 1. Click the New () button from the Connectors window toolbar and select the CPS option (). The CPS Connector dialog box appears. 2. In the Name: text box, enter the name for the new CPS connector to be created. 3. Enter the CPS connector URL. CPS supports two types of URLs: a. CPS Form URL, for example: • http(s)://<cps server>/UltimusCPS/Home/Fullscreen#/sform/?SolutionName=HR (when operating CPS on a separate machine from UATS) • /UltimusCPS/Home/Fullscreen#/sform/?SolutionName=HR(when operating CPS together with UATS on the same server) b. CPS Service URL, for example http://<cps server>:8733/CpsService/CpsService.svc Caution: Do not use http(s)://<cps server> URL prefix in Ultimus environments that operates both Ultimus CPS and UATS. 3. In the Description text box, enter a short description of the CPS connector if needed.
Editing connector properties To modify the properties of an existing connector, follow these steps: I. In the Connectors window, select the connector name from the list of connectors. 2. Click the Edit () button from the Connectors window toolbar. The dialog box to configure that connector type appears. 3. Edit the connector configuration, then click OK to accept changes. Note: The connector name in the Name: text box, once defined, cannot be edited.
Deleting a connector To delete a connector, follow these steps: I. In the Connectors window, select the connector name from the list of connectors. 2. Click the Delete () button from the Connectors window toolbar. A message appears to confirm that the connector is to be deleted. 3. Select Yes to delete the connector; select No to not delete the connector. Caution: Be careful when deleting connectors. Once deleted, connectors cannot be recovered.
This section briefly introduces the Event Log window. The Event Log window is used for viewing the log messages during simulation, publishing a process and other processing done in Ultimus BPM Studio. This includes displaying error messages as a result of a consistency check (when performed), output and error messages while getting the process history. The Event Log window is a dockable window which can be detached from the workspace and moved to other areas on the screen or attached at other borders of Ultimus BPM Studio. The Event Log window interface The Event Log window consists of these default columns: • Type: The Type column displays the type of the message. There are three types of log entries: information, warning, and error. Each of these is discussed below: a. Information (): An information log entry is for informative purposes only. b. Warning (): A warning log entry has a warning message associated with it. c. Error (): An error log entry has an error message associated with it. • Date: The Date column displays the date and time in which the log had been created. • Message: The Message column contains the message or details of the text that appears against the log entry. • Category: The Category column displays the object or the category against which the log entry is made. • Source: The Source column displays the name of the particular source for which information is being displayed. The log entries in the Event Log window can be saved for future reference (for such purposes as troubleshooting and maintenance) and they can also be deleted. Clearing log entries To clear all log entries from the Event Log window, follow these steps: 1. Select any log entry from the Event Log window. 2. Right-click on it, then select Clear All. Clearing log entries from the Event log window Caution: Be careful when using the Clear All function. This function removes all the displayed log entries. Once cleared, those log entries cannot be recovered. Saving log entries To save log entries, follow these steps: 1. Select one or more log entries. If all the log entries are to be selected, right-click, then select Select All. Selecting all log entries 2. Right-click, then select the Copy option. Selecting the Copy option to copy the selected log entries 3. Open any text file, paste the copied log entries and save the file.
Operations performed when a business process is checked in Once a business process is cleared for check-in, a number of consistency checks are performed to ensure that the business process and its components function as desired when published on Ultimus BPM Server. Consistency checks are performed every time a business process is checked-in if the Verify on Check In option is selected. Errors, if any, are recorded in the Event Log window. Following is a list of consistency checks performed when a process is checked-in: a. Build mode consistency checks: • Check whether all steps have valid recipients assigned to them. • Check whether there is a valid organization specified. • Check whether all Flobot/Automated Activity steps are trained. • Check whether all Maplet/Subprocess steps are trained. • Check whether the XML schema elements being used in step properties or elsewhere in Build mode have been defined in the XML schema. b. XML schema editor consistency checks: • Check syntax for defined formulas. • Verify the XSD is valid. • Verify the XML is valid. • Check whether all process attachments have valid paths. • Verify linking is correct. c. Business rules consistency checks: • Check whether the aliases used in business rules exist. • Check whether all actions configured in business rules are valid. • Check whether the user defined actions used in business rules exist. • Check whether User steps being referenced in business rules exist. d. Ultimus Form consistency checks: • Check whether the database Connectors used in an Ultimus Form design exist. • Check whether XML schema elements linked to form controls exist. • Check whether the used Form Object Libraries exist. e. User defined actions consistency checks: • Check whether XML schema elements linked in the user defined actions exist. • Check whether all methods specified in the training of user defined actions are valid. • If Web service actions are used, check whether the specified Connector, if any, exists. If an error is encountered during any of these checks and verifications, an error message displays. Consistency check as failed The detailed error is recorded in the Event Log window. If the check in verifications are successful, the business process is checked in. The business process is now available for publishing or for other process designers to revise.
This section discusses the Organizations dialog box. The Organizations dialog box is used to search and browse for individuals in the organization. This may be accomplished in different ways depending on how the User Search and Browse dialog box is used within Ultimus Digital Process Automation (DPA) Suite. The User Search and Browse dialog box Functionality within the Organizations dialog box depends on how it is used at any given time. This section discusses all possible functionality. Note: The Organizations window can be used by selecting the View»Windows»Organizations menu option. In overview, an individual within the organization may be selected in using the following guidelines: a. Search method: An individual, chart or group may be sought using one of three searching methods: • Browsing • Searching • Advanced searching b. Organization: Within each of these searching methods, an individual, job function, chart or a group known within the organization may be sought in one of the following two ways: • Business organization: An individual, job function, chart or a group may be searched against any existing business organization that has been created in Ultimus Organization Charts. • Domain name: An individual, job function, chart or a group may be searched against any Directory Organization structure accessible to Ultimus Digital Process Automation (DPA) Suite. c. Category: Depending on which search method and organization is selected, an individual may be sought in up to five ways: • Charts: If selecting to search by either business organization or domain, the entire membership of a chart may be selected. • Group Members: If selecting to search by domain, an individual may be sought within groups of a Directory Organization. • Groups: If selecting to search by either business organization or domain, the entire membership of a group may be selected. • Job Functions: If selecting to search by either business organization or domain, an individual may be sought by his or her primary job function. • Users: If selecting to search by either business organization or domain, an individual may be sought by user name. How to perform each search method is discussed below. Each procedure assumes the Organizations dialog box is in focus. Browsing To search for an individual, job function, chart or group using Browse, follow these steps: 1. Click the Browse button. Using the “browse” method 2. From the Organization: combo box, select one of the following options: a. Business Organization: Select the Business Organization option to search through Ultimus business charts. b. Domain: Select a domain in which to search Directory Organization structures. 3. From the Look For combo box, select the category in which to search for the user. There are five potential categories available, though all may not be available depending on the selected Organization option and the Ultimus BPM Studio function that launched the Organization dialog box. The following five category options are potentially available: • Charts: If selecting to search by either business organization or domain, the entire membership of a chart may be selected. • Group Members: If selecting to search by domain, an individual may be sought within groups of a Directory Organization. • Groups: If selecting to search by either business organization or domain, the entire membership of a group may be selected. • Job Functions: If selecting to search by either business organization or domain, an individual may be sought by his or her primary job function. • Users: If selecting to search by either business organization or domain, an individual may be sought by user name. 4. In the list box, browse within the specified category for the individual, job function, chart, or group being sought. 5. Click the OK button. Searching To search for an individual, job function, chart or group using the “search” method, follow these steps: 1. Click the Search button. Using the “search” method 2. From the Organization: combo box, select one of the following options: a. Business Organization: Select the Business Organization option to search through Ultimus business charts. b. Domain: Select a domain in which to search Directory Organization structures. 3. From the Look For combo box, select the category in which to search for the user. There are four potential categories available, though all may not be available depending on the selected Organization option and the Ultimus BPM Studio function that launched the search feature. The following four category options are potentially available: • Charts: If selecting to search by either business organization or domain, the entire membership of a chart may be selected. • Groups: If selecting to search by either business organization or domain, the entire membership of a group may be selected. • Job Functions: If selecting to search by either business organization or domain, an individual may be sought by his or her primary job function. • Users: If selecting to search by either business organization or domain, an individual may be sought by user name. 4. In the Criteria text box, enter a text string to search against. Tip: If necessary, use an asterisk (*) as a wild card character in your searches to broaden your search results. 5. Click the Find button. 6. In the list box, browse within the specified category for the individual, chart or group being sought. 7. Click the OK button. Advanced searching To search for an individual, job function or group using the Advanced Search, follow these steps: 1. Click the Advanced Search button. Using the “advanced search” method 2. From the Organization: combo box, select one of the following options: a. Business Organization: Select the Business Organization option to search through Ultimus business charts. b. Domain: Select a domain in which to search Directory Organization structures. 3. If searching against a domain, use any of the following options: a. From the OU: combo box, specify the Organizational Unit based on the selected domain. b. From the Look for: combo box, specify any or all of the following options: • Users: Select the Users check box to search against user short names. • Full Names: Select the Full Names check box to search against user full names. • Job Functions: Select the Job Functions check box to search against Active Directory titles. • Emails: Select the Emails check box to search against e-mail addresses. c. From the Search Criteria group, select one of the following options: • Define: Select the Define option to define specific search parameters based on a user short name, a user full name, an Active Directory title, and/or an e-mail address. Select the Define combo box to specify any or all of the following search parameters: a. Users: Beside the Users attribute table cell, replace the asterisk with a user short name to search against. b. Full Names: Beside the Full Names attribute table cell, replace the asterisk with a user full name to search against. c. Job Functions: Beside the Job Functions attribute table cell, replace the asterisk with a job function name to search against. d. Emails: Beside the Emails attribute table cell, replace the asterisk with an e-mail address to search against. Each search parameter entered is incorporated into the Define combo box. • Custom: Select the Custom option to define a custom search parameter. Enter that search parameter into the Custom text box. 4. If searching against a business organization, use any of the following options: a. From the Look for: combo box, specify any or all of the following options: • Users: Select the Users check box to search against user short names. • Full Names: Select the Full Names check box to search against user full names. • Job Functions: Select the Job Functions check box to search against Active Directory titles. • Charts: Select the Charts check box to search against charts. b. From the Search Criteria group, select one of the following options: • Define: Select the Define option to define specific search parameters based on a user short name, a user full name, an Active Directory title, and/or an e-mail address. Select the Define combo box to specify any or all of the following search parameters: a. Users: Beside the Users attribute table cell, replace the asterisk with a user short name to search against. b. Full Names: Beside the Full Names attribute table cell, replace the asterisk with a user full name to search against. c. Job Functions: Beside the Job Functions attribute table cell, replace the asterisk with a job function name to search against. Each search parameter entered is incorporated into the Define combo box. 5. Click the Find button. 6. In the list box, browse for the individual being sought. 7. Click the OK button.