im editgroup
edits a group
Synopsis
im editgroup [--name=value] [--description=value] [--queryTimeout=value] [--sessionLimit=value] [--image=[none|default|<path>] [--email=value] [--notificationRule=rule] [--notificationRuleFile=value] [--copyNotification=[user|group]:<name>] [--[no]active] [--name=value] [--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]] group
Description
im editgroup edits a group for workflows and documents. You can edit the following group details: group name, e-mail address, image, description, and notification settings. For example:
im editgroup --image=/admin/creategroup/services2.jpg "Services"
changes the custom image in the Services group.
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 group. Names can be a maximum of 100 characters and cannot contain square brackets.
|
|
PTC recommends you do not use commas, colons, or special characters in group names. If you use commas in the group name, you cannot select the group in a multi-valued user field. If you use colons in the group name, the group cannot edit shared system provided objects (charts, queries, reports, and dashboards).
|
• --description=value
specifies a description of the group.
--image=[none|default|<path>]
specifies whether an image appears for the group.
◦ --image=none does not specify an image for the group.
◦ --image=default specifies the default "group" image for the group.
◦ --image=[<path>] specifies the path and name of a custom image for the group, for example, c:\images\group_icon.gif.
|
|
Images must be GIF or JPEG format, and no larger than 16 by 24 pixels.
|
• --email=value
specifies the e-mail address of the group.
• --notificationRule=rule
specifies the notification rule for this principal. For the rule syntax, see Specifying Rules on the
options reference page.
|
|
• To specify a date and time for a date field, use the MM/dd/yyyy h:mm:ss [AM|PM] format. You can specify a time only if the date field is configured to display the time. To specify the current date for a date field, type today. This option can be specified for a date field or a date field configured to display the date and time. To specify the current date and time for a date field, type now. This option can be specified only if the date field is configured to display the date and time. To specify an empty value for the date field, type none.
• E-mail notification is subject to project, type, and field visibility rules. Only users that have visibility for a given project and type receive e-mail notification for issues related to that project and type. In addition, e-mail notifications include only the fields they have permission to view.
|
• --notificationRuleFile=value
specifies the file that contains the rules to read. For the file content format, see Specifying Rules on the
options reference page.
• --copyNotification=[user|group]:<name>
copies the given user/group's notification rules. This command copies the given user/group's notification rule into this group's rule at the time that the command is run. The command does not create a pointer to another notification rule.
• --[no]active
Specifies if the group is actively used in Windchill RV&S. This option is useful for removing groups that are no longer needed. Specifying --noactive prevents the group from being displayed as an available default group field value; however, the group still appears in existing issue data.
|
|
If the group is referenced in a trigger assignment or as the default value in a group field, moving the group from active to inactive displays an error message. The reference must be removed before making the group inactive.
|
• --queryTimeout=value
specifies the total time in seconds allowed for queries performed by members of the specified group.
• --sessionLimit=value
specifies the number of sessions each user in the group can open at one time. This option assists in managing resource allocation for the Windchill RV&S Server. For example, if you specify 5, a user can begin a session in the Web interface, and open 5 tabs in a browser to run a chart in each tab. You can specify a maximum of 100 connections. Default is 5; however, a value of 0 specifies the default value.
|
|
If there are Web interface users with heartbeat and idle timeout, then an idle-timed-out user still continues to exist, and is not subject to this limit.
|
• group
specifies the name of group you want to edit.
See Also
