CLI Reference > Server Administration Commands > im createstate
im createstate
creates a state
im createstate [--name=value] [--description=value] [--image=[none|default|<path>] [--position=<number>|first|last|before:<name>|after:<name>] [--capabilities=MKSSI:OpenChangePackages,MKSSI:ChangePackagesUnderReview,MKSIM:TimeTracking,MKSTM:ModifyTestResult] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [--quiet] [-g|--gui] [--settingsUI=[gui|default]] [--status=[none|gui|default]]
im createstate creates a state for workflows and documents. For example:
im createstate --description="Initial state" --name=Submit
creates the Submit state with a description.
This command takes the universal options available to all im commands, as well as some general options. See the options reference page for descriptions.
specifies the name of the state to create. Names can be a maximum of 100 characters and cannot contain square brackets. This option is mandatory.
specifies a description of the state.
specifies whether an image appears for the state.
does not specify an image for the state.
--image=default specifies the default image for the state.
--image=<path> specifies the path and name of a custom image for the state, for example, c:\images\state_icon.gif.
Images must be GIF or JPEG format, and no larger than 16 by 24 pixels.
specifies the position in the order of states. The first position is 0.
sets the given state capabilities to allow open change packages, change packages under review, time entries, or modifications to test results.
See Also
Commands: im editstate, im viewstate, im deletestate, im states
Miscellaneous: options