Users.xml file structure

Description

Ingeniux users and user groups are maintained in the users.xml file located in the \xml directory.  The Ingeniux CMS uses this file to persist the list of users and user groups.  This article describes the structure of this file and describes how to manually edit this file.

Purpose

To troubleshoot user and/or user group errors or to create, efficiently,  a large number of users and user groups, manually editing the user.xml may be necessary.  In order to do so, it is important to understand the structure of this file to ensure any edits to this file do not break the Ingeniux Application.

Please note that all of these functions can be performed within the Administrator's Client User Interface.

The users.xml containing three sections:

A) User Manager Settings which specifies the next Group ID, the default domain, the default SMTP domain, and default Workflow notification value.

<UserManager nextID="" NTDomain="domain" SMTPDomain="mail,com" SendWorkFlowNotificationMail="False">

B) User Section which contains an entry for each user in the Ingeniux Application and specifies the user Name (display name), User ID, Email Address, and a Workflow notification value.  User Name and User ID are required values.

<Users>
<User UserID="domain\user" Name="user" Email=user@mydomain.com"
ReceiveWorkFlowNotificationMail="False"/>
</Users>  

C) Group Section which specifies a Group ID, a group Name, the user who are members of this group, and the permissions associated with this group.

<Group Name="Group" ID="1">
<Users>
<User UserID="domain\user"/>
</Users>
<UserRights>
<UserRight Name=""/>
</UserRights>
</Group>

Requirements

Full file level access to the users.xml file located in <sitedirectory>\xml directory on the Design Time Server

Access to an HTML or XML editor

Step-by-Step

A. Backing up the users.xml:

Before modifying the users.xml, Ingeniux recommends backing up the original users.xml.  To so, follow these steps:

1. Navigate in the File system to the <sitedirectory>\XML, locate the users.xml, right click the file, left click Rename, and change the name to users.old

B. To add Groups manually to the users.xml, use the following steps:

1. Determine the next available Group ID by searching on the following Tag:

<UserManager nextID="" NTDomain="domain" SMTPDomain="mail,com" SendWorkFlowNotificationMail="False">

Record the value for nextID.

2. Create the following tag structure within the <Groups></Groups> Tag:

<Group Name="GroupName" ID="">
<Users>
</Users>
<UserRights>
</UserRights>
</Group>

where Name= the display name for the group to be created and ID equals the value of the nextID recorded in step 1.

3. Add permissions to the group by adding one or more of following tags within the <UserRights></UserRights> tag:

<UserRight Name="Create"/>
<UserRight Name="PageTypes"/>
<UserRight Name="ForcePCR"/>
<UserRight Name="CheckinCheckOut"/>
<UserRight Name="Main"/>
<UserRight Name="Tree"/>
<UserRight Name="Transition"/>
<UserRight Name="Workflow"/>
<UserRight Name="Assignment"/>
<UserRight Name="Rollback"/>
<UserRight Name="Publish"/>
<UserRight Name="IncrementalPublish"/>
<UserRight Name="Mark"/>
<UserRight Name="Delete"/>
<UserRight Name="CheckIn"/>
<UserRight Name="Edit"/>
<UserRight Name="Admin"/>
<UserRight Name="Assignment"/>
<UserRight Name="Reorder"/>

4. Increment the nextID attribute value by 1 in the following tag:

Determine the next available Group ID by searching on the following Tag:

<UserManager nextID="" NTDomain="domain" SMTPDomain="mail,com" SendWorkFlowNotificationMail="False">

5. Save the changes to the users.xml.

6. Go to Start, Run, and type in the following command:

IISReset

and click Okay.

C. To add users manually to the users.xml, two entries must be created for each user:

1) a new user needs to be added to the user list within the <Users>* Tag using the following syntax:

<User UserID="domain\user" Name="user" Email=user@mydomain.com"
ReceiveWorkFlowNotificationMail="False">

where UserID is matches the user's account, Name is the label displayed in the User Manager for the user, Email specifies the user's email address, and ReceiveWorkFlowNotificationMail indicates whether the user receives Workflow notification using a True or False value.

* Note, there are two <Users> tags.  The <Users> tag referred in this step is the first <Users> tag in the users.xml.

2) The newly created user needs to be added to a group.  For each group, a group tag exists defining the group name and ID ( <Group Name="Administrators" ID="1">).  Search the file for the group name to locate where the user entry needs to be added.  Add the user using the following syntax to the <Users> tag within the <Group> tag (see Reason Section above for the tag structure):

<User UserID="domain\user"/>

3. Save the changes to the users.xml.

4. Go to Start, Run, and type in the following command:

Iisreset

and click Okay.