[Index]

Model: relation/HcsRoleREL

Roles

Full HTML Help

Overview

Provider administrators can manage the roles that are available for administrators, operators, and users at lower levels in the hierarchy.

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

Edit a Role

To edit an existing role:

  1. Log in as provider administrator.
  2. Go to Role Management > Roles.
  3. Locate the role you want to change; then, click on the role to open it.
  4. Update the role settings, as required.
  5. Save your changes.

Note

If hierarchy node types are removed from the Hierarchies Allowed list while users or Site Defaults reference this node type, then the update cannot be saved. The transaction Message shows:

"Cannot update Role. Some User(s) or Site Defaults exist with the hierarchy rules defined in this role."

Add a Role

To add a new role:

  1. Log in as provider administrator.
  2. Choose Role Management > Roles.
  3. Click Add.
  4. Define role settings:
Setting Description
Name* Name of the role. This field is mandatory.
Hcs Component Access*

Controls which HCM-F components (FF or SA) that users with this role have access to. Used with Hierarchy Type and Service Assurance Role Type when mapping roles to HCM-F. This field is mandatory.

If Self Service is selected, options default to self-service options.
Service Assurance Role Type* Controls read/write access to HCM-F components. Used with Hierarchy Type and Hcs Component Access when mapping roles to HCM-F. This field is mandatory.
Hierarchy Type* The type of hierarchy nodes applicable at the selected hierarchy level. For example, at Provider level, the following values are allowed: Provider, Reseller, Customer, and Site. While at the Reseller level, the following values are allowed: Reseller, Customer, Site. Controls which roles are available at which levels in the hierarchy. Also used with Hcs Component Access and Service Assurance Role Type when mapping roles to HCM-F. This field is mandatory.
Hierarchies Allowed

The list of hierarchies where the role is available to be assigned to a user. Where a user is at a specific hierarchy, available roles will then include all roles that include that specific hierarchy in the Hierarchies Allowed list.

Refer to the Hierarchies Allowed List Impact below.

When the role is saved, the selected Hierarchy Type is added to the Hierarchies Allowed list if it is not included.

If the Hcs Component Access field has Fulfillment and ServiceAssurance selected, at least one entry must be available here.
Description Description of the role.
Access Profile* Permissions for resources are defined in Access Profiles. This field is mandatory.
Menu Layout The menu layout assigned to the role. Controls the menu options available to users assigned to the role.
Landing Page The home page assigned with the role. Controls what the home page looks like for users assigned to the role.
Theme* The name of the theme assigned to the role. The theme controls the overall look and feel of the Admin Portal. This field is mandatory.
Self Service Feature Display Policy The selected Self Service Feature Display Policy that is associated to the role.
Self Service Links Provide useful links to Self Service end users.
  1. Click Save to save the role.

Hierarchies Allowed List Impact

The following areas in the system are impacted by list entries available in the Hierarchies Allowed List of a role:

Microsoft-only Role

Starting with version 21.3-PB1, VOSS Automate ships with a Microsoft-only role (MicrosoftOnlyRole) and accompanying role-based access control elements, which are predefined for a Microsoft-only user interface experience. These elements include predefined field display policies, landing pages (MicrosoftOnlyLP), and menus (MicrosoftOnlyMenu). Installing these templates provides the baseline for a Microsoft-only version of VOSS Automate, and hides non-Microsoft GUI elements, such as the FDPs, menus, and landing pages reflecting functionality used for managing Cisco devices.

To use the MicrosoftOnlyRole in VOSS Automate:

  1. Log in to VOSS Automate as hscadmin.

  2. Go to (default menus) Role Management > Roles.

  3. Locate MicrosoftOnlyRole in the list view.

  4. Select the role in the list (or click on the role to open it).

    Note

    This role ships with a standard access profile and a predefined menu layout and landing page.

  5. Click Export to export the role to a JSON file, and save the file to your local computer.

  6. Edit the JSON file to specify the hierarchy where you want to use the role.

  7. Go to (default menus) Administration Tools > Import.

  8. Browse to the location you saved the JSON file, then click Import.

  9. Go to (default menus) Role Management > Roles to verify that the role now exists also at the hierarchy you specified.

  10. At the hierarchy where you wish to assign the role to a user (Provider or Customer), go to (default menus) User Management > Admins. Choose a user (or add a user), then on the User Details tab, from the Role field, choose the role (MicrosoftOnlyRole) you imported to this level, and save your change.

