Board Manager Business Process Workflow: Difference between revisions

From Hornbill
Jump to navigation Jump to search
No edit summary
No edit summary
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
This document can now be found at its new location in the [https://docs.hornbill.com/boardmanager-config/customize/workflow Hornbill Document Library].
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[Board Manager Administration |Board Manager]] > Business Process Workflow
 
</div>
[[file:hornbill-document-library.png|Board Manager Workflow|link=https://docs.hornbill.com/boardmanager-config/customize/workflow]]
[[Category:HDOC]]
<!--
 
{{Breadcrumb|[[Main Page|Home]] > [[Administration]] > [[Board Manager Administration |Board Manager]] > Business Process Workflow|Board Manager}}
 
{|style="width: 100%"
{|style="width: 100%"
|- valign="top"
|- valign="top"
|style="width:73%"|
|style="width:73%"|
== Introduction ==
== Introduction ==
The Board Manager Business Process Workflows are used to automate the creation, movement and management of Boards, Lists and Cards
The Board Manager Business Process Workflows are used to automate the creation, movement and management of Boards, Lists and Cards.
 
Board Manager options can be used in other Hornbill Applications through the Business Process Designer.
* Use the '''Automated Tasks''' node, and find the  '''Board Manager''' options under the Application drop down.
 
|style="width:5%"|
|style="width:5%"|
|
|
Line 12: Line 21:


== Related Articles ==
== Related Articles ==
:* [[Board Manager]]
:* [[Business Process Designer]]
:* [[Business Process Designer]]
:* [[Request Variables]]
:* [[Request Variables]]
Line 17: Line 27:


==Board==
==Board==
Use the Boards nodes to automatically add, move or remove a Request from an existing Board. Requests can be added to one or multiple Boards in Service Manager, and can be moved between Lists on specified Boards automatically.
Use the Board node get Board Information


<!-- ******************************************************************************************* -->
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="AddCommentToBoard"></div>
<div id="AddCommentToBoard"></div>
* Add Comment To Board
* Get Board Information
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 28: Line 37:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmaddcommenttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/9e/Bpmaddcommenttoboard.png|Add Comment to a Board]]
[[File:bpmgetboardinformation.png|thumb|link=https://wiki.hornbill.com/index.php/File:Bpmgetboardinformation.png|Get Board Information]]
==== Add Comment To Board ====
==== Get Board Information ====
Use this node to manually add a Comment card to a Service Manager Board at the required stage in a process.
Use this node to retrieve information about a specific Board
==== Options ====
==== Options ====
:* '''Board'''
:* '''Application'''
:: The name of the Service Manager Board on which the Comment card will be added
:: The name of the Application the Board belongs too - Mandatory
:* ''' List '''
:* ''' Entity '''
:: The name of the list from the above specified board to which the Comment card will be added
:: The name of the list from the above specified board to which the Comment card will be added
:* '''Comment'''
:* '''Entity ID'''
:: The actual comment, as it will appear on the card on the Board.
:: The actual comment, as it will appear on the card on the Board.
:* ''' Board '''
:: The name of the board you wish to get information about
|}
|}
</div>
</div>
</div>
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->


<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="addRequestToBoard"></div>
* Add Request to Board
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
::{|
|- valign="top"
|style="width:700px"|
[[File:bpmaddrequesttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/96/Bpmaddrequesttoboard.png |Add Request to Board]]
==== Add Request to Board ====
This operation will automatically add a request to a selected Service Manager Board or move a request from one list to another.  This particularly works well on a Board where users have been given View Access only and the BPM takes control of all the card movements.
==== Options ====
:* '''Request Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM.  This should be set to ''Auto''.
:* '''Board'''
:: The name of the Service Manager Board on which the Request card will be added
:* '''List'''
:: The name of the list from the above specified board to which the Request card will be added
<br>
<br>
|}
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->


<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
==Card==
<div id="AddUniqueIdForAnchor"></div>
Use the Cards nodes to automatically add, move, get info or remove a CARD from an existing Board. Cards can be added to one or multiple Boards in Service Manager, and can be moved between Lists on specified Boards automatically.
* Remove Request from Board
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
::{|
|- valign="top"
|style="width:700px"|
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Remove Request from Board]]
==== Remove Request from Board ====
Use this option to remove a Request from a Service Manager Board at a specific stage in a process. 
==== Options ====
:* '''Request Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM. This should be set to ''Auto''.
:* '''Board'''
:: The name of the Service Manager Board from which the Request card will be removed.
<br>
<br>
|}
</div>
</div>
</div>
<!-- ************************************************END OF OPERATION DOCUMENTATION************************************************** -->


==Card==
Use the Boards nodes to automatically add, move or remove a Request from an existing Board. Requests can be added to one or multiple Boards in Service Manager, and can be moved between Lists on specified Boards automatically.


<!-- ******************************************************************************************* -->
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="AddCommentToBoard"></div>
<div id="AddCardToBoard"></div>
* Add Comment To Board
* Add Card To Board
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 106: Line 67:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmaddcommenttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/9e/Bpmaddcommenttoboard.png|Add Comment to a Board]]
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Add Card to a Board]]
==== Add Comment To Board ====
==== Add Card To Board ====
Use this node to manually add a Comment card to a Service Manager Board at the required stage in a process.
Use this node to manually add a card to a Board at the required stage in a process.
==== Options ====
==== Options ====
:* '''Application'''
:: Optionally choose which application the card you want to add to the board originates from.  The benefit of doing this, is it will automatically define and populate the values for the Title, Content, Link, Card Type options below.  If you want to manually set these values for the card you are adding, then leave this option as '''Auto''' otherwise it will overwrite any manually entered values in the other options mentioned previously.
:* '''Key'''
:: The Key identifier for the new card, in the case of Service Manager requests this will be Requestid
:* '''Board'''
:* '''Board'''
:: The name of the Service Manager Board on which the Comment card will be added
:: The name of the Board on which the card will be added
:* ''' List '''
:* '''Lane'''
:: The name of the list from the above specified board to which the Comment card will be added
:: The name of the lane from the above specified board to which the card will be added
:* '''Comment'''
:* '''Lane Column'''
:: The actual comment, as it will appear on the card on the Board.
:: The column within a lane which the new card will be added to, if not specified the card will be added to the first column in the lane. This option expects a zero based index to the column, so the supplied value should the column number minus 1.
:* '''Order'''
:: The position the card will appear in on the lane of the board, if not specified the card will appear at the top of the lane.  You can use the '''Get Lane Information''' option to get the next available position for a card on the lane
:* '''Value'''
:: A value for the card, for example scrum points, cost
:* '''Progress'''
:: A numerical value between 0-100 to represent the progress to completion on the card
:* '''Title'''
:: The title of the card on the board.  This value will be ignored if the '''Application''' option is populated
:* ''' Content'''
:: The content of the card on the board. This value will be ignored if the '''Application''' option is populated
:* '''Link'''
:: This will allow you to open in a pop up or other tab if configured.  This value will be ignored if the '''Application''' option is populated
:* '''Card Type'''
:: The type of the new card, there are various card types to choose from, please review these on the '''Card Types''' wiki page. This value will be ignored if the '''Application''' option is populated
|}
|}
</div>
</div>
</div>
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->
 


