Configure roles by direct edit
In addition to configuring roles through the Role Manager, you can also configure roles by editing the roles.xml file directly.
Note: MadCap Software recommends that
you avoid directly editing the roles.xml file
whenever possible. The Role Manager window
has built-in validation mechanisms to reduce errors.
To configure roles by direct edit:
-
Open the TEXTML Administration perspective by clicking the
TEXTML Administration shortcut on the
tool bar. If the shortcut is not displayed, follow these steps:
- Select Window > Perspective > Open Perspective > Other
- Click TEXTML Administration.
- Click Open.
- In the TEXTML Administration view, double-click the server.
-
If your server is not displayed in the view, add it by doing
the following:
-
To find the server name, click Window > Preferences and select IXIA CCMS.
In the TEXTML Server Connection section, the server name is the Hostname.
- Copy the Hostname and close the Preferences window.
- In the TEXTML Administration view, right-click and select Add Server.
-
In the Server field, enter the
server name.
The Port field should fill automatically. If you need the port number, you can find it in the same place as the server name in the Preferences window.
- Click OK.
-
To find the server name, click Window > Preferences and select IXIA CCMS.
- When the Connect as dialog opens, type your username and password and click OK.
- Double-click the name of your Content Store to open a connection to it.
- Expand the Content Store's Repository node and browse to /system/conf to locate the roles.xml file.
- Right-click roles.xml and select Check Out.
- Open the file in an XML editor.
-
Take the following actions to create a role:
- Enter a name.
-
Enter a
maxassignee
value to define the maximum number of persons in that role that can be simultaneously assigned to a document.For example, if your team includes four technical writers, you might enter a Max Assigned value of 2 for the Author role, to indicate that only two writers can be simultaneously assigned to any particular document.Note: Assigned documents appear on users' respective Todo Lists. When a writer creates a document object, that document is automatically assigned to him or her. Additional individuals (in any role) can be assigned to document objects through the Assignments dialog box or by right-clicking a document and selecting Assign to. -
Enter a topworkload value. It
defines the amount of active items allocated to one person.
This value does not prevent a user's assignments from exceeding this number. It is only used within projects to track workload allocation.
-
Associate a document type with the role.
Possible doctypes are:
- Topic to associate this role with topics
- Map to associate this role with maps
- Image to associate this role with image creation or editing
- Resource to associate this role with resources
- Project to associate this role with documentation projects
For example:<doctype name="Map">
-
Configure the time line and status for the role and document
types:
-
Enter a time line value:
Incoming
,Active
, orRetained
. - Enter one or more cycles and one or more status for the time line.
<doctype name="Map"> <timeline value="Incoming"> <status value="Authoring:done"/> </timeline> <timeline value="Active"> <status value="Published"></status> </timeline> </doctype>
-
Enter a time line value:
- Repeat to associate additional document types with the role and to configure time line and status.
- Repeat to create additional roles.
- When done, save, close, and check in the roles.xml file.
-
Inform users of the changes.
The changes will be applied automatically once users close and then reopen their CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIA CCMS > Synchronize Configuration. Additionally, refresh IXIA CCMS Web so that users will see the change reflected there.