Model Details: relation/HcsRoleREL

Title Description Details
Base Group Assigned by FDP
  • Field Name: Base
  • Type: Object
Name * Name of Role
  • Field Name: Base.name
  • Type: String
  • MaxLength: 1024
Description Description of Role
  • Field Name: Base.description
  • Type: String
Role
  • Field Name: role
  • Type: Object
Description Description of Role
  • Field Name: Base.role.description
  • Type: String
Rules
  • Field Name: rules
  • Type: Object
Hierarchies Allowed Hierarchies where this Role can be assigned to a user. Roles may exist at a higher level in the hierarchy.
  • Field Name: hierarchy_types.[n]
  • Type: Array
  • Cardinality: [1..n]
Access Profile * The selected Access Profile that is associated with the Role.
  • Field Name: Base.role.access_profile
  • Type: String
  • Target: /api/data/AccessProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24j9jKrmLums94ITBk%24Szt0BDFGLV0Q6iK%2BLqbdpMeuPqLNTB%2B8D4o9ma8UbYhasO8KiUmQD7CRAVxCC35TyqdX0uKEJIywEsQFMs2QtmSneqM4BF%2BfBpQ29Vu9WV5pFFONSRxY69VFfmzK4X8U6qwXIBBF9GGR2fVyyELwumPXgSfqEMU5Xen8pVJyvdY2%2BnW76evBI3fSVlQIpSHCi57vafP0RVq/FU3YltOwHv1JJPeklWTFC8oCY5FeohNpHAQe/fi2wmTHFhjg1cziM2D6%2B%2BUnCpsN7gydLOHkvRNWNc3CWlLE9AsDHhZR6DuCv1%2BiyCxk0qv21vuSURcQsPfGUNAkflLs0lwzjnnHJ2lWxSCX8pio7BvyY5YjdUsvywiI8OL16bwUgg%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AccessProfile
  • Format: uri
  • Choices: []
Menu Layout The selected Menu Layout that is associated with the Role.
  • Field Name: Base.role.menu_layout
  • Type: String
  • Target: /api/data/MenuLayout/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24bHSxOCJxuJDiYdYr%246uIxrEgaMQiqkfGQ/RuklBksiamg9EKZYH38gVoU6DFh//XJVrsIyfhXfV%2B%2BF2UiyDypZstGdpIsyVns0%2BSbegek8WGi/n2r%2Bc6yCnJTqXQZBytosjbCl2nKsOHdbsHCs7S3niOIQLClv6v5ozD7wnPdIqBTDLPApO7d58hysFi3xqzG/bOS1tn2vWNMiNZEdYE9tBlIytmF743aef2ZykEFYuUnEUK//fkz8pkVrUZObOAMSXfv/joyJraULIDKKJW2P2BzvRPyockutYnA7mvMyaGzKLLaup61GRMYWLFt%2BUi1lCVQiwc90k1oVmWqHvCHktUzmUNq0jiTVPVDvxv%2Bssf5%2BlpOlEmrqKnlQGu7LYcvgcx6BA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/MenuLayout
  • Format: uri
  • Choices: []
Landing Page Landing page for user
  • Field Name: Base.role.landing_page
  • Type: String
  • Target: /api/data/LandingPage/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ImUoZ4lGiiUaomWO%242ZnZvQizg0waNHL8byQoKpYP1d4VU4GFDR5ORDysjAgQoDrg4WdyYHgj0L3v1nGK8M9tYBdL4YJQitS1K%2Bqljqnb1oZ6Q6AmuGxL3nMnc378fbaaY%2BfzPjlpCFncxsYee4v0fl7inc1cbHxsaft1uD8iB2gnYZxh9qwBjCtqD0/hxzb4BWxMR22wnC3IwFiJRxiEZK%2BsxdysgOkspQNSYQPBhjM4/qlxMniY%2BpUYcJ/XzoCT3lYWezg6lHRPCSAtvN8v%2BoEhXZ2tPRe8m53HTA2yaf5oRzxPHYfpjLohoGHhc8kOSpzIeS4fU1RBiUD8W3roNvz7TJOiTWrQcF3GEbJT5autRim%2B%2BRiR%2BU/djpvDbKczKmftioA%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/LandingPage
  • Format: uri
  • Choices: []
