EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB44266: How to deploy a workflow in System Manager via Command Line in MicroStrategy 9.4.x-10.x?


Community Admin

• Strategy


This knowledge base article documents the process of deploying workflows in System Manager via Command Line in MicroStrategy 9.4.x-10.x.

Once the user creates a workflow using System Manager, the user can use a command line version of the System Manager interface to deploy a workflow in Strategy 9.4.x-10.x. The command line version lets the user deploy a workflow without having to use an interface, which can be beneficial for silent configuration routines and OEM deployments.
Users should be aware that some processes are dependent on the machine that is being used to deploy the workflow. For example, if the user includes processes to create DSNs, the DSNs are created on the machine that was used to deploy the workflow.
The command line version of System Manager is a one-line command line tool. This means that the command to begin the deployment is included in a single statement. The syntax of the statement depends on the environment in which the workflow is being deployed:
- Windows: MASysMgr.exe, followed by the parameters listed below.
- UNIX and Linux: mstrsysmgr, followed by the parameters listed below.
Parameters:
Of the parameters listed below, only -w to specify a workflow file is required, all other parameters are optional:


-w “WorkflowFile”: This parameter is required to specify the workflow to deploy. WorkflowFile is the path to the workflow file. For example, -w “C:\Create DSNs.smw” is valid syntax to deploy the Create DSNs.smw workflow file in a Windows environment.

 
-s “EntryProcess”: This parameter can be used to specify the first process to attempt for the workflow. Only processes that have been enabled as entry processes can be used as the first process in a workflow. EntryProcess is the name of the process as it is defined in the workflow.
-f “ParametersFile”: This parameter can be used to specify a parameters file, which supplies values for the parameters in the workflow. ParametersFile is the path to the parameters file. For example, -f “C:\Parameters.smp” is valid syntax to use the Parameters.smp parameter file in a Windows environment.
-l “LogFile”: This parameter can be used to specify a log file. All results of deploying a workflow are saved to the file that the user specifies. LogFile is the path to the log file. For example, -l “C:\WorkflowResults.log” is valid syntax to use the Workflow Results.log log file in a Windows environment.
-showoutput: This parameter can be used to display all the results of deploying the workflow to the command line. If the user is deploying a workflow as a completely silent process, excluding this option prevents these results from being displayed on the command line. The results can still be retrieved from the log file after deployment is complete.
-p “ParameterName1=Value1 ParameterName2=Value2”: This parameter can be used to specify values for parameters of the workflow. Any parameter values that are provided in this way are used in place of values provided in the workflow itself, as well as provided through a parameters file. Providing parameter values directly during command line execution is often required to supply login and password credentials specific to the machine or user environment for a given deployment.
 
To include multiple parameter and value pairs, the user must enclose each parameter in double quotes (" ") and separate each parameter and value pair using a space. For example, -p "UserName=User1" "Password=1234" is valid syntax to provide values for the parameters UserName and Password.
The steps below show the user how to deploy a workflow using the command line version of System Manager:
Prerequisites:
- The user created a workflow and saved it in a location that can be accessed from the machine that the user is deploying the workflow on. The user has created a workflow.
- System Manager is installed. This tool is installed as part of the general Strategy product suite.
- The user has installed any Strategy products and components that are required for the processes of the workflow.
- If required, the user has created a parameters file to provide values for the parameters of the workflow and saved it in a location that can be accessed from the machine that the user is deploying the workflow on.
 
To deploy a workflow using the command line version of System Manager:
1. Open a command line.
2. Check to verify that System Manager is installed on the machine:
 - Windows: Type MASysMgr.exe and press ENTER.
 - UNIX and Linux: Type mstrsysmgr and press ENTER.
If help information for using the command line version of System Manager is displayed, this means that System Manager is installed correctly.
3. Type the command to deploy the workflow:
 - Windows: Type MASysMgr.exe and include the required parameters as necessary.
For example, the command below is a valid command to deploy a System Manager workflow on a Windows environment:

MASysMgr.exe -w “C:\Create DSNs.smw” -s “CreateOracle DSN” -f “C:\Parameters.smp” -l “C:\WorkflowResults.log” -showoutput -p “UserName=User1” “Password=1234”

 - UNIX and Linux: Type mstysysmgr and include the required parameters, as necessary.
For example, the command below is a valid command to deploy a System Manager workflow on a UNIX or Linux environment:

mstrsysmgr -w “$HOME/Create DSNs.smw” -s “CreateOracle DSN” -f “$HOME/Parameters.smp” -l “$HOME/Workflow Results.log” -showoutput -p “UserName=User1” “Password=1234”

4. Once the user has typed the full command, press ENTER. The workflow is started and results are saved to the log file, as well as displayed on the screen if the user included the parameter -showoutput.


Comment

0 comments

Details

Knowledge Article

Published:

April 28, 2017

Last Updated:

April 28, 2017