Elements and Sections in the Role Associations for Analytics XML Output File

The following table describes the elements and sections in the role associations for analytics folders XML output file.

Table Elements and Sections in the Role Associations for Analytics Folders XML File

Description Element or Section

The <ReportFolder> section contains all of the information for a single folder and its subfolders.

<data:ReportFolder>
. . .
</data:ReportFolder>

<Catalog> contains the catalog version for the folder. The valid value is V3.

Note: When you insert or update the role associations for a folder, you must either set the <Catalog> element to V3 or leave it empty. If you leave the element empty, then V3 is used by default.
<data:ReportFolder>
  <data:Catalog>V3</data:Catalog>
. . .
</data:ReportFolder>

<Path> contains the path for the folder.

<data:ReportFolder>
 . .
  <data:Path>/shared/Company Analyses/
   Test Folder</data:Path>
. . .
</data:ReportFolder>

<FolderName> contains the name of the folder.

<data:ReportFolder>
. . .
  <data:FolderName>Test Folder
  </data:FolderName>
. . .
</data:ReportFolder>

<Description> contains the description of the folder, if a description exists.

<data:ReportFolder>
. . .
  <data:Description>This is my test 
   folder</data:Description>
. . .
</data:ReportFolder>

<ParentFolder> contains the name of the parent folder. If the folder is created directly in the company wide shared folder, then the name of the parent folder is Company Analyses.

<data:ReportFolder>
. . .
  <data:ParentFolder>Company Analyses
  </data:ParentFolder>
. . .
</data:ReportFolder>

The <ListOfSubFolders> section contains details of the subfolders under the current folder, if any exist.

<data:ReportFolder>
. . .
  <data:ListOfSubFolders>
. . .
  </data:ListOfSubFolders>
. . .
</data:ReportFolder>

The <SubFolder> section contains details of one subfolder. It includes the following elements:

  • <Catalog> contains the catalog version for the subfolder.

  • <Path> contains the path to the subfolder.

  • <FolderName> contains the name of the subfolder.

  • <Description> contains a description of the subfolder.

<data:ReportFolder>
. . .
  <data:ListOfSubFolders>
    <data:SubFolder>
      <data:Catalog>V3</data:Catalog>
      <data:Path>/shared/Company Analyses/
      Test Folder/Test Folder A</data:Path>
      <data:FolderName>Test Folder A
      </data:FolderName>
      <data:Description/>
    </data:SubFolder>
. . .
  </data:ListOfSubFolders>
. . .
</data:ReportFolder>

The <ListOfAssociatedRoles> section contains details of the role associations for the folder.

<data:ReportFolder>
. . .
  <data:ListOfAssociatedRoles>
. . .
  </data:ListOfAssociatedRoles>
</data:ReportFolder>

The <AssociatedRole> section contains details of a single role association, including the following:

  • <RoleName> is the name of the role.

  • <AccessLevel> is the level of access that is given to this role for this folder.

<data:ReportFolder>
. . .
  <data:ListOfAssociatedRoles>
    <data:AssociatedRole>
      <data:RoleName>User Role2
      </data:RoleName>
      <data:AccessLevel>Change/Delete
      </data:AccessLevel>
    </data:AssociatedRole>
. . .
  </data:ListOfAssociatedRoles>
</data:ReportFolder>