# Administrator Guide

# Administering Collaboration

This chapter provides information on the tasks required to administer and maintain Collaboration. It includes the following sections:

- Default Administrator Groups
- Working with the Collaboration Administration Utility
- Configuring Collaboration for Importing Files into the Knowledge Directory
- Setting Up Collaboration Logging
- Backing Up and Restoring Collaboration
- Configuring the Notification Service for Working with Experience Definitions

For details on assigning moderators to folders and discussions, see Assigning Moderators.

For details on clustering Collaboration, see AquaLogic User Interaction Networking and Authentication Guide.

## Default Administrator Groups

When Collaboration is installed, two default Collaboration administrator groups are created in the portal as follows:

- Collaboration Project Administrators: By default, this group contains the portal Administrators group and has the following activity right:

- Manage Collaboration Projects

- Collaboration Administrators: Initially, this group does not have any members. An authorized portal administrator must add the first user and/or group to this new group. By default, this group is installed with the following activity rights:

- Access Administration
- Access Utilities
- Manage Collaboration
- Manage Collaboration Projects

Collaboration Project Administrators can create and manage projects and project templates.

Collaboration Administrators can configure global settings that apply to all Collaboration projects by using the Collaboration Administration Utility. They can also manage the Collaboration project folder hierarchy.

For more information on the activity rights granted to the default administrator groups, see Activity Rights.

## Working with the Collaboration Administration Utility

The Collaboration Administration Utility controls global settings that affect the functionality of Collaboration across all Collaboration projects.

This section outlines the tasks that can be performed using the Collaboration Administration Utility. It includes the following topics:

- Accessing the Collaboration Administration Utility
- Performing Diagnostic Tests
- Configuring Miscellaneous Settings
- Creating, Editing and Deleting Holidays
- Setting Up Collaboration for Publishing
- Configuring Groupware Servers
- Changing Collaboration Notification Settings
- Working with the Search Service
- Granting Portal Access to Collaboration

### Accessing the Collaboration Administration Utility

Collaboration Administrators can access the Collaboration Administration Utility via the portal from the Select Utility drop-down list.

To access the Collaboration Administration utility:

1. Log in to the portal.
2. Click the Administration tab.
3. In the Select Utility drop-down list, click Collaboration Administration Utility.

### Performing Diagnostic Tests

The Diagnostics page provides diagnostic and configuration information about the various components of Collaboration. If there is a failure with one of the components, the Diagnostics page displays the failure, related settings, and a possible resolution. We recommend that you check diagnostics:

- After you have installed Collaboration
- After the system has failed. For example, you can check the Diagnostics page to confirm that the Notification Service is down if users have stopped receiving notification messages for subscriptions

Each test returns one of these messages to the Status column:

- OK: The installation or startup was successful, or the component is functioning correctly
- FAIL: The installation or startup was not successful, or the component is not functioning correctly.

The message provides a reason for failure and might provide troubleshooting recommendations.

- NOT ENABLED: The component is not enabled. This is not necessarily an error if the component is not being used

This table describes the diagnostics that are provided for Collaboration's components:

Table 3-1 Collaboration Diagnostics
Test | Description
--- | ---
Collaboration Startup and DB | Verifies that Collaboration started up successfully.
Collaboration Notification Service | Verifies that the Notification Service is enabled and running.
Document Repository Service | Verifies that the Document Repository Service is running.
Search Service | Verifies that the Search Service is running.
Groupware Exchange SOAP Service | Verifies that the Groupware Exchange SOAP service is running.
Note: | For this test to run, you must enable Groupware Exchange SOAP Service and configure Microsoft Exchange as the back-end server. If Groupware Exchange SOAP Service is not enabled, a Not Enabled message appears.
JSControls (version_number) Configuration and JavaScript Files from the Image Service | Verifies that you have correctly installed the JSControls component. In the application, the version number of JSControls appears instead of version_number.
Portal Connection through PTAPI | Verifies that the API Service is running.
ALIP Integration | Verifies that the AquaLogic BPM server is up.
Note: | For this test to run, you must enable configuration with AquaLogic BPM.

