How to use CLI(Command Line Interface) Commands

Topic: This article explains how CLI (Command Line Interface) commands are used to perform operations on Diyotta.

Environment: This article is written for Diyotta version 4.1

CLI is a user interface to Diyotta application that enables interaction with Diyotta from any shell program for orchestration purpose or for use in any control processes written as a shell program on the DI Server. It includes options for administration, execution, monitoring  and maintenance of the jobs and objects in DI Suite. 

Command Line Interface Operations

The Command Line Interface requires a putty session (or any other SSH client) and corresponding credentials to perform the operations on Diyotta.

1 . Provide the necessary credentials in order to connect to putty session

 3. After entering the values, the command prompt opens; enter username and password.

4. After logging into the specified repository, enter the following CLI command.

dicmd -  It lists all the possible operations that can be performed on Diyotta using CLI commands.


A list of all the commands is given below-

Command  Syntax Description
dicmd version

This command is used to view the current Diyotta version/build

dicmd serverstatus

This command is used to view the status of the current repository connected through the CLI. It displays whether the server is running or unable to connect

dicmd execute [-u userName -w userPassword] -c start|abort|stop

-p ProjectName -l LayerName -s StreamName [-f ParamName]

This command is used to execute/Abort/Stop the streams

dicmd compile [-u userName -w userPassword] -p ProjectName [-l LayerName] [-s StreamName]

This command is used to compile the Objects [Designs/Streams] present in the specified project

dicmd export [-u userName -w userPassword] -p ProjectName [-l LayerName] [-o DOBJ|DOGRP|CONNGRP|CONN|SEQGRP|NSEQ|DBFN|FUNGRP|

UDF|UDFGRP|DESIGN|STREAM|REUSABLEDESIGN] [-t NZ|HV|TD|ORA|FF|DB|PG|MS|BI|CO|SF|GP|ED|HQ|HD|JS|HB|XD|SP] [-g GroupName] [-n Object Name] -f OutXMLFileName

Export command is used to export the XML specifications of Data Objects, Connections, Sequence, Functions, UDFs, Designs, Streams, Reusable Designs.

One can also export the Complete Project, Connection group, Data Objects Group, Sequence Group, Functions Group, and UDFs Group.

dicmd genoptions [-u userName -w userPassword]

-p ProjectName[should be target project name where you want to import]

-i InXMLFileName -f OutXMLFileName

Genoption XML is used to provide additional importing options [Replace/Reuse/Rename] to the already Exported XML. So that based on the options provided in the genoption Xml, the objects present in the Xml may be imported into the specified project.

dicmd import [-u userName -w userPassword] -p ProjectName [-l LayerName] -f InXMLFileName  [-o GenoptionsXml]

Import command is used to Import the exported Xml present at the specified location/default Location into the current project, Layer

dicmd refresh [-u userName -w userPassword] -c mvw

Refresh command is used to refresh the Metaview component.

dicmd cleanup [-u userName -w userPassword] -c tform|local|applogs|opsruns|srvlogs|stage

[-p Project Nm] [-n days]

Cleanup command is used to clean all the tform, local, applogs, opsruns, srvlogs, and stage files present in a specified project that are older  ‘n’ number of days given in the command.

dicmd scheduler [-u userName -w userPassword] -c pause|resume [-t task|group]

Scheduler pause/resume command is used to pause/resume the Task/Task Group specified in the Command/ present in the Scheduler module.

dicmd jobstatus [-u userName -w userPassword]

[-c ACTIVE|FAILED|SUCCESS|ABORT|STOP|ALL] [-p ProjectName] [-l LayerName] [-s StreamName]

Jobstatus command is used to view the status[Active, Failed, Success, Aborted, Stopped, ALL] of all the Jobs/Streams or specific Stream executed in that particular project, layer

dicmd passwd -e TextToEncrypt Password command is used to encrypt the given text provided to it.

Note: You can specify your own username and password created in the current repository in the “dicmd” command. By default it picks up the username and password specified in the Environment Variables present in the bash profile.

This username and password can be altered based on the user choice [You can provide your username, password in the place of default username, password].



On this page