Saturday, September 17, 2011

Cobra API Builder



The Cobra API Builder is a tool that assists in creating and running scripts for the Cobra 5 API.
For more information on Deltek Cobra 5, visit:
http://www.deltek.com/products/cobra/default.asp
A script can be added by using the add script button (ctrl+shift+a).
An integrated help system enables displaying of hints by pressing the question mark key.


To select a script, pick an entry in the dropdown list.


If the script needed to be run is known, simply type in the name of the script.
Choosing a script in the dropdown control will display the parameters in the panel below it.

Selecting ok will populate the main editor window with the necessary details to run the process.

The script can be saved by clicking on the save icon or hitting Ctrl+S on the keyboard.


Creating a batch file to run the script
Click on the Create/Configure batch script icon to configure a batch file that can be used to run the script. This invokes the dialog which allows the necessary credential to be specified.
The batch file name defaults to the name of the saved file with an extension of bat.
The credential fields must contain the cobra login details that will be used to run the script.
The Cobra API Location must point to the location of the Cobra.Api.exe which is the main executable required to run the script.

This will generate a batch file in the same folder where the script is saved.
Running the script via the API Builder
Click on the Run batch script icon or press F5 on the keyboard to run the script using the API Builder. This invokes a dialog which allows the necessary credential to be specified.

After the run has completed, Cobra API Builder will open the Cobra API log file which contains the results of the run.

This API log file can be viewed anytime via the view Menu.


Auto complete
As of Cobra API Builder version 1.0.4, the main script editor window has been added the capability to use basic auto complete to guide the user in building the API script.


Scheduling a Process
The Cobra API Builder allows sending the current script as a job to be run by the Windows Task Scheduler.
Once a script has been setup, click on the schedule button in the toolbar.

No comments:

Post a Comment