If the portal is down, you can access the Diagnostics page by typing the following URL in a browser's address bar: http://<server_name>:<port_number>/collab/admin/diagnostic/index.jsp. For example: http://brettg-gx:8080/collab/admin/diagnostic/index.jsp.

Note: | When you access the Diagnostics page by typing the URL, the JS Controls and Portal Connection tests are not visible.

You can also perform diagnostic tests on the groupware servers that are integrated with Collaboration. For information on testing groupware servers, see Testing Groupware Servers

### Configuring Miscellaneous Settings

The following sections describe configuration options on the Miscellaneous Settings page.

#### Enforcing the Maximum Size of Projects

If you want to limit the size of projects, select Enforce a Maximum Project Size, then type the size limit in megabytes. Set the storage space according to the anticipated number and size of documents or files and their revisions.

By default, Collaboration does not limit the size of projects. If a project size limit was previously set and you want to go back to the original setting of unlimited project sizes, clear the check box.

The size limit is for individual projects, not the entire collection of projects in Collaboration. This setting affects every project in Collaboration. A Project Leader can define the maximum size for a specific project in that project's General Settings page; the size defined on that page cannot exceed the value that you type into the box next to the Enforce a Maximum Project Size check box.

Note: | Collaboration includes objects in the Project Recycle Bin in its calculation of a project’s memory usage.

#### Enabling Personal Projects

The personal projects feature lets users create and maintain their own personal project. A personal project contains documents, task lists, notes, and calendar features. To enable this feature, select Enable Personal Projects. To restrict the size of each personal project, type the size in megabytes.

By default, Collaboration does not limit the size of personal projects. If a project size limit was previously set and you want to go back to the original setting of unlimited project sizes, clear the check box.

#### Enabling Add to My Page

If you want your users to be able to add projects to their My Page, select the Enable Add To My Page check box. By default, this check box is selected.

#### Enabling Portal Group Notifications

If you want your users to be able to select individual users within portal groups or entire portal groups at once to receive notifications, select the Enable portal group notifications check box. By default, this check box is cleared.

#### Hiding Unused Project Folders

If you want to hide project folders that contain only projects that users cannot access, select Hide project folders that contain only projects a user cannot access. By default, this check box is cleared.

Enabling this option might cause the Project Explorer to perform more slowly due to the added security checks.

#### Enabling WebDAV

If you want your users to use Collaboration's desktop integration features, select Enable WebDAV. To be able to select and clear this check box, you must set the fullWebDAVAccessToThisServer node in the config.xml file to yes. Config.xml also includes other nodes that you must set for WebDAV. Changes that you make to this option are never carried over to config.xml.

#### Enabling WebEdit

WebEdit simplifies the process of editing a document in Collaboration. Using this feature a user can edit a Microsoft Office document “in-place,” without having to perform check-ins, check-outs, uploads, and downloads.

If you want your users to edit Microsoft Office documents on their desktop, select Enable WebEdit. To be able to select and clear this check box, you must set the webEdit enabled node in the config.xml file to yes. Config.xml also includes other nodes that you must set for WebEdit. Changes that you make to this option are never carried over to config.xml.

To use WebEdit, an end user’s browser must not be configured to disable Microsoft ActiveX controls. Users can still employ the features of WebEdit without having the Collaboration Office Tools Add-In installed on their machines.

#### Enabling Bulk Upload

The Bulk Upload feature allows users to upload multiple documents or to copy a directory hierarchy from a local machine to Collaboration. To enable this feature:

1. If you did not choose to enable the Bulk Upload feature during installation, you must edit config.xml and set the bulkUpload.enabled element to yes.

Alternatively, you may enable Bulk Upload by using the Collaboration Administration utility.

1. Click the Administration tab.
2. Select the Collaboration Administration utility.
3. Click Miscellaneous Settings.
4. Click Enable bulk upload.

2. Grant the corresponding activity rights by performing the following:

