Administrative Area Components

• User
• Group
• Containered Asset
• Asset Factory
• Asset Factory Container
• Page Configuration Set
• Page Configuration Set Container
• Structured Data Definition
• Asset Factory Container
• Metadata Set
• Metadata Set Container
• Publish Set
• Publish Set Container
• Target
• Destination
• File System Transport
• FTP Transport
• Workflow Definition
• Workflow Definition Container

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Group

A Group is defined in the following WSDL:

<complexType name="group"> <sequence> <!-- The name of the group REQUIRED --> <element maxOccurs="1" minOccurs="1" name="groupName" type="xsd:string"/> <!-- Define the group starting page relationship here For all users for which this group is that user's default group, This starting page will override the global starting page set in the system preferences NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="groupStartingPageId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="groupStartingPagePath" type="xsd:string"/> </choice> <!-- Define the group base folder relationship here For all users for which this group is that user's default group, This base folder will be where assets are suggested to be created to the user when using an asset factory that does not have a placement folder or a base asset, or when the user has already manually selected a folder on the left hand side. NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="groupBaseFolderId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="groupBaseFolderPath" type="xsd:string"/> </choice> <!-- Define the group asset factory container relationship here For all users for which this group is that user's default group, This asset factory container will determine which asset factories show on that user's dashboard under the "My New Content Wizards" section. NOT REQUIRED default: none --> <choice> <element maxOccurs="1" minOccurs="0" name="groupAssetFactoryContainerId" type="xsd:string"/> <element maxOccurs="1" minOccurs="0" name="groupAssetFactoryContainerPath" type="xsd:string"/> </choice> <!-- For all users for which this group is that user's default group, these will be the CSS classes that are shown in the WYSIWYG dropdown unless there are styles designated at the target level for that page NOT REQUIRED default: none --> <element maxOccurs="1" minOccurs="0" name="cssClasses" type="xsd:string"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowFontAssignment" type="xsd:boolean"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowFontFormatting" type="xsd:boolean"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowTextFormatting" type="xsd:boolean"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowViewSource" type="xsd:boolean"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowImageInsertion" type="xsd:boolean"/> <!-- For all users for which this group is that user's default group, this will determine if that user has the font assignment options available on the WYSIWYG toolbar NOT REQUIRED default: false --> <element maxOccurs="1" minOccurs="0" name="wysiwygAllowTableInsertion" type="xsd:boolean"/> <!-- Semi-colon delimited list of all of the member users of this group --> <element maxOccurs="1" minOccurs="0" name="users" type="xsd:string"/> <!-- The highest role for this group. Note that this role will also apply to all the members, possibly promoting those users --> <element maxOccurs="1" minOccurs="1" name="role" type="impl:roles"/> </sequence> </complexType>

The WSDL for the group complex type contains all the fields one is used to seeing in the web interface when creating or editing a group. The required fields are as follows: group name and role.

Some things to note: when specifying the groups's users, list the users as a semi-colon delimited list, i.e. "user1;user2;user3". When specifying the group's role, one only need specify the highest role for that group due to the fact that roles are cumulative. The roles are defined by the following simple type restriction in the WSDL:

<simpleType name="roles"> <restriction base="xsd:string"> <enumeration value="administrator"/> <enumeration value="manager"/> <enumeration value="publisher"/> <enumeration value="approver"/> <enumeration value="contributor"/> </restriction> </simpleType>

Also, note that users in this group will inherit that role if it is higher than the explicitly defined role for that user.

Comments

Wiki | Edit