Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

managername

Property

UI Field Name

Description

Specifications

Required

Anchor
ctrlNavigationVisibility - GR
ctrlNavigationVisibility - GR
ctrlNavigationVisibility

Control Navigation Visibility

Indication of whether or not to control the visibility of navigation pane entries in the Controller Navigator, via the navigationVisibility property, for members of this Group. If ctrlNavigationVisibility is false, all entries are visible.

Boolean. Valid values: true/false. Default is false.

N

Anchor
description - GR
description - GR
description

Description

Description of the group.


N

Anchor
email - GR
email - GR
email

Email

Email address of this group.


N

Anchor
excludeRelated - GR
excludeRelated - GR
excludeRelated

n/a

For the Modify Group web service; specification for whether or not to exclude related records (Group Roles, Group Members, Group Permissions) from the update, even if they are provided in the request.

Note
titleNote

In XML, excludeRelated is specified as an attribute in the <userGroup> element.

Valid values: true/false (default is false).

N

Anchor
groupMembers - MEM
groupMembers - MEM
groupMembers

n/a

Users in this group.

Note
titleNote

Universal Controller only supports a user being a member of 1,000 groups or less.

Format:
XML


Panel
Html bobswift
<pre>
&lt;groupMembers&gt;
      &lt;groupMember&gt;
            &lt;user&gt;userc&lt;/user&gt;
      &lt;/groupMember&gt;
&lt;/groupMembers&gt;
</pre>


 
JSON


Panel

N

Html bobswift
<pre>
"groupMembers": [
  {
  "user":  "userc"
  }
]
</pre>

N

Anchor
groupRoles - ROLE
groupRoles - ROLE
groupRoles

n/a

Roles assigned to this group.

Format:
XML


Panel

 
JSON

Panel

N

Anchor
manager - GRmanager - GR

Manager

ID of the Universal Controller user that is the manager of this group.

N

Anchor
name - GRname - GR
Html bobswift
<pre>
&lt;groupRoles&gt;
      &lt;groupRole&gt;
            &lt;role&gt;ops_report_admin&lt;/role&gt;
      &lt;/groupRole&gt;
&lt;/groupRoles&gt;
</pre>


 
JSON


Panel
Html bobswift
<pre>
"groupRoles": [
  {
  "role": "ops_report_global"
  }
]
</pre>

N

Anchor
manager - GR
manager - GR
manager

Manager

ID of the Universal Controller user that is the manager of this group.


N

Anchor
name - GR
name - GR
name

Name

Name of the group.


Y

Anchor
navigationVisibility - GR
navigationVisibility - GR
navigationVisibility

Navigation Visibility

List of all Controller Navigator entries.

Format:
XML


Panel
To include all
Html bobswift
<pre>
&lt;navigationVisibility&gt;
      &lt;navigationNode&gt;Reports&lt;/navigationNode&gt;
&lt;/navigationVisibility&gt;
</pre>


To include all values, set the navigationNode to All


Panel

 
JSON

Panel

 
Valid values: (see navigationNode Valid Values, below)

N

Anchorparent - GRparent - GRparent

Parent

Name of this group's parent group, if any.

N

Anchorpermissions - PERMpermissions - PERMpermissions

n/a

Permissions assigned to this group.

N

AnchorretainSysIds - GRretainSysIds - GRretainSysIds

n/a

For
Html bobswift
<pre>
&lt;navigationVisibility&gt;
      &lt;navigationNode&gt;All&lt;/navigationNode&gt;
&lt;/navigationVisibility&gt; 
</pre>


 
JSON


Panel
Html bobswift
<pre>
"navigationVisibility": [
  "Reports",
  "Support Portal"
]
</pre>


 
Valid values: (see navigationNode Valid Values, below)

N

Anchor
parent - GR
parent - GR
parent

Parent

Name of this group's parent group, if any.


N

Anchor
permissions - PERM
permissions - PERM
permissions

n/a

Permissions assigned to this group.


N

Values

Navigation Panel

  • All

All navigation panels

Anchor
retainSysIds - GR
retainSysIds - GR
retainSysIds

n/a

  • Activity
  • Task Instances
  • History
  • All Triggers
  • Active Triggers

    • For Create and Read web services; specification for whether or not the web service should persist the sysId property.

    Note
    titleNote

    In XML, retainSysIds is specified as an attribute in the <userGroup> element.

    Valid values: true/false (default is true).

    N

    AnchorsysId - GRsysId - GRsysId

    n/a

    System ID field in the database for this record.

    Persisted only if retainSysIds is set to true.

    N

    ...


    Html bobswift
    <ul>