1. Click the Administration tab.
2. Select the Activity Manager utility.
3. Click Enable bulk upload.
4. Click Add Group.
5. Select the groups you want to add.
6. Click OK.
7. Click Finish.

##### Client Requirements for Using Bulk Upload

This section describes the client settings required to use the Bulk Upload feature. After Bulk Upload has been enabled, the following software must be installed on the client machine:

- Java Runtime Environment (JRE), version 1.4.2 or greater
- Java Plug-in, version 1.4 or greater
- The Bulk Upload Applet

When a user attempts to use the Bulk Upload feature, the browser verifies if the Java Runtime Environment and the Java Plug-in are installed. If they are not, the user will be prompted to download and install them.

If they are installed, the Java Plug-in attempts to load the Bulk Upload applet. If the applet is not found, it is downloaded from the Image Service. The user is then prompted to trust the applet. Users should answer “Always” when prompted to trust the applet.

#### Enabling Zip Download

If you want your users to be able to download folders and multiple documents as .zip files, select Enable zip download. Type the size limit for the .zip file in the box. The download aborts if the .zip file exceeds the size limit.

#### Setting the Number of Document Versions

If you want to limit the number of document versions that Collaboration manages, select the Enable system-wide control of document versions check box and type a number from 3 to 999 into the Maximum number of versions allowed box. Collaboration keeps the most recent specified number of versions and permanently removes the extra versions.

For example: Collaboration has 25 versions of a document. You specify 10 as the maximum number of versions allowed. Collaboration removes versions 1-15 of the document, keeping versions 16-25 (which are the 10 most recent versions). A user creates version 26 of the document. As a result, Collaboration removes version 16, keeping versions 17-26 (again, Collaboration keeps the 10 most recent versions). This process continues for as long as users create new versions of the document.

Note: | Collaboration removes versions on a nightly basis. For this reason, users can access all versions before Collaboration removes them. You cannot recover document versions after Collaboration has removed them.

In addition, Collaboration always keeps:

- The working version of the document. If the working version is older than the first version that you allow, Collaboration keeps the number of versions that you specify, plus the working version.
- The version of the document that has been published to the Knowledge Directory. If it is older than the first version that you allow, Collaboration keeps the number of versions that you specify, plus the published version.

Note: | This setting does not affect document versions that are in the Project Recycle Bin.

#### Restricting the Size of Single File Uploads

If you want the maximum size of an uploaded file to be anything other than the default, type a number from 1 to 999 into the Maximum single file upload in MB box. The default is 10 MB. Collaboration always uses the setting that you configure here except during upgrade, when it uses the maxUploadMegabytes node in config.xml. Changes that you make to this option are never carried over to config.xml.

#### Restricting the Size of Discussion Messages

If you want the maximum number of characters in a message to be anything other than the default, type a number from 1000 to 99999 into the Maximum number of characters in a discussion message box. The default is 16000. Collaboration always uses the setting that you configure here except during upgrade, when it uses the maxMessageChars node in config.xml. Changes that you make to this option are never carried over to config.xml.

### Creating, Editing and Deleting Holidays

The Holidays page lets you create, change the properties of and delete holidays from Collaboration’s calendar. You can create a maximum of one holiday per day. Holidays appear on and affect every project calendar in Collaboration. You cannot create, edit or delete holidays from the Calendar portlets or projects.

### Setting Up Collaboration for Publishing

You can set up Collaboration so that users can manually publish files into the Knowledge Directory (“KD”) by configuring the Collaboration Publishing Content Source. The Collaboration Publishing content source must be configured before any publishing activity can take place. This section discusses how to configure the Collaboration Publishing content source. For more information on setting up crawlers for automatic importing of files into the Knowledge Directory, see Configuring Collaboration for Importing Files into the Knowledge Directory

To configure a content source for publishing to the Knowledge Directory:

1. Go to the Collaboration Administration utility.
2. Click Publish to Directory.
3. Click Configure a Content Source.
4. In the Content Source dialog box, select Collaboration Publishing.

