Documentation Center

Changes to the class UserGroup 2.5

The new UserGroup class should be used for user group provisioning and retrieving information about user groups

Definition

The UserGroups, previously known as Departments, are roles grouping access permissions to allow read/write access on an object.

Usage

The user group is used for specifying read/write security and is specified on 2 levels:
  • On each user is specified to which user groups he/she has access.

  • The type of access is configured on the folder by specifying which user groups have read access and which user groups have write access.

    If no user group is specified, everybody has read and write access.

Changes in database structure

Moving the user group Translation Configuration to the general Translation Configuration XML

Before SDL Trisoft 9.2.0, you had to configure a Translation configuration XML for each user group which specified the fields that had to be copied from the source language to the target language.

Starting from SDL Trisoft 9.2.0, this extra Translation Configuration was moved from the user group to the general Translation Configuration XML. If the user group is not specified, the default configuration is used.

<infoshareTranslationConfig version="2.0">
  <parameters>
    ...
  </parameters>
  <translationobject>
    <copyfromsource>      
      <ishfields ishcondition="ISHType in ('ISHMasterDoc', 'ISHModule', 'ISHLibrary') and ISHUserGroup='VUSERGROUPSYSTEMMANAGEMENT'">
        <!-- Copy system fields -->
        ...
        <!-- Copy mandatory fields -->
        <ishfield name="FAUTHOR" level="lng"/>
        <ishfield name="FREVIEWER" level="lng"/>
        <ishfield name="FTRANSLATOR" level="lng">Translator</ISHField>
      </ishfields>
      <ishfields ishcondition="ISHType in ('ISHIllustration', 'ISHTemplate') and ISHUserGroup='VUSERGROUPSYSTEMMANAGEMENT'">
        <ishfield name="FAUTHOR" level="lng"/>
        <ishfield name="FREVIEWER" level="lng"/>
        <ishfield name="FTRANSLATOR" level="lng">Translator</ISHField>
      </ishfields>
      <ishfields ishcondition="ISHType in ('ISHMasterDoc', 'ISHModule', 'ISHLibrary')">
        <!-- Copy system fields -->
        ...
        <!-- Copy mandatory fields -->
        <ishfield name="FAUTHOR" level="lng"/>
        <ishfield name="FREVIEWER" level="lng"/>                
        <ishfield name="FTRANSLATOR" level="lng"/>
      </ishfields>
      <ishfields ishcondition="ISHType in ('ISHIllustration', 'ISHTemplate')">
        <ishfield name="FAUTHOR" level="lng"/>
        <ishfield name="FREVIEWER" level="lng"/>
        <ishfield name="FTRANSLATOR" level="lng"/>
      </ishfields>
    </copyfromsource>
  </translationobject>
  <languagepaths>
    <languagepath from="fr" to="es"/>
    <languagepath from="fr" to="it"/>
    <languagepath from="es" to="pt"/>
    <languagepath from="nl" to="de"/>
    <languagepath from="nl" to="fr"/>
    ...
  </languagepaths>
</infoshareTranslationConfig>
Changes in naming

Content Manager had various legacy terminology. Starting with the Web Services 2.5, terminology was made consistent. In order to do this, the element names of some UserGroup related objects are changed and some objects were removed.

The following table provides an overview of those changes:
Object typeOld element nameNew element nameDescription
CardTypeDEPARTMENTCTUSERGROUPThe card type of the user group objects
LOVDEPARTMENT

The DEPARTMENT LOV contains the names of the user groups.

LOVROLESDUSERGROUPThe LOV contains the names of the user groups
FieldDEPARTMENT

This field linked the user group with its name in the DEPARTMENT LOV.

FieldFISHUSERGROUPNAMEThis new field links the user group with its name in the DUSERGROUP LOV.
PrefixVDEPARTMENT...VUSERGROUP...The values in the DUSERGROUP LOV will start with the prefix VUSERGROUP
FieldFISHOBJECTACTIVEThis new field can be used to disable/enable the user group

Changes in methods

Starting from Web Services 2.5 you must use the new UserGroup class for user group provisioning and retrieving information about user groups. The API methods work similar to the API calls of Output Format and Baseline:
  • The user groups are uniquely identified using an element name which starts with the prefix VUSERGROUP
  • The standard Metadata XML structure (with level none) can be used for retrieving or setting fields
  • The retrieve methods return an ishobject list xml with objects of type ISHUserGroup
    <ishobjects>
      <ishobject ishref="VUSERGROUPDEFAULTDEPARTMENT" ishtype="ISHUserGroup" ishuserref="30">
        <ishfields>
          <ishfield name="FISHUSERGROUPNAME" level="none">Default Department</ishfield>
          <ishfield name="CREATED-ON" level="none">07/05/2001 13:36:13</ishfield>  
          <ishfield name="MODIFIED-ON" level="none">20/04/2011 09:24:03</ishfield>  
          <ishfield name="FDESCRIPTION" level="none"></ishfield>
          <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
        </ishfields>
      </ishobject>
      <ishobject ishref="VUSERGROUPSYSTEMMANAGEMENT" ishtype="ISHUserGroup" ishuserref="5970">
        <ishfields>
          <ishfield name="FISHUSERGROUPNAME" level="none">System management</ishfield>
          <ishfield name="CREATED-ON" level="none">30/07/2004 12:11:41</ishfield>  
          <ishfield name="MODIFIED-ON" level="none">22/04/2011 16:12:39</ishfield>  
          <ishfield name="FDESCRIPTION" level="none"></ishfield>
          <ishfield name="FISHOBJECTACTIVE" level="none" ishvaluetype="element">TRUE</ishfield>
        </ishfields>
      </ishobject>
    </ishobjects>