<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="addRequestToBoard"></div>
<div id="addRequestToBoard"></div>
* Add Request to Board
* Get Card Information
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 130: Line 109:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmaddrequesttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/96/Bpmaddrequesttoboard.png |Add Request to Board]]  
[[File:bpmaddrequesttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/96/Bpmaddrequesttoboard.png |Get Card Information]]  
==== Add Request to Board ====
==== Get Card Information ====
This operation will automatically add a request to a selected Service Manager Board or move a request from one list to another. This particularly works well on a Board where users have been given View Access only and the BPM takes control of all the card movements.
This Hornbill Automation retrieves the details about a card on a board. This includes the lane that the card resides in on the board, the progress made on the card, the order of the card on the board and other useful properties. This node can be used once at the beginning of a Workflow stage and does not need to be used each time you want to move or remove a card in a stage.
 
==== Options ====
==== Options ====
:* '''Request Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM.  This should be set to ''Auto''.
:* '''Board'''
:* '''Board'''
:: The name of the Service Manager Board on which the Request card will be added
:: This is a mandatory option and is needed to identify the board that the card resides in.
:* '''List'''
:* '''Lane'''
:: The name of the list from the above specified board to which the Request card will be added
:: This option can be set with name of the lane that the card resides in. This is optional and should only be set when a card with the same key appears with two different types on the same board. In Service Manager,
:* '''Key'''
:: The key identifier for the card. For example in Service Manager, the Id of a Request is the key identifier.
<br>
<br>
<br>
<br>
Line 146: Line 126:
</div>
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->
 


<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="AddUniqueIdForAnchor"></div>
<div id="AddUniqueIdForAnchor"></div>
* Remove Request from Board
* Move Card on Board
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 156: Line 136:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Remove Request from Board]]  
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Move Card on Board]]  
==== Remove Request from Board ====
==== Move Card on Board ====
Use this option to remove a Request from a Service Manager Board at a specific stage in a process.   
Use this option to move a card between lanes on a board.   
==== Options ====
==== Options ====
:* '''Request Id'''
:* '''card Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM.  This should be set to ''Auto''.
:: This is a mandatory setting and is needed to identify which card to move on the board.  You can get the card id by first having a '''Get Card Information''' node in the stage on the process, and using the output param as a variable for this field using the variable picker
:* '''Board'''
:* '''Lane'''
:: The name of the Service Manager Board from which the Request card will be removed.
:: The name of the lane on the board which you wish to move the card into
:* '''Order'''
:: The position the card will appear in on the lane, if not specified it will appear at the top of the lane
<br>
<br>
<br>
<br>
Line 170: Line 152:
</div>
</div>
</div>
</div>
<!-- ************************************************END OF OPERATION DOCUMENTATION************************************************** -->