Theme The selected Theme that is associated with the Role.
  • Field Name: Base.role.theme
  • Type: String
  • Target: /api/data/Theme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24OVPt4rUWZ1R0vlqf%245my0lsAsRDru6ViA6ZvX/XHcWvSOfVwpDkLH/f3%2BVSAD3AUhypo3notG0dzY5lBCRg7aMEY64L%2BPxae9XXNDJtjFnf3qbBMlQHKsVH4KJEowWxg4h8NJek6ELjpxjlcGeABElTR7MavwUOCNAr/DfNSG4SPcH50bDCguqOXRoQ/wVpm48kU2Ko/SHeo3LdoWcz8Qg8352axAbydiKjjqMBJct7aY9zP%2BAh%2Bz%2BKGcD17EFxxjq1UFXMz2K/YMe8Jeh6Ke05nXp/ZiPcjCfJty7gKYthjg4p1w6OvhZpA82cRzZfTcCR/QCztNyyrQtcefTVwOYOmE0Pi0sHOEcBpJAPJBHrP6L9kFZpFd4nIoXZ0wshE%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Theme
  • Format: uri
  • Choices: []
Self Service Feature Display Policy
  • Field Name: Base.role.ss_display_policy
  • Type: String
  • Target: /api/data/SelfServiceFeatureDisplayPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5cVY9voWiIeFZZ5%24kJqNn4D0z7fuMA4mx7v2LZLhL8CxQXO2uaGiFj7c4pZnFWQGhfvQl97ImHFl%2BE5mpniHonkpbileTaRbqcY7DltjONqvFN41Tug%2BIW6bi5BKRu2kHHH2FthWf7ebAi4t%2BqZF7%2Br6IeQaHPNhupYZKSUnxl36ri92URAz5LzDwG8TGDyFGdPE4zUPgkkOmp/GQk1j8LGLjcEXt9XGpw4Vc2ZYumYN/Rg8JhkXvM%2BiYiUPX5AVJm/tEb9AkqWk6YrDNNZPCGMwD/rmKBYGaGYVIHa9u6Zknix8/LlMydzd9iNA3p8yf3/ClrHRnn/4eTFkVe7Fv4Zb05Qz8UV4T/GQLhQyAovc0MBDCEVlppS858beevoZcJs0JiQN%2BLruPM4TJb6W5ULu/uDW49bRYA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/SelfServiceFeatureDisplayPolicy
  • Format: uri
  • Choices: []
Self Service Links Provide useful links to Self Service end users
  • Field Name: Base.role.selfservice_links
  • Type: String
  • Target: /api/data/SelfServiceLinks/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24FPP04qioqGkXVhyl%24n0kDRnHwsEWPqYwCjvSy0eBYj6lVFzq7ZspGkGyB207mg0d7tEJVg%2BPr0LLnykhGVvEYNH/7iNHlp2VyETIBlka9UNZqxw/gcrLyEpkioqZC9jD1HFJ268pULhs9%2BbXr37FMgBPorbYvhobewBzR45oX1IdIGgqSreU/GC0e0g4aMicwkEmycUFPfBKzJSxOs440Z77YUukwtyB544Xr/8uvgGgX9SAoea2xC2jQM6RR/u3oftqfBom48zyEzFVn65L6aATK/xmx4fVhvLcrZjHzXMrsUh8zkRp4oxC5/kbV0paAcEAtwX9rxipskY3FStv8orPWte9sWVZTUeM89savN7FxpwqURVzQ7n1c4SXUnVEAJeQCfLDIwLryDA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/SelfServiceLinks
  • Format: uri
  • Choices: []
Hcs Component Access * Determines the type of HCS Components a User (assigned to this Role) is permitted to access. The types are: All HCS Applications:(Fulfillment and ServiceAssurance), HCMF Access Only:(Fulfillment Only), Service Assurance Access Only:(Service Assurance Only) and End User:Self Service Access (Self Service)
  • Field Name: Base.hcsComponentAccess
  • Type: String
  • MaxLength: 1024
  • Choices: ["Fulfillment and ServiceAssurance", "Fulfillment Only", "Service Assurance Only", "Self Service"]
Service Assurance Role Type * Determines the type of operations a User (assigned to this Role) is permitted to perform.
  • Field Name: Base.privileges
  • Type: String
  • MaxLength: 1024
  • Choices: ["Administrator", "Operator"]
