im editstate
edits the properties of a state
Synopsis
im editstate [--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] [--overrideForType=type] [--removeOverride=description,image,capabilities] [--[no|confirm]removeDescriptionOverride] [--quiet] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [-g|--gui] [--settingsUI=[gui|default]] [--status=[none|gui|default]]state
Description
im editstate edits the properties of a state for workflows and documents. For example:
im editstate --description="Initial state" --name="1st_State" Submit
changes the name of the Submit state to 1st_State.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --name=value
specifies the new name of the state. Names can be a maximum of 100 characters and cannot contain square brackets.
• --description=value
specifies a description of the state.
• --image=[none|default|<path>]
specifies whether an image appears for the state.
◦ --image=none 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.
|
• --position=<number>|first|last|before:<name>|after:<name>
specifies the position in the order of states.
• --capabilities=MKSSI:OpenChangePackages,MKSSI:ChangePackagesUnderReview,MKSIM:TimeTracking,MKSTM:ModifyTestResult
sets the given state capabilities to allow open change packages, change packages under review, time entries, or modifications to test results.
• --overrideForType=type
sets a type-specific override for the state through the selected type or an issue of the selected type. The customized value supersedes the global settings for the state attribute when referenced through the selected type or an issue of the selected type. You can only override the attributes for description, image, and capabilities. The value is the name of the type you want to apply the override to.
To set an empty override, use the following syntax, leaving a blank space after the option for description, image, or capabilities:
im editstate --overrideForType=<type name> --capabilities=<state name>
• --removeOverride=description,image,capabilities
removes the specified type override for the state and reverts to the global state attribute defined for that type. Use this option as a comma-separated list to name each of the attributes you wish to remove. Acceptable values are capabilities, description, and image.
For example, the following command removes an override for state capability for the Approved state in the Defect type:
im editstate --overrideForType=Defect --removeOverride=capabilitiesApproved
• --[no|confirm]removeDescriptionOverride
confirms removing the translations in all the locales for the overridden description.
• state
specifies the name of state you want to edit.
See Also
