ultimus_docs
stringlengths
52
24.9k
Assigning users to a role Note: The DEFAULT ROLE contains all Ultimus DPA Portal users. You can not modify its content in the Role section. Tip: The Search function at User Role Handling works differently from the other filtering functions on the Roles page. See tips in Using the Search function. Tip: For more information about handling user lists, see section Managing Ultimus DPA Portal users. The Role User Handling section (Roles page) 1. In the Roles section, select a role to work with. 2. In the User Role Handling section, select the users to assign from the Not Assigned box, then move them to the Assigned box. You can move list entries between the boxes by selecting one or more entries and using the arrows as follows: • To select multiple consecutive entries, hold the SHIFT key down while selecting the first and last entries of the list of entries you wish to move. • To select multiple entries, you can also hold the CTRL key down while selecting the entries to be moved. • Clicking on the double arrow moves the entire content of the box to the other box. • Use the Search function for filtering and searching. For more information on how to use the Search function, see section Using the Search function. 3. Click Update to save changes.
Assigning Templates to a Role (Role Template Handling) Note: Before this step, make sure the Template has been created. For more information, see section Creating a new Template. In the Role Template Handling section, you can define which templates can be used by users assigned to a specific Role in Ultimus DPA Portal. For more information on handling templates, see section Managing templates. Adding templates to a role (Role Template Handling) To assign one or more Templates to a User Role, do the following: 1. In the Roles section, select a Role to work with. 2. Go to section Role Template Handling. 3. Select the existing Template(s) from the list in the Not Assigned box. Tip: See also Creating a new Template. 4. Move the selected template(s) to the Assigned box. Tip: You can move list entries between the boxes by selecting one or more entries and using the arrows as follows: • To select multiple consecutive entries, hold the SHIFT key down while selecting the first and last entry of the list of entries you wish to move. • To select multiple entries, you can also hold the CTRL key down while selecting the entries to be moved. • Clicking on the double arrow moves the entire content of the box to the other box. • Use the search box to filter to entries. The results are shown as you type. To display the full list again, delete the text from the search box. 5. Click on Update to save changes.
Assigning Navigation Pane content to a role In the Role Navigation Node and Application Handling section of the Roles page of the UATS Administrator, you can assign third-party applications and other Navigation Pane items to user roles. Tip: For more on adding navigation nodes and applications to the DPA Portal interface, see section Adding an application/navigation node. Role Navigation Node and Application Handling 1. Go to the top of the page. In the Roles section, select the role to work with. 2. In the Not Assigned box, select the application to assign, then move it to the Assigned box. Note: To assign a Navigation Pane item to a role, you must create the item first on the Navigation & Applications page. For instructions on how to assign a Navigation Pane item to a user Role, see section Adding an application/navigation node. Tip: Items containing a hash-mark (#) are grouped into navigation nodes. The navigation node names are visible before the hash-mark(s). See also Organizing DPA Portal Navigation Pane content (navigation nodes). You can move list entries between the boxes by selecting one or more entries and using the arrows as follows: • To select multiple consecutive entries, hold the SHIFT key down while selecting the first and last item of the list of entries you wish to move. • To select multiple entries, you can also hold the CTRL key down while selecting the entries to be moved. • Clicking on the double arrow moves the entire content of the box to the other box. • Use the Search function for filtering and searching.The results are shown as you type. To display the full list again, delete the text from the search box. 3. Click Update to save changes. The selected applications are now assigned to the role. To group and define their display order, see Changing the display order of the Navigation Pane items.
Changing the display order of the Navigation Pane items In the Navigation Node and Application Sequence Handling section, you can change the display order of third-party applications and other Navigation Pane items in Ultimus DPA Portal. Note: Regrouping or removing default Navigation Pane elements affects product usability. For the list of these type of elements, see section Default Navigation Pane elements. Tip: If an item does not appear in the list: verify if it has been assigned to user role(s). For instructions, see section Assigning Navigation Pane content to a role. Please also note that to assign a Navigation Pane item to a role, you must create the item first on the Navigation & Applications page. For instructions, see section Adding an application/navigation node. To change the display order of applications/navigation nodes in Ultimus DPA Portal, do the following: 1. Drag&Drop to reorder the applications. 2. Click on Update to save your changes. The changes will take effect with the next login of the DPA Portal users in the selected role. Navigation Node and Application Sequence Handling - List (example) The list of Navigation Pane items also displays information about the position of each item. (In our example, we take a three-level list in the Navigation Pane, with Views as a main group, Central_Folders as a sub-group, and CF1 as a sub-group of Central Folders. ) • A hash-mark (#) and a number at the beginning of the row keep count of the navigation pane items. For example, #009 is the ninth item in the sequence list. • The name of a navigation node is shown before a hash-mark (#). For example, at item Views#Central_Folders#CF1: CF1 is in the group named Central_Folders ( parent), which is in the group named Views. • Items that are grouping other items are marked with a double-leaf () icon.For example, both Views#Central_Folders and Views# would be marked with double-leaf icons, because these are groups, containing another list item(s). • Items that are not grouping other items are marked with a single-leaf (). For example, in the list, item Views#Central_Folders#CF1 would be marked with a single-leaf, because CF1 is not a group (it is on leaf-level). • The letter L followed by a number shows the position of the list item in the hierarchy as it appears in the Navigation pane.For example an item marked with L01 is on the first level of the structured list in the DPA Portal Navigation Pane, while L02 is on the second level (also meaning it is included in a group. In our example, Views# is on L01, Views#Central_Folders is on L02 and Views#Central_Folders#CF1 is on L03. Tip: See also Organizing DPA Portal Navigation Pane content (navigation nodes).
Default Navigation Pane elements This section lists the default Navigation Pane elements. Note: Regrouping or removing these items affects product usability. • Requests# • Requests# - marked with the double-leaf () icon: group. • Requests#Initiate and Requests#Queue objects: single-leaf () objects that must be grouped by placing them under the respective node (as shown on Figure 22). • Tagged Views under Initiate (placement on the third level) • Tasks# • Tasks#Inbox • Tasks#Queue • Tasks#Assigned • Tasks#Completed • Views# • Views#Central Folders# • Views#Shared Folders# • Views#User Folder#
Setting General and Task operation permissions for user Roles Note: Before making changes, ensure you understand the relation between the various permission as well as their combined effect to DPA Portal user actions. The General user permissions section of the Roles page in UATS Administrator is used to grant or restrict basic permissions for users in the selected role. General user permissions In the Task operation permissions section, you can define which operations are available in the specific Ultimus DPA Portal Views for the users in the selected Role. Task operation permissions To set General an Task operation permissions for the DPA Portal users, do the following: 1. Open the Roles section in UATS Administrator and select a role to work with (on the top of the page). 2. The General user permissions and the Task operation permissions sections, the buttons show the current setting. 3. Click on the buttons as many times as required to set user permissions to Default, Allow, or to Deny. Note: The Deny setting has priority over the Allow permission. This applies to all user Roles including the DEFAULT ROLE, as well as to interdependent functions. Example 1:In in section General user permissions, the Future Task Management is set to Deny for the DEFAULT ROLE and to Allow for the MyAdmins role.As a result, the FTM menu will not be visible for DPA Portal users in the MyAdmins Role - because every DPA Portal user is a member of the DEFAULT ROLE, and the Deny setting for the DEFAULT ROLE overrides the Allow permission set for the MyAdmins role. Example 2:The default permission settings allow the DPA Portal users to automatically assign Tasks to themselves by simply opening them in Queued View. This requires the Open from Queue and the Assign to self permissions, together. If Open Task is set to Allow (or Default), but Assign to self is set to Deny, then the DPA Portal users in the specified Role will be able to open the tasks in Queued View, but the opened task will not be assigned to them with this operation, therefore they can fill in the task form, but will not be able to Submit it.
Managing the Ultimus DPA Portal Navigation Pane content(Navigation & Applications) On the Navigation & Applications page of the UATS Administrator, you can manage third-party applications and other Navigation Pane content into navigation nodes for the Ultimus DPA Portal users. • Organizing DPA Portal Navigation Pane content (navigation nodes) • Adding an application/navigation node • Editing an application/navigation node • Deleting an application/navigation node • Managing application parameters • Localizing application names and navigation node names Navigation & Applications page of UATS Administrator Tip: See also Managing application parameters.
Organizing DPA Portal Navigation Pane content (navigation nodes) Tip: For instructions on changing the Navigation Pane item’s display order, as well as on assigning third-party applications and navigation nodes to the Ultimus DPA Portal users, see section Roles. This section explains the basic principles to consider when organizing third-party applications and other Navigation Pane items into navigation nodes in the Ultimus DPA Portal. • Overview of Navigation Nodes • Navigation Pane element types • Special URLs • Fixed elements
Overview of Navigation Nodes Third-party applications and other Navigation Pane items can be grouped into maximum four-level deep lists that are displayed as collapsible navigation nodes in the Ultimus DPA Portal. The path specified in the Name field of an Application/Navigation node shows the grouping structure, where the node names are followed by a hash-mark (#). For example: • The NameToplevelNode#2ndLevelNode#3rdLevelNode#Application1creates an application on the fourth level of the list. • The Name ToplevelNode#Application2 creates another application on the second level of the same list. Applications in Navigation Nodes - Node hierarchy example Tip: You can define application grouping and navigation nodes when adding the item as new (as described in section Adding an application/navigation node), or when editing the path later (as described in section Editing an application/navigation node). Tip: After creating an application/navigation node, you must assign the new item to a Role For instructions, see section Assigning Navigation Pane content to a role. Tip: To change the display order of third-party applications and navigation nodes on the DPA Portal, see Changing the display order of the Navigation Pane items.Please note that the location of certain Navigation Pane elements are fixed. Tip: Empty navigation nodes are not displayed in the Ultimus DPA Portal Navigation Pane.
Navigation Pane element types There are two types of Navigation Pane elements in the hierarchy displayed in the DPA Portal Navigation Pane: • Groups (navigation nodes): DPA Portal Views/Folders and third-party applications may optionally be organized into groups. These items can be third-party applications, DPA Portal Views/Folders, or other Groups. Groups are marked with a double-leaf icon () in the Navigation Node and Application Sequence Handling list.Certain default elements are not recommended to be reorganized. For a list of these elements, see section Default Navigation Pane elements. • Single elements are items that are not groups themselves. At the same time, they may optionally be included in a group, depending on node grouping settings. These are the leaf-level elements that are marked with a single-leaf () icon in the Navigation Node and Application Sequence Handling list. These items can be third-party applications, or DPA Portal Views/Folders. Groups • Clicking on the name of a group in the DPA Portal Navigation Pane opens the item group, but does not display a task list. • The name of a group is followed by a hash-mark (#) in the Name field. • The URL field is allowed to contain a special URL, or left empty. • Can be automatically generated from a Leaf/Application node. • Placement: only in the Navigation Pane. Single elements • Their names are not followed by a hash-mark (#) in the Name field. • The URL field contains a special URL. For the list of special URLs, see section Special URLs. • Leafs must be included in a navigation node and assigned to one or more Role(s) otherwise they are not displayed in the Ultimus DPA Portal Navigation Pane. • Placement: only in the Navigation Pane. Adding Applications to the Navigation Pane hierarchy (grouped or not grouped): • Third-party Application names are not followed by a hash-mark (#) in the Name field, because they can not be groups themselves. Groups are only for organizing DPA Portal Views/Folders and Third-party applications, creating hierarchy in the DPA Portal Navigation Pane. Applications are on leaf-level, marked with a single-leaf () icon in the Navigation Node and Application Sequence Handling list. • However they are also leaf-level items, Ultimus CPS Application names are followed by a hash-mark (#). • When adding an application, the URL field must be added a regular URL (empty, https, http, ftp, etc.). Special URL can not be used. • Applications must be assigned to one or more Role(s), otherwise they are not displayed in the Ultimus DPA Portal Navigation Pane. • Placement: Navigation Tree, Settings Menu Task List Three Dot Dropdown menu, or Bottom of Login Screen - Public. Please note that accessing applications from the Login screen may not require an additional authentication step from the DPA Portal user. • Hierachy (grouping into navigation nodes) can be created only if the placement is navigation-pane, or both. • For instructions on adding applications to the Navigation Pane hierarchy, see section Adding an application/navigation node.
Special URLs The following Navigation Panel items can be assigned special URLs: • group://tasks • group://applications • group://folder • group://none • group://userfolders • group://sharedfolders • group://adminfolders Special URLs for Views in the Ultimus DPA Portal Special URLs are Ultimus-specific parameters in URL-like notation, added to the URL field for DPA Portal Navigation Pane items in UATS Administrator. The type of the item (e.g. view) is before the :// . The :// is followed by the name of the item. A semicolon (;) after the name of the item describes the behavior of the item, for example view://completed;delayloading means that the list of tasks in the Completed view will populated upon clicking on the name of the Completed View in DPA Portal. • view://inbox • view://queue • view://assigned • view://completed;delayloading • tag://initiate/MyTagName • view://initiate;tags or view://initiate;subtagsBehavior configured to a Tagged View: the Tagged View will be visible on the same level as the Initiate View or as a child, depending on this setting.
Fixed elements There are default, built-in Navigation Pane elements that are predefined, as well as their placement. For the list of these type of elements, see section Default Navigation Pane elements. Note: Regrouping or removing default Navigation Pane elements affects product usability.
Adding an application/navigation node 1. On the Navigation & Applications page, click on New Node/Application. The Add New Node/Application dialog box appears. Add New Node/Application dialog 2. Enter the required information and settings into the following fields: • Name: enter the name of the third-party application or navigation node as required to appear in Ultimus DPA Portal for the end-user. Tip: To group the applications and other Navigation Pane elements in maximum four-level navigation nodes, add a hash-mark (#) after the node name (before the application name). Examples: ApplicationGroupName#Application, ToplevelNode#2ndLevelNode#3rdLevelNode#Item See also section Organizing DPA Portal Navigation Pane content (navigation nodes). • Require Auth: Place a check-mark to require authentication for accessing the application. • Url: Enter the URL of the application (if it is not an application, leave it empty). • Placement: Select the placement of the new item in the Ultimus DPA Portal: Navigation Tree, Settings Menu, Task List Three Dot Dropdown menu, or Bottom of Login Screen - Public. Note: Applications placed in the Bottom of Login screen require authentication for accessing the application if the Require auth is check-marked. • Embed: Set ON for the application to open inside the task list pane of the Ultimus DPA Portal, and set OFF to open in a new window. • Icon Name: Enter a name for the icon to display in DPA Portal. This field is mandatory. • Icon Image: You can either use the default icon (e.g. for Applications), or define a unique icon to display in the Portal. a. Click on Default Icon to use the default icon. b. To use a custom icon, locate the icon file using Browse, select the icon file, then click on the Upload button. The image file will be saved to the proper UATS directory, and its preview is displayed under the Browse button. Tip: For proper display, select a square image file, otherwise the image file will be compressed to a square format. Tip: Ultimus DPA Portal with UATS supports version 5.12 Font Awesome icons. For more information and the available icon packages, please refer to their website. 3. Click Save changes. Tip: For instructions on how to define application parameters, see section Managing application parameters. 4. The next step is to assign this new item to a user Role. For instructions on how to assign the new list item to a user Role, see section Assigning Navigation Pane content to a role. Tip: Section Node/Application assigned to Roles (bottom-right section of the Roles page) list the Role(s) already assigned to the selected Navigation node.
Editing an application/navigation node Tip: The Name field is editable, this allows to change the place of the item in the display hierarchy (DPA Portal, Navigation Pane). This way the navigation node grouping can be redefined easily. When done, continue to section Assigning Navigation Pane content to a role. 1. On the Navigation & Applications page, click on Edit Node/Application. The Edit Node/Application dialog box appears. 2. Make the necessary changes - for instructions, please refer to section Adding an application/navigation node. 3. When done, Click Save changes.Click on Close to exit without saving.
Deleting an application/navigation node 1. On the Navigation & Applications page, click on Delete Node/Application. 2. In the CONFIRM dialog, click Yes to confirm that you want to delete the selected application/navigation node. Click on No to cancel the operation.
Managing application parameters Third-party application parameters depend completely on the application. The Ultimus DPA is unable to read and automatically apply these third-party application parameters. Therefore, once a new application is created, the next is to define behavior parameters to it. For configuring third-party applications, administrators must be know the list of parameters and the configuration values in advance. • Adding a new parameter • Editing a parameter • Deleting a parameter
Adding a new parameter When adding a new parameter, you can use predefined parameter values that will be replaced with the specific values when the URL is generated: • %ssid% or %sys_ssid%: Returns the session ID of the primary BPM Server. • %ssid_X%: Returns the session ID of the specified BPM Server (X is the BPM Server ID). • %allssid%: Returns the session ID of all the assigned BPM Servers as a list of values, URL-encoded. For example ssid[1]=ABCDEF,ssid[2]=2ABCDEF2 • %sys_hostname%: Returns the host name of the primary BPM Server. • %sys_username%: Returns the user name of the logged-in user. • %sys_fullname%: Returns the full display name of the logged-in user. • %sys_language%: Returns the current language. • %sys_view_selected%: Returns the name of the current view, for example Initiate, Inbox, etc. The name of any of the columns from the current matching View can be used as predefined value as well. For example, the following parameter value will be translated as &MyParam=Urlaub%20Prozess%20Starten : UATS Admin » App » Parameter » Name: MyParam Value: sys_processname You can add the names of Processes and Steps both as localized or not localized using the following parameters: Note: Only Process and Step names are localized. Note: Set encryption: If specific parameters (e.g. processname) are configured, third-party applications will receive Task/user/session data from the DPA Portal. You can set to pass the specified data to the third-party application in an encrypted/secure way. To do this, add an asterisk (*) in front of the parameter name, for example: *sys_processname. • sys_processname: Adds the Process name (localized). • sys_processname_original : Adds the Process name as defined in BPM Studio (not localized) • sys_step_label: Adds the Step name (localized). • sys_step_label_original: Adds the Step name as defined in BPM Studio (not localized). • sys_incident_number : Adds the incident number. To add a new parameter, do the following: 1. In the list, select the application to which you want to add a new parameter. 2. In the Application Parameters section, click New Parameter. The Add New Parameter dialog box appears. Add New Parameter dialog 3. Name: Enter the name of the new parameter, that is, the data that is to be retrieved from the third-party application. 4. Value: Enter the value of the parameter: the value that should be retrieved from the third party application. For example, for a search query, enter the value that should be searched in the application. 5. Click on Save changes.
Editing a parameter 1. In the Application Parameters section, select the required parameter, then click Edit Parameter.The Edit Application dialog box appears. 2. As required, edit the name or the value of the parameter. 3. Click Save changes.
Deleting a parameter 1. In the Application Parameters section, select the required parameter, then click Delete Parameter. 2. In the verification dialog, click Yes to verify that you want to delete the selected parameter.
Localizing application names and navigation node names Third-party applications names as well as navigation node names can be localized, translated for the Ultimus DPA Portal users. The translations can me managed in the Translation Items section. • Adding Translation Item • Editing a Translation Item • Deleting a Translation Item Adding Translation Item Tip: You can add as many translation items as required.   Note: When an Application or a Navigation Node is deleted, its translations are deleted as well. 1. Select an Application or a Navigation Node to work with. 2. Go to the Translation Items section, and click on New Translation Item.The Add New Localization dialog box appears. 3. Select a Language from the drop-down list, and type in your translation. Managing Applications and Navigation Nodes - Add New Localization 4. Save your changes. If the respective Application or Navigation Node is selected in the Navigation Nodes and Applications box, its available translations are listed in the Translation Items box, with their language code. List of available Translation Items Editing a Translation Item 1. Select an Application or a Navigation Node to work with.The list of the available translations appear in the Translation Items box automatically. 2. In the Translation Items section, select the entry to modify. 3. Click on the Edit Translation Item button. The Edit Localization dialog box appears. 4. Change the translation as required. 5. When complete, click on Save Changes. Deleting a Translation Item 1. Select an Application or a Navigation Node to work with.The list of the available translations appear in the Translation Items box automatically. 1. In the Translation Items section, select the translation to delete. 2. Click on the Remove Translation Item button. 3. A pop-up message appears asking you to confirm your choice.Click on Yes to delete the translation. Click on No to keep the translation.
Process Step Localization This section outlines how to localize BPM Process and Step names for Ultimus DPA Portal using the Process Step Localization page of UATS Administrator. Note: Only the BPM Process and Step names can be localized this way. Process Step Localization window To translate BPM Process and Step names, open Process Step Localization from the Main menu. All BPM Processes from all connected BPM Servers will be listed in the Process List window. Tip: Use the Refresh Processes button to refresh the list of Processes: open the drop-down list by clicking on the button, and select a BPM Server. Tip: You can add as many translations as required. The following localization functions are available: • Supported languages • Adding a Process name translation • Editing a Process name translation • Deleting a Process name translation • Adding a Step name translation • Editing a Step name translation • Deleting a Step name translation   Supported languages The web.config file for both applications contain the list of supported languages. All of them are displayed by default by both applications. You can remove unnecessary list items from the respective web.config file from the following key: <add key="SupportedLanguages" value="ar,de,en-us,en,es,fr,hu,it,ja,lv,nl,pt-br,ru,ur,zh-cn,zh-tw" />   Adding a Process name translation Tip: You can add as many translations as required. 1. In the Process List box, click on a Process to work with. 2. Scroll down to the Process Translations section. 3. Click on the New Translation Item button. The Add New Localization dialog box appears. 4. Select a Language from the drop-down and add your translation in the Translation field. Add New Localization dialog - Process 5. Save your changes. If the respective Process is selected in the Process List box, its available translations are listed in the Process Translations box, with their language code. List of available Process name translations Editing a Process name translation 1. In the Process List box, click on a Process to work with.The list of the available translations appear in the Process Translations box automatically. 2. Scroll down to the Process Translations section. 3. Select the translation to work with and click on the Edit Translation Item button. 4. The Edit Localization dialog box appears, where you can edit the translation as required. 5. When complete, click on Save Changes. Deleting a Process name translation 1. In the Process List box, click on a Process to work with.The list of the available translations appear in the Process Translations box automatically. 1. Scroll down to the Process Translations section, and select the translation to work with. 2. Click on the Remove Translation Item button. 3. A pop-up message appears asking you to confirm your choice.Click on Yes to confirm. Click on No to keep the translation. Adding a Step name translation Tip: You can add as many translations as required. 1. In the Process List box, click on a Process to work with.The list of the Process Steps appear in the Step List box automatically. Tip: Use the Refresh Steps of Process button to refresh the list of Steps. 2. In the Step List box, select a Step name to work with. 3. Scroll down to the Step Translations section. 4. Click on the New Translation Item button. The Add New Localization dialog box appears. 5. Select a Language from the drop-down and add your translation in the Translation field. Add New Localization dialog - Step 6. Save your changes. If the respective Process is selected in the Process List box, the available translations to the Process Steps will be displayed in the Step Translations box, with their language code. List of available Step name translations Editing a Step name translation 1. In the Process List box, click on a Process to work with.The list of the Process Steps appear in the Step List box automatically. 2. Select the Process Step to work with from the Step List. 3. In the Step Translations section, select the translation to work with. 4. Click on the Edit Translation Item button. 5. In the Edit Localization dialog box, edit the translation. 6. Click on Save Changes. Deleting a Step name translation 1. In the Process List box, click on a Process to work with.The list of the Process Steps appear in the Step List box automatically. 2. Select the Process Step to work with from the Step List. 3. In the Step Translations section, select the translation to work with. 4. Click on the Remove Translation Item button. 5. A pop-up message appears. To confirm your choice, click on Yes to confirm. Click on No to keep the translation.
Managing Aliases This section outlines how to manage Aliases for Ultimus DPA Portal on the Aliases page of UATS Administrator. Aliases are terms which represent Process elements. Types of Aliases: • External database reference • Process Incident data reference • Ultimus Composed Process Solutions (CPS) model data reference. On the Aliases page, you can manage the list of Aliases, define localization for an Alias, and check to which templates an Alias is assigned, or which process uses it. • Managing list of Aliases • Managing Alias localizations Aliases page of UATS Administrator
Managing list of Aliases • Adding a new Alias • Editing a new Alias • Deleting an Alias • Linking an Alias
Adding a new Alias 1. In the Aliases section, click New Alias. The Add New Alias dialog box appears. Add New Alias dialog 2. In the Name text box, enter the name of the Alias to be created. 3. Click Save changes. The new Alias appears at the end of the Alias list. Tip: To start using an Alias in Ultimus DPA Portal, you have to define at least one localization for it. Without localization defined the original name is visible. For further information, see section Managing Alias localizations.
Editing a new Alias 1. In the Aliases section, select the required Alias, then click Edit Alias. The Edit Alias dialog box appears. 2. Edit the name of the Alias, then click Save changes.
Deleting an Alias 1. In the Aliases section, select the required Alias, then click Delete Alias 2. In the verification dialog, click Yes to verify that you want to delete the selected Alias.
Linking an Alias Aliases can be linked to multiple internal system (or incident) variables, or to one single external database column. Note: The Link Alias button activates only if there is an incident launched in Ultimus DPA Portal or an external data source defined in UATS Administrator. See also: Managing external data sources. 1. In the Aliases section, select the required Alias, then click Link Alias. The Link Alias dialog appears. Link Alias dialog box (default) 2. Server: Select the BPM Server on which the desired process is stored. 3. Process: Select the process to which to link the Alias. (All process versions are listed.) Note: The list only shows those synchronized processes that have incidents and tasks. 4. Link To: Specify if the Alias will be linked to an external data source, or to an incident variable, and define the respective settings: • External: Select a database in the DataSource combo box, and select a column in the Column combo box to link its value to the Alias. The selected Alias will fetch the data (value) from the specified column of the specified external data source. As a result, its value will be displayed instead of the Alias for the Ultimus DPA Portal users. Tip: The logic of how external data values are loaded to the Ultimus DPA Portal is defined by joins. For more details on this topic, see section Managing external data sources. Linking Alias to an external source • (Process) Incident variable: Choose this to link the Alias to an incident variable. Specify the incident-level variable: a. To display exactly as defined in BPM Studio, use the following formats, depending on the type of the variable (global, or incident-level): IncidentData/Global/<variable> or IncidentData/<variable> b. To display CPS data in a column instead of the Alias, specify the modeldata resource in the following format:cps://MyModelData/MyModelValue Special parameters:cps://@RequestId : Request idcps://@ModifiedDate : Modified date in sortable ISO formatcps://@TaskId : BPM Task Idcps://@Id : Modeldata Idcps://@ProcessName : Process namecps://@SolutionName : Solution name Linking Alias to an incident variable Process version: Every published Ultimus Process has a process version. The definition of an Alias for an incident variable includes this piece of data, thus the Alias definition is dependent on the process version. At Follow new versions, you can define if the selected Alias will follow every new version of the process (the DPA Portal will show all previous versions of the incident): • ON: the Aliases of the earlier process versions will be re-used for the newly published process version. It is not necessary to manually define all Aliases that have been already defined for older process versions. • OFF: the Alias will be bound to the process version defined earlier in the Process selection part of this dialog. To cancel the Follow new versions option, select the desired version of the incident belonging to the selected Alias in the Used By Processes window in the lower right corner. Click on the Edit Alias Link and select OFF from the Follow new versions options. Edit Alias Link Click on Save changes when finished.
Managing Alias localizations Localizations provide the possibility to assign terms in different languages to an Alias. These terms are displayed in Ultimus DPA Portal for the respective process element. • Creating a new localization • Editing a localization • Deleting a localization
Creating a new localization 1. In the Aliases list, select the Alias for which you want to create a new localization. 2. In the Alias Localization section, click New Localization. The Add New Localization dialog box appears. Add New Localization dialog 3. Language: Select a language from the drop-down list. 4. Translation: Enter the localized text for the Alias in the required language. 5. Click Save changes.
Editing a localization 1. In the Aliases list, select the Alias for which you want to edit localizations. 2. In the Alias Localization section, select the required localization, then click Edit Localization. The Edit Localization dialog box appears. 3. Edit the required fields, then click Save changes.
Deleting a localization 1. In the Aliases list, select the Alias for which you want to delete a localization. 2. In the Alias Localization section, select a localization, then click Delete Localization. 3. In the verification dialog, click Yes to confirm that you want to delete the selected localization.
Managing templates Templates apply to Views and Folders in the Ultimus DPA Portal, determining which columns (Aliases) are displayed in a View/Folder, as well as the column display order. The Templates are assigned to User Roles. Tip: For instructions on how to assign a Template to a User Role, see section Assigning Templates to a Role (Role Template Handling). When an Ultimus DPA Portal user opens a View/Folder, the displayed columns and their order are based on either a default (built-in) Template, or a custom Template: • Views use their own built-in Templates tailored to fit the function of the View. • User Views (User Folders) use the DEFAULT_USERFOLDER_TEMPLATE that includes the following columns (Aliases) by default: Task status, Process, Step, Incident, Summary, Task urgent. • Custom Templates: In order to provide Ultimus DPA Portal users with additional information about their Tasks - for example the Due Date, etc - you can add (and manage) custom Templates with custom columns and column display order. Tip: For instructions on how to create a Template, see section Creating a new Template.   Default columns (Aliases) displayed in Views Column (Alias) Description Displayed in Process The name of the business process. Initiate, Inbox, Queued, Assigned, Completed Process version The version of the business process. Initiate Step The name of the step. Initiate, Inbox, Queued, Assigned, Completed Incident The number of the process incident. Inbox, Queued, Assigned, Completed Summary The entered task summary. Inbox, Queued, Assigned, Completed Task Summary The entered task summary. Initiate Task Urgent The urgency of the task. Inbox Incident Priority Priority of the task. Inbox, Queued, Assigned Due Date The date the task is due by. Queued, Assigned Task Assigned To The domain and the name of the user the task is assigned to (e.g. Companydomain/User1) Assigned Task Start Shows when the task was initiated. Completed Task End Shows when the task was completed. Completed The following sections describe how manage View/Folder Templates for Ultimus DPA Portal users in the Templates page of UATS Administrator: • Creating a new Template • Renaming a Template • Deleting a Template • Assigning Aliases to Templates • Managing Alias column order Templates page of UATS Administrator
Creating a new Template You can create and manage custom Templates and specify their content (columns and column display order) to display additional task information for the Ultimus DPA Portal users. For example, task Due Date information, etc. 1. In the Templates section, click New Template. The Add New Template dialog box appears. Add New Template dialog 2. Name: enter the name of the template to be created. 3. Click Save changes or Close to exit without saving. The new template appears at the end of the template list. 4. The next step is to define which Aliases (columns) should the new Template display. For instructions, refer to section Assigning Aliases to Templates. Tip: When a Central Folder is created, the belonging Template is created automatically with the same name and starting with CF_ .
Renaming a Template Warning: Renaming a Central Folder (CF_ ) Template on the Templates page of the UATS Administrator is not supported. A Central Folder (CF_) Template is renamed automatically if a Central Folder is renamed. 1. In the Templates section, select the required template, then click Edit Templates.The Edit Templates dialog box appears. 2. Edit the name of the template. 3. Click Save changes, or Close to exit without saving.
Deleting a Template Warning: Template names starting with CF_ are in use by a Central Folder. They can not be deleted this way. To delete a Central Folder Template, you must delete the Central Folder first. The assigned Central Folder Template will be deleted automatically. 1. Go to the Templates page from the Main menu. 2. In the Templates section, select the template to delete, then click Delete Template. 3. In the CONFIRM dialog box, click Yes to verify that you want to delete the selected template. Click No to cancel the operation.
Assigning Aliases to Templates 1. In the Templates section, select the template for which you want to assign Aliases. 2. Go to the Template Aliases section. 3. Select the Alias(es) that you want to assign to the template, and click the Move selected () button. Adding Aliases to a template Tip: Use SHIFT to select multiple consecutive items, or use CTRL to select individual nonconsecutive items in the list.To move all selected items to the Assigned list box, click the Move all () button.To remove items from the Assigned list box, click the Remove selected () button. To remove all the items from the Assigned list box, click the Remove all () button.To filter the list of Assigned or Not Assigned Aliases, enter the filtering criteria into the Filter text box.To display all available Aliases: delete the text from the Filter text box. 4. Click Update to save changes. The selected Aliases are now assigned to the template. Tip: Once the required Aliases are assigned to the template, define which role(s) it is assigned to. For more information, see section Assigning Templates to a Role (Role Template Handling).
Managing Alias column order When a template is selected in the Templates window, the Aliases (columns) assigned to it are listed in the Template Alias Order section. Alias column ordering To change the display order of the Aliases (columns) assigned to a Template appear in the Ultimus DPA Portal, do the following: 1. Change the order using the Drag&Drop method. Note: According to the position of an Alias in the list, the Ultimus DPA Portal Task lists display the Aliases as follows: • The Alias on the top of this list will appear on the left in the Task list. • The Alias in the bottom of this list will appear on the right in the Task list. 2. Click on Update to apply the changes.
Managing Central Folders Central Folders display Inbox tasks of the end-users in specified roles based on the centrally applied rules and conditions. Central Folders are accessible in the VIEWS list in Ultimus DPA Portal. Visit the Central Folders page of the UATS Administrator to create, delete and to manage Central Folders (define their display order, assign roles, rules and conditions). • Creating a Central Folder • Renaming a Central Folder and its Template • Deleting a Central Folder and its Template • Managing Central Folder name translations • Changing Central Folder display order • Assigning a Central Folder to user Roles • Managing Central Folder rules and conditions Note: Central Folders assigned to the DEFAULT_ROLE are visible for all DPA Portal users. Central Folders page in UATS Administrator
Creating a Central Folder 1. From the Dashboard, select Central Folders. 2. Click on New Central Folder. 3. In the Create New Central Folder dialog box, type in the name and select a display template from the drop-down menu. Creating a new Central Folder automatically creates a new Template that can be handled the same way as the other templates. For more information on how to handle Templates, see section Managing templates.By default, automatically created Templates use the name of the new Central Folder but start with ‘CF_’ . For example: CF_Central Folder Name. Creating a Central Folder 4. Click on Save Changes to create the Central Folder, or Close to abandon the process. 5. Your new Central Folder is listed under Central Folders and Central Folder Display Order. 6. To add translations for the Central Folder names that will display for the assigned DPA Portal users, see section Managing Central Folder name translations.
Renaming a Central Folder and its Template Note: Use this method to rename a Template belonging to a Central Folder. Note: When renaming a Central Folder and its template, ensure you also update the translation. For instructions, see Managing Central Folder name translations. 1. Select a Central Folder from the list. 2. Click on Rename Central Folder. 3. In the Rename Central Folder dialog box, type in the new name. 4. Click on Save Changes to rename the Central Folder, or Close to abandon changes. Renaming a Central Folder
Deleting a Central Folder and its Template Note: Use this method to delete a Template belonging to a Central Folder. Note: The change takes effect with the user’s next log-on to the DPA Portal. 1. Select a Central Folder from the list in the Central Folders section. 2. Click on Delete Central Folder. 3. In the Delete Central Folder dialog, check if the Central Folder name displayed belongs to the one you wish to delete. Deleting a Central Folder 4. Click on Save Changes to confirm deleting the selected item, or Close to cancel.
Managing Central Folder name translations Central Folder names can be configured to display translated to the language set as preferred in DPA Portal. Central Folder page (Managing CF name translations) To manage CF name translations, visit the Central Folders page of the UATS Administrator, and start by adding translations in the Central Folder Translations section. • Adding a Central Folder name translation • Editing a Central Folder name translation • Deleting a Central Folder name translation Adding a Central Folder name translation Note: You can add as many translations as required. 1. In the Central Folders box, select a Central Folder to work with. 2. Go to the Central Folder Translations section, and click on New Translation Item.The Add New Localization dialog box appears. 3. Select a Language from the drop-down list, and type in your translation. Central Folders - Add New Localization 4. Save your changes. If the respective Central Folder is selected in the Central Folders box, its available translations are listed in the Central Folder Translations box, with their language code. List of available Central Folder name translations Editing a Central Folder name translation 1. Select a Central Folder to work with.The list of the available translations appear in the Central Folder Translations box automatically. 2. In the Central Folder Translations section, select the translation to modify. 3. Click on the Edit Translation Item button. The Edit Localization dialog box appears. 4. Change the translation as required. 5. When complete, click on Save Changes. Deleting a Central Folder name translation 1. Select a Central Folder to work with.The list of the available translations appear in the Central Folder Translations box automatically. 1. In the Central Folder Translations section, select the translation to delete. 2. Click on the Remove Translation Item button. 3. A pop-up message appears asking you to confirm your choice.Click on Yes to delete the translation. Click on No to keep the translation.
Changing Central Folder display order To rearrange the order Central Folders are displayed at the end-users on the DPA Portal, go to the Central Folder Display Order section, and use Drag&Drop to rearrange. Click Update to save your changes. Changing Central Folder display order
Assigning a Central Folder to user Roles To define which Central Folders are displayed for specific users (Roles) in DPA Portal, do the following: 1. Open Central Folders from the Dashboard. 2. Select a Central Folder to work with. Assigning roles to a Central Folder 3. In the Central Folder Role Assignment section, select the user Roles for which the selected Central Folder will be available in DPA Portal. Use the arrows to move the item(s) between the Assigned and the Not Assigned boxes (single arrows move the selected item, double arrows move all items from one box to the other). 4. Click on Update to save your changes.
Managing Central Folder rules and conditions Rules specified in Dashboard » Central Folders page of the UATS Administrator define the content of Central Folders for the assigned DPA Portal users by filtering their Inbox tasks automatically. Tip: See also Assigning a Central Folder to user Roles. Tip: Rules and conditions defined this way are processed prior to user-defined Rules and Conditions. Inbox Tasks: The tasks visible in a Central Folder remain in the Inbox of the process participants. These tasks can be handled as any other tasks, with one exception: the centrally specified Central Folder rules and conditions will override the user-defined task processing rules and conditions set e.g., in Future Task Management. The centrally applied rules and conditions are shown as non-modifiable, gray items in Future Task Management. Queue Tasks, Assigned Tasks: These are not affected directly, but whenever a Queue task is opened, it is assigned to the opener automatically, therefore the task appears in the Inbox as well as the Central Folder for the DPA Portal user, where it can be checked out by the recipient.
Validity of Central Folder Rules Start: Central Folder rules and conditions are applied only to tasks that arrive after the rule was successfully saved. If a rule was created in advance, then it takes effect at 00:00 on the specified date. End: Central Folder rules are executed until 23:59:59.999 of the specified date, local server time of the server running the DataLoader service.
Defining new Rules and Conditions to a Central Folder Note: The defined Rules will be valid to every Central Folder in the list. 1. Select a Central Folder from the list in the Central Folders section. Add or Edit Central Folder Rules 2. Click Add or Edit Central Folder Rules to display the Central Folder Rules window. Central Folder Rules window 3. Specify central rules and conditions the same way as you would for the Future Task Management function in the DPA Portal. For instructions, please refer to the Ultimus DPA Portal Help. Note: The displayed processing Conditions are inherited from the Template that was applied when this Central Folder was created. Note: Rules and conditions are executed case sensitive. Ensure you specify them with special attention to upper case/lower case. For example a condition value containing upper case (ProcessName Contains Delivery) will not be executed on processes containing the same word with lower case (delivery). Note: The referred Process and Step names are not localized, use the names as defined/visible in BPM Studio or in the Process Administrator. For instructions on how to add localization for BPM Process and Step names, see section Process Step Localization. 4. Click on OK to save your changes, or on Close to cancel.
Editing Central Folder Rules and Conditions 1. Select a Central Folder from the list in the Central Folders section. Add or Edit Central Folder Rules 2. Click on Add or Edit Central Folder Rules to display the Central Folder Rules window. Central Folder Rules (edit rules) 3. Select a rule to display its active conditions.Make changes the same way as you would for Future Task Management on the DPA Portal. For instructions, please refer to the Ultimus DPA Portal Help. Note: The Conditions column list items are inherited from the Template that was applied automatically or manually when the Central Folder was created. Note: Rules and conditions are executed case sensitive. Ensure you specify them with special attention to upper case/lower case. For example a condition value containing upper case (ProcessName Contains Delivery) will not be executed on processes containing the same word with lower case (delivery). 4. Click on OK to save your changes, or on Close to exit without saving.
Sorting the Initiate View content (Managing Tags) The Initiate View is a built-in View that is located in the REQUEST section on the Navigation Pane in Ultimus DPA Portal. This default View contains all business processes the logged-on DPA Portal user can initiate. Create Tags to sort the available business processes into categories (Tagged Views) under the Initiate View according to user Roles in DPA Portal. Tagged Views on the DPA Portal The following sections explain how to create Tagged Views and assign them to business processes and then to user Roles: • Creating a Tag • Assigning user roles to a Tag The following sections explain how to modify Tagged View parameters or delete a Tagged View: • Editing a Tag • Deleting a Tag Tags Dashboard
Creating a Tag Tags in UATS Administrator are represented by Tagged Views in Ultimus DPA Portal, within the Initiate view. Tagged Views are category views that list business processes that are assigned to the specific Tagged View when creating the Tag. Tip: To define which DPA Portal users can see a Tagged View on the DPA Portal, see Assigning user roles to a Tag. Create Tag To create a new tag, do the following: 1. Click New Tag and specify the following: • Tag Name: Type in the name of the Tag to display in the Navigation Pane for the user on the DPA Portal. Note: This parameter cannot be changed later. • Processed From and Processed Until: Specify the date from and until when the tag will be used. The default setting is the current date as Processed From, and the same date in 2099 as Processed Until. Note: Set this parameter according to the requirements in your organization. • Display Icon: Choose the Default icon, or upload a custom Tagged View icon to be displayed on the DPA Portal. Note: This parameter cannot be changed later. • Processes: Select the processes to include in the Tagged View. To assign multiple processes, hold down the Shift key when selecting the processes. 2. When finished, click on Save Changes to save the new tag. The new Tag will be visible upon the next login to Ultimus DPA Portal. 3. Continue with Assigning user roles to a Tag. Tip: Drag&Drop the Tags to reorder the list in Tags Display Order on the DPA Portal (use Update to save their position).
Assigning user roles to a Tag Assign User Role to a Tag 1. Select a Tag to work with. Tip: Start typing the name of a User Role in the Filter to search. Tip: Use SHIFT to select multiple consecutive list entries. 2. You can assign one or more user Roles to a Tag using the Not Assigned and Assigned boxes under Tags Role Assignation: In the Not Assigned box, select the user roles to be assigned to the selected Tag and use the arrows to add the selected user role(s), and the double arrow to add all users from this list to the Assigned box. To change which User roles are assigned to a Tag: Use the single and the double arrows in the Assigned box to move user role(s) back from the Assigned box to the Not Assigned box. 3. Use the Update button to save your changes and update the servers.
Editing a Tag Note: The Tag Name and Display Icon parameters are not editable. Note: Changing the Name or the Display Icon of a Tag is possible only by deleting the Tag, then adding a new one. Ensure you add translations to localize the new Tag for the Ultimus DPA Portal users. 1. Click on Edit Tag to display the Create Tag window. Edit Tag 2. You can change the following: Processed From, Processed Until, and the assigned Processes. Hold down the Shift key to select multiple Processes. 3. Click on Save Changes when finished.
Deleting a Tag Note: When a Tag is deleted, its translations are deleted as well. To delete a Tagged View from the Ultimus DPA Portal, do the following: 1. Select a Tag by clicking on it. 2. Click on Delete Tag. 3. Confirm your choice: click on Save Changes to delete the Tag. Click on Close to cancel.
Localizing a Tag name Names of Tagged Views can be localized to be displayed translated for the Ultimus DPA Portal users. The translations can me managed in the Tag Translations section. • Adding a Tag name translation • Editing a Tag name translation • Deleting a Tag name translation Adding a Tag name translation Tip: You can add as many translations as required.   Note: When a Tag is deleted, its translations are deleted as well. 1. Select a Tag to work with. 2. Go to the Tag Translations section, and click on New Translation Item.The Add New Localization dialog box appears. 3. Select a Language from the drop-down list, and type in your translation. Managing Tags - Add New Localization 4. Save your changes. If the respective Tag is selected in the Tags: sub items under Initiate view box, its available translations are listed in the Tag Translations box, with their language code. List of available Tag name translations Editing a Tag name translation 1. Select a Tag to work with.The list of the available translations appear in the Tag Translations box automatically. 2. In the Tag Translations section, select the translation to modify. 3. Click on the Edit Translation Item button. The Edit Localization dialog box appears. 4. Change the translation as required. 5. When complete, click on Save Changes. Deleting a Tag name translation 1. Select a Tag to work with.The list of the available translations appear in the Tag box automatically. 1. In the Tag Translations section, select the translation to delete. 2. Click on the Remove Translation Item button. 3. A pop-up message appears asking you to confirm your choice.Click on Yes to delete the translation. Click on No to keep the translation.
Managing external data sources This section outlines how to define and manage external data sources for Ultimus DPA Portal on the External Data page of UATS Administrator. UATS provides an interface to external databases and sources. An external data source is a database table that the UATS Database can use as a source for Aliases: • The external source can be any other database outside the UATS DB, but it must reside in the same server as the UATS DB (otherwise it is not possible to access it). • The credentials the UATS DB uses to access the external resource are the same as those used to access the UATS DB itself. Note: Alias values received this way from an external data source will be stored in the UATS DB and handled as incident data. Note: Read section Guidelines for using external database tables with UATS before adding external data sources. External Data page of UATS Administrator
Guidelines for using external database tables with UATS Caution: The administrator bears full responsibility when configuring UATS-independent databases, as well as when creating and maintaining the external database tables to be used with UATS. Note: Alias values received this way from an external data source will be stored in the UATS DB and handled as incident data. To ensure that a table in the external database works properly with UATS, please follow these guidelines when creating and maintaining external database tables that are to be used with UATS: • The database where the external data source is created should be accessible with the same login credentials as the UATS database. • To ensure that the external tables work properly with UATS, the generic SQL naming conventions should be followed without an exception.For example, use only letters and numbers for naming the tables you wish to add to UATS, and do not use special characters (e.g. + - ? * , etc.) • To ensure that DPA Portal users are able to access a table located at another DPA Portal user, make sure all respective users are granted SELECT ANY TABLE system privilege before you add the mentioned table. • Be prepared to use an external data source only once.
Adding a new external data source Note: If the external data source is in Oracle: for making a table located at a DPA Portal user accessible to other DPA Portal users you need to grant SELECT ANY TABLE system privilege to the respective users before adding the mentioned table as an external source. Note: The external database must be on the same Oracle server, or the same MSSQL server as the UATS database. It is not possible to mix data providers (the external data sources are displayed using double-dot notation). To add an external database, do the following: 1. Go to the External Data page of UATS Administrator. 2. Click Add Table to display the Add External DataSource dialog box. Add External DataSource 3. Database: enter the database name. 4. Table: enter the name of the table in the external database from which to read the data.MSSQL databases can be specified with or without schema name, the default schema is dbo. 5. Click on Save changes. Note: An external data source can be added only once.
Managing joins of external data sources Note: External data only can be linked to Processes. The same will be displayed for all of the Tasks/Steps. Joins are used for attaching an external data source to a linked process Alias, so that the retrieved external data appears for the specified process variable in the task list in Ultimus DPA Portal. For information about linking process Aliases, see section Managing list of Aliases. In the Joins section of the External Data page, you can use clauses to create an expression that handles the join of tables. When a join is defined, it creates a condition that is used to determine the value of the Alias previously linked to this external data source. To re-formulate the expressions, drag and drop the required clause to its preferred location in the expression. To add a join to a table, follow these steps: 1. From the External Data list, select the item to which you want to attach a join. 2. Click Add Join. Add Join dialog 3. Specify the required information or settings in the following fields: • Join Type: Select the type of the join.From the second Join definition onwards, you can choose from options AND or OR. • Process Alias: Select a process Alias to assign. • Operator: Select the operator for the join. The following options are available: Equal, NotEqual, LowerThan, GreaterThan, LowerOrEqualThan, GreaterOrEqualThan, Contains, DoesNotContain, • Column: From the table column list, select one to join to the specified process Alias. 4. Click on Save changes.
Disconnecting an external data source Note: Disconnecting an external data source for which there are joins defined deletes all related joins. 1. Go to the External Data page of UATS Administrator. 2. Select a table in the list, and click on Delete Table. 3. In the verification dialog, click Yes to verify that you want to disconnect the selected item. Tip: After disconnecting an external data source this way, the External Data page might not update list items properly. To refresh the page, switch to another page in UATS Administrator, then switch back to the External Data page.
Synchronization On the Synchronization page of UATS Administrator, you can manually export/import UATS localization data, synchronize tasks and user information. • Exporting and importing localization data • Synchronizing full name and e-mail address for a specific user • Synchronizing OC Group Assignments • Removing old completed incidents • Synchronizing information with the selected BPM Server • Synchronizing tasks • Synchronizing all users • Refreshing the Initiate view for all DPA Portal users
Exporting and importing localization data Use the Synchronization Export function to save localization data from the UATS Database if you would like to delete the UATS DB when removing UATS, for example before you upgrade to a higher UATS version. After installing UATS, use Synchronization Import to import the previously exported localization data. Synchronize localization data - Export and Import
Synchronizing full name and e-mail address for a specific user In section Synchronize User Data, you can synchronize the full name and the email address of specific user with the Authentication Ultimus BPM Server that is marked as Primary on the Servers page of the UATS Administrator. 1. Enter the short user name of the selected user (<domain name>/<username>) 2. Click on the Full name and e-mail address button to start. User data synchronization
Synchronizing OC Group Assignments Group membership is synchronized with Organization Charts as follows: • When an Ultimus DPA Portal user logs in, the OC Group membership information loads from the UATS Database in the connected BPM Server. The data is retained in the UATS Database for 24 hours. • If the membership information changes, it is possible to delete the outdated information from the UATS Database until the until JSON service restarts at midnight. • OC group membership information is automatically synchronized if there was a membership change in Ultimus Organization Charts, or a queue task arrives. • Only OC groups are synchronized, AD groups are not. • If the membership information (OC Group content) changes more than once within 60 minutes, only the first change will synchronize. This is due to caching properties which are configurable in the DataLoader application configuration file. In section OC Group Assignments, you can remove the Ultimus Organization Charts membership information stored in the UATS Database for the specified user, or all Ultimus DPA Portal users. The OC Group membership information will be refreshed and saved to the UATS Database with the next user login. • Single user To delete the OC Group membership information for a single user: 1. Type in the username in the following format: <domain name>/<username> 2. Click on the Remove membership information button. • All usersTo delete the OC Group membership information for all Ultimus DPA Portal users, click on the Remove membership info for ALL users button. OC Group Assignments
Removing old completed incidents In section Remove Old Completed Incidents, you can request the deletion specific Tasks from the Ultimus DPA Portal. Note: This function only marks the data for deletion, the actual removal is carried out during the automatic JSON cleanup procedure. Remove Old Completed Incidents
Synchronizing information with the selected BPM Server The following operations are available in section Synchronization with the selected BPM Server: • Synchronizing tasks • Synchronizing all users • Refreshing the Initiate view for all DPA Portal users Synchronization for a specific BPM Server Synchronizing tasks In section Task Synchronization, you can synchronize tasks between (including) the selected dates with the selected Ultimus BPM Server. 1. Select a Server to synchronize with. 2. Fill in the From Date and To Date in the specified format . 3. Click on Sync Tasks to start the synchronization process. Synchronizing all users In section Synchronize All Users, you can synchronize the current list of DPA Portal users with the selected BPM Server. 1. Select a Server to synchronize with. 2. Click on the Start All Users Sync button. Refreshing the Initiate view for all DPA Portal users In section Force refresh of Initiate, you can manually refresh the list of Business Processes the Ultimus DPA Portal users are allowed to Initiate when connected to the selected BPM Server. The list of Business Processes to Initiate will be updated with the next user login. 1. Select a Server to synchronize with. 2. Click on the Start button.
Diagnostics and Messaging • Diagnostics • Messaging
Diagnostics The Diagnostics page displays diagnostics information and notifications about the data processing cycles of the running DataLoader Service instances. Tip: If the list is not displaying, restart the Ultimus UATS DataLoader Service manually in Services. Diagnostics information in UATS Administrator
Messaging Use the DPA Portal Message function on the Diagnostics & Messaging page of the UATS Administrator to send messages to Ultimus DPA Portal users or a Logout Request The sent notifications are displayed in the following way in the Ultimus DPA Portal: Notifications in the Ultimus DPA Portal - example To send a notification message to the Ultimus DPA Portal users, specify the following: 1. Select the Message Recipient Type • USER(S)- Specified DPA Portal User(s)The message will be displayed as a regular notification to the specified DPA Portal user(s). This type of message is stored until logout. • OC GROUP - All members of the specified OC Group: The message will be delivered to those members of the specified Ultimus Organization Charts user group who are also Ultimus DPA Portal users. • USER ROLE(S) - All users in the specified Role: The message will be delivered to all Ultimus DPA Portal users in the specified Role. • PROCESS(ES) - All recipients of the specified Process(es): The message will be delivered to all Process Participants who are assigned to the specified - one or more - process(es). • INCIDENT RECIPIENTS - All recipients of a Process Incident: The message will be delivered to all Process Participants who are assigned to the specified - one or more - Process Incidents. Note: For performance reasons, this type is disabled by default. To enable it, modify the web.config file as follows:<!-- Subscribing to incidents can have a performance effect if a user has more than 1000 tasks. Valid values separated by semicolon: Process;Incident --><add key="SubscribeToTaskDetails" value="Process;"/> 2. Specify the Message Recipient(s) according to the recipient type: • Recipient Type: USER(S) • Use the following format: domain.local/username1 • You can add a single user, or a list of users divided by a semicolon (;)e.g. domain.local/username1;domain.local/username1 • Recipient Type: OC GROUP • Type in the name of the message recipient OC Group as stored in Ultimus Organization Charts, e.g. SiteManagers • Specify only one OC Group as recipient. • Recipient Type: USER ROLE(S) • Type in the name of the recipient User Role as stored, e.g. SALES_AGENTS • Specify only one User Role as recipient. • For the list of available User Roles, see the Roles page of the UATS Administrator. • Recipient Type: PROCESS(ES) • Type in the name(s) of the Process(es) of which the Process Participants should receive the notification, e.g. HRProcess • You can add multiple Process Names divided by a semicolon (;)e.g. HRProcess;CreditCardApproval • Recipient Type: INCIDENT RECIPIENTS • Type in the name(s) of the Process Incident(s) of which the Recipients should receive the notification. • Use the following format: IncidentName|IncidentNumber Please note that the Incident Name and the Incident Number are separated with a divisor character (|).e.g. HRProcess|134 • You can add multiple Incident Names divided by a semicolon (;)e.g. HRProcess|134;HRProcess|145;HRProcess|197 3. Message Title: Specify a message title. 4. URL link: If an URL is added to your message, an icon () will appear in the notification. The linked page opens in a new browser window.Both http:// and https:// are supported. 5. Message text: Specify the notification text. 6. Expiration: Select how long the message will be available. 7. Send your message by clicking on the respective Send... button.   Send Logout Request You can send a logout request in the form of a customized message with a countdown timer to all logged-on Ultimus DPA Portal users. The message is not stored in the database. Send Logout Request To send a custom logout message, do the following: 1. Reason/message to logout: Type in your message. 2. Seconds to force logout: Specify a value for the timer in seconds. 3. Click on Send logout message.
General information about UATS with Ultimus DPA Portal The General page of UATS Administrator displays license information for Ultimus Advanced Task Service with Ultimus Digital Process Automation Portal with Ultimus DPA Portal. License access errors are also displayed here. Example of UATS license information
This document explains how to configure the Ultimus Advanced Task Service with Ultimus Digital Process Automation Portal after it has been installed, and how it integrates with the Ultimus Adaptive BPM Suite. Disclaimer The example organizations, credentials, names, e-mail addresses, people, computer names, software versions, URLs depicted herein are fictitious unless otherwise noted. Assumptions about the reader This document makes the following assumptions about the reader: • The person installing, administering or maintaining UATS with Ultimus DPA Portal (referred henceforth as “the reader”) has an extensive understanding and knowledge of the Ultimus Adaptive BPM Suite in his or her Ultimus environment. • The reader is a network administrator or IT professional: an individual who oversees the installation (and possibly deployment and maintenance) of enterprise-class software. • The reader is an experienced Microsoft Windows user who is familiar with working within the Microsoft Windows environment. This applies to any Windows operating system that UATS with Ultimus DPA Portal supports. The reader has Administrator rights on all computers within the organization and can make changes to LAN security and configuration. • The reader is knowledgeable in configuring any hardware or software firewall tools the organization has in place. Communication among Ultimus modules in a firewall-enabled environment is incumbent upon the network administrator to properly configure. UATS with Ultimus DPA Portal modules communicate over HTTP and do not require any additional settings in a firewall environment. However, there may be certain firewall restrictions that may hinder the ability for Ultimus to operate. For up-to-date information about changes to supported technologies, see document Ultimus Supported Technologies on Ultimus Customer Portal. Contacting Ultimus Ultimus is always striving to improve its products and support services. Furthermore, Ultimus offers a number of ways to find answers or to submit feedback. You may use the following ways to find answers to your Ultimus-related questions or to submit feedback to Ultimus: • Ultimus Customer Portal At the Ultimus Customer Portal, you can access technical experts to resolve your technical issues, use the KnowledgeBase to get answers to common and specific questions, and download the latest product builds and documentation. You can reach Ultimus Support at: http://www.ultimussupport.com/. • Ultimus Education Ultimus Education provides technical training and certification on the latest Ultimus products to ensure you have up-to-date knowledge of the latest product releases. For more information, see http://www.ultimus.com/training-services or contact [email protected]. • Product enhancement Ultimus strives to improve our product. If you would like to submit a product enhancement or feature concept, go to the Ultimus Customer Portal at: http://www.ultimussupport.com and follow the Ideas link in the upper area. • Documentation feedback Ultimus strives to improve technical documentation and online help. If you would like to submit documentation feedback, contact http://www.ultimussupport.com. Conventions The following conventions are used throughout this document:   bold Bold text denotes items that you must select or click on in an application, such as menu options, dialog box options, and dialog box output. Bold text is also used to designate labels within table columns. italic Italic text denotes variables, emphasis, and document, chapter, and section titles. This also denotes text that is a place holder for a word or value that you must supply. monospace Text in this font denotes text or characters that you should input to an application, application output, sections of code, programming examples, and syntax examples. This is also used for the proper names of disk drives, paths, directories, device names, file names, file extensions, code excerpts, and URLs. monospace italic Italic text in this font denotes text that is a placeholder for text or value(s) that you must supply. underlined blue text Underlined blue text represents a link to a different section in this document or reference to an external Web site. Clicking on the underlined blue text displays that topic or open your preferred Web browser to display the Web site. The symbol, along with underlined text, represents a link that may be selected to display an application procedure. The link opens (represented by the symbol) to display the application procedure. Selecting the link again hides the application procedure. » The » symbol leads you through nested Start menu options, application menu options, and dialog box options to a final action. For example, the sequence File»Page Setup»Printer... directs you to pull down the File menu, select the Page Setup item, then select Printer... from the dialog box. This icon denotes a tip, which alerts you to advisory information. This icon denotes a note, which alerts you to important information. This icon denotes a caution, which advises you of precautions to take to avoid specific application errors, data loss, or system crash. This icon denotes a warning, which advises you of precautions to take to avoid damaging computer hardware or losing computer data. UATS with Ultimus DPA Portal in brief UATS is a service layer between one or more Ultimus BPM Servers and the Ultimus DPA Portal. UATS retrieves, caches, and intelligently streams data to Ultimus DPA Portal. Ultimus DPA Portal is the presentation layer which efficiently transfers the retrieved business process data to client devices. Using UATS with Ultimus DPA Portal, it is also possible to include additional external data from third-party systems. The figure below shows the architecture of UATS and Ultimus BPM Server. UATS with Ultimus BPM Servers For detailed information about UATS architecture, see section Types of UATS installations in the respective Installation Guide for UATS. UATS Administrator architecture UATS with Ultimus DPA Portal can be configured mainly through the UATS Administrator application concerning the following areas: • Managing Ultimus BPM Server settings • Managing Ultimus DPA Portal users • Managing User Roles • Managing the Ultimus DPA Portal Navigation Pane content (Navigation & Applications) • Process Step Localization • Managing Aliases • Managing templates • Managing Central Folders • Sorting the Initiate View content (Managing Tags) • Managing external data sources • Synchronization • Diagnostics and Messaging • General information about UATS with Ultimus DPA Portal The following picture gives an overview of how UATS Administrator modules relate to each other. UATS Administrator architecture For detailed information, see section Configuration through UATS Administrator. Outline This document contains the following sections: • Configuration through UATS Administrator This section discusses how to connect UATS with Ultimus DPA Portal to Ultimus BPM Server(s) from which to retrieve business process data, and details further configuration instructions to be done in UATS Administrator. • Additional configurations This section describes further configurations required for proper usage of Ultimus DPA Portal; for example, how to configure Single-Sign On (SSO) for logging in to Ultimus DPA Portal, or what browser-level settings may be required to properly display Ultimus DPA Portal. • Troubleshooting This section lists potential fault scenarios after configuring UATS, or using Ultimus DPA Portal and provides solution for them.
Date Scope Due to release Change 03/02/2020 document 2021 Images and content have been updated throughout the documentation to reflect changes and new features and the latest user interface. New sections: Process Step Localization, Managing Central Folder name translations, Localizing a Tag name, Localizing application names and navigation node names, Setting up multiple Ultimus DPA Portal instances, Granting Write permission to Temporary ASP.NET Files, Configuring reverse proxy for DMZ access, Toggle User Login Expired, Organizing DPA Portal Navigation Pane content (navigation nodes), Changing the display order of the Navigation Pane items, Default Navigation Pane elements, Supported languages, Exporting and importing localization data, Messaging, Securing UATS and SSL configuration for UATS with DPA Portal, Task synchronization issues after time zone changes, Configuring user name visibility in listsUpdated sections: Dashboard, Creating a Central Folder, Renaming a Central Folder and its Template, Managing Central Folder rules and conditions, Editing a Tag, Deleting a Tag, Creating a new role; Users are not synchronized with BPM Server, User Role Handling, Add/Remove OC Groups, Assigning Navigation Pane content to a role, Managing the Ultimus DPA Portal Navigation Pane content (Navigation & Applications), UATS Administrator architecture, Synchronization, Diagnostics and MessagingAssigning Aliases to Templates, Managing Alias column order, Changing the display order of the Navigation Pane items, Linking an Alias, Synchronizing OC Group Assignments, Managing Central Folder name translations, Enabling Debug logging for UATS, Setting up multiple Ultimus DPA Portal instances, Sorting the Initiate View content (Managing Tags), Managing external data sources, Setting General and Task operation permissions for user RolesImages have been updated throughout the document to reflect the current user interface and functions. Removed sections: Configuring offline localization for Oracle, Using the Search Function, Configuring HTTPS for Ultimus DPA Portal, Enabling Tagged Views on the DPA Portal Product name changed throughout the document as follows: • Ultimus Advanced Task Service with Ultimus WebClient to Ultimus Advanced Task Service with Ultimus Digital Process Automation Portal. • UATS with Ultimus WebClient to UATS with Ultimus DPA Portal. • WebClient to Ultimus DPA Portal, or DPA Portal 6/10/2019 document 2019 Images and content have been updated throughout the documentation to reflect changes and new features and the latest user interface. 5/23/2017 document 2017 Images and content have been updated to reflect changes and new features and the latest user interface. New sections: Managing TagsUpdated sections: Managing user roles, Diagnostics 4/18/2016 document UATS 2016 Images and content have been updated to reflect changes and new features and the latest user interface. New sections: Managing Central Folders, Guidelines for using external database tables with UATS and Configuration steps for using embedded CPS forms.Updated sections: Managing templates, Managing external data sources, Adding a join to a table, Synchronization, Managing third-party Applications, Linking an Alias, Managing user roles.Removed sections: Sections Disabling Compatibility View for IE 8 and Disabling Compatibility View in IE 8 for Ultimus WebClient. 5/8/2015 document UATS 2015 R1 Images and content have been updated to reflect changes and new features. 2/3/2015 document UATS 2014 R2 Images and content have been updated to reflect changes and new features. 6/18/2014 document UATS 2014 R1 Images have been updated to reflect latest user interface. The following sections have been added: Diagnostics, Synchronization, Role Group Handling, Role Department Handling, Role JobFunctionGroup Handling, Role Basic Features handling, Role View Features handling.The following sections have been updated: Configurations in UATS Administrator. 12/12/2013 N/A UATS and WebClient 3.0 This is the first version of the document. The document now contains the previous Administration chapter of UATS Installation Guide.
UATS Configuration and Administration   Ultimus Advanced Task Service with Ultimus Digital Process Automation Portal 2021 Copyright information No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose, without the express written consent of Ultimus, Inc. The software described in this manual is furnished under a license agreement or non-disclosure agreement and may be used or copied only in accordance with the terms of the agreement. The information contained in this manual is subject to change without notice and does not represent a commitment on the part of Ultimus, Inc. Copyright © 1999-2021 Ultimus, Inc. All rights reserved. Companies, names, and data used in examples herein are fictitious unless otherwise noted. Ultimus®, Adaptive Discovery®, BAMport™, Flobot™, FloPort™, FloStation™, iBAM™, Inlet™, Maplet™, Profit from the Process™, U2Net™, and Unruly Event™ are trademarks of Ultimus, Inc. Windows, Word, Excel, InfoPath, and SQL Server are registered trademarks of Microsoft Corp. All other names may be trademarks of their respective owners and are used for reference only. All Ultimus specifications contained in documentation and literature are subject to change without notice.
This section lists potential error scenarios after configuring UATS with Ultimus DPA Portal, or using Ultimus DPA Portal and provides solution for them. • Users are not synchronized with BPM Server • The website does not communicate with the JSONCache provider • Granting Write permission to Temporary ASP.NET Files • Task synchronization issues after time zone changes
Users are not synchronized with BPM Server Error After defining the Ultimus BPM Server(s) for UATS, users are not retrieved from BPM Server(s). Root cause The Ultimus Data Loader service has not yet retrieved user information from the BPM Server(s). Resolution 1. Wait for a few minutes for the user synchronization to start. 2. Check the logs. 3. Restart the Ultimus Data Loader service. 4. Check if the new BPM Server users are listed on the Users page of the UATS Administrator.
The website does not communicate with the JSONCache provider Error There is no communication between the website and the JSONCache provider. Root cause The JSONCache provider and the DPA Portal application are not installed to the same server. Resolution Verify the locations where the JSONCache provider and the DPA Portal are installed. Make sure that the values of the FQDN name of the server and the port used is the same in the web.config files of the DPA Portal applications (see Figure 99). Configuring NLB helper service in the web.config file Note: Please note that this resolution applies only to non-NLB configurations.
Granting Write permission to Temporary ASP.NET Files Error The current identity (NT AUTHORITYNETWORKSERVICE) does not have write ACCESS TO 'C:\Windows\Microsoft.NET&Framework64\v4.0.30319\Temporary ASP.NET Files' Resolution Change the application pool identity from Network service to ApplicationPoolIdentity in IIS for the following application pools: • Ultimus_UATSAdmin • Ultimus_UltimusWebClient
Task synchronization issues after time zone changes Error Changing the time zone post-installation disables task synchronization for DPA Portal. Root cause After adjusting the time zone, there is a gap in the flow of time in the environment and the services need time to restart. Tasks created during this gap are not visible for the DPA Portal synchronization mechanism. Resolution Although the daily regular synchronization would solve this, we recommended that you restart all services manually (including UATS, CPS, BPM and COM+ components) if this error occurs.
This section outlines how to configure Ultimus BPM Studio Server using Ultimus BPM Studio Configuration. Ultimus BPM Studio Configuration is a Microsoft MMC-based application that is installed on the same computer as Ultimus BPM Studio Server. Refer to the following sections: • Starting Ultimus BPM Studio Configuration • Ultimus BPM Studio Configuration’s main interface • Configuring process repositories • Configuring Ultimus BPM Servers • Configuring domains and LDAP servers • Configuring Studio Configuration Access Rights • Configuring access rights of BPM Studio Client users
Starting Ultimus BPM Studio Configuration To start Ultimus BPM Studio Configuration, follow these steps: 1. Select Start»Programs»Ultimus Digital Process Automation Suite 2021 »Ultimus BPM Studio Configuration. Ultimus BPM Studio Configuration login dialog box appears. When launching Ultimus BPM Studio Configuration for the first time, all fields are empty except for the Server option. Ultimus BPM Studio Configuration login dialog box 2. Specify the Ultimus BPM Studio Server to which to connect. To do so, select Change opposite the Server label. The Change Server dialog box appears. Change Server dialog box Enter the following information into the dialog box: a. Server: Select the browse button opposite the Server text box to select a server from the list.Alternatively, type the name of the computer hosting Ultimus BPM Studio Server to which to connect. The hosting computer can be the local computer or a remote Ultimus BPM Studio Server on the same domain. b. Port: Specify the port in which the computer hosting Ultimus BPM Server is waiting for connections. By default, this is port 80 unless changed by the Ultimus system administrator. c. Secure: Select the Secure check box if the connection to Ultimus BPM Server is a secure connection. By default, the port for secure connections is 443 unless changed by the Ultimus system administrator. Once this information has been provided, click OK. Note: The OK button is not available until the name of the computer hosting Ultimus Studio BPM Server is entered in the Server text box. 3. If using Windows Authentication to provide log on credentials, select the Use Windows Authentication check box, then click Log On. Otherwise, in the User ID text box, enter the user name to log on to Ultimus BPM Studio Configuration. 4. Password: Enter the password to log on to Ultimus BPM Studio Configuration. 5. Domain: Select to which domain the user account belongs. 6. Click Log On. When next logging on to Ultimus BPM Studio Configuration, only the password is required. The rest of the login information is retained from the initial login and only needs verification.
Ultimus BPM Studio Configuration’s main interface This section describes the main sections of the Ultimus BPM Studio Configuration interface. Ultimus BPM Studio Configuration’s main interface Following is a description of each node and its associated function: • The Repositories node is used to configure multiple process repositories for the Ultimus BPM Studio Server being configured. To learn how to configure process repositories, refer to Configuring process repositories section. • Business processes are published from Ultimus BPM Studio Clients to Ultimus BPM Servers. The BPM Servers node is used to configure Ultimus BPM Server definitions that specify which Ultimus BPM Studio Client users are permitted to publish business processes (with the appropriate security rights). To learn how to configure Ultimus BPM Servers, refer to Configuring Ultimus BPM Servers section. • The Domains node is used to specify domains or LDAP servers upon which Ultimus BPM Servers are located. To learn how to configure domains or LDAP servers, refer to Configuring domains and LDAP servers section. • The Studio Configuration Access Rights node is used to add or remove users that are allowed to access the Ultimus BPM Studio Configuration application. To learn how to configure Studio Configuration access rights, refer to Configuring Studio Configuration Access Rights section. • The Access Rights node is used to specify which users are allowed to access which process repositories, and to which Ultimus BPM Servers those users are permitted to publish business processes. To learn how to configure access rights, refer to Configuring Studio Configuration Access Rights section. This node is also used to view which users are currently connected to Ultimus BPM Studio and provides the facility to disconnect any or all of them forcefully. To learn more about active users, see Viewing Ultimus BPM Studio Client user activity.
Configuring process repositories This section outlines how to configure process repositories in Ultimus BPM Studio Configuration. This process repository is also known as the Ultimus BPM Studio repository. Ultimus BPM Studio Server maintains process repository definitions (and all associated business process information) in a SQL Server or Oracle database. Therefore, before users can access process repositories from Ultimus BPM Studio Client installations, process repository configurations must be made through Ultimus BPM Studio Configuration. Tip: Using this procedure, you can configure multiple process repositories for a single Ultimus BPM Studio Server. 1. To add a new process repository, right-click the Repository node, then select Add to display the Repository dialog box. Adding a repository to the Repository node The Repository dialog box 2. Name: Enter the name of the computer hosting the process repository. 3. Database Type: Select Ultimus BPM Studio Client repository: a. Select the SQL Server option if Microsoft SQL Server is used as the Ultimus BPM Studio repository, and follow these additional steps: 1. Server: Enter or select the name of the computer hosting the Ultimus repository database. This may be the computer name, the IP address of the computer hosting the SQL Server database, or the local host values. The hosting computer can be the local computer, or a remote Ultimus BPM Studio Server on the same domain. 2. User ID: Enter the user name configured to connect to the selected SQL Server database. 3. Password: Enter the password configured to connect to the selected SQL Server database. 4. Select the Use Trusted Connection check box if a trusted connection is to be used. 5. Catalog: Select the name of the SQL Server database to be used as Ultimus BPM Studio repository. b. Select Oracle if Oracle is to be used as the Ultimus BPM Studio repository and follow these additional steps. Note: Select Oracle only if Oracle service is configured on the computer hosting Ultimus BPM Studio Configuration. The Repository dialog box when Oracle is the Ultimus BPM Studio repository 1. Service Name: Enter the schema name of the Oracle service. 2. Enter the User ID and Password configured to connect to the selected Oracle database. To edit an existing process repository configuration, follow these steps: 1. Select the Repositories node to display all configured process repositories. 2. In the details window, right-click the process repository configuration to be edited, then select Edit to display the Repositories dialog box. Editing a process repository 3. The Repositories dialog box shows the configured process repository connection information. 4. After editing the configured information, click on OK to save your changes. To delete an existing process repository configuration, follow these steps: 1. Select the Repositories node to display all configured process repositories. 2. In the details window, right-click the process repository configuration to be deleted, then select Delete. Deleting a process repository 3. A dialog box appears to confirm if the process repository should be deleted. Click on Yes to delete the process repository configuration.
Configuring Ultimus BPM Servers Tip: Using this procedure, you can configure multiple Ultimus BPM Servers. To configure an Ultimus BPM Server in Ultimus BPM Studio Configuration, follow these steps: 1. Right-click the BPM Servers node, then select the Add to display the BPM Server dialog box. Adding an Ultimus BPM Server to the BPM Server node 2. Select or enter the name of the computer hosting Ultimus BPM Server or enter that computer’s IP address. This computer must be on the same domain as the computer hosting Ultimus BPM Studio Client. In the Port: text box, enter the port number. By default, it is 80 The BPM Server dialog box 3. Select the Secure check box if the connection is required to be made secure. For a secure connection, the default port number is 443. 4. Click on OK. To delete an existing Ultimus BPM Server configuration, follow these steps: 1. Select the BPM Servers node to display all configured Ultimus BPM Servers. 2. In the details window, right-click the Ultimus BPM Server configuration to be deleted, then select Delete. Deleting an Ultimus BPM Server 3. A dialog box appears to confirm if the Ultimus BPM Server configuration should be deleted. Click on Yes to delete the selected Ultimus BPM Server configuration.
Configuring domains and LDAP servers This section outlines how to configure domains and LDAP servers in Ultimus BPM Studio Configuration. To configure a domain in Ultimus BPM Studio Configuration, follow these steps: 1. Right-click the Domains node, then select the Add option. Adding a domain to the Domains node The Add Domain or LDAP Server dialog box appears. The Add Domain or LDAP Server dialog box 2. From the Domain Name: combo box, select the domain in which the computer hosting Ultimus BPM Studio is. 3. Click on OK. Multiple domains may be configured using this procedure. To configure an LDAP server in Ultimus BPM Studio Configuration, follow these steps: 1. Right-click the Domains node, then select the Add option. Adding a domain to the Domains node The Add Domain or LDAP Server dialog box appears. The Add Domain or LDAP Server dialog box 2. Select the LDAP Server option. Options within the LDAP Server group enable. 3. From the LDAP Server group, specify the following information: a. Server Name: In the Server Name text box, enter the name of the computer hosting Ultimus BPM Studio Client or its IP address. b. Time Out: In the Timeout text box, enter the LDAP authentication timeout interval (in milliseconds). c. Port: In the Port text box, enter the port to which Ultimus BPM Studio Client listens for connections. The port number can be any number between 1 and 65535. d. Root DNS: In the Root DNS text box, enter the Root DNS of the LDAP server to get connected. e. Base DN: In the Base DN text box, enter the Base DN of the LDAP server. f. Secure: Select the Secure check box if connecting to a secure LDAP server. g. User Name: In the User Name text box, enter the user name to successfully log on to the LDAP server. Note: When entering the user name, internal LDAP format may be used. For example, a valid user name would be cn=Marcus Anthony, ou=Documentation, dc=MyCompany, dc=com. h. Password: In the Password text box, enter the password to successfully log on to the LDAP server. 4. Select the OK button. Multiple LDAP servers may be configured using this procedure. To delete an existing domain or LDAP server configuration, follow these steps: 1. Select the Domains node from the Console tree. All configured domains and/or LDAP servers appear in the details window. 2. From the details window, right-click the domain or LDAP server configuration to be deleted, then select the Delete option. Deleting a domain 3. A dialog box appears to confirm if the domain should be deleted. Select the Yes button to delete the domain/LDAP server configuration.
Configuring Studio Configuration Access Rights This section discusses how you can define a list of users who have access to BPM Studio Configuration module. If no users are added to the Studio Configuration Access Rights list, all users can access the application using domain credentials. If access rights handling is defined, at least one user needs to be granted access rights to BPM Studio Configuration module. At BPM Studio Configuration login the system will check against this Studio Configuration Access Rights list. • Adding users to Studio Configuration Access Rights list • Removing users from the Studio Configuration Access Rights list
Adding users to Studio Configuration Access Rights list This section outlines how to grant access rights to a user who can then access Ultimus BPM Studio Configuration. 1. Select the Studio Configuration Access Rights node, then in the details window select and right-click the Studio Configuration option. Select Add/Remove (as shown in Figure 17). Adding a user to the Studio Configuration Access Rights list 2. In the Add/Remove Users window, select Add to see the available users. 3. Select the required users and click OK to grant them access to Ultimus BPM Studio Configuration. Note: If a name is not listed in the tree view, or for faster addition, the user name can be entered manually in the following format: <domain>/<user name> (as shown in access rights window). Browsing and selecting the user for the Studio Configuration Access Rights list
Removing users from the Studio Configuration Access Rights list This section outlines how to remove a user from the Studio Configuration Access Rights list. Note: If you remove all users from the list, Access Rights check will be disabled and everyone can login using domain credentials. 1. Select the Studio Configuration Access Rights node, then in the details window select and right-click the Studio Configuration option. Select Add/Remove (as shown in Figure  19). Removing a user from the Studio Configuration Access Rights list 2. The window listing all users with Studio Configuration access rights appear. Browse and select the user to be removed from the list and click Remove (as shown in Figure  20). Browse and select the user to be removed from the Studio Configuration Access Rights list 3. Click OK when finished.
Configuring access rights of BPM Studio Client users This section discusses how to add Ultimus BPM Studio Client users to Ultimus BPM Studio Configuration, then specify to which process repositories and Ultimus BPM Servers each user has access. • Adding Ultimus BPM Studio Client users • Granting Ultimus BPM Studio Client users access to process repositories • Granting Ultimus BPM Studio Client users access to Ultimus BPM Servers
Adding Ultimus BPM Studio Client users This section outlines how to add Ultimus BPM Studio Client users to Ultimus BPM Studio Configuration. Such users must be added to Ultimus BPM Studio Configuration to specify to which repositories and Ultimus BPM Servers those users have access. Ultimus BPM Studio Client users must have access to Ultimus BPM Servers to publish business processes. 1. Right-click the Access Rights node, then select New User. Adding a new Ultimus BPM Studio Client user from the Access Rights node The Add Users dialog box appears Note: If a name is not listed in the tree view, or for faster addition, the user name can be entered manually in the following format: <domain>/<user name> (as shown in access rights window). The User dialog box 2. Domains: Select the domain of the user whose access rights you are configuring. The domains that appear here are those that were added from the Domains node. 3. Depending upon the domain selected, a tree view appears. Select the user name from the tree, then click on OK . Ultimus BPM Studio Client uses that person’s short name for Windows authentication when logging on to an Ultimus BPM Studio process repository. The selected Ultimus BPM Studio Client user short name appears under the Access Rights node as well as in the details window. The selected Ultimus BPM Studio Client user appears under the Access Rights node Ultimus BPM Studio Client users added to Ultimus BPM Studio Configuration may be granted administrative rights. Once granted administrative rights, Ultimus BPM Studio Client users have the following attributes: • In Ultimus BPM Studio Client, a user with administrative rights on a particular repository may define access rights for all other users accessing that repository. These security rights can be applied at the process- or object-level and include the ability to edit, lock, delete, and publish business processes and objects. • A user with administrative rights may check in, check out, lock, delete, and publish business processes on behalf of any other user. This is useful in cases when an Ultimus BPM Studio Client user checks out an object, goes on vacation, but forgets to check in the object. The administrative rights user may then check in the object. At least one Ultimus BPM Studio Client user granted access to a process repository should be assigned administrative rights. However, due to the powerful nature of this function, it is recommended that only selected individuals be granted this privilege. To grant an Ultimus BPM Studio Client user administrative rights, follow these steps: 1. Expand the Access Rights node to expose all Ultimus BPM Studio Client users configured with Ultimus BPM Studio Configuration. 2. Select the Ultimus BPM Studio Client user to be granted administrative rights. Right-click, then select the Administrative Rights option. Granting Administrative Rights to an Ultimus BPM Studio Client Once selected, a check mark beside Administrative Rights appears, indicating that user has administrative rights to all process repositories to which that person has been granted access. To delete an Ultimus BPM Studio Client user from Ultimus BPM Studio Configuration, follow these steps: 1. Expand the Access Rights node to expose all Ultimus BPM Studio Client users configured with Ultimus BPM Studio Configuration. 2. Select the Ultimus BPM Studio Client user node that is to be deleted in one of these ways: • Right-click, then select the Delete option. • From the details window, right-click the Ultimus BPM Studio Client user name, then select the Delete option. Deleting an Ultimus BPM Studio Client user The Ultimus BPM Studio Client user, as well as any process repositories and/or Ultimus BPM Servers that user had been granted access, are deleted.
Granting Ultimus BPM Studio Client users access to process repositories This section outlines how to grant Ultimus BPM Studio Client users access to process repositories. This section assumes that at least one process repository configuration exists. To learn how to add a process repository configuration, refer to Configuring process repositories section. This section also assumes that at least one Ultimus BPM Studio Client user has been added to Ultimus BPM Studio Configuration. To learn how to add Ultimus BPM Studio Client users, refer to Adding Ultimus BPM Studio Client users section. To grant Ultimus BPM Studio Client users access to process repositories, follow these steps: 1. From the Access Rights node, expand the Ultimus BPM Studio Client user name node to expose the Repositories node. 2. Right-click on the Repositories node, then select the Add option. Granting an Ultimus BPM Studio Client user process repository access The Add Repository dialog box appears. The Add Repository dialog box 3. From the Add Repository: combo box, select the process repository on which the Ultimus BPM Studio Client user is to be granted access. 4. Select the OK button. Once the Ultimus BPM Studio Client user has been granted access to the process repository, the process repository name displays in the details window of the Repositories node under that user name node The Ultimus BPM Studio Client user has been granted access to a process repository To remove an Ultimus BPM Studio Client user’s access rights to a process repository, follow these steps: 1. Expand the Access Rights node until the Ultimus BPM Studio Client user’s node is exposed. 2. Expand the Ultimus BPM Studio Client user’s node, then select the Repositories node. The process repositories that the Ultimus BPM Studio Client user has been granted access appear in the details window. 3. From the details window, right-click the process repository on which the Ultimus BPM Studio Client user should no longer have access. Select the Delete option. Removing an Ultimus BPM Studio Client user’s access rights to a process repository The Ultimus BPM Studio Client user no longer has access to that process repository.
Granting Ultimus BPM Studio Client users access to Ultimus BPM Servers This section outlines how to grant Ultimus BPM Studio Client users access to Ultimus BPM Servers. This section assumes that at least one Ultimus BPM Server configuration exists. To learn how to add an Ultimus BPM Server configuration, refer to Configuring Ultimus BPM Servers section. This section also assumes that at least one Ultimus BPM Studio Client user has been added to Ultimus BPM Studio Configuration. To learn how to add Ultimus BPM Studio Client users, refer to Adding Ultimus BPM Studio Client users section. To grant Ultimus BPM Studio Client users access to Ultimus BPM Servers, follow these steps: 1. From the Access Rights node, expand the Ultimus BPM Studio Client user name node to expose the BPM Servers node. 2. Right-click on the BPM Servers node, then select the Add option. Granting an Ultimus BPM Studio Client user Ultimus BPM Server access The Add BPM Server dialog box appears. The Add BPM Server dialog box 3. From the Add Server: combo box, select the Ultimus BPM Server on which the Ultimus BPM Studio Client user is to be granted access for publishing business processes. 4. Select the OK button. Once the Ultimus BPM Studio Client user has been granted access to the Ultimus BPM Server, the name of the computer hosting the Ultimus BPM Server displays in the details window of the BPM Servers node under that user name node. The Ultimus BPM Studio Client user has been granted access to the Ultimus BPM Server To remove an Ultimus BPM Studio Client user’s access rights to an Ultimus BPM Server, follow these steps: 1. Expand the Access Rights node until the Ultimus BPM Studio Client user’s node is exposed. 2. Expand the Ultimus BPM Studio Client user’s node, then select the BPM Servers node. The Ultimus BPM Servers to which the Ultimus BPM Studio Client user has been granted access appear in the details window. 3. From the details window, right-click the Ultimus BPM Server on which the Ultimus BPM Studio Client user should no longer have access. Select the Delete option. Removing an Ultimus BPM Studio Client user’s access rights to an Ultimus BPM Server The Ultimus BPM Studio Client user no longer has access that Ultimus BPM Server for publishing business processes.
“Active users” are all Ultimus BPM Studio Client users currently connected to Ultimus BPM Studio Server. Any user with administrative rights can disconnect Ultimus BPM Studio Client user(s) whenever required, and can enable or disable Ultimus BPM Studio Client authentication. Disabling client authentication allows users to log on to Ultimus BPM Studio without entering a password. Dealing with active users To view or delete active users of Ultimus BBM Studio, follow these steps: 1. Right-click the Access Rights node, then select the Active Users... optionto open the Active Users dialog box. Selecting the Active Users option 2. The Active Users dialog box appears. The list shows the short names of all the users connected to Ultimus BPM Studio Server. The Active Users dialog box 3. Select the user short name(s) from the list of active users to be disconnected from Ultimus BPM Studio Server. 4. Select the Disconnect User button to disconnect the selected user(s) from Ultimus BPM Studio Server, or select the Disconnect All button to disconnect all connected users. 5. Click the Done button to close the dialog box. Enabling client authentication To enable client authentication in Ultimus BPM Studio Configuration, follow these steps: 1. Right-click the Access Rights node, then select the Active Users... option to open the Active Users dialog box. Selecting the Active Users option 2. The Active Users dialog box appears. If not enabled, select the Enable Client Authentication check box to enable client authentication for Ultimus BPM Studio Server. This option is enabled by default. This option functions independently of the client authentication option in Ultimus System Administrator. Enabling Ultimus BPM Studio Server client authentication in the Active Users dialog box 3. Click the Done button. This closes the Active Users dialog box.
Ultimus BPM Studio is designed on a two-tier architecture that consists of the following components: • The Ultimus BPM Studio Client operates on every process designer’s computer. This module serves as the primary interface that developers use to design and model business processes. • The Ultimus BPM Studio Server is a component that controls access to process repositories. Designers who are working collaboratively on process maps in the BPM Studio Client each have a connection to the particular Ultimus BPM Studio Server that manages access for those repositories. All business processes managed by Ultimus BPM Studio Servers are kept in a Microsoft SQL Server or in an Oracle database. This Help describes how to configure Ultimus BPM Studio Client users to access the Ultimus BPM Studio Server. Reader’s responsibilities and expectations After reading this Help, the reader should be able to use Ultimus BPM Studio Configuration. Ultimus expects the reader to: • Be proficient with the operating system(s) on which Ultimus Adaptive BPM Suite and its related components operate. For more information, refer to the Installation Guide issued for the respective Ultimus BPM Suite version. • Understand the hardware requirements to operate Ultimus Adaptive BPM Suite 2021 and each component there of. Contacting Ultimus Ultimus is always striving to improve its product and support services. Furthermore, Ultimus offers a number of ways to find answers or to submit feedback. You may use the following ways to find answers to your Ultimus-related questions or to submit feedback to Ultimus: • Ultimus Customer Portal: At the Ultimus Customer Portal, you can access technical experts to resolve your technical issues, use the KnowledgeBase to get answers to common and specific questions, and download the latest product builds and documentation. You can reach Ultimus Support at: http://www.ultimussupport.com/. • Ultimus Education: Ultimus Education provides technical training and certification to ensure you have up-to-date knowledge about the latest product releases. Ultimus Enterprise Integration Kit (EIK) training is provided on an as-needed basis. For more information, see http://www.ultimus.com/training-services or contact [email protected]. • Product enhancement: Ultimus strives to improve our product. If you would like to submit a product enhancement or feature concept, go to the Ultimus Customer Portal at: http://www.ultimussupport.com and follow the Ideas link in the upper area. • Documentation feedback: Ultimus strives to improve documentation quality. To submit a documentation feedback, visit http://www.ultimussupport.com. Conventions used in this document The following conventions are used throughout this document:   bold Bold text denotes items that you must select or click on in an application, such as menu options, dialog box options, and dialog box output. Bold text is also used to designate labels within table columns. italic Italic text denotes variables, emphasis, and document, chapter, and section titles. This also denotes text that is a place holder for a word or value that you must supply. monospace Text in this font denotes text or characters that you should input to an application, application output, sections of code, programming examples, and syntax examples. This is also used for the proper names of disk drives, paths, directories, device names, file names, file extensions, code excerpts, and hyperlinks. monospace italic Italic text in this font denotes text that is a placeholder for text or value(s) that you must supply. underlined blue text Underlined blue text represents a link to a different section in this document or reference to an external Web site. Clicking on the underlined blue text displays that topic or opens your preferred Web browser to display the external Web site. The symbol, along with underlined text, represents a link that may be selected to display an application procedure. The link opens (represented by the symbol) to display the application procedure. Selecting the link again hides the application procedure. » The » symbol leads you through nested Start menu options, application menu options, and dialog box options to a final action. For example, the sequence File»Page Setup»Printer... directs you to pull down the File menu, select the Page Setup item, then select Printer... from the dialog box. This icon denotes a video can be viewed when the icon or the hyperlink after the icon is clicked. The video plays in a new Web browser window, so ensure that Web browser pop-ups are allowed. This icon denotes a tip, which alerts you to advisory information. This icon denotes a note, which alerts you to important information. This icon denotes a caution, which advises you of precautions to take to avoid specific application errors, data loss, or system crash. This icon denotes a warning, which advises you of precautions to take to avoid damaging computer hardware or losing computer data.
Guidelines for Ultimus BPM Studio Servers and process repositories This section outlines guidelines for Ultimus BPM Studio Servers and process repositories. This section assumes the reader understands the primary components of the Ultimus BPM environment. To read more about the components of the Ultimus BPM environment, see the Configuration Guide issued for the respective Ultimus BPM Suite version. The following guidelines apply to Ultimus BPM Studio Servers and process repositories: • A single Ultimus BPM Studio Server is capable of housing multiple process repositories. For example, separate process repositories for Human Resources, Finances, and Sales departments may be maintained. • Each process repository is capable of housing multiple business processes. Instructions on how to publish business processes to process repositories is described in Ultimus BPM Studio Help. • Either a Microsoft SQL Server or an Oracle database must serve as the Ultimus BPM Studio Client repository in the Ultimus BPM environment. • Ultimus BPM Studio Server leverages either a Microsoft SQL Server or an Oracle Server database to store business process definitions. To learn which database applications are supported or how to configure an Ultimus BPM Studio Server to use database applications, see the Installation Guide issued for the respective Ultimus BPM Suite version. • Each process repository must point to a different physical database. The same physical database and table definitions cannot be shared for multiple process repositories. For example, if two process repositories are maintained in the database application (one for Finances, the other for Sales), two separate database definitions must be set up in that database application. Furthermore, each process repository must have two different System OLE DB database definitions, each pointing to a database. Note: If the connection to Ultimus BPM Database is using an SQL trusted connection: for a detailed explanation of the necessary configurations, see the Configuration Guide issued for the respective Ultimus BPM Suite version.
Ultimus BPM Studio Configuration Help Ultimus Digital Process Automation Suite 2021 Copyright information No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose, without the express written consent of Ultimus, Inc. The software described in this manual is furnished under a license agreement or non-disclosure agreement and may be used or copied only in accordance with the terms of the agreement. The information contained in this manual is subject to change without notice and does not represent a commitment on the part of Ultimus, Inc. Copyright © 1999-2021 Ultimus, Inc. All rights reserved. Companies, names, and data used in examples herein are fictitious unless otherwise noted. Ultimus®, Adaptive Discovery®, BAMport™, Flobot™, FloPort™, FloStation™, iBAM™, Inlet™, Maplet™, Profit from the Process™, U2Net™, and Unruly Event™ are trademarks of Ultimus, Inc. Windows, MS-DOS, Word, Excel, InfoPath, and SQL Server are registered trademarks of Microsoft Corp. All other names may be trademarks of their respective owners and are used for reference only. All Ultimus specifications contained in documentation and literature are subject to change without notice. This document was last updated on March 18, 2021.
This section discusses how to log on to Ultimus BPM Studio. In connecting to the repository for the first time, some assistance may be required from the Ultimus administrator to define the settings below. To start Ultimus BPM Studio, follow these steps: 1. Select Start»Programs»Ultimus Digital Process Automation Suite 2021 »Ultimus BPM Studio. The login dialog box appears. Ultimus BPM Studio login dialog box 2. Specify the computer hosting Ultimus BPM Server in which to connect. To do so, select the Change option opposite the Server: label. The Change Server dialog box appears. The Change Server dialog box Enter the following information into the Change Server dialog box: • Server: Select the browse button opposite the Server: text box to select a server from the list. Alternatively, type the name of the computer hosting Ultimus BPM Server in which to connect. • Port: In the Port: text box, specify the port in which the computer hosting Ultimus BPM Server is waiting for connections. By default, this is port 80 unless changed by the Ultimus system administrator. • Secure: Select the Secure check box if the connection to Ultimus BPM Server is a secure connection. By default the port for secure connections is 443 unless changed by the Ultimus system administrator. Once this information has been provided, click the OK button. 3. If using Windows Authentication to provide log on credentials, select the Use Windows Authentication check box, then select the Log On button. Tip: Windows Authentication may be disabled once successfully logged on to Ultimus BPM Studio. To do so, select the Tools»Disable Windows Authentication menu option. Otherwise, in the User ID: text box, enter the user name to log on to Ultimus BPM Studio. 4. In the Password: text box, enter the password to log on to Ultimus BPM Studio. 5. From the Domain: combo box, select to which domain the process designer belongs. The list displayed here is the one configured in Ultimus BPM Studio Configuration. 6. Specify the name of the Ultimus BPM Studio repository. To do so, select the Change option opposite the Repository: label. The Change Repository dialog box appears. The Change Repository dialog box From the Repository: combo box, select the Ultimus BPM Studio repository, then click on OK. 7. Click Log On. Note: It is not possible to log on using the same credentials on another computer. To do so, the previous session must be terminated from Ultimus BPM Studio Configuration’s active users. For more information, refer Viewing Ultimus BPM Studio Client user activity section in Ultimus BPM Studio Configuration Help.. Once successfully logged on, the Ultimus BPM Studio interface displays in Preview mode. For information on working in the Preview mode, refer to Working in the Preview mode section. The Ultimus BPM Studio main interface In Ultimus BPM Studio, business processes are designed in two different modes: modeling and building. Each are described briefly below: • Modeling mode: The goal of modeling is to ensure that the business process behaves as expected and yield results that are consistent with the requirements of the business owners, and the expectations of the customers who are served by the business process. Modeling mode is designed for business users who understand the needs a business process must fulfill. • Build mode: Once modeled, process designers can import a business process into Build mode. Build mode represents the central working environment in Ultimus BPM Studio for process design.   Starting a new business process To start working on a new business process, follow these steps: 1. Perform one of the following: a. From the Repository window, select the New button (). b. From the Repository window, right-click on the Processes folder, then select New. Starting work on a new business process 3. Type a name for the new business process. 4. Open the business process in Build or in Modeling mode Right-click on the business process to open, and select one of the following: a. Select Edit to open the business process in Build mode. b. Select Edit (Model) to open the business process in Modeling mode. Bringing the business process into Modeling mode Tip: To get started with modeling, see Working with the Process editor in Modeling mode. To get started with designing process in build mode, Working with the Process editor in Build mode.
Working in the Preview mode This section outlines features available while working in Preview mode. The Preview mode contains the following user interface elements: • The menu bar • The Standard toolbar User interface elements within the Preview mode editor are discussed below.
The menu bar Below is a description of unique menu bar item(s) when working in the Preview mode. For information on common menu bar items in all editors, refer to The menu bar section. • File • Object • View • Tools 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 are accessible under the File menu when working in the Preview mode: • Close • Close All • Save • Save All • Exit Each of these functions is described below.
Close The Close menu option closes the displayed editor. Since it is the Preview mode and none of the editors are displayed, this option is not available.
Close All The Close All menu option closes all editors associated with the business process. Since it is the Preview mode and none of the editors are displayed, this option is not available.