CommandArguments

Command arguments

The CDP4-COMET-BatchEditor Community Edition is Command Line tool. It can run from CommandLine using arguments. The following arguments are mandatory:

• -s, --server (Default: https://cdp4services-test.cdp4.org) Uri of CDP server to connect to

• -m, --model Short name of the engineering model to process. Asterisk means: process all engineering models.

• -u, --user (Default: admin) Username to connect with

• -p, --password (Default: pass) Password associated to the username to connect with

It is also possible to run the COMET-BatchEditor without any arguments to list the available commands

• --dry (Default: false) Perform a dry run, i.e. do not commit any changes to persistent data store.

• --action see action

• --parameters Comma-separated list of short names of parameters. Use in conjunction with --action=AddParameters | RemoveParameters | AddRequirementParameters | RemoveRequirementParameters | ChangeDomain | Subscribe| Override | ApplyStateDependence | RemoveStateDependence | ApplyOptionDependence | RemoveOptionDependence.

• --categories Comma-separated list of short names of categories. Use in conjunction with --action. The specified action will only be applied to Element Definitions that are a member of at least one of the given categories.

• --element-definition Short name of an Element Definition that sets the top node of a decomposition subtree. Use in conjunction with --action. The specified action will only be applied to the given Element Definition and its subtree of contained Element Definitions.

• --requirements-specification Short name of a Requirements Specification that sets the Requirements Specification. Use in conjunction with --action=AddRequirementParameters | RemoveRequirementParameters. The specified action will only be applied to the given RequirementsSepcification's subtree of contained Requirements.

• --included-owners Comma-separated list of short names of domains of expertise. Use in conjunction with --action. The specified action will only be applied to Element Definitions owned by one of the given domains. If not specified all domains will be included.

• --excluded-owners Comma-separated list of short names of domains of expertise. Use in conjunction with action. The specified action will only be applied to Element Definitions not owned by one of the given domains. The --included-owners will be processed before the --excluded-owners.

• --domain Short name of a domain-of-expertise owner or subscriber. Use in conjunction with --action=AddParameters | ChangeParameterOwnership | SetSubscriptionSwitch | Subscribe.

• --to-domain Short name of a domain-of-expertise to change to. Use in conjunction with `--change-domain.

• --state Short name of an actual finite state list on which to make parameters state dependent. Use in conjunction with --action=ApplyStateDependence | RemoveStateDependence and --parameters.

• --parameter-switch Set switch on all subscriptions on parameters or parameter overrides owned by --domain. Possible value is: COMPUTED | MANUAL | REFERENCE.

• --report (Default: false) Report the element definitions, parameters and parameter subscriptions in a CSV file.

• --parameter-group Name of a parameter group into which new parameters will be added. If it does not exist, the parameter group will be created. Use in conjunction with --action=AddParameters.

• --scale Short name of a measurement scale to be assigned to selected parameters. The assignment will only be performed if the scale is one of the possible scales of the parameter. Use in conjunction with --action=SetScale and --parameters.

• -i, --iteration The iteration short name to work on

• --help Display this help screen.

• --version Display version information.