Cobra Help

Validity Check Process

Use the Validity Check API process to automatically run a validity check.

Process Settings

Below are the settings you must define for the Validity Check API process.

Setting

Description

Sample Value

ProcessID

This setting informs Cobra to run the Validity Check process.

ValidityCheck

Project

This setting refers to the Cobra project you are validating.

The project name is case-sensitive. This setting is required.

DEMOADV

ConfigurationName

This setting refers to the name of the configuration file.

The configuration name is case-sensitive. This setting is optional.

VALCHK_CONFIG

ConfigurationOwner

This setting refers to the owner of the export configuration file. If this setting is not specified, Cobra will assume that the API login user is the owner of the configuration file.

This setting is optional.

SYSADMIN

BusinessValidation

If the value is set to 1, Cobra validates the control account, work package, forecast, and milestone dates on the project, and performs other data integrity checks on the control accounts or work packages.

This setting is optional and the default value is 1.

1

ResourceCodeAssignmentValidation

If the value is set to 1, Cobra validates that the resource and code assignments in the project do not have invalid referenced data or undefined results.

This setting optional and the default value is 1.

1

AncillaryFilesValidation

If the value is set to 1, Cobra validates all the ancillary files (rate files, resource files, calendar files, and code files) attached to the project and rebuild resource/code structures.

This setting is optional and the default value is 1.

1

DataAnomalyValidation

If the value is set to 1, Cobra validates data anomalies such as work packages with invalid control accounts and orphan and duplicate records in the project.

This setting is optional and the default value is 1.

1

ProjectApportionmentDefinitionValidation

If the value is set to 1, Cobra validates the master project and project definitions such as the class/cost set assignments, project audit log records, master project, and apportionment definition checks.

This setting is optional and the default value is 1.

1

Setting Precedence Rules

The following rules describe how Cobra determines the final state of Validity Check settings.

  1. If a setting is set to 1 through the API, the process uses the default values of the corresponding options.

  2. If a configuration name is supplied and no other optional settings are specified, Validity Check uses the settings defined in the configuration.

  3. If a configuration name and one or more optional settings are supplied, the process uses the supplied setting values and the default values of the corresponding options.

  4. If an option is secured in Project Preferences, the secured option value takes precedence over all other rules.

Sample Script

Below is a sample script file for the Validity Check API process.

[Process017]
ProcessID=ValidityCheck
Project=DEMOADV
ConfigurationName=VALCHK_CONFIG
ConfigurationOwner=SYSADMIN
BusinessValidation=1
ResourceCodeAssignmentValidation=1
AncillaryFilesValidation=1
DataAnomalyValidation=1
ProjectApportionmentDefinitionValidation=1

How to...

Perform a Validity Check

Run the API Script

Create Windows Shortcut for the API Script


Learn more about...

Validity Check Preferences

Validity Check Error Codes and Messages

API Script

Project Template Creation

Validity Check


Parent Topic:

Process Sections of the API Script