This data source is pre-configured when the Collaboration6.pte file is loaded into the portal.

5. Click OK.
6. Click Finish.

Note: | Once a document is published to the Knowledge Directory, access to the published version from the KD inherits the access settings of the parent KD folder. For example, if the Everyone group has Read access to the Knowledge Directory folder, the version of the Collaboration document published will be accessible from the KD by all users, including Guest Users.

### Configuring Groupware Servers

To configure a new groupware server:

1. Go to the Collaboration Administration utility.
2. Click Groupware Servers.
3. Click Add Server.
4. Enter the configuration information:

If you are configuring a Microsoft Exchange back-end server, enter the following configuration information:

Table 3-2 Microsoft Exchange Configuration Parameters
Parameter | Description
--- | ---
Server Name/IP/URL | The server name, IP address, or URL of the groupware server.
Note: | If you are upgrading Collaboration from 3.x, you should use the value of the serverURL element in the 3.x version of the configuration file and add the http:// protocol prefix.
Example: http://mail.company.com/exchange
Alias | An optional descriptive name for this groupware server.

If you are using a Lotus Domino back-end server, enter the following configuration information:

Table 3-3 Lotus Domino Configuration Parameters
Parameter | Description
--- | ---
Server Name/IP/URL | The server name, IP address, or URL of the groupware server.
Note: | If you are upgrading Collaboration from 3.x, you should use the value of the serverURL element in the 3.x version of the configuration file and add the http:// protocol prefix.
Example: http://mail.company.com/exchange
Alias | An optional descriptive name for this groupware server, which will be available to end users. Example: MyCompany Exchange Server
Server Port | If your server port number is other than 80, type a port number; otherwise leave this blank.
Proxy Host/Firewall Port | If you are using a proxy server or a firewall, type the host name; otherwise leave this blank.
Use SSL | If you are using https, select the check box.
HTTPS Port | If you are using an https port number other than 443, type the port number; otherwise leave this blank.
Session Based Authentication | If you are using form-based authentication (cookies), select this; if you are using basic authentication, clear the check box.
Notes Server Temp Dir | Type the local directory of the Lotus Domino server that stores the attachments.
Notes Server Temp UNC | Type the UNC path of the directory of the Lotus Domino server that stores the attachments. This should be the same directory that you typed in the Notes Server Temp Dir box. For example: \\<Lotus Domino server name>\<directory name>.

Note: | Other tasks are required for groupware integration besides configuring this page. For complete information, see Integrating Collaboration and Groupware.

#### Testing Groupware Servers

You can perform a diagnostic test on all of the groupware servers that are integrated with Collaboration.

To test groupware servers:

1. Go to the Collaboration Administration utility.
2. Click Groupware Servers.
3. Click Test Servers.

Note: | This button does not appear in Linux and other UNIX platforms.

Test results appear in the Status column for each groupware server. Each test returns one of these messages:

- OK: The groupware server is functioning correctly
- FAIL: You incorrectly added the groupware server, or the groupware server is not functioning correctly

The message provides a reason for failure and might provide troubleshooting recommendations. The detailed error information can be found in the Collaboration log. You can find the log at:

- The top of the Diagnostics page in the Collaboration Administration Utility (click the here link)
- <PT_HOME>\ptcollab\<version_number>\settings\logs\collaboration.log.

By default, PT_HOME is C:\bea\alui. However, if you upgraded to Collaboration 4.2, PT_HOME is the same as in the previously installed version of Collaboration.

### Changing Collaboration Notification Settings

You can specify the time when Collaboration Notification generates and mails summary notifications to project users. The summary job time is executed according to the machine time on which Collaboration is installed.

To configure the summary job time:

1. Go to the Collaboration Administration utility.
2. Click Collaboration Notification.
3. Select the hour and minute for the summary job time.
4. Click Finish.

Additionally, end users can set the format (plain text or HTML) of notification e-mails that are sent to them by navigating to My Account, Collaboration Settings, Subscriptions and selecting the desired format. For details see Collaboration Online Help.

