Datasets:
SaffalPoosh
/
ultimus_docs_dataset

Dataset card Data Studio Files
xet
 Community
1
ultimus_docs
stringlengths
52
24.9k
Creating a documentation template Ultimus BPM Studio provides the facility to create a documentation template that specifies the format and content of the documentation. Multiple document templates can be created and used for different purposes. Creating a documentation template To create a documentation template, foll...
The Process editor is used to display and edit the process map for either Build or Modeling modes in Ultimus BPM Studio. The Process editor, in Build mode, can be accessed when a process is checked out for editing in the Repository window. This section discusses the following topics regarding the Process editor in Buil...
Overview The Process editor, in Build mode, is the central working environment in Ultimus BPM Studio. Process modeling development (in Ultimus Process Designer or Ultimus BPM Studio’s Modeling mode) can be leveraged to jump-start process development. Below is a broad overview of functions which can be performed in the ...
The Process editor in Build mode Tip: See Open the business process in Build or in Modeling mode. Tip: To get started with designing process in Modeling mode, see The Process editor in Modeling mode. The Process editor in Build mode contains the following user interface elements: • The menu bar • The Standard toolb...
The menu bar Below is a description of unique menu bar item(s) when viewing the Process editor in Build mode. For information on common menu bar items in all editors, refer to The menu bar section. • File • 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 unique functions are accessible under the File menu when viewing the Process editor in Build mode: • Print • Print Preview • Print Setup Each of these functions is discussed below.
Print The Print menu option (CTRL-P shortcut) prints the process map. This function is not available during simulation.
Print Preview The Print Preview menu option displays a preview of the process map for printing. Once the Print Preview menu option is selected, the following options are available in the Process editor: • Print (): The Print button prints the displayed preview. • Next Page (): The Next Page button displays the next p...
Print Setup The Print Setup menu option is used to configure printer settings.
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 viewing the Process editor in Build mode: • Toolbars • Windows • Grid • Snap to Grid Each of these functions is discussed below.
Toolbars The Toolbars menu option contains three submenu options: • Standard • Designer • Simulation These options are used to display or hide specific toolbars in the Ultimus BPM Studio interface. Each of these submenu options is discussed below.
Standard The Standard submenu option is a toggling menu option that makes the Standard toolbar appear and disappear on the Ultimus BPM Studio interface. The Standard toolbar offers convenient access to common functions. When the icon beside the Standard submenu option is highlighted, the Standard toolbar is visible. Fo...
Designer The Designer submenu option is a toggling menu option that makes the Designer toolbar appear and disappear on the Ultimus BPM Studio interface. The Designer toolbar offers convenient access to process map design functions. When the icon beside the Designer submenu option is highlighted, the Designer toolbar is...
Simulation The Simulation submenu option is a toggling menu option that makes the Simulation toolbar appear and disappear on the Ultimus BPM Studio interface. The Simulation toolbar offers convenient access to business process simulation functions. When the icon beside the Simulation submenu option is highlighted, the ...
Windows The Windows menu option contains six submenu options: • Properties • Event Log • Connectors • Repository • Toolbox • Simulation Watch 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. For more information about the Prop...
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...
Toolbox The Toolbox submenu option displays the Toolbox window. The Toolbox window displays different tools to be added to the process map. For more information about the Toolbox window, refer to The Process editor toolbox section.
Simulation Watch The Simulation Watch submenu option displays the Simulation Watch window. The Simulation Watch window is used to monitor XML schema element values, and is therefore useful in debugging and testing business processes. The Simulation Watch submenu option is available only when simulation mode is in progr...
Grid The Grid menu option displays a grid by which process map objects may be aligned. The grid is only for visual purposes.
Snap to Grid The Snap to Grid menu option automatically places steps into the center of the nearest grid box. This option is only available when the Grid option is enabled.
Tools Items under the Tools menu may be accessed with the keyboard shortcut ALT-T. This menu option provides configuration support. The following unique functions are accessible under the Tools menu when viewing the Process editor in Build mode: • Change Organization Server • Change Simulation Database • Change Mode...
Change Organization Server The Change Organization Server menu option is used to change which Organization Server Ultimus BPM Studio is connected. The Organization Server maintains business chart information as designed in Ultimus Organization Charts and directory structure information as configured in Ultimus System A...
Change Simulation Database The Change Simulation Database menu option opens the Simulation Database Settings dialog box. The Simulation Database Settings dialog box is used to define the simulation database that is necessary to run process simulations. For more information, see section Configuring a simulation databas...
Change Model Database The Change Model Database menu option opens the Model Database Settings dialog box. The Model Database Settings dialog box is used to define the model database that is necessary to run process modeling. For more information, see section Modeling Database and Configuring a Modeling Database.
Custom Flobots The Custom Flobots menu option is used to add or remove custom Flobots (or “Automated Activities,” as they are called in BPMN view). Custom Flobots/Automated Activities provide functionality from third-party developers. Because custom Flobots/Automated Activities are not part of Ultimus Digital Process A...
Swim Colors Swim Colors are used to distinguish steps based on their type, resource, recipients, or any other attributes the process designer finds relevant. For example, in a business process, all steps assigned to the Purchasing department can be assigned a green Swim Color to indicate that these steps are being perf...
The Standard toolbar For information on options available in the Standard toolbar, refer to The Standard toolbar section.
The Designer toolbar Below is a description of buttons on the Designer toolbar when viewing the Process editor in Build mode: Print button • Print (): The Print button prints the process map. Print Preview button • Print Preview (): The Print Preview button displays a preview of the process map for printing. Once the...
The Simulation toolbar Below is a description of buttons on the Simulation toolbar when viewing the Process editor in Build mode: Simulate button • Simulate (): The Simulate button is used to test the process before deploying it to be used by all process participants. Running a simulation displays exactly how the busi...
The Process editor toolbox The Process editor toolbox groups its tools in three categories. These categories vary in name depending on whether displayed in Ultimus Standard view, or BPMN view. Tip: To learn how to switch between Ultimus Standard view and BPMN view, refer to Switch View section. The toolbox categories ...
General Below is a description of tools in the General category. Tool names in Ultimus Standard view and BPMN view are both presented. The images reflect in Ultimus Standard view. Arrow tool • Arrow (): The Arrow tool is used to select process map elements. Text/Annotations tool • Text/Annotations (): The Text/Annota...
Anchors Anchors are used to change the path of links and virtual links in the process map. Up to ten anchors may be inserted on to any link or virtual link. Anchors appear as dots on the process map. At each anchor, the path of the link may be changed. This allows process designers to create clear, easy-to-discern link...
Steps (“Activities and Gateways” in BPMN view) Below is a description of tools in the Steps category (“Activities and Gateways” in BPMN view). Tool names in Ultimus Standard view and BPMN view are both presented. The images reflect in Ultimus Standard view. User tool • User (): The User tool is used to place a User st...
Flobots (“Automated Activities” in BPMN view) Below is a description of tools in the Flobots/Automated Activities category. Flobots (or “Automated Activities” as they are called in BPMN view) provide a powerful means of using third-party applications to perform specific tasks as steps in a business process. Flobots are...
Creating groups in a process map Two or more process map objects may be “grouped.” This grouping is nothing more than a visual cue that there is an association between these objects and has no effect on Ultimus engine logic. However, once objects are grouped, the collective group may be moved together in the process ma...
The Properties window This section discusses options available when the Properties window is displayed. The Properties window is a dockable window. The Properties window The options available in the Properties window vary in accordance to what is selected in the process map or from the Properties combo box. The Prope...
Configuring an e-mail notification using the Properties window Within many properties, e-mail notifications can be configured to inform process participants, process designers, and/or process experts when particular events take place during the course of a process incident. For example, Ultimus BPM Server can send an e...
Associating a global schema element or an Ultimus Keyword with a property Many properties are configured by associating the property with an Ultimus Keyword or a global schema element. When configured this way, the Ultimus Keyword or global schema element represents and specifies that property’s value. Ultimus Keyword...
Business process properties This section discusses properties for the business process. Business process properties are displayed in the Properties window. Business process properties To view business process properties, perform one of the following: • With nothing selected in the process map, select View»Windows»Pro...
Email Notifications Properties within the Email Notifications category: • Incident Aborted: The Incident Aborted property is used to dictate whether Ultimus BPM Server is to send an e-mail notification each time an incident from this business process is aborted. This property can be configured to specify the content o...
General Properties within the General category: • Name: The Name property specifies the name of the published business process. This property cannot be edited. • Family Name: The Family Name property specifies the name of the CPS Family the business process should be linked to. • Solution Name: The Solution Name pro...
Begin step properties Begin step properties are displayed in the Properties window. The Properties window for the Begin step in a process map To view properties for the Begin step, perform one of the following: • Select the Begin step, then select View»Windows»Properties from the menu bar. • Select the Begin step, r...
Email Notifications Properties within the Email Notifications category: • New Task: The New Task property is used to dictate whether Ultimus BPM Server is to send an e-mail notification each time a new process incident has been started. This property can be configured to specify the content of the e-mail notification....
General Properties within the General category: • Name: The Name property represents the Begin step’s label in the process map, and is used by Ultimus BPM Studio to report any errors pertaining to the step. It is also used in report output. The name must, therefore, be unique. It is possible to change the label when t...
Security Properties within the Security category: • Non-Assignable: The Non-Assignable property represents the Begin step cannot be assigned. If the Yes option is selected, the Begin step cannot be assigned. If the No option is selected, the Begin step can be assigned. The default option is No. • Private: The Private...
End step properties The End step does not have any configurable properties. This is because the End step represents the conclusion of the process incident.
User step properties User step properties are displayed in the Properties window. User step properties To view properties for a User step, perform one of the following: • Select the User step in which to view its properties, then select View»Windows»Properties from the menu bar. • Select the User step in which to vi...
Email Notifications Properties within the Email Notifications category: • Minimum Response: The Minimum Response property is used to dictate whether Ultimus BPM Server is to send an e-mail notification when a minimum number of group recipients have responded to the task. When a job function, department, or group is se...
General Properties within the General category: • Name: The Name property represents the User step’s label in the process map, and is used by Ultimus BPM Studio to report any errors pertaining to the step. It is also used in report output. The name must, therefore, be unique. It is possible to change the label when th...
Security Properties within the Security category: • Non-Assignable: The Non-Assignable property represents the User step cannot be assigned. If the Yes option is selected, the User step cannot be assigned. If the No option is selected, the User step can be assigned. The default option is No. • Private: The Private pr...
Flobot/Automated Activity step properties Business process management involves applications, including databases, ERP, accounting, word processors, and spreadsheets. Business applications are used to produce reports, search for information, do analysis, and produce charts and graphs. To automate business processes, it ...
Email Notifications Properties within the Email Notifications category: • Task Failed: The Task Failed property is used to dictate whether Ultimus BPM Server is to send an e-mail notification if the Flobot/Automated Activity task fails to be completed. This failure may be due to a problem with the Ultimus FloStation p...
General Properties within the General category: • Name: The Name property represents the Flobot/Automated Activity step’s label in the process map, and is used by Ultimus BPM Studio to report any errors pertaining to the step. It is also used in report output. The name must, therefore, be unique. It is possible to cha...
Junction/Gateway step properties A Junction step (or “Gateway step” as it is called in BPMN view) allows many links in a map which are going to the same destination to be merged into one link (join). A Junction/Gateway step simplifies this arrangement with links going to and from the Junction/Gateway step. Junction/Gat...
General Properties within the General category: • Name: The Name property represents the Junction/Gateway step’s label in the process map, and is used by Ultimus BPM Studio to report any errors pertaining to the step. The name must, therefore, be unique. It is possible to change the label when the process is checked o...
Maplet/Subprocess step properties Maplets (or “Subprocesses,” as they are called in BPMN view) are in-line sub-processes that break down a large process map into smaller chunks so that they may be designed and tested independently. Maplet/Subprocess step properties are displayed in the Properties window. Maplet/Subpro...
General Properties within the General category: • Name: The Name property represents the Maplet/Subprocess step’s label in the process map, and is used by Ultimus BPM Studio to report any errors pertaining to the step. It is also used in report output. The name must, therefore, be unique. It is possible to change the ...
Text box properties Text boxes are visual descriptors, but do not affect process map routing. Text boxes can be used as titles, comments, and captions. Text box properties are displayed in the Properties window. Text box properties To view properties for a text box, perform one of the following: • Select the text box...
Appearance Properties within the Appearance category: • Shadow: The Shadow property is used to display or hide a drop shadow for the text box. The Yes option implies the drop shadow is to be displayed. The No option implies that the drop shadow is not to be displayed. The default setting is No. • Border: The Border p...
Font Properties within the Font category: • Bold: The Bold property is used to display bold text in the text box. The Yes option implies the text box to display bold text. The No option implies the text box not to display bold text. The default setting is No. • Size: The Size property specifies the point size of the ...
General Properties within the General category: • Text: The Text property specifies which text to display in the text box.
Group properties A “group” is a visual cue that two or more process map objects have an association. This grouping is nothing more than a visual cue that there is an association between these objects and has no effect on Ultimus engine logic. Group properties are displayed in the Properties window. Group properties To...
Appearance Properties within the Appearance category: • Background Color: The Background Color property specifies the background color of the group. To change the background color, click the button next to the Background Color combo box. The default background color is yellow. Selecting the background color for a gro...
General Properties within the Misc category: • Caption: The Caption property specifies the text for the group label.
This section discusses how to define XML types. The following topics are covered: • Overview of XML types • The Global XML Type Definitions editor • Creating Global XML type definitions • Importing data types from an external file • Elements and data types properties
Overview of XML types This section outlines introductory topics, including definitions to key concepts regarding XML. Refer to the following sections: • Defining terms • Ultimus built-in data types compatibility with supported external data types
Defining terms Before beginning a discussion of how to define XML types, three terms must be defined: • Element: An element is the basic unit of an XML schema. Elements can be of two types: simple and complex. Each of these is described below: a. Simple elements: Simple elements contain only text (boolean, string, dat...
Ultimus built-in data types compatibility with supported external data types When creating schema elements, the following tables should be referenced to ensure compatibility between XML schema data types and external data types.   Recommended XML schema data types for use with .NET applications  .NET data types Ultimus...
The Global XML Type Definitions editor The Global XML Type Definitions editor contains the following user interface elements: • The menu bar • The Standard toolbar • The Schema toolbar The Global XML Type Definitions editor User interface elements within the Global XML Type Definitions editor are discussed below.
The menu bar Below is a description of unique menu bar item(s) when viewing the Global XML Type Definitions editor. For information on common menu bar items in all editors, refer to The menu bar section. • View • Insert • Tools Functions within each of these items are described below.
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 viewing the Global XML Type Definitions editor: • Toolbars • Windows Each of these functions is discussed below.
Toolbars The Toolbars menu option contains two submenu options: • Standard • Schema Toolbar These options are used to display or hide specific toolbars in the Ultimus BPM Studio interface. Each of these submenu options is discussed below.
Standard The Standard submenu option is a toggling menu option that makes the Standard toolbar appear and disappear on the Ultimus BPM Studio interface. The Standard toolbar offers convenient access to common functions. When the icon beside the Standard submenu option is highlighted, the Standard toolbar is visible. Fo...
Schema Toolbar The Schema Toolbar submenu option is a toggling menu option that makes the Schema toolbar appear and disappear on the Ultimus BPM Studio interface. When the icon beside the Schema Toolbar submenu option is highlighted, the Schema toolbar is visible. For more information about the Schema toolbar, refer to...
Windows The Windows menu option contains four submenu options: • Properties • Event Log • Connectors • Repository 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. For more information about the Prop...