Model: relation/HcsRoleREL

Roles

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

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 an Existing Role

To edit an existing role:

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

Add a New Role

To add a new role:

Log in as provider administrator.
Choose Role Management > Roles.
Click Add.
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.
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.
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.
Custom Interfaces	Add Interface Types and Names for the role. The available custom Interface Type is InterfaceBusinessAdminPortal, which provides access to the Business Portal Admin Portal. Choose profile MS Only for admins to manage Microsoft subscribers in the Business Admin Portal.

Click Save to save the role.

Model Details: relation/HcsRoleREL

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title															Description																				Details
Name *																																			Field Name: name Type: String MaxLength: 1024
Hierarchy Type *																																			Field Name: hierarchyType Type: String Target: data/HierarchyNodeType Target attr: name MaxLength: 1024 Format: uri
Privileges *																																			Field Name: privileges Type: String MaxLength: 1024 Choices: ["Administrator", "Operator"]
Hcs Component Access *																																			Field Name: hcsComponentAccess Type: String MaxLength: 1024 Choices: ["Fulfillment and ServiceAssurance", "Fulfillment Only", "Service Assurance Only", "Self Service"]
Role																																			Field Name: role Type: Object
	Name *														The name that is given to the Role.																				Field Name: role.name Type: String
	Description														A description for the Role.																				Field Name: role.description Type: String
	Menu Layout														The selected Menu Layout that is associated with the Role.																				Field Name: role.menu_layout Type: String Target: data/MenuLayout Target attr: name Format: uri
	Theme														The selected Theme that is associated with the Role.																				Field Name: role.theme Type: String Target: data/Theme Target attr: name Format: uri
	Access Profile *														The selected Access Profile that is associated with the Role.																				Field Name: role.access_profile Type: String Target: data/AccessProfile Target attr: name Format: uri
	Interface *														The selected interface that is associated with the Role. The interface can be an Administration or Self Service.																				Field Name: role.interface Type: String Choices: ["Administration", "Self Service", "None"]
	Landing Page														Landing page for user																				Field Name: role.landing_page Type: String Target: data/LandingPage Target attr: name Format: uri
	Self Service Links														Provide useful links to Self Service end users																				Field Name: role.selfservice_links Type: String Target: data/SelfServiceLinks Target attr: name Format: uri
	Self Service Feature Display Policy																																		Field Name: role.ss_display_policy Type: String Target: data/SelfServiceFeatureDisplayPolicy Target attr: name Format: uri
		Custom Interfaces													The list of interfaces that are associated with the role.																				Field Name: interfaces.[n] Type: Array
			Interface Type *												The selected interface type that is associated with the role.																				Field Name: role.interfaces.[n].interface_type Type: String Target: data/InterfaceType Target attr: name Format: uri
			Name *												The selected interface that is associated with the role.																				Field Name: role.interfaces.[n].name Type: String Format: uri
	Rules																																		Field Name: rules Type: Object
			Permitted Hierarchy Types												Hierarchy Types that this Role can be added under.																				Field Name: hierarchy_types.[n] Type: Array Cardinality: [1..n]