==Lane==
Use the Boards nodes to automatically add, move or remove a Request from an existing Board. Requests can be added to one or multiple Boards in Service Manager, and can be moved between Lists on specified Boards automatically.


<!-- ******************************************************************************************* -->
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="AddCommentToBoard"></div>
<div id="AddUniqueIdForAnchor"></div>
* Add Comment To Board
* Remove Card from Board
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 184: Line 162:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmaddcommenttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/9e/Bpmaddcommenttoboard.png|Add Comment to a Board]]
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Remove Card From Board]]  
==== Add Comment To Board ====
==== Remove Card From Board ====
Use this node to manually add a Comment card to a Service Manager Board at the required stage in a process.
Use this option to remove a card from a specific board
==== Options ====
==== Options ====
:* '''Board'''
:* '''card Id'''
:: The name of the Service Manager Board on which the Comment card will be added
:: This is a mandatory setting and is needed to identify which card to remove on the board.  You can get the card id by first having a '''Get Card Information''' node in the stage on the process, and using the output param as a variable for this field using the variable picker
:* ''' List '''
:::* It is possible that a card resides on different boards, and will therefore have different card id's for each board. As such you will need to obtain the card id for the board you wish to remove the card from
:: The name of the list from the above specified board to which the Comment card will be added
:* '''Remove Completely'''
:* '''Comment'''
:: The default is false, and the card will be '''archived''', if set to '''true''' the card will be completely removed from the board and will not be able to be manually un-archived.
:: The actual comment, as it will appear on the card on the Board.
|}
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->
 
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="addRequestToBoard"></div>
* Add Request to Board
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
::{|
|- valign="top"
|style="width:700px"|
[[File:bpmaddrequesttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/96/Bpmaddrequesttoboard.png |Add Request to Board]]
==== Add Request to Board ====
This operation will automatically add a request to a selected Service Manager Board or move a request from one list to another.  This particularly works well on a Board where users have been given View Access only and the BPM takes control of all the card movements.
==== Options ====
:* '''Request Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM.  This should be set to ''Auto''.
:* '''Board'''
:: The name of the Service Manager Board on which the Request card will be added
:* '''List'''
:: The name of the list from the above specified board to which the Request card will be added
<br>
<br>
<br>
<br>
Line 224: Line 177:
</div>
</div>
</div>
</div>
<!-- **************************************END OF OPERATION DOCUMENTATION***************************************************** -->
 
 
==Lane==
Use the Lane operation to get information about the card position and order in the lane, in order to have the information available when using other operations like '''Add to Board''' and '''Move on Board''' if you want to add a card to the next position on a lane, as appose to always adding it to the top.


<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:700px">
<div id="AddUniqueIdForAnchor"></div>
<div id="GetLaneInformation"></div>
* Remove Request from Board
* Get Lane Information
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
<div style="border:1px solid #e6e6e6; background:#f2f2f2; width:99%; padding:4px; margin-bottom:10px;">
Line 234: Line 190:
|- valign="top"
|- valign="top"
|style="width:700px"|
|style="width:700px"|
[[File:bpmremoverequestfromboard.png|thumb|link=https://wiki.hornbill.com/images/0/07/Bpmremoverequestfromboard.png|Remove Request from Board]]  
[[File:bpmaddcommenttoboard.png|thumb|link=https://wiki.hornbill.com/images/9/9e/Bpmaddcommenttoboard.png|Get Lane Information]]
==== Remove Request from Board ====
==== Get Lane Information====
Use this option to remove a Request from a Service Manager Board at a specific stage in a process.
Use this node to obtain the next card position and order on a given lane on a board.  Once this node has been used, you can use the output params from it via the variable picker to insert new cards on to boards and lanes using the '''Add to Board''' and '''Move on Board''' operations.
==== Options ====
==== Options ====
:* '''Request Id'''
:: This is a mandatory setting that uses a variable to hold the Request Id of the request that is using this BPM.  This should be set to ''Auto''.
:* '''Board'''
:* '''Board'''
:: The name of the Service Manager Board from which the Request card will be removed.
:: The name of the Board on which the lane exists
<br>
:* '''Lane'''
<br>
:: The name of the lane against which you wish to obtain the information
|}
|}
</div>
</div>
</div>
</div>
</div>
</div>
<!-- ************************************************END OF OPERATION DOCUMENTATION************************************************** -->
[[Category:Board Manager]]

Latest revision as of 21:53, 3 June 2024

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

Board Manager Workflow

Retrieved from "https://wiki.hornbill.com/index.php?title=Board_Manager_Business_Process_Workflow&oldid=32493"