<li> If <code>retainSysIds</code> is true and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <code>retainSysIds</code> is false and <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. |
</ul>



    Note
    titleNote

    In XML, retainSysIds is specified as an attribute in the <userGroup> element.

    Valid values: true/false (default is true).

    N

    Anchor
    sysId - GR
    sysId - GR
    sysId

    n/a

    System ID field in the database for this record.

    Persisted only if retainSysIds is set to true.

    N

    Anchor
    navigationNode Valid Values
    navigationNode Valid Values
    navigationNode Valid Values

    Values

    Navigation Panel

    • All

    All navigation panels

    • Activity
    • Task Instances
    • History
    • All Triggers
    • Active Triggers
    • Cron Triggers
    • Time Triggers
    • Manual Triggers
    • Temporary Triggers
    • File Monitor Triggers
    • Task Monitor Triggers
    • Variable Monitor Triggers
    • Email Monitor Triggers
    • Application Monitor Triggers
    • Composite Triggers
    • Forecasts
    • Forecast Calendar
    • All Tasks
    • Workflow Tasks
    • Linux/Unix Tasks
    • Windows Tasks
    • z/OS Tasks
    • Universal Command Tasks
    • SAP Tasks
    • PeopleSoft Tasks
    • File Transfer Tasks
    • Manual Tasks
    • Timer Tasks
    • SQL Tasks
    • Stored Procedure Tasks
    • Email Tasks
    • Web Service Tasks
    • Task Monitors
    • File Monitors
    • FTP File Monitors
    • System Monitors
    • Variable Monitors
    • Email Monitors
    • Application Control Tasks
    • Calendars
    • Custom Days
    • Variables
    • Scripts
    • Virtual Resources
    • Credentials

    Automation Center

    • Dashboards
    • Reports
    • Widgets
    • Colors

    Reporting

    • All Agents
    • Linux/Unix Agents
    • Windows Agents
    • z/OS Agents
    • Linux/Unix Agent Clusters
    • Windows Agent Clusters
    • OMS Servers
    • Cluster Nodes
    • Email Templates
    • Email Connections
    • Database Connections
    • PeopleSoft Connections
    • SAP Connections
    • SNMP Managers
    • Applications

    Agents & Connections

    • Bundles
    • Promotion Targets
    • Promotion History
    • Promotion Schedules

    Bundles & Promotion

    • Properties
    • LDAP Settings
    • Data Backup / Purge
    • Server Operations
    • Universal Templates
    • Filters
    • Users
    • Groups
    • Business Services
    • Audits
    • Support Portal
    • Video Classroom

    Administration

    ...

    opReadopUpdateopswiseGroups

    Format:
    XML

     
    JSON

    permissionType

    Property

    UI Field Name

    Description

    Specifications

    Required

    Anchor
    allGroups - PERM
    allGroups - PERM
    allGroups

    Member of Any Business Service or Unassigned

    Specification for whether or not this permission applies both to records that belong to any Business Service and to records that do not belong to any Business Service.

    Boolean. Valid Values: true/false. Default is false.

    N

    Anchor
    commands - PERM
    commands - PERM
    commands

    Commands

    Commands that are associated with each permission.

    Valid values: see Group Web Services#Command Permissions, below.

    N

    Anchor
    defaultGroup - PERM
    defaultGroup - PERM
    defaultGroup

    Unassigned to Business Service

    Specification for whether or not this permission applies to records that do not belong to any Business Service.

    Boolean. Valid Values: true/false. Default is false.

    N

    Anchor
    nameWildcard - PERM
    nameWildcard - PERM
    nameWildcard

    Name

    Specification to apply this permission to records whose name matches the string specified here.

    Wildcards (*'s) can be used.

    Y

    Anchor
    opCreate - PERM
    opCreate - PERM
    opCreate

    Create

    Allows members of the group to create records of the specified permissionType.

    Boolean. Valid Values: true/false. Default is false.
     
    Cannot be set to true if permissionType is Agent or Task Instance.

    N

    Anchor
    opDelete - PERM
    opDelete - PERM
    opDelete

    Delete

    Allows members of the group to delete records of the specified permissionType.

    Boolean. Valid Values: true/false. Default is false.
     
    Cannot be set to true if permissionType is Agent.

    N

    Anchor
    opExecute - PERM
    opExecute - PERM
    opExecute

    Execute

    Allows the user to execute records of the specified permissionType.

    Boolean. Valid Values: true/false. Default is false.
     
    If the Strict Connection Execute Constraints Universal Controller system property is false:

    If the Strict Connection Execute Constraints Universal Controller system property is true:

    N

    Anchor
    opRead - PERM


    		opRead - PERM

    Read

    Allows the user to read records of the specified permissionType.

    		opUpdate - PERM

    Update

    		Allows members of the group to update
    Boolean. Valid Values: true/false. Default is false.
     
    If the Strict Business Service Membership Read
    Html bobswift
    <ul>
<li> <code>opExecute</code> can be set to true only if <code>permissionType</code> is Agent, Credential, Script, or Virtual Resource.
</ul>


    If the Strict Connection Execute Constraints Universal Controller system property is falsetrue:

    N

    Anchor
    opUpdate - PERM


    Html bobswift
    <ul>
<li> <code>opExecute</code> can be set to true only if <code>permissionType</code> is Agent, Credential, Database Connection, Email Connection, SAP Connection, Script, SNMP Manager, or Virtual Resource.
</ul>

    N

    Anchor
    opRead - PERM
    opRead - PERM
    opRead

    Read

    Allows the user to read records of the specified permissionType.

    Boolean. Valid Values: true/false. Default is false.
     

    Must be set to true if opCreate is set to true.

    N

    Anchor
    opswiseGroups - PERMopswiseGroups - PERM

    Member of Business Services

    Applies this permission to records that are members of the selected Business Service(s).

    Panel
    Panel

    N

    Anchor
    permissionType - PERMpermissionType - PERM

    Type

    Type of permission for this group.

    Valid values:If the Strict Business Service Membership Read Constraints Universal Controller system property is false:


    Html bobswift
    <ul>
<li> <code>opRead</code> must be set to true if <code>permissionType</code> is Agent, Agent Cluster, Calendar, Credential, Database Connection, Email Connection, SAP Connection, Email Template, SNMP Manager, or Virtual Resource.
</ul>

    N

    Anchor
    opUpdate - PERM
    opUpdate - PERM
    opUpdate

    Update

    Allows members of the group to update records of the specified permissionType.

    Boolean. Valid Values: true/false. Default is false.
     
    Must be set to true if opCreate is set to true.

    N

    Anchor
    opswiseGroups - PERM
    opswiseGroups - PERM
    opswiseGroups

    Member of Business Services

    Applies this permission to records that are members of the selected Business Service(s).

    Format:
    XML


    Panel
    Html bobswift
    <pre>
&lt;opswiseGroups&gt;
  &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt;
&lt;/opswiseGroups&gt;
</pre>


     
    JSON


    Panel
    Html bobswift
    <pre>
"opswiseGroups": ["test"]
</pre>

    N

    Anchor
    permissionType - PERM
    permissionType - PERM
    permissionType

    Type

    Type of permission for this group.

    Valid values:


    Html bobswift
    <ul>
<li> As String = Agent, As Value = 1
<li> As String = Calendar, As Value = 2
<li> As String = Credential, As Value = 3
<li> As String = Task, As Value = 4
<li> As String = Task Instance, As Value = 5
<li> As String = Trigger, As Value = 6
<li> As String = Application, As Value = 7
<li> As String = Script, As Value = 8
<li> As String = Variable, As Value = 9
<li> As String = Virtual Resource, As Value = 10
<li> As String = Agent Cluster, As Value = 11
<li> As String = Email Template, As Value = 12
<li> As String = Email Connection, As Value = 13
<li> As String = Database Connection, As Value = 14
<li> As String = SAP Connection, As Value = 15
<li> As String = SNMP Manager, As Value = 16
<li> As String = PeopleSoft Connection, As Value = 17
<li> As String = Bundle, As Value = 18
<li> As String = Promotion Target, As Value = 19
<li> As String = OMS Server, As Value = 20
</ul>

    Y

    Anchor
    sysId - PERM
    sysId - PERM
    sysId

    n/a

    System ID field in the database for this record.

    Persisted only if retainSysIds is set to true.

    N

    ...