Command Line Interface

This chapter lists the commands used to perform various tasks.

Commands

Command	Description
backup	Backup Infoworks configuration (specify the target location of the config file using the -target option.)
build	Build entity (specify the entity using the -pipeline or -cube option)
workflow-execute	Execute an action on a workflow (Pass an action using -workflow-action, -workflow , -domain )
delete	Delete entity (specify the entity using the (–group –source-for-group ), –source , –pipeline or –cube option. To also purge the metadata, use the option –purge-metadata.)
ingest	Ingest table groups for a source (specify the source and group using the –source –group options. To only perform a certain type of ingestion, use the –ingest-type option.)
ingest-segment	Ingest table segment for a source (specify the source and segment group ID using the –source –segment-group options.)
export	Export a table group or a pipeline target to an external database
list	List entities (specify the entity type using the –type option)
restore	Restore Infoworks configuration (specify the location of the config file using the –target option)
status	List jobs in the job queue (running or blocked)
validate	Validate a license key for DF pro feature
reorganize-data	Reorganize table data for a source (specify the source using –source –table options.)
data-reconciliation	Reconcile table group data for a source (specify the source using –source –source-for-group options.)
get-auth-token	Get authentication token for an Infoworks user (specify the username using –username –password options.)

Optional Arguments

Argument

Description

-h, -help

Show this help message and exit.

-debug

Toggle debug output

-quiet

Suppress all output

-u , –username

Username of Infoworks user

-p , –password

Password of Infoworks user

-at , –auth-token

Authentication Token (generated using iw-keygen).

-t <sources,domains,pipelines,cubes,groups>, –type <sources,domains,pipelines,cubes,groups>

Type of entities

-it <cdc,merge,truncate-reload,cdc-merge,switch,all>, –ingest-type <cdc,merge,truncate-reload,cdc-merge,switch,all>

Type of ingestion

-s , –source

Name of the source

-dom , –domain

Name of the domain

-pl , –pipeline

Name of the pipeline

Choose one of the actions from the list to apply it on the workflow

-c , –cube

Name of the cube

-tb , –table

Name of the table

-g , –group

Name of the table group

-sg , –segment-group

Table segment group id

-sfg , –source-for-group

Source name for table group

-lkey , –license-key

License key validator for DF Pro

-j , –jobid

IW job id

-tgt , –target

Target directory where the mongo backup should be stored

-pm, -purge-metadata

Delete the metadata of the entity

-hu, -humanize

Return a human readable output

Examples

Ingest table group under a source: {$IW_HOME}/apricot-meteor/infoworks_python/infoworks/cli/infoworks.sh ingest –source <source_name> –group <table_group_name> –ingest_type <ingestion_type> –auth-token <auth_token>
Get status of all jobs in mongo queue: {$IW_HOME}/apricot-meteor/infoworks_python/infoworks/cli/infoworks.sh status –auth-token <auth_token>
Get auth token from IW username and password: {$IW_HOME}/apricot-meteor/infoworks_python/infoworks/cli/infoworks.sh get-auth-token –username <username> –password <password>

Last updated on