Understanding users.xml

The users.xml file is used for configuring who has access to IXIASOFT CCMS along with the roles they have and groups they belong to.

users.xml keeps track of who has access to the CCMS, and what they can do on the system. It contains information about the name and location of the individual who has access to the system, in addition to login credentials, along with any roles or groups they are assigned to. It also determines who has access IXIASOFT CCMS Web for Contributors and Reviewers, and to IXIASOFT CCMS Web for Writers.

A typical entry looks like the following:


			<user active="true">
				<reference/>
				<name>
					<prefix/>
					<first>Walter</first>
					<middle/>
					<last>Write</last>
				</name>
				<location>Yoyodyne</location>
				<identifier>
					<domain>yoyodyne.local</domain>
					<login>wwrite</login>
				</identifier>
				<email>
					<type>text</type>
					<address>wwrite@yoyodyne.com</address>
				</email>
				<roles>
					<role name="Writer"/>
				</roles>
				<groups>
					<group name="Everyone"/>
					<group name="Advanced"/>
				</groups>
			</user>
		

An explanation of the elements being used in this code snippet:

  • user: contains all information for a single user. The attribute active="true" must be used to point out a current user of the system.
  • reference: Additional information about this account. Such as indicating that it is a demo account.
  • name: contains information about the name of the user
    • prefix: a title for the user, such as "Dr.", "Ms.", "Mrs.", "Mr." etc.
    • first: the first name of the user.
    • middle: the middle name of the user.
    • last: the last name of the user.
  • location: describes the geographic location of the user, or the name of the company division.
  • identifier: information on how the user is identified within the system.
    • domain: the name for the domain that CCMS is hosted on.
    • login: the login credentials assigned to the user.
  • email: information on the format and address of the user
    • type: describes the format that the email address uses.
    • address: the email address of the user.
  • roles: contains entries corresponding to the roles this user has within CCMS.
  • groups: contains entries corresponding to the groups this user is a member of within CCMS. This includes whether the user has access to CCMS Web Advanced or not.

The administrator can make changes to users.xml, which are checked for validity automatically when saved.