CLI Reference > Server Administration Commands > im editproject
 
im editproject
edits the properties of a project
Synopsis
im editproject [--name=value] [--parent=project] [--description=value] [--permittedAdministrators=u=user1,user2,...;g=group1,group2] [--permittedGroups=group,group,...] [--[no]inheritPermittedGroups] [--openImage=[none|default|<path>] [--closedImage=[none|default|<path>] [--[no]active] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-Ffile|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [-g|--gui] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]]project
Description
im editproject edits the properties of a project for workflows and documents. For example:
im editproject --inheritPermittedGroups --parent=/FinancialToolkit "SavingsManager"
changes the SavingsManager group to inherit the permitted groups from the parent project FinancialToolkit.
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 project. Names can be a maximum of 100 characters, cannot contain square brackets or a forward slash (/).
--parent=project
Specifies the new name of the parent project. If specified, then the project becomes subproject of the new parent project. The specified parent project must exist before creating a subproject. When specifying a parent project, you must include a forward slash and the full project name, for example, /AuroraProject.
--description=value
Specifies a description of the project.
--permittedAdministrators=u=user1,user2,...;g=group1,group2,...
Specifies a comma delimited list of users and/or groups that can administer this project. Project Administrators are allowed to edit and view projects. Project Administrators can also manage all child projects of the project they are approved for, but they cannot edit projects assigned to another Project Administrator. Project Administrators can only create and delete subprojects, they cannot create top level projects unless they have been granted the CreateProject ACL permission. Project Administrators can also view all users, groups, and dynamic groups, but they can only edit dynamic groups membership for the projects they are assigned to. For more information, see the Integrity Lifecycle Manager Help Center.
--permittedGroups=group,group,...
Specifies a comma delimited list of groups that have visibility for this project.
--[no]inheritPermittedGroups
Controls whether or not permissions are inherited from the parent project. Project settings cannot be inherited unless there is a parent project. Inherited permissions are mutually exclusive with --permittedGroups.
--openImage=[none|default|<path>]
Specifies whether an image appears for an open project. The default image is an open folder.
--image=none does not specify an image for the project.
--image=default specifies the default "open" image for the project.
--image=<path> specifies the path and name of a custom image for the project, for example, c:\images\project_icon.gif.
* 
Images must be GIF or JPEG format, and no larger than 16 by 24 pixels.
--closedImage=[none|default|<path>]
Specifies file path for an image icon file used for a closed project when displayed in the graphical user interface. See --openImage for details. The default image is a closed folder.
--[no]active
Specifies if the project is actively used in Integrity Lifecycle Manager. This option is useful for removing inactive projects in your organization. Specifying --noactive prevents the project from being displayed as an available default project field value; however, the project still appears in existing issue data.
* 
If the project is referenced in a trigger assignment, moving the project from active to inactive displays an error message. The reference must be removed before making the project inactive.
project
specifies the project you want to edit. Include a forward slash (/) when specifying a high level project. For subprojects, include the full path to the subprojects, for example, /AuroraProject/BorealisSubProject.
See Also
Commands: im createproject, im viewproject, im deleteproject, im projects
Miscellaneous: options