### Working with the Search Service

The Collaboration Administration utility lets you monitor the status of the Search Service and rebuild its data.

#### Viewing Search Service Status

Collaboration provides the following information about the Search Service:

Table 3-4 Descriptions of Search Service Statuses
Status | Description
--- | ---
Uptime | The length of time the Search Service has been running.
Installation Directory | The location where the Search Service is installed.
Objects Currently Indexed | The number of Collaboration items in the Search Service index.
Pending Index Requests | The number of requests outstanding for indexing Collaboration objects.

#### Rebuilding the Search Collection

Rebuilding reconciles data between the Collaboration database and Search Service index. Since this is a lengthy and computationally expensive process, use the rebuild operation only when absolutely necessary.

To rebuild the Search Service database:

1. Go to the Collaboration Administration utility.
2. Click Search Service.
3. Click Rebuild Search Collection.
4. Click OK.

### Granting Portal Access to Collaboration

When Collaboration is configured, it is associated with a primary portal, known as the owning portal. Collaboration has a direct relationship with its owning portal, including access to the owning portal’s database.

Every portal accessing Collaboration sends an authentication name and password. Collaboration uses this authentication information to ensure that the attempted access is coming from the owning portal. The owning portal is assigned a unique authentication identifier so that Collaboration can identify each portal.

#### Changing the Owning Portal

Collaboration determines its owning portal based on the values specified in config.xml. However, you can also change the owning portal using the Collaboration Administration utility by performing the following:

1. Access the Collaboration Administration utility.
2. Click Portal Access.
3. Manually enter the values for the following fields:

- Web Service ID
- Gateway Page URL
- Collaboration Service URL

4. Click Finish.

## Configuring Collaboration for Importing Files into the Knowledge Directory

You can configure crawlers to automatically import files from Collaboration into the Knowledge Directory. You must have the proper activity rights in the portal to be able to create and configure content crawlers. For information on the necessary activity rights, see the Administrator Guide for BEA AquaLogic Interaction.

This section discusses:

- Configuring Content Crawlers for Importing Files
- Configuring Collaboration Document Properties

For more information on setting up Collaboration so that users can manually publish files into the Knowledge Directory, see Setting Up Collaboration for Publishing.

### Configuring Content Crawlers for Importing Files

You create content crawlers from the Collaboration Crawler Content Source to import files from Collaboration into the Knowledge Directory. You must use the Collaboration Crawler Content Source with Collaboration content crawlers. The authentication settings for the Collaboration Crawler Content Source must match the authentication settings in the Collaboration Remote Server object.

The API Service and the Automation Service must be installed for Collaboration files to be imported into the Knowledge Directory. For more information about installing them, see the Installation Guide for BEA AquaLogic Interaction.

To configure a content crawler for importing files from Collaboration into the Knowledge Directory, perform the following on the content crawler’s Main Settings page:

- Click Browse next to the Project icon to choose the project that contains the folder that you want the content crawler to access. You can only select projects for which you are a Project Leader.
- Click Browse next to the Folder icon to choose a folder. You must have Admin access to the folder. Additionally, you must make this folder content crawler-accessible by selecting Accessible to Content Crawlers in the folder's properties. Content crawler accessibility settings are passed down to child folders.

By default, the maximum number of levels within the folder that the content crawler can access is unlimited. You can change this number using the Maximum number of levels to crawl drop-down list.

We recommend the following settings for content crawlers that import files into the Knowledge Directory:

- On the content crawler’s Main Settings page, select the Mirror the source folder structure option
- On the content crawler’s Advanced Settings page:

- Select the from this Content Source option
- Select the refresh them option
- Select the regenerate deleted links option

Error information about content crawler jobs can be found in:

- The job history for each content crawler job
- The Collaboration log, which can be found at:

- The top of the Diagnostics page in the Collaboration Administration Utility (click the here link)
- <PT_HOME>\ptcollab\<version_number>\settings\logs\collaboration.log

For more information about creating content crawlers, see Administrator Guide for BEA AquaLogic Interaction.

