About Procedures

A Procedure is a customizable sequence of Actions (also called Steps), capable to perform a broad range of tasks: for example, it can be used for updating a Board Data model, processing, extracting or printing data, performing calculations, broadcasting reports, and navigating Capsules and Screens. They can also be used for hidden tasks that process data, from simple calculations of values in Cubes to complex allocation procedures required in business models such as budgeting, planning, forecasting, profitability models, and business simulations in general.

The elementary steps of Procedures are called "Actions", belonging to various Action groups depending on their purpose. An Action can run a Data reader protocol, perform a calculation step (called Dataflow) on a Cube, extract data from Board, and much more. Some Actions are interactive and require users to interact with Board—for example they may prompt the user to make a selection—while other Actions can run unattended.

Procedures execution

Procedures can be executed:

• when users click on Button Objects or interact with other elements of a Screen

• automatically, when a specific Screen is opened or when Data entry is performed

• manually, from the Procedures home page

• through a specific API call

• as a scheduled task.

Procedures can be called by a user via:

• interactive Elements (Buttons, Labels, Data view)

• triggers (Data View, Pager, Screen)

• other Procedures (by calling a Procedure within another Procedure).

Procedures can be automated/scheduled for:

• Cloud environments via the Cloud administration portal

• on-premises environments via BoardProcedureLauncher.exe

Users do not have to wait for a Procedure launched by another user to finish, they will execute in parallel.
Some specific Data model Actions will exclusively lock the Data model. In this case, Board will automatically queue actions that require exclusive Data model access.

Procedure location

Board Procedures can be saved in a Capsule or in a Data model. With a few exceptions, the actions that can be performed are the same, regardless of the location of the Procedure.

Capsule Procedures

• A Procedure saved at the Capsule level can act on multiple Data models, but it can only be invoked from Screens of that same Capsule

• Suited for Capsule-near Actions (Screen interactions, Calculations for a Screen, etc.)

• Are independent from the data and can be transferred across environments with the Capsule

• Are able to perform all possible Actions

• Can only be invoked from the Capsule and cannot be scheduled

To access the Procedures section of a Capsule, access the designer space of the desired Capsule. From a Screen, navigate to the left panel and and click on Procedures.

Data model Procedures

• A Procedure saved in a Data model can only act on that same Data model: since it is saved at the Data model level, it can be invoked from different Capsules

• Suited especially for DB-near actions (Data reader, Backup/Restore, etc.)

• Can only be transferred to another environment together with the entire Data model (unless Transporter is used)

• Some Capsule specific actions are unavailable

• Can be scheduled

To access the Procedures section of a Data model, access the designer space of the desired Data model and click on the Procedures tile.

In the Procedures page, you can see all existing Procedures in the Data model and their main information: the table is sortable and searchable using the interactive header fields. You can also show or hide columns to your liking, by clicking the Column chooser button in the upper right corner of the table.

You can perform different Actions on one or more Procedures by selecting them and by clicking on the different buttons above the table.

Click anywhere on the corresponding row to view the structure of a Procedure: a dedicated panel on the right-hand side of the page will appear, showing the entire set of steps of the selected Procedure along with any breakpoints.

The Procedure section of each Data model in Board allows you to:

• Create, delete, copy, and run Procedures

• Edit options of one or multiple Procedures

• Add breakpoints that stop the execution of a Procedure at a given step to review various aspects of it

See Managing Procedures and Procedure Debugger for more details.