Hierarchy Type * The Hierarchy Level at which this Role will be created and accessible for assignment.
  • Field Name: Base.hierarchyType
  • Type: String
  • Target: /api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24IRzIUMHNxgZKtOz3%24OeiCg1YZrPs29FOit8EK/96Tn7fQAhIZAQHr9%2BXBjffXKEnRbC4rJ2FvvzZNT4drsAcmaVfgeC%2BaQN2hvjlHoRMBj9Q1F88787lMcbVcqUgIVevx9jlRCuC4bFDmCqqiCY71rKE48wy28hT%2Bu7suwJqbYEOfBXRtfNa8CZzIzJ002xJlRgYlzh8VVqgmfMU2Wug3luqmN160VYkQB6jiU3UtfsaDGja6wIG5zwm1ECJ%2B0vKiSv7IOjorD6bX47%2Bez3HfJDhQSigBFuFLJywbTjxwthhXTLCg9Hu4ghqH6cTU6/3NjEhcpCN2t0T6KOz7smmwEQv24Rq61j/BQcuQyw5JUNRZWw1827sJuSfuQnLmsviLN/dXGfr6uiuMXbo%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/HierarchyNodeType
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Rules
  • Field Name: rules
  • Type: Object
Hierarchies Allowed Hierarchies where this Role can be assigned to a user. Roles may exist at a higher level in the hierarchy.
  • Field Name: hierarchy_types.[n]
  • Type: Array
  • Cardinality: [1..n]
Access Profile * The selected Access Profile that is associated with the Role.
  • Field Name: Base.access_profile
  • Type: String
  • Target: /api/data/AccessProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24j9jKrmLums94ITBk%24Szt0BDFGLV0Q6iK%2BLqbdpMeuPqLNTB%2B8D4o9ma8UbYhasO8KiUmQD7CRAVxCC35TyqdX0uKEJIywEsQFMs2QtmSneqM4BF%2BfBpQ29Vu9WV5pFFONSRxY69VFfmzK4X8U6qwXIBBF9GGR2fVyyELwumPXgSfqEMU5Xen8pVJyvdY2%2BnW76evBI3fSVlQIpSHCi57vafP0RVq/FU3YltOwHv1JJPeklWTFC8oCY5FeohNpHAQe/fi2wmTHFhjg1cziM2D6%2B%2BUnCpsN7gydLOHkvRNWNc3CWlLE9AsDHhZR6DuCv1%2BiyCxk0qv21vuSURcQsPfGUNAkflLs0lwzjnnHJ2lWxSCX8pio7BvyY5YjdUsvywiI8OL16bwUgg%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/AccessProfile
  • Format: uri
  • Choices: []
Menu Layout The selected Menu Layout that is associated with the Role.
  • Field Name: Base.menu_layout
  • Type: String
  • Target: /api/data/MenuLayout/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24bHSxOCJxuJDiYdYr%246uIxrEgaMQiqkfGQ/RuklBksiamg9EKZYH38gVoU6DFh//XJVrsIyfhXfV%2B%2BF2UiyDypZstGdpIsyVns0%2BSbegek8WGi/n2r%2Bc6yCnJTqXQZBytosjbCl2nKsOHdbsHCs7S3niOIQLClv6v5ozD7wnPdIqBTDLPApO7d58hysFi3xqzG/bOS1tn2vWNMiNZEdYE9tBlIytmF743aef2ZykEFYuUnEUK//fkz8pkVrUZObOAMSXfv/joyJraULIDKKJW2P2BzvRPyockutYnA7mvMyaGzKLLaup61GRMYWLFt%2BUi1lCVQiwc90k1oVmWqHvCHktUzmUNq0jiTVPVDvxv%2Bssf5%2BlpOlEmrqKnlQGu7LYcvgcx6BA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/MenuLayout
  • Format: uri
  • Choices: []
