Documentation Center

Changes to the class UserRole 2.5

The new UserRole class should be used for user role provisioning and retrieving information about user roles (e.g. Administrator, Reviewer, Author,...)

Definition

The UserRoles are roles grouping permissions to allow action/workflow .

Usage

The user role can be used during configuration to limit certain actions to users owning a certain user role.
  • On each status transition you can specify that this status transition is only allowed for users with a specific user role
  • In Organize Space, the Settings tab can only be accessed by administrators.
However, the user role Administrator is also used inside the Content Manager code to ensure that:
  • the administrative actions located in the Settings tab can only be executed by an administrator
  • the actions which can break data consistence (e.g. overwriting the blob of a released topic) can only be executed by an administrator

Changes in behavior

The largest change concerning the user role, is that starting from Web Services 2.5 the UserRole is "upgraded" from values in the DCAPABILITIES LOV to a separate, independent object of type ISHUserRole with its own API.

The user roles can be disabled/enabled by toggling the field FISHOBJECTACTIVE.

Changes in methods

Starting from Web Services 2.5 you must use the new UserRole class for user role provisioning and retrieving information about user roles. The API methods work similar to the API calls of Output Format and Baseline:
  • The user roles are uniquely identified using an element name which starts with the prefix VUSERROLE
  • The standard Metadata XML structure (with level none) can be used for retrieving or setting fields
  • The retrieve methods will return an ishobject list xml with objects of type ISHUserRole
    <ishobjects>
      <ishobject ishref="VUSERROLEADMINISTRATOR" ishtype="ISHUserRole" ishuserroleref="359933">
        <ishfields>
          <ishfield name="FISHUSERROLENAME" level="none">Administrator</ishfield>
          <ishfield name="CREATED-ON" level="none">20/04/2011 09:24:02</ishfield>
          <ishfield name="MODIFIED-ON" level="none"></ishfield>
          <ishfield name="FDESCRIPTION" level="none"></ishfield>
          <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
        </ishfields>
      </ishobject>
      <ishobject ishref="VUSERROLEAUTHOR" ishtype="ISHUserRole" ishuserroleref="359934">
        <ishfields>
          <ishfield name="FISHUSERROLENAME" level="none">Author</ishfield>
          <ishfield name="CREATED-ON" level="none">20/04/2011 09:24:02</ishfield>
          <ishfield name="MODIFIED-ON" level="none"></ishfield>
          <ishfield name="FDESCRIPTION" level="none"></ishfield>
          <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
        </ishfields>
      </ishobject >
    </ishobjects>

Changes in naming

In order to make the naming consistent, the element names of some UserRole related objects are changed:
Old element nameNew element nameDescription
FISHCAPABILITIESFISHUSERROLESThe field on the user containing the user roles
DCAPABILITIESDUSERROLEThe LOV contains the names of the user roles and is linked with the field FISHUSERROLES
VCAPABILITY...

VROLE...

VUSERROLE...The values in the DUSERROLE LOV will start with the prefix VUSERROLE