Difference between revisions of "Runbooks"

From Hornbill
Jump to navigation Jump to search
 
(55 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT Operations Management|ITOM]] > Runbooks|[[:Category:ITOM|Index]]}}
 
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT Operations Management|ITOM]] > Runbooks|[[:Category:ITOM|Index]]}}
 
{{IntroAndLinks
 
{{IntroAndLinks
−
|A Runbook provides an orchestration mechanism, that enables dissimilar operations to be bound together within a business process to perform a complete end to end solution. Enabling for the standardisation/automisation of best practices that improve efficiency, reliability and reducing user error. An example might be the on-boarding of a new user may require the following to be set-up / configured:
+
|Orchestration is fulfilled via the creation of a Runbook, enabling different operations to be bound together within a business process to perform a complete end to end solution. Allowing for the standardisation/automation of best practices that improve efficiency, reliability and reducing user error. As an example, the onboarding of a new user could require the following to be set-up / configured:
−
 
 
 
:* AD User Account creation
 
:* AD User Account creation
 
:* Mailbox Creation
 
:* Mailbox Creation
Line 8: Line 7:
 
:* Software Installation
 
:* Software Installation
 
:* Database Access rights
 
:* Database Access rights
−
Whether some or all of the above operations are actioned would can be conditional on information passed to the runbook or logic controlled by the Runbook's business process.
+
The above actions are most likely conditional based on information passed to the Runbook and logic provided by Hornbill's Powerful Business Process Workflow tool.  Only features specific to Runbooks will be discussed and any differences that there may be; for further details, refer to the [[Business Process Designer]] documentation.  One of the main omissions is the use of Stages and Checkpoints as they are not required for use within a Runbook Process.
 
|
 
|
 
* [[ITOM Package Library]]
 
* [[ITOM Package Library]]
Line 15: Line 14:
 
==Runbooks List==
 
==Runbooks List==
 
[[Image:RunbookListFade.png|350px|right|link=https://wiki.hornbill.com/images/3/35/RunbooksList.png]]
 
[[Image:RunbookListFade.png|350px|right|link=https://wiki.hornbill.com/images/3/35/RunbooksList.png]]
−
{{Bullet1|Runbook|}}
 
−
{{Bullet1|Category|}}
 
−
{{Bullet1|Created By|}}
 
−
{{Bullet1|Created On|}}
 
−
{{Bullet1|Updated By|}}
 
−
{{Bullet1|Published version|}}
 
−
{{Bullet1|Active State|}}
 
−
{{Bullet1|Action Buttons|}}
 
−
{{Bullet2|Publish|}}
 
−
{{Bullet2|Copy|}}
 
−
{{Bullet2|Rename|}}
 
−
{{Bullet2|Delete|}}
 
−
{{Bullet2|Invoke|}}
 
−
 
−
==Toolbar==
 
−
{{Bullet1|Filter|Free Text Filter on Process}}
 
−
{{Bullet1|Create New|Create a new runbook}}
 
−
{{Bullet1|Delete|Delete all selected runbbook(s)}}
 
−
 
−
== Process Blocks ==
 
−
The blocks you have access to are:
 
 
:{|
 
:{|
 
|- valign="top"
 
|- valign="top"
 
|
 
|
−
:* Hornbill Automation
+
{{Bullet1|Runbook|The name of the Runbook}}
−
:* Cloud Automation
+
{{Bullet1|Category|Runbook Category}}
−
:* IT Automation
+
{{Bullet1|Created By|The User that created the Runbook process}}
−
:* Decision
+
{{Bullet1|Created On|Runbook Process creation date}}
−
:* End Process
 
−
:* Abort
 
−
:* Start Parallel Processing
 
−
:* Finish Parallel Processing
 
−
<!--:* [[#Download Site Integration Server|Download]]-->
 
 
|
 
|
−
Invoke Hornbill Actions<br/>
+
{{Bullet1|Updated By|The User that last updated the Rnbook process}}
−
Interact with third parties<br>
+
{{Bullet1|Published version|Runbook published version number}}
−
Interact with other ITOM packages/runbooks<br>
+
{{Bullet1|Active State|Identifies Active or De-Activated Runbooks}}
−
go down a second path<br>
+
|
−
you are able to set Output Parameters in this block type<br>
+
{{Bullet1|Action Buttons|Enables actions to be executed on the adjacent Runbook}}
−
stop processing<br>
+
{{Bullet2|Publish|Open the Publishing Manager}}
 +
{{Bullet2|Copy|Createa a new copy of the Runbook}}
 +
{{Bullet2|Rename|Rename the Runbook}}
 +
{{Bullet2|Delete|Delete the Runbook}}
 +
{{Bullet2|Invoke|Execute the Runbook}}
 
|}
 
|}
  
−
== Core Concepts ==
+
==Toolbar==
−
One major difference with a Business Process within Service Manager is that you can define '''Output Parameters''' (under "Manage process settings"). These Output Parameters can be used within a Business Process - much like a Cloud Automation results.
+
[[File:ITOMRunbooksListToolbar.png]]
 +
{{Bullet1|Filter|Free Text Filter on Runbook, Category & Created By}}
 +
{{Bullet1|Dropdown Filter|Active State filter}}
 +
{{Bullet1|Search Button|Searches process for a Set Value}}
 +
{{Bullet1|Manage Executed Processes|Displays all executed processes, provides troubleshooting and process control features}}
 +
{{Bullet1|Create New [[File:NewPackageButton.png|23x22px]]|Creates a new Runbook process|}}
 +
{{Bullet1|Delete [[File:ITOMGenericDustbin.png|23x22px]]|Delete selected Runbook(s)}}
  
−
== Runbook Settings ==
+
==Runbook Process==
−
[[File:ITOMRunbookProperties.png|ITOM Runbook Properties]]
 
  
 +
[[Image:RunbookProcessDesignerFade.png|350px|right|link=https://wiki.hornbill.com/images/f/f4/RunbookProcessDesigner.png]]
 +
One significant difference with the BPM, as used within Applications such as Service Manager, is the definition of input and output parameters.  Runbook process can be called via an applications BPM, using a Runbook Process node where the process can set and use the parameters the same as for system nodes.
 +
 +
=== Process Nodes ===
 +
The following nodes are available for use within the Runbook processes and function mostly identically to how they work within the BPM Engine except for the parameter "Auto" and suspend features.  We recommended that all parameters be manually entered or populated using variables and not The "Auto" feature, which relies on executing within the context of an application.  Any nodes that can suspend the process will not be available for use within a Runbook, as they should be able to execute with no user interaction seamlessly.
 +
 +
{{Bullet1|[[Service Manager Business Process Workflow|Hornbill Automation]]|Invoke Actions within a Hornbill Application or Core Feature}}
 +
{{Bullet1|[[Cloud Automation|Cloud Automation]]|Interact with third-party systems via a Hornbill iBridge automation}}
 +
{{Bullet1|[[Runbook IT Automation|IT Automation]]|Invoke an ITOM Package operation}}
 +
{{Bullet1|[[Custom Expression Builder|Decision]]|Used to control the flow of a process based on the outcome of the previous node(s), with more complex logic possible via custom expressions using process variables.  Each decision node allows for a maximum of three outcomes, where more than this is required, it is also possible to chain decision nodes with the use of a '''No Match''' outcome.}}
 +
{{Bullet1|End|Successfully terminate the process, allowing for values to be assigned, manually or via variables,  to the output parameters as defined in the Runbook Processes settings.}}
 +
{{Bullet1|Abort|Abandons the process and sets the status to "Failed", allowing for a message to be manually supplied or sourced via a variable.}}
 +
{{Bullet1|Start Parallel Processing|Allows a process stage to invoke more than one stream of actions and for these to run in parallel. Adding this node will enable multiple process streams to be defined, and these will run independently until brought back together by the '''Finish Parallel Processing''' node. Examples of this would be a requirement for assigning tasks to different teams, but there is no dependency or need to complete one before the other can be created and invoked in parallel.}}
 +
{{Bullet1|Finish Parallel Processing|Use this node to bring together and finish the individual process lines initiated from a '''Start Parallel Processing''' node.}}
 +
 +
{{infobox|Currently, the Hornbill Automation type "Suspend" is currently available and will be deprecated from use in a future release of Runbooks and should therefore NOT be used.}}
 +
 +
===Runbook Process Settings===
 +
[[Image:RunbookProcessSettingsFade.png|350px|right|link=https://wiki.hornbill.com/images/5/59/RunbookProcessSettings.png]]
 
{{Bullet1|Input Parameters|Parameters which can be used throughout the process}}
 
{{Bullet1|Input Parameters|Parameters which can be used throughout the process}}
 
{{Bullet1|Output Parameters|Parameters which will be passed on to the calling process}}
 
{{Bullet1|Output Parameters|Parameters which will be passed on to the calling process}}
Line 68: Line 69:
 
{{Bullet1|Description|Allowing for searching}}
 
{{Bullet1|Description|Allowing for searching}}
 
{{Bullet1|Display Options|Normal/Projector - providing a more high contrast viewing alternative}}
 
{{Bullet1|Display Options|Normal/Projector - providing a more high contrast viewing alternative}}
−
{{Bullet1|Access Granted To|Access can be granted based on Role, User or Group <span>Role is currently not working</span>}}
+
{{Bullet1|Access Granted To|Access can be granted based on Role, User or Group}}
−
 
 
−
It is possible to set Input and Output Parameters which are either Required (MUST be passed or returned to/by the Runbook) as well as Optional parameters.
 
  
−
{{infobox|IF the "Access Granted To" is set, then the ability to run this particular Runbook will be limited to only specific users and/or those users who are members of the configured groups Groups}}
+
{{infobox|IF the "Access Granted To" is set, the system will limit then the ability to run this particular Runbook to either specific users and those users who are members of the configured Groups}}
  
 
[[Category:ITOM]]
 
[[Category:ITOM]]

Latest revision as of 22:56, 8 September 2021

Home > Administration > ITOM > Runbooks Index

Introduction

Orchestration is fulfilled via the creation of a Runbook, enabling different operations to be bound together within a business process to perform a complete end to end solution. Allowing for the standardisation/automation of best practices that improve efficiency, reliability and reducing user error. As an example, the onboarding of a new user could require the following to be set-up / configured:

  • AD User Account creation
  • Mailbox Creation
  • Forum / Wiki Access
  • Software Installation
  • Database Access rights

The above actions are most likely conditional based on information passed to the Runbook and logic provided by Hornbill's Powerful Business Process Workflow tool. Only features specific to Runbooks will be discussed and any differences that there may be; for further details, refer to the Business Process Designer documentation. One of the main omissions is the use of Stages and Checkpoints as they are not required for use within a Runbook Process.

Related Articles

Runbooks List

RunbookListFade.png
  • Runbook
The name of the Runbook
  • Category
Runbook Category
  • Created By
The User that created the Runbook process
  • Created On
Runbook Process creation date
  • Updated By
The User that last updated the Rnbook process
  • Published version
Runbook published version number
  • Active State
Identifies Active or De-Activated Runbooks
  • Action Buttons
Enables actions to be executed on the adjacent Runbook
  • Publish
Open the Publishing Manager
  • Copy
Createa a new copy of the Runbook
  • Rename
Rename the Runbook
  • Delete
Delete the Runbook
  • Invoke
Execute the Runbook

Toolbar

ITOMRunbooksListToolbar.png

  • Filter
Free Text Filter on Runbook, Category & Created By
  • Dropdown Filter
Active State filter
  • Search Button
Searches process for a Set Value
  • Manage Executed Processes
Displays all executed processes, provides troubleshooting and process control features
  • Create New NewPackageButton.png
Creates a new Runbook process
  • Delete ITOMGenericDustbin.png
Delete selected Runbook(s)

Runbook Process

RunbookProcessDesignerFade.png

One significant difference with the BPM, as used within Applications such as Service Manager, is the definition of input and output parameters. Runbook process can be called via an applications BPM, using a Runbook Process node where the process can set and use the parameters the same as for system nodes.

Process Nodes

The following nodes are available for use within the Runbook processes and function mostly identically to how they work within the BPM Engine except for the parameter "Auto" and suspend features. We recommended that all parameters be manually entered or populated using variables and not The "Auto" feature, which relies on executing within the context of an application. Any nodes that can suspend the process will not be available for use within a Runbook, as they should be able to execute with no user interaction seamlessly.

Invoke Actions within a Hornbill Application or Core Feature
Interact with third-party systems via a Hornbill iBridge automation
Invoke an ITOM Package operation
Used to control the flow of a process based on the outcome of the previous node(s), with more complex logic possible via custom expressions using process variables. Each decision node allows for a maximum of three outcomes, where more than this is required, it is also possible to chain decision nodes with the use of a No Match outcome.
  • End
Successfully terminate the process, allowing for values to be assigned, manually or via variables, to the output parameters as defined in the Runbook Processes settings.
  • Abort
Abandons the process and sets the status to "Failed", allowing for a message to be manually supplied or sourced via a variable.
  • Start Parallel Processing
Allows a process stage to invoke more than one stream of actions and for these to run in parallel. Adding this node will enable multiple process streams to be defined, and these will run independently until brought back together by the Finish Parallel Processing node. Examples of this would be a requirement for assigning tasks to different teams, but there is no dependency or need to complete one before the other can be created and invoked in parallel.
  • Finish Parallel Processing
Use this node to bring together and finish the individual process lines initiated from a Start Parallel Processing node.
Information
Currently, the Hornbill Automation type "Suspend" is currently available and will be deprecated from use in a future release of Runbooks and should therefore NOT be used.

Runbook Process Settings

RunbookProcessSettingsFade.png
  • Input Parameters
Parameters which can be used throughout the process
  • Output Parameters
Parameters which will be passed on to the calling process
  • Category
Allowing for categorisation & searching
  • Description
Allowing for searching
  • Display Options
Normal/Projector - providing a more high contrast viewing alternative
  • Access Granted To
Access can be granted based on Role, User or Group
Information
IF the "Access Granted To" is set, the system will limit then the ability to run this particular Runbook to either specific users and those users who are members of the configured Groups
Retrieved from "https://wiki.hornbill.com/index.php?title=Runbooks&oldid=27546"