Business Processes

From Hornbill
Revision as of 22:50, 29 September 2021 by Jamesa (talk | contribs) (→‎List)
Jump to navigation Jump to search
Home > Administration > Business Processes Index

Introduction

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.

Related Articles

Tool Bar

  • 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
  • Status Filter
Filter the list of Business Processes by status using the options Show All ProcessesShow Active Processes, Show De-Activated Processes
  • Manage Executed Processes
Select this option to open a list of Executed Processes. This is a great tool for identifying and fixing issues with Executed Processes
  • Create New
Bpmaddstagebutton.png
Select this option to create a new workflow
  • Delete
DeleteBPM.png
Delete one or more workflows that have been selected in the list of workflows

List

  • Column Headings
Each heading can be clicked on to change the order in which the workflows are displayed
  • Workflow
Name of each individual workflow. This can be clicked on to view and edit the selected workflow
  • Actions
Some quick access options for managing the workflow
  • Process Publishing & Activiation
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.
  • Copy process
Create an identical copy of this workflow
  • Rename process
Rename this workflow. This can only be done when the workflow as no executed processes with a status of active or suspended
  • Delete process
Delete this workflow. This can only be done when the workflow as no executed processes with a status of active or suspended
  1. 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 :-
  • create new New workflow - Provide the workflow name and a new basic new Workflow will be created with a start and end node
  • delete Delete workflow - This will remove the workflow from the list
  • copy Copy workflow - Create a copy of an existing workflow with a new name
  • copy Rename workflow - Rename an existing workflow
  • copy Activate/Deactivate workflow - Change the state of the workflow to allow or dis-allow its execution


2. BPM Edit screen - On the menu bar at the top of the view you have 2 sets of buttons.
On the left hand side you have:-
  • 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.
information - If you don't define checkpoints here then you cannot have checkpoints in the stage
information - Its good practice to add to comments for the stage about what is expected from the current stage of workflow
  • delete stage Delete Stage - Deletes current stage
  • add stage Add Stage - Adds a new stage as the last stage. You can then move the stage to correct sequence using Manage Current Stage.
  • stages Stages - Shows defined stages an their sequence (current stage is highlighted)
On the right hand side you have:-
  • manage process parameters Manage process parameters - Here you can specify details for the whole process (including all stages). You can define:-
  1. 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.
  2. Output Parameters - You should not normally to define anything here
  3. Process Description - Here you can add any comments about the process function, inputs outputs etc.
  4. Display Options - This changes the how the workflow is presented. Projector option options changes the colours to be stronger.
  • 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.
  • 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.
  • 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.