BOARD Procedure Launcher

Document created by mik1893 Employee on Jul 13, 2017Last modified by davidegenini on Sep 26, 2019
Version 4Show Document
  • View in full screen mode

FUNCTIONALITY

The BOARD Procedure Launcher allows a BOARD Database procedure to be executed from a Windows command line (CMD), therefore scheduled through Windows Task Scheduler or other scheduling tools.

The tool comes with the server installation of BOARD on all versions starting from BOARD 8, and is located in: C:\Program Files\Board\Board Server\Tools.

 

This utility is not only useful for launching a procedure without opening the BOARD client but also to monitor the execution in a better way. The procedure is executed in synchronous way and you can have information about the status just looking at the job status (running or terminated).

Only database procedure can be called with this utility and must contain only "server-side" actions.

 

HOW TO USE IT

The Procedure Launcher can be incorporated in a batch file. The batch file can then be called from the Windows Task Scheduler to trigger the procedure at a specific time and at a given frequency.

 

Batch File

The syntax to call the Procedure Launcher in batch file (.bat) is explained below:

 

OptionValueExample
hostHostname or IP address of the server followed by the port number (typically 9700)/host "localhost:9700"
sslActivation of an encrypted connection, necessary if the server has the SSL option active. Default = off (Optional)/ssl "on"
winEncryptionActivation of the Windows Encryption in the communication with the server. Default = on  (Optional)/winEncryption "on"
ssoUtilization of the Single SignOn. It's an optional parameter. If this is active, the password parameter is not necessary. Default = off  (Optional)/sso "off"
usernameName of a BOARD user registered as an Assign License/username "administrator"
passwordPassword of the BOARD user/password "administrator"
ProcedureName of the BOARD procedure/Procedure "00 - Data Loading"
DataBaseName of the database (CASE-SENSITIVE)/DataBase "BFC_CONSO"

 

This results in a command like the following:

 

"C:\Program Files\Board\Board Server\Tools\BoardProcedureLauncher.exe"  /host "localhost:9700"  /username "administrator"  /password "administrator"  /Procedure "00 - Data Loading"   /DataBase "BFC_CONSO"

 

Scheduled Task

When the batch file is created, it can be scheduled. A common tool is Windows Task Scheduler, where the points of attention are the following:

1) Mapping the batch file

  • Go the Task Properties: Action tab --> Edit
  • Action: Start a program
  • Program/script: path to your batch script, e.g. C:\Board\Job\DataLoading.bat

2) General Settings

  • Security Options: set it to "Run whether user is logged or not"
  • Run with highest privileges: to be flagged
15 people found this helpful

Attachments

    Outcomes