Tech News

Settings.xml and Approvals Configurations

Home

The article below is intended to give an insight into what is going on 'under the hood'. A new interface is under development to allow easier editing of these configuration settings; a prototype will be demoed at the Customer Focus day on 11th July.

In Triaster Server 2011, nearly all configurations have been consolidated in a single file:

Triaster\Triaster2011\Settings\Settings.xml

There are configurations that are scoped to the server, to a library and to sites.

Originally, approval configurations applied to all libraries. However, from Triaster Server 13.1, approvals can be scoped to a library. Of course, such configurations can be made through the Approvals page of a Process Library website. However, it may sometimes be easier to edit Settings.xml directly, particularly when settings are copied from one area to another.

IMPORTANT: Whenever Settings.xml is edited, a backup copy should be taken first. The integrity of this file is important, as so much depends on it.

Approvals

Approvals can be configured to be scoped globally or to a library. This would be commonly done using the publication configuration utility, but is accessible directly in Settings.xml. In Settings.xml:

<Settings>
.
<ServerGeneral>
.
<GlobalApprovers>false</GlobalApprovers>

Approvers (but see below), authors and functions that are defined globally aren't visible through a library site's Approvals page.

Approvers

Approvers are defined globally, and are then conferred permissions at a library level.

Global approvers

In Settings.xml:

<Settings>
.
<ApprovalCategories>
</ApprovalCategories>
<Users>
<User>
<Username>Installation Only</Username>
<EmailAddress>E-mail Address</EmailAddress>
<Password>Encrypted password</Password>
<AdminUser>True</AdminUser>
<ApprovalUser>True</ApprovalUser>
<SuperUser>True</SuperUser>
</User>
<User>
<Username>User Name</Username>
<EmailAddress>E-mail Address</EmailAddress>
<Password>Encrypted password</Password>
</User>

Library approvers

In Settings.xml:

<Settings>
.
<PublicationSettings>
.
<Library Name="Library Name">
.
<Site Name="Site Name">
.
<UserPermissions>
<Permissions EmailAddress="E-mail Address">
<UserAdmin Permissions="True|False">
<Publish Permissions="True|False">
<Approve Permissions="True|False">
<SuperUser Permissions="True|False">
</Approve>
</Permissions>

When a new approvals user is added through the Approvals webpage, a new global User record is created, and UserPermissions records for the library sites.

Authors

A map's author is defined in the Author property of a Node (Prop.Author). Any such author should have a corresponding record on the server, with an associated e-mail address to which alerts can be sent.

Global authors

In Settings.xml:

<Settings>
.
</PublicationSettings>
<Authors>
<Author>
<Username>Author Name</Username>
<EmailAddress>E-mail address</EmailAddress>
</Author>

Library authors

In Settings.xml:

<Settings>
.
<PublicationSettings>
.
<Library name="Library Name">
.
<Authors>
<Author>
<Username>Author Name</Username>
<EmailAddress>E-mail address</EmailAddress>
</Author>
</Authors>
<ApprovalCategories>
</ApprovalCategories>
</Library>

A global author record (everything within and including the tags) can be copied to a library section in Settings.xml.

Functions

A map can be related to a business function (a Node's Business Function property - Prop.Function). A Function record on the server would typically be associated with a distribution group's e-mail address so that members of that group can be alerted to a change in a published map.

Global functions

In Settings.xml:

<Settings>
.
.
<ApprovalCategories>
<ApprovalCategory>
<Name>Function Name</Name>
<EmailList>E-mail address</EmailList>
</ApprovalCategory>

Library functions:

In Settings.xml:

<Settings>
.
<PublicationSettings>
.
<Library name="Library Name">
.
<ApprovalCategories>
<ApprovalCategory>
<Name>Function Name</Name>
<EmailList>E-mail address</EmailList>
</ApprovalCategory>
</ApprovalCategories>
</Library>

Just as for authors, the global records can be copied to a library section. A function record is that within and including the <ApprovalCategory></ApprovalCategory> tags.

So in summary, direct editing of Settings.xml can be quicker and easier than the website or server configuration utility interfaces. If you choose to do this:

  • Be aware of the importance of this file, and always take back-up copies that can be restored.
  • Note the scope of the configurations to be made.
  • Maintain indenting so that the logical structure of these configurations is evident.

Register to receive product release notifications

SIGN UP FOR CONNECTOR

Sign up for Connector
Industry best practice and knowledge in our ‘best of breed’ newsletter.
Published bi-annually.

Signup here