Datasets:
SaffalPoosh
/
ultimus_docs_dataset

Dataset card Data Studio Files
xet
 Community
1
ultimus_docs
stringlengths
52
24.9k
Save The Save menu option (CTRL-S shortcut) saves the content of the active editor. Since it is the Preview mode and none of the editors are displayed, this option is not available.
Save All The Save All menu option (CTRL-SHIFT-S shortcut) saves the entire business process. Since it is the Preview mode and none of the editors are displayed, this option is not available.
Exit The Exit menu option closes Ultimus BPM Studio.
Object Items under the Object menu may be accessed with the keyboard shortcut ALT-E. The options available under the Object menu become active depending upon the currently selected node in the Repository window. The following functions are accessible under the Edit menu when working in the Preview mode: • Repository •...
Repository The Repository menu option is used to check in/check out a selected object from the Repository window, view the history of the selected object or undo any changes made during the last check out.
Edit The Edit menu option is used to open the selected object in the Build editor mode.
Edit (Model) The Edit (Model) menu option is used to open the selected object in the Modeling editor mode.
Simulate The Simulate menu option is used to simulate a selected process from the Repository window. Simulation is a powerful tool which is helpful in thoroughly testing the business process before publishing it to Ultimus BPM Server.
Security The Security menu option allows the process designer or Ultimus system administrator to control who can edit, delete, lock, and publish objects; only such an individual can define object security on all object types in Ultimus BPM Studio. Tip: User access rights for process repositories is controlled through ...
New The New menu option allows creating a new object in the currently selected repository. This is a context sensitive menu option and depends upon which folder is selected from the Repository window. For example, if Processes folder is selected, a new process node is created under the Processes folder. However, if a F...
Add Existing The Add Existing menu option adds pre-defined objects to the currently selected repository.
Delete The Delete menu option deletes the currently selected object from the Repository window, provided the deletion conditions are met.
Rename The Rename menu option allows to rename the selected object from the Repository window.
Create Copy The Create Copy menu option creates a copy of the currently selected object. When a copy is created, it is given a name automatically in the following format: Copy [number] of [object name], where • [number] is the ‘serial’ number of the copy (you can create more than one copies) • [objectname] is the n...
Create Folder The Create Folder menu option creates a new folder under the currently selected folder in the Repository window.
Generate Documentation The Generate Documentation menu option opens the Generate Documentation dialog box. The Generate Documentation dialog box is used to design documentation templates relating to design, functionality, and specifications for the business process. This information may then be used to develop the busi...
Notes... The Notes... menu option opens a comprehensive text editor, where detailed notes for the currently selected object from the Repository window can be entered. The Notes dialog box
Publish The Publish menu option allows publishing the currently selected object from the Repository window, to the Ultimus BPM Server.
Save Offline The Save Offline menu option allows saving the currently selected object from the Repository window as an offline object. This allows process participants to work on objects on their local computers, without having to connect to the process repository. The Save Offline menu option is active and available o...
Save to Disk... The Save to Disk... menu option allows saving the currently selected object from the Repository window to a local computer’s hard disk.
Import from XML... The Import from XML option is used to import an XML file into Ultimus BPM Studio from third-party or custom applications which include an XML data model. Once imported, this content can be saved as a new .WFL file for further development. This is useful to import content from BPA or other BPM tools f...
Export as XML... The Export as XML... function is used to export a business process to an XML file. The business process may be checked in or checked out in Preview mode for this option to be available. Customers who utilize third-party BPM tools can export the Ultimus business process into an external XML file so that...
Properties The Properties menu option displays the Properties window for the currently selected object from the Repository window.
View Items under the View menu may be accessed with the keyboard shortcut ALT-V. The following unique functions are accessible under the View menu when working in the Preview mode: • Toolbars • Windows Each of these functions is described below.
Toolbars The Toolbars menu option contains one submenu options: Standard. This option is used to display or hide specific toolbars in the Ultimus BPM Studio interface. The Standard submenu option is a toggling menu option that makes the Standard toolbar appear and disappear on the Ultimus BPM Studio interface. The Stan...
Windows The Windows menu option contains five submenu options: • Properties • Event Log • Connectors • Repository • Publish Log These options are used to display or hide specific windows in the Ultimus BPM Studio user interface. Each of these submenu options is discussed below.
Properties The Properties submenu option displays the Properties window. The Properties window displays properties for any selected object in the business process or editor workspace. When the icon beside the Properties submenu option is highlighted, the Properties window is visible.
Event Log The Event Log submenu option displays the Event Log window. The Event Log window displays event logs, information, caution, and warnings from Ultimus BPM Server as it performs functions. When the icon beside the Event Log submenu option is highlighted, the Event Log window is visible. For more information abo...
Connectors The Connectors submenu option displays the Connectors window. The Connectors window displays information regarding configured connections to databases, Web services, and mail servers in the Ultimus BPM environment. When the icon beside the Connectors submenu option is highlighted, the Connectors window is vi...
Repository The Repository submenu option displays the Repository window. The Repository window displays repositories, business processes, and process objects. It is used to organize business processes and objects within repositories.When the icon beside the Repository submenu option is highlighted, the Repository windo...
Publish Log The Publish Log submenu option displays the Publishing Process window. The Publishing Process window displays the log information generated while publishing the selected object from the Repository window.
Tools Items under the Tools menu may be accessed with the keyboard shortcut ALT-T. The following unique functions are accessible under the Tools menu when working in the Preview mode: • Change Repository... • Import Offline Object... • Add External Editor... Each of these functions is discussed below.
Change Repository... The Change Repository... menu option is used to change the current working repository. When selected, the Change Repository dialog box appears. The Change Repository dialog box From the Repository: list box, select a repository and click the OK button. For information on how to reference a reposit...
Import Offline Object... The Import Offline Object... menu option is used to import an offline object to the currently selected repository. When this menu option is selected, the Import Offline Object dialog box appears. The Import Offline Object dialog box To import an offline object, follow these steps: 1. From the ...
Add External Editor... The Add External Editor... menu option allows adding an external editor as a plug-in under the currently opened repository. External code and content can easily be edited using external editors in Ultimus BPM Studio. When this menu option is selected, the Add External Editor dialog box appears. ...
The Standard toolbar For information on options available in the Standard toolbar when working in the Preview mode, refer to The Standard toolbar section.
This section introduces the menu bar and the Standard toolbar options, common to all editors in the Ultimus BPM Studio environment. Refer to the following sections: • The menu bar • The Standard toolbar
The menu bar This section describes the common menu bar options in all editors. These are as follows: • File • Edit • View • Tools • Help Functions within each of these items are described below.
File Items under the File menu may be accessed with the keyboard shortcut ALT-F. The following functions under the File menu are common to all Ultimus BPM Studio editors: • Close • Close All • Save • Save All • Exit Each of these functions is discussed below.
Close The Close menu option closes the displayed editor. If contents within that editor have been revised since it was opened, a prompt to save changes is displayed.
Close All The Close All menu option closes all editors associated with the business process. If any editor(s) within the business process has been revised since it was opened, a prompt to save changes is displayed.
Save The Save menu option (CTRL-S shortcut) saves the content of the active editor.
Save All The Save All menu option (CTRL-SHIFT-S shortcut) saves the entire business process.
Exit The Exit menu option closes Ultimus BPM Studio. If an opened business process has been revised since it was opened, a prompt to save changes in the business process is displayed before Ultimus BPM Studio closes.
Edit Items under the Edit menu may be accessed with the keyboard shortcut ALT-E. The following functions under the Edit menu are common to all Ultimus BPM Studio editors: • Undo • Redo • Cut • Copy • Paste • Delete Each of these functions is discussed below.
Undo The Undo menu option (CTRL-Z shortcut) is used to undo the last action. Ultimus BPM Studio keeps track of all actions performed since the editor was opened. The Undo function is only available once an action has been executed which may be undone. Note: The Undo function does not work in the Modeling Rules window,...
Redo The Redo menu option (CTRL-Y shortcut) is used to redo the action if the undo function was just performed. The redo function may be used as many times as the undo function was just used. The Redo function is only available once the Undo function has been used.
Cut The Cut menu option (CTRL-X shortcut) deletes a selected object. In doing so, that object is also saved in Windows Clipboard, so it may be pasted. The Cut function is only available when an object is selected.
Copy The Copy menu option (CTRL-C shortcut) copies a selected object. In doing so, that object is saved in Windows Clipboard, so it may be pasted. The Copy function is only available when an object is selected.
Paste The Paste menu option (CTRL-V shortcut) pastes an object which has been saved in Windows Clipboard. Once the Paste function is used, move the mouse to the desired location for the object, then left-click the mouse to place the object. The Paste function is only available when an object has been cut or copied into...
Delete The Delete menu option deletes a selected object. The Delete function is only available when the selected object can be deleted.
View Items under the View menu may be accessed with the keyboard shortcut ALT-V. The following functions under the View menu are common to all Ultimus BPM Studio editors: • Status Bar • Large Icons • Toolbars • Windows • Color Scheme • Switch View Each of these functions is discussed below.
Status Bar The Status Bar menu option is a toggling menu option that makes the Status bar appear and disappear on the Ultimus BPM Studio interface. When the icon beside the Status Bar menu option is highlighted, the Status bar is visible.
Large Icons The Large Icons menu option is a toggling menu option that makes icons in the Ultimus BPM Studio interface appear larger. When the icon beside the Large Icons menu option is highlighted, large icons are displayed.
Toolbars The Toolbars menu option contains different submenu options depending upon the editor that is currently selected. These options are used to display or hide specific toolbars in the Ultimus BPM Studio interface. For further details, refer to the respective editor section.
Windows The Windows menu option contains different submenu options depending upon the editor that is currently selected. These options are used to display or hide specific windows in the Ultimus BPM Studio user interface. For further details, refer to the respective editor section.
Color Scheme The Color Scheme menu option contains two options: Blue and Green. Each of these options is discussed below.
Blue Displays the Ultimus BPM Studio user interface with the blue color scheme. When the icon next to the Blue submenu option is highlighted, the Ultimus BPM Studio user interface displays using the blue color scheme.
Green Displays the Ultimus BPM Studio user interface with the green color scheme. When the icon next to the Green submenu option is highlighted, the Ultimus BPM Studio user interface displays using the green color scheme.
Switch View The Switch View menu option contains two options: BPMN view and Ultimus Standard view. Each of these submenu options is discussed below.
BPMN view Displays the visible process map in BPMN view. This view uses a set of symbols inspired by the symbols of the Business Process Modeling Notation (BPMN). If the process map is already displayed in BPMN view, this option is disabled.
Ultimus Standard view Displays the visible process map in Ultimus standard view. If the process map is already displayed in Ultimus standard view, this option is disabled.
Tools Items under the Tools menu may be accessed with the keyboard shortcut ALT-T. This menu option provides configuration support. The following functions under the Tools are common to all Ultimus BPM Studio editors: • Disable Windows Authentication • Enable AutoSave • Verify on Check In Each of these functions is ...
Disable Windows Authentication The Disable Windows Authentication menu option is used to disable Windows Authentication if that feature is enabled. If disabled, the next time the Ultimus BPM Studio process designer logs on, he or she must use proper user name and password credentials to log on to Ultimus BPM Studio. T...
Enable AutoSave The Enable AutoSave menu option is a toggling menu option that automatically saves any changes made while working on the business process. When the icon beside the Enable AutoSave menu option is highlighted, changes are saved automatically when any editor within Ultimus BPM Studio is closed; the process...
Verify on Check In The Verify on Check In menu option, when enabled, verifies consistency and validity of business process objects when the business process is checked in to the process repository. When the icon beside the Verify on Check In menu option is highlighted, the Ultimus engine performs its consistency and va...
Help Items under the Help menu may be accessed with the keyboard shortcut ALT-H. This menu option provides access to Ultimus BPM Studio Help and version information. The following functions under the Help menu are common to all Ultimus BPM Studio editors: • Ultimus BPM Studio Help • About Ultimus BPM Studio Each of t...
Ultimus BPM Studio Help The Ultimus BPM Studio Help menu option accesses the Ultimus BPM Studio Help.
About Ultimus BPM Studio The About Ultimus BPM Studio menu option displays information about Ultimus BPM Studio, such as its build and version number.
The Standard toolbar This section describes the Standard toolbar button options available in all editors. Below is a description of buttons on the Standard toolbar: Save button • Save (): The Save button saves the content of the active editor. Save All button • Save All (): The Save All button saves the entire busine...
This section introduces the Repository window. The Repository windowis a dockable window which can be detached from the workspace and moved to other areas on the screen or attached at other borders of Ultimus BPM Studio. The Repository window The Repository window is used for browsing and manipulating processes, proce...
The Repository window toolbar This section describes the Repository window toolbar. The Repository window toolbar Below is a description of buttons on the Repository window toolbar: New button • New (): Selecting the New button creates a new object under the currently highlighted folder in the Repository window. For ...
Processes folder The Processes folder is where all published business processes are organized. The process designer can add, edit, create, delete and rename processes along with a number of other actions while working in this folder. For information on how to perform actions in the Processes folder, refer to Processes ...
Map Properties The Map Properties subnode accesses general properties information for the entire process. Information regarding incident level e-mail notifications, Completion Time and Help URL is saved in the Map Properties and can be modified through the Map Properties editor. To design or edit Map Properties, check ...
Rules The Rules node allows the management and viewing of all process-level business rules. To design or edit the process-level business rules, check out the Rules node, then right-click and select Edit. Alternatively, select the Edit button () from the Repository window toolbar or select Object»Edit from the menu bar....
Process XML Schema The Process XML Schema node is used to define an XML schema for the business process, thereby defining what, where, and how data is routed in the business process. To edit the process XML schema, check out the Process XML Schema node, then right-click and select Edit. Alternatively, select the Edit b...
Global XML Type Definitions The Global XML Type Definitions node displays global elements and data types that are used throughout the process. A data type is a schema type that is common throughout a business process and can be used to create process and step XML schemas. Types defined here are available for subsequent...
Form Objects Ultimus BPM Studio may be used to create and save reusable “form objects” in a library. The Form Objects node is used to define a standard set of form controls which can be grouped and saved for insertion into any Ultimus Form of a process. Objects created under the Form Objects node retain their positioni...
Steps The Steps node stores the steps defined in the business process. The Steps node has additional subnodes for managing business rules for each step, properties for each step, and other step-related settings that are dependent on the step type. For information on how to design steps, refer to Working with the Proces...
Actions The Actions node stores all the actions defined for the business process.The Actions node has two additional subnodes: • .Net Code: .NET Code custom actions may be created and stored under the Actions node. The .NET Code custom actions execute .NET Code in Ultimus Director. When rules evaluate for a particular...
Documentation Templates folder Ultimus BPM Studio provides the capability to take the process design and produce an electronic document that describes the model, its objects, and requirements. The Documentation Templates folder stores multiple document templates used as a foundation to generate technical documentation ...
Context menu options The context menu for each node in the Repository window must be according to which features are available for that node. The context menu presents various options through which the majority of design features in Ultimus BPM Studio can be performed. The context menu options depend on the node curren...
Processes folder options This section describes the options available when right-clicking on the Processes folder. The Processes folder context menu Following is the list of context menu options for the Processes folder: New • New (): Selecting the New option creates a new business process. To create a new business p...
Selected process level options This section describes the options available at the selected process level. The process folder context menu when the selected process is checked in Following is the list of context menu options when the selected business process is checked in: Repository • Repository: The Repository opt...
Documentation Templates folder options This section describes the options available when the Documentation Templates folder is right-clicked on. The Documentation Templates folder context menu Following is the list of context menu options for the Documentation Templates folder: New • New (): Selecting the New option ...
Selected documentation template level options This section describes the options available at the selected documentation template level. The context menu of a documentation template when it is checked in Following is the list of context menu options when a specific documentation template is checked in: Repository • R...
The Repository window properties This section discusses the properties of the objects accessible in the Repository window. All objects possess the same common properties showing the current status. Following is the list of these properties (All properties are listed by their category): • Name: The Name property displa...
Connectors make it easier to interact with all databases, Web services, CPS Solutions, or mail server connections used in the Ultimus environment. A connector may be defined in Ultimus System Administrator, then another connector with the same name and properties needs to be defined in Ultimus BPM Studio: the database ...
Types of connectors There are different types of connectors: • Database connectors: Database connectors are used for making connections to database repositories accessed in the Ultimus DPA environment. Database connectors support Microsoft SQL Server, Oracle and IBM DB2 data sources. For information on how to create D...
The Connectors window toolbar Below is a description of buttons on the Connectors window toolbar. • New (): The New list is used to create a new connector. It has the following options to select from: Database, E-Mail, Web Service, Custom and CPS. • Edit (): The Edit button is used to edit the properties of a selecte...
Creating a Database connector To create a Database connector, follow these steps: 1. Click the New () button from the Connectors window toolbar, then select the Database option (). The Database Connector dialog box appears. The Database Connector dialog box using SQL Server 2. In the Name: text box, enter the name fo...
Creating an E-mail connector To create an E-mail connector, follow these steps: 1. Open View » Windows » Connectors Click the New () button in the Connectors window toolbar. Select the E-Mail to display the E-Mail Connector dialog box Creating an SMTP connection in E-Mail Connector dialog box 2. In the Name: text box, ...
Creating a Web service connector To create a Web service connector, follow these steps: 1. Click the New () button from the Connectors window toolbar, then select the Web Service option (). The Web Service Connector dialog box appears. The Web Service Connector dialog box 2. In the Name: text box, enter the name for t...
Creating a Custom connector To create a Custom connector, follow these steps: 1. Click the New () button on the Connectors window toolbar, then select the Custom Connector option. The Custom Connector dialog box appears. Custom Connector dialog box 2. In the Name text box, enter the name for the new Custom connector. ...
Creating a CPS connector CPS connectors are used to connect to any CPS Form or CPS Service. Caution: Custom Form URLs are not supported with for CPS Forms. Therefore, when defining the Default Forms for Process Steps using Ultimus CPS, use CPS connectors. To create a CPS connector, follow these steps: 1. Click the Ne...
Editing connector properties To modify the properties of an existing connector, follow these steps: I. In the Connectors window, select the connector name from the list of connectors. 2. Click the Edit () button from the Connectors window toolbar. The dialog box to configure that connector type appears. 3. Edit the c...
Deleting a connector To delete a connector, follow these steps: I. In the Connectors window, select the connector name from the list of connectors. 2. Click the Delete () button from the Connectors window toolbar. A message appears to confirm that the connector is to be deleted. 3. Select Yes to delete the connector; s...
This section briefly introduces the Event Log window. The Event Log window is used for viewing the log messages during simulation, publishing a process and other processing done in Ultimus BPM Studio. This includes displaying error messages as a result of a consistency check (when performed), output and error messages ...
Operations performed when a business process is checked in Once a business process is cleared for check-in, a number of consistency checks are performed to ensure that the business process and its components function as desired when published on Ultimus BPM Server. Consistency checks are performed every time a business...
This section discusses the Organizations dialog box. The Organizations dialog box is used to search and browse for individuals in the organization. This may be accomplished in different ways depending on how the User Search and Browse dialog box is used within Ultimus Digital Process Automation (DPA) Suite. The User S...