### Configuring Collaboration Document Properties

Documents that are published and crawled into the Knowledge Directory contain the Checked In By property, which is a Collaboration property that contains the name of the user who checked in the version of the document that is accessible in the Knowledge Directory. In order for the Checked In By property to be displayed, you must add it to the Global Document Property Map by performing the following:

1. Log in to the portal.
2. Click the Administration tab.
3. From the Utilities drop-down list, select Global Document Property Map.
   The Global Document Property Map appears.
4. Click Add Property.
5. In the Add Property window, select Checked In By.
6. Click OK.
   The Checked In By property is added to the Global Document Property Map page.
7. Click the Checked In By link.
8. In the Document Attributes column of the Checked In By Row, type: CheckedInBy.
9. Click Finish.

## Setting Up Collaboration Logging

Collaboration writes log messages to:

- Collaboration.log, which is the local Collaboration log file. This log file exists at <PT_HOME>\ptcollab\<version_number>\settings\logs\collaboration.log. No setup is required to enable logging to the Collaboration log file and view the log.
- ALI Logging Spy, which is the primary log message receiver in the ALI Logging Utilities. ALI Logging Spy provides a graphical user interface for displaying log messages as they stream in from Collaboration and other log message senders (such as the portal or Publisher).

This section discusses:

- Setting Up Logging Utilities for Collaboration Logging
- Configuring ALI Logging Spy to Display Collaboration Messages

Note: | You must set up logging utilities for Collaboration logging before you configure ALI Logging Spy to display Collaboration messages.

### Setting Up Logging Utilities for Collaboration Logging

To set up Collaboration logging, you use the OpenLog section of the audit.xml file. By default, the audit.xml file is installed in <PT_HOME>\ptcollab\4.2\settings\config, where <PT_HOME> is, by default, C:\bea\alui. The following is an example of this section and a description of each of the nodes in the section:

    <openlog enabled="yes">

           <serverName value=""/>

           <restrictToLocalMachine value="no"/>

       </openlog>

##### <openlog enabled> Node

This node enables or disables OpenLog. By default, openlog enabled is set to yes.

##### <serverName value> Node

This node:

- Defines the Collaboration logging name, which distinguishes it from all other BEA AquaLogic Interaction applications that use the logging framework
- Facilitates the viewing of Collaboration log messages

During installation, the Collaboration installer sets the Collaboration logging name to:

    collab.[machine-name].[user-name]

In this default, machine-name is the name of the machine on which Collaboration is installed. user-name is the name of the user who runs the installer.

You can override the default Collaboration logging name by typing your own string into the <serverName value> node. The string that you enter must meet these criteria:

- The logging name can contain only visible ASCII characters and the space character.

It cannot contain invisible ASCII characters such as tabs, carriage returns, and so on. It also cannot contain the forward slash character (/).

- The logging name cannot exceed 128 characters in length

##### <restrictToLocalMachine value> Node

The <restrictToLocalMachine> XML node enables or disables remote spying of Collaboration log messages. When the value is no, instances of ALI Logging Spy that run on other machines on the network can receive log messages from Collaboration. When the value is yes, only instances of ALI Logging Spy that run on the machine on which Collaboration is installed can receive log messages from Collaboration. The default value is no.

For successful remote spying of Collaboration log messages, you must configure the network to allow UDP multicast messages between the machine on which Collaboration is installed and the machine on which ALI Logging Spy is installed. For help with this, see your network administrator.

### Configuring ALI Logging Spy to Display Collaboration Messages

This section discusses how to configure ALI Logging Spy to display Collaboration messages.

Note: | You must set up logging utilities for Collaboration logging before you configure ALI Logging Spy to display Collaboration messages. For more information, see Setting Up Logging Utilities for Collaboration Logging

To configure ALI Logging Spy to display Collaboration messages:

1. Launch ALI Logging Spy by navigating to Start |All Programs | BEA | ALI Logging Utilities | Logging Spy. For more information on using ALI Logging Spy, see the online help provided with ALI Logging Spy.

