Difference between revisions of "Business Processes"

From Hornbill
Jump to navigation Jump to search
 
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
When setting up or amending workflow there are two pages you will need to know how to use.
+
This document can now be found at its new location in the [https://docs.hornbill.com/servicemanager-config/customize/workflows/workflow-designer/ Hornbill Document Library].
  
:# '''BPM list view''' - This displays a list of all active and in-active workflows that have been saved. Selecting a workflow will open the BPM edit screen. You can use the following options to manage them :-
+
[[file:hornbill-document-library.png|Workflow Designer|link=https://docs.hornbill.com/servicemanager-config/customize/workflows/workflow-designer/]]
:::* [[File:Create_new.png|80px|create new]] '''New''' workflow - Provide the workflow name and a new basic new Workflow will be created with a start and end node
 
:::* [[File:Delete.png|40px|delete]] '''Delete''' workflow - This will remove the workflow from the list
 
:::* [[File:Copy.png|40px|copy]] '''Copy''' workflow - Create a copy of an existing workflow with a new name
 
:::* [[File:Rename.png|40px|copy]] '''Rename''' workflow - Rename an existing workflow  
 
:::* [[File:Active or in-active.png|25px|copy]] '''Activate/Deactivate''' workflow - Change the state of the workflow to allow or dis-allow its execution
 
  
---
+
<!--
  
 +
{{bluebanner|[[Main Page|Home]] > [[Administration]] > Business Processes|[[:category:administration|Index]]}}
 +
{{IntroAndLinks|Business Processes provide an easy, yet extremely powerful method of automating a number of aspects within Hornbill.  Each app that uses Business Processes will have the Business Process card displayed when you navigate to the app within Administration.|
 +
:* [[Business Process Designer]]
 +
}}
 +
== Tool Bar ==
 +
{{bullet1|Filter|Filter the list of Business Processes by typing text that will match against the following fields: Workflow name, Category, Created By, and Updated By}}
 +
{{bullet1|Status Filter|Filter the list of Business Processes by status using the options ''Show All Processes', 'Show Active Processes'', Show De-Activated Processes}}
 +
{{bullet1|Search processes for a set value|[[file:searchbpmsbutton.png|22px|left|link=]] This option will search all of your existing workflows for a string of text. For example, you can search on a User ID to locate all the workflows where that User ID has been set within the workflow options.}}
 +
{{bullet1|Manage Executed Processes|[[file:manageExecutedProcessesButton.png|140px|left|link=]] Select this option to open a list of Executed Processes.  This is a great tool for identifying and fixing issues with  Executed Processes}}
 +
{{bullet1|Create New|[[File:bpmaddstagebutton.png|20px|left|link=]] Select this option to create a new workflow}}
 +
{{bullet1|Delete|[[File:deleteBPM.png|21px|left|link=]]Delete one or more workflows that have been selected in the list of workflows. This option will only be available once a workflow has been selected}}
  
::2.  '''BPM Edit screen''' - On the menu bar at the top of the view you have 2 sets of buttons.
+
== List ==
 
+
{{bullet1|Column Headings|Each heading can be clicked on to change the order in which the workflows are displayed}}
:::On the '''left hand side''' you have:-
+
{{bullet1|Workflow|Column that displays the name of each individual workflow. This can be clicked on to view and edit the selected workflow within the [[Business Process Designer]]}}
:::* [[File:Manage_current_stage.png|30px|Manage Current Stage]] '''Manage Current Stage''' - Allows you to describe the stage (names and comments) and assign any checkpoints you will use in the stage. You can move the current stage to the left or right in the sequence of stages using the '''<< or >>''' buttons.
+
{{bullet1|Actions|Some quick access options are available in the last column for each workflow}}
::::[[File:Information.png|16px|information]] - If you don't define checkpoints here then you cannot have checkpoints in the stage
+
{{bullet2|Process Publishing & Activation|[[file:ppandabutton.png|20px|left|link=]] Clicking this option will allow you to publish the workflow, using the latest draft version. You are also able to activate one of the previous 10 versions of the workflow or copy them back to the draft version.}}
::::[[File:Information.png|16px|information]] - Its good practice to add to comments for the stage about what is expected from the current stage of workflow  
+
{{bullet2|Copy process|[[file:copybpmlistbutton.png|20px|left|link=]] Create an identical copy of this workflow}}
:::* [[File:Delete_stage.png|30px|delete stage]] '''Delete Stage''' - Deletes current stage
+
{{bullet2|Rename process|[[file:editbpmlistbutton.png|20px|left|link=]] Rename this workflow. This can only be done when the workflow as no executed processes with a status of active or suspended. Use the ''Manage Executed Processes'' option to identify and manage these executed processes.}}
:::* [[File:Add_stage.png|30px|add stage]] '''Add Stage''' - Adds a new stage as the last stage. You can then move the stage to correct sequence using [[File:Manage_current_stage.png|30px|Manage Current Stage]].
+
{{bullet2|Delete process|[[file:delBPMlistbutton.png|20px|left|link=]] Delete this workflow. This can only be done when the workflow as no executed processes with a status of active or suspended. Use the ''Manage Executed Processes'' option to identify and manage these executed processes.}}
:::* [[File:Stages.png|200px|stages]] '''Stages''' - Shows defined stages an their sequence (current stage is highlighted)
+
-->
 
+
[[Category:HDOC]]
:::On the '''right hand side''' you have:-
 
:::* [[File:Manage_process_parameters.png|30px|manage process parameters]] '''Manage process parameters''' - Here you can specify details for the whole process (including all stages). You can define:-
 
::::# [[File:Input_parameters.png|300px|input parameters]] - these are what the process operates on. For ''Service Manager'' this is usually requests so 'RequestId' should normally used along with optional and string.
 
::::# Output Parameters - You should not normally to define anything here
 
::::# Process Description -  Here you can add any comments about the process function, inputs outputs etc.
 
::::# Display Options - This changes the how the workflow is presented. Projector option options changes the colours to be stronger. 
 
:::* [[File:Save_process_structure.png|30px|save process structure]] '''Save process structure''' - This option becomes available when you have made any changes to the workflow. It only save if you have no errors with the workflow you have defined. It performs the 'Save and Validate' operation. Workflow will NOT be active.
 
:::* [[File:Save_and_validate.png|30px|save and validate/activate]] '''Save and Validate/Activate''' - You can use this option to 'Save and Validate' a workflow (i.e. - one with no errors) or 'Save and Activate' which will not only save a valid workflow it will also activate it for immediate use.
 
:::* [[File:Selected_node_properties.png|30px|selected_node_properties]] '''Selected node properties''' - This allows you to edit the proprieties of each node you have defined in your workflow. The parameters you can define change from node to node.
 
 
 
 
 
== Example of BPM Edit view ==
 
:::[[File:Workflow_-_nav2.png|700px|bpm list]]
 

Latest revision as of 20:54, 18 March 2024

This document can now be found at its new location in the Hornbill Document Library.

Workflow Designer