Process Sections of the API Script
Use the process sections of the API script to define the API processes that you want to run in a batch.
- Each section must have a ProcessID setting that identifies a valid API process to run.
- The settings that are relevant for each API process depend on the process itself.
Cobra recognizes a maximum of 999 API processes in a single API script.
The Process Number consists of three digits, which can be from 001-999. API processes are run based on the order that they appear in the API script, and not based on the process ID. Process ID numbers are used for reference in error messages in the log files. Process IDs should be unique for each API process.Note: If an API process fails, processing still continues with the other API processes.The value you specify for the API setting must align with the format (case and spacing) of the corresponding Cobra field option.
Each process section can contain the Exit on Error parameter. For example, ExitOnError=0. Values can be 0 or 1.
- 1: Abort all processing if the API process that contains this setting results in an error.
- 0: Continue processing even if the API process that contains this setting results in as error. For example,
Related Topics:
Use the Advance Calendar API process to advance the calendar for a selected project.
Use the ANSI EIA X12 API process to automatically export ANSI EIA X12 data.
Use the Apportionment API process to calculate apportioned budget and forecast values for a selected project.
Use the Backup Project API process to back up a Cobra project in a specified location.
Use the Batch Report API process to run a Cobra batch report.
Use the Calculate Progress API process to calculate the value earned for a specific period.
Use the Calculate Forecast API process to automatically calculate forecasts.
Use the Copy Project API process to create a new Cobra project by copying an existing project. You can also use this process to copy a Cobra master project which results in a new copy of the master project and all its children projects.
Use the Cost Data Export API process to generate the Cost Data Export file in batch.
Create Project from Template Process
Use the Create Project from Template API process to create a new project from an XML configuration file.
Use the Delete Project API process to automatically delete projects.
Use the Freeze Forecast process to freeze a forecast and retain historical forecast data
Use the Get Cobra Spread API process to view the results of a Cobra Tphase spread for a specified resource and date range.
Use the Initialize Forecast API process to automatically initialize forecasts.
Integrate Actual Costs Process
Use the Integrate Actual Costs API process to import actual costs into a project in progress.
Integrate Ancillary Data Process
Use the Integrate Ancillary Data API process to automate the import of ancillary files. This improves integration with other applications.
Integrate Apportionment Definition Process
Use the Integrate Apportionment Definition API process to import apportionment definition for a selected resource file.
Integrate Apportionment Mapping Process
Use the Integrate Apportionment Mapping API process to calculate apportioned budget and forecast values for a selected project using the Integration Wizard.
Integrate Project Data Process
Use the Integrate Project Data API process to integrate a Cobra project with a schedule.
Use the Recalculate API process to recalculate data in a project file.
Use the Reclass API process to change, copy, or replace an existing cost class with a different cost class.
Use the Reconcile Log API process to reconcile project logs.
Use the Replace Resources API process to automatically replace resources.
Use the Replan API process to remove variances from any ongoing projects.
Use the Respread API process to respread project costs.
Use the Restore API process to automatically restore projects in batch.
Use the Rolling Wave API process to facilitate weekly earned value management and reporting over a user defined period while the remaining project data before and after this period is stored less frequently (generally, monthly).
Use the Set Project Baseline API process to set and verify the values for the contract budget accounts.
Use the SQL Command API process to automate SQL scripts, which is helpful in exporting data or running SQL scripts on data.
Use the Update Totals API process to update and save the total values for Budget, Earned, Actuals, and Forecast.
Use the Update Tphase API process to update an individual Tphase (time-phase) period for a specified resource and date.
Use the Validity Check API process to automatically run a validity check.
Use the wInsight Export API process to export Cobra data to wInsight in batch.
Use the Zero-Out Data process to set budget, forecast, progress, or actual time-phased resource values to zero.