Note: | If you upgraded to Collaboration 4.2, the path to ALI Logging Spy is the same as in the previously-installed version of Collaboration.

2. Open the Filter Settings dialog box by selecting View | Set Filters.
3. To add a logging server, right-click anywhere in the Filter Settings window. The context menu appears.
4. Select Add Message Sender. The Add Message Sender dialog box appears.
5. Type a server name or select it from the list of names and click OK.

Server names exists in the <serverName> nodes of the openLog section in the audit.xml file.

When you add a server as a message sender, it appears as a tree structure in the Filter Settings window. Click the plus sign to expand the server and see a list of its message-sending components.

6. In the Filters Settings window, expand each component under a server to see the selected logging levels for that component.

The checkbox next to each component has three states:

- Gray with a check mark: the initial four logging levels (listed above) are selected
- Clear with a check mark: all of the logging levels are selected
- Clear: none of the logging levels are selected

You can toggle through these states by clicking the checkbox next to the component.

7. You can perform the following additional actions in the Filter Settings window:

- To remove a message-sending server and its components, right-click on the server name, and select Remove Message Sender
- To enable a selected logging level for all components of a server, right-click on the server name, and select Enable <LoggingLevel>, for example, Enable Performance
- To enable or disable logging levels for a single component, expand the component, and select or clear the checkbox next to the logging level
- To clear all logging levels for all components of a server, right-click on the server name, and select Clear All Filters. Then click OK when asked to confirm. This prevents those components from sending logging messages to this instance of ALI Logging Spy
- To reset logging levels for all components of a server to the original four levels, right-click on the server name, and select Reset Filters. Then click OK when asked to confirm

8. Click OK when finished.

#### Filter Settings and Debugging

The filter settings in ALI Logging Spy are independent of the logging levels specified in Collaboration’s audit.xml file. The settings in audit.xml affect only the messages written to the collaboration.log file and do not affect the messages that appear in ALI Logging Spy. Conversely, the settings in ALI Logging Spy have no effect on the messages written to the collaboration.log file.

Because the filter settings in ALI Logging Spy are independent of the settings in audit.xml, you can use ALI Logging Spy to debug problems with Collaboration without changing the logging level in audit.xml and restarting Collaboration. To do this, launch ALI Logging Spy and enable the Debug logging level on all relevant components to view debug messages from Collaboration.

Note: | When you enable the Debug logging level in ALI Logging Spy, you affect Collaboration performance. Do not leave debug logging enabled in ALI Logging Spy for long periods of time when it is used with an installation of Collaboration that is used in a production context.

## Backing Up and Restoring Collaboration

This section discusses how to back up and restore Collaboration.

### Backing Up Collaboration

To back up Collaboration:

1. To ensure that the Collaboration database, portal database, and Document Repository are in sync, perform the following at the same time:

- Back up the Collaboration database that you created when you installed Collaboration. For details, refer to the instructions for your database type
- Back up the portal database
- Back up all of the Document Repository files. By default, they are located in:
  <PT_HOME>\ptdr\documents\PTCollab

2. Back up Collaboration’s configuration files.
3. (Optional) Back up the Search index, which you can rebuild when you restore Collaboration.
4. (Optional) Back up any customizations that exist in your deployment.

### Restoring Collaboration

To restore Collaboration:

1. Shut down the portal and Collaboration.
2. Restore the Collaboration and portal databases.
3. Restore the Document Repository files.
4. Restore Collaboration’s configuration files.
5. (Optional) If you backed up the Search index, restore the Search index.
6. (Optional) If you backed up any customizations that exist in your deployment, restore them.
7. Restart the portal and Collaboration.

## Configuring the Notification Service for Working with Experience Definitions

Notification Service-generated e-mails can include user-specific URLs that point to Experience Definitions. To enable the Notification Service to include links to Experience Definitions, edit the Notification Service’s config.xml and set the <experience-definitions enabled> node to yes.

Note: | You must restart the Notification Service for this change to take effect.