Landing Page Landing page for user
  • Field Name: Base.landing_page
  • Type: String
  • Target: /api/data/LandingPage/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ImUoZ4lGiiUaomWO%242ZnZvQizg0waNHL8byQoKpYP1d4VU4GFDR5ORDysjAgQoDrg4WdyYHgj0L3v1nGK8M9tYBdL4YJQitS1K%2Bqljqnb1oZ6Q6AmuGxL3nMnc378fbaaY%2BfzPjlpCFncxsYee4v0fl7inc1cbHxsaft1uD8iB2gnYZxh9qwBjCtqD0/hxzb4BWxMR22wnC3IwFiJRxiEZK%2BsxdysgOkspQNSYQPBhjM4/qlxMniY%2BpUYcJ/XzoCT3lYWezg6lHRPCSAtvN8v%2BoEhXZ2tPRe8m53HTA2yaf5oRzxPHYfpjLohoGHhc8kOSpzIeS4fU1RBiUD8W3roNvz7TJOiTWrQcF3GEbJT5autRim%2B%2BRiR%2BU/djpvDbKczKmftioA%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/LandingPage
  • Format: uri
  • Choices: []
Theme The selected Theme that is associated with the Role.
  • Field Name: Base.theme
  • Type: String
  • Target: /api/data/Theme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24OVPt4rUWZ1R0vlqf%245my0lsAsRDru6ViA6ZvX/XHcWvSOfVwpDkLH/f3%2BVSAD3AUhypo3notG0dzY5lBCRg7aMEY64L%2BPxae9XXNDJtjFnf3qbBMlQHKsVH4KJEowWxg4h8NJek6ELjpxjlcGeABElTR7MavwUOCNAr/DfNSG4SPcH50bDCguqOXRoQ/wVpm48kU2Ko/SHeo3LdoWcz8Qg8352axAbydiKjjqMBJct7aY9zP%2BAh%2Bz%2BKGcD17EFxxjq1UFXMz2K/YMe8Jeh6Ke05nXp/ZiPcjCfJty7gKYthjg4p1w6OvhZpA82cRzZfTcCR/QCztNyyrQtcefTVwOYOmE0Pi0sHOEcBpJAPJBHrP6L9kFZpFd4nIoXZ0wshE%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Theme
  • Format: uri
  • Choices: []
Self Service Feature Display Policy
  • Field Name: Base.ss_display_policy
  • Type: String
  • Target: /api/data/SelfServiceFeatureDisplayPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5cVY9voWiIeFZZ5%24kJqNn4D0z7fuMA4mx7v2LZLhL8CxQXO2uaGiFj7c4pZnFWQGhfvQl97ImHFl%2BE5mpniHonkpbileTaRbqcY7DltjONqvFN41Tug%2BIW6bi5BKRu2kHHH2FthWf7ebAi4t%2BqZF7%2Br6IeQaHPNhupYZKSUnxl36ri92URAz5LzDwG8TGDyFGdPE4zUPgkkOmp/GQk1j8LGLjcEXt9XGpw4Vc2ZYumYN/Rg8JhkXvM%2BiYiUPX5AVJm/tEb9AkqWk6YrDNNZPCGMwD/rmKBYGaGYVIHa9u6Zknix8/LlMydzd9iNA3p8yf3/ClrHRnn/4eTFkVe7Fv4Zb05Qz8UV4T/GQLhQyAovc0MBDCEVlppS858beevoZcJs0JiQN%2BLruPM4TJb6W5ULu/uDW49bRYA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/SelfServiceFeatureDisplayPolicy
  • Format: uri
  • Choices: []
Self Service Links Provide useful links to Self Service end users
  • Field Name: Base.selfservice_links
  • Type: String
  • Target: /api/data/SelfServiceLinks/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24FPP04qioqGkXVhyl%24n0kDRnHwsEWPqYwCjvSy0eBYj6lVFzq7ZspGkGyB207mg0d7tEJVg%2BPr0LLnykhGVvEYNH/7iNHlp2VyETIBlka9UNZqxw/gcrLyEpkioqZC9jD1HFJ268pULhs9%2BbXr37FMgBPorbYvhobewBzR45oX1IdIGgqSreU/GC0e0g4aMicwkEmycUFPfBKzJSxOs440Z77YUukwtyB544Xr/8uvgGgX9SAoea2xC2jQM6RR/u3oftqfBom48zyEzFVn65L6aATK/xmx4fVhvLcrZjHzXMrsUh8zkRp4oxC5/kbV0paAcEAtwX9rxipskY3FStv8orPWte9sWVZTUeM89savN7FxpwqURVzQ7n1c4SXUnVEAJeQCfLDIwLryDA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/SelfServiceLinks
  • Format: uri
  • Choices: []