# &adminguide;

## Overview

The module contains several parameters and functions common to all modules using XCAP capabilities.

The module is currently used by the following modules: presence_xml, rls and xcap_client.

## Dependencies

### &osips; Modules

The following modules must be loaded before this module:

- a database module.

## External Libraries or Applications

The following libraries or applications must be installed before running &osips; with this module loaded:

- libxml-dev.

## Exported Parameters

### `db_url`(str)

The database url.

Default value is &defaultdb;.

#### Set `db_url` parameter

    ...
    modparam("xcap", "db_url", "&exampledb;")
    ...

### `xcap_table`(str)

The name of the db table where XCAP documents are stored.

Default value is xcap.

#### Set `xcap_table` parameter

    ...
    modparam("xcap", "xcap_table", "xcap")
    ...

### `integrated_xcap_server` (int)

This parameter is a flag for the type of XCAP server or servers used. If integrated ones, like OpenXCAP from AG Projects, with direct access to database table, the parameter should be set to a positive value. Apart from updating in xcap table, the integrated server must send an MI command refershWatchers [pres_uri] [event] when a user modifies a rules document.

Default value is 0.

#### Set `integrated_xcap_server` parameter

    ...
    modparam("xcap", "integrated_xcap_server", 1)
    ...

## Exported Functions

None to be used in configuration file.