8/11/2019 pmcmd1

1/14

Mahindra Satyam 2009

PMCMD Commands

8/11/2019 pmcmd1

2/14

2

Mahindra Satyam 2009

Introduction

pmcmd means PowerMart Command Prompt

pmcmd is a program used to communicate with the Integration Service.

With pmcmd, we can perform some of the tasks that we can also perform in the

Workflow Manager, such as starting and stopping workflows and sessions.

pmcmd commands can be used in following modes:

1. Command line mode.

Invoke and exit pmcmd each time issue a command.

2. Interactive mode.

Establish and maintain an active connection to the Integration Service.

8/11/2019 pmcmd1

3/14

3

Mahindra Satyam 2009

Running Commands in Command Line Mode

Command line mode is useful when we want to runpmcmdcommands throughbatch files, scripts, or other programs.

When you run pmcmd in command line mode, need to enter connection

information such as:

domain name,

Integration Service name,user name and

password, etc.

To run pmcmd commands in command line mode:

1. At the command prompt, switch to the directory where pmcmd executable is

located.(By default, pmcmd installs in the \server\bindirectory)

2. Enter pmcmd followed by the command name and its required options and

arguments:

pmcmd command_name[-option1] argument_1 [-option2] argument_2...

8/11/2019 pmcmd1

4/14

4

Mahindra Satyam 2009

Example:

To start the workflow wf_SalesAvg in folder SalesEast, use the following syntax:

In Command line mode, pmcmd uses the return code to indicate the success or

failure of command.

0 : Success

other : Failure

pmcmd startworkflow -sv MyIntService-d MyDomain-u seller3

-pjackson-f SalesEastwf_SalesAvg

8/11/2019 pmcmd1

5/14

5

Mahindra Satyam 2009

Running Commands in Interactive Mode

Interactive mode is used to start and stop workflows and sessions withoutwriting a script.

No need to write connection information for each command.

To run pmcmd commands in interactive mode:

1. At the command prompt, switch to the directory where pmcmd executable islocated.(By default, pmcmd installs in the \server\bindirectory)

2. Typepmcmd.

This will start the pmcmd in interactive mode and display pmcmd>prompt.

3. Enter connection information for the domain and Integration Service.example:

connect -sv MyIntService -d MyDomain -u seller3 -p jackson

8/11/2019 pmcmd1

6/14

6

Mahindra Satyam 2009

Continued

4. Type a command and its options and arguments in the following format:command_name [-option1] argument_1 [-option2] argument_2...

5. Type exitto end an interactive session.

Example:

pmcmd

pmcmd> connect -sv MyIntService -d MyDomain -u seller3 -p jackson

pmcmd> setfolder SalesEast

pmcmd> startworkflow wf_SalesAvg

pmcmd> startworkflow wf_SalesTotal

8/11/2019 pmcmd1

7/147

Mahindra Satyam 2009

Continued

There are some commands that can be used only in Interactive mode.

Connect

Disconnect

Exit

Setfolder

SetnowaitSetwait

Showsettings

Unsetfolder

8/11/2019 pmcmd1

8/148

Mahindra Satyam 2009

Options

Option Argument Description

-service-sv

service Required. Integration Servicename.

-domain

-d

domain Optional. Domain name.

-timeout

-t

timeout Optional. Amount of time, in

seconds.Default is 180.

-user

-u

username Required in command line mode

-uservar

-uv

userEnvVar Specifies the user name

environment variable. Requiredin command line mode.

-password

-p

password Required in command line mode

8/11/2019 pmcmd1

9/149

Mahindra Satyam 2009

Option Argument Description

-passwordvar

-pv

passwordEnvVar Required in command

line mode

-usersecuritydomain

-usd

usersecuritydomain Optional in command

line mode. Required if

you use LDAP

authentication.

-usersecuritydomainvar

-usdv

userSecuritydomain

EnvVar

Optional in command

line mode. Securitydomain environment

variable.

-folder

-f

folder Required if the workflow

name is not unique in the

repository.-workflow

-w

workflow Required. Name of the

workflow.

-wait

-nowait

n/a Optional. Configures the

wait mode

Default is nowait.

8/11/2019 pmcmd1

10/1410

Mahindra Satyam 2009

Option Argument Description

-runinsname

-rin

runInsName Name of the workflow run instance. Use

this option if you are running concurrent

workflows.

-wfrunid workflowRunId Run identifier number (Run ID) of the

workflow run instance. Use this option if

you are running concurrent workflows.

8/11/2019 pmcmd1

11/1411

Mahindra Satyam 2009

Commands

StarttaskStartworkflow

Stoptask

Stopworkflow

Aborttask

Abortworkflow

ScheduleworkflowUnscheduleworkflow

Recoverworkflow

Pingservice

Gettaskdetails

Getworkflowdetails

8/11/2019 pmcmd1

12/1412

Mahindra Satyam 2009

Starttask

Option Argument Description

-paramfile paramfile Optional. Determines which parameter file

to use when a task or workflow runs.

-recovery

-norecovery

n/a Optional. If the task is a session, runs the

session based on the configured recovery

strategy.

8/11/2019 pmcmd1

13/1413

Mahindra Satyam 2009

Startworkflow

Option Argument Description-startfrom taskInstancePath Optional. Starts a workflow from a

specified task.

-localparamfile

-lpf

Localparamfile Optional. Specifies the parameter file

on a local machine.

-osprofile-o osProfile Optional. Specifies the operatingsystem profile assigned to the

workflow.

8/11/2019 pmcmd1

14/14