Skip Headers

Oracle® Communicator User's Guide 10g Release 3 (10.1.3) Part Number E12748-01 |
Home | Contents | Index | Contact Us

Previous | Next
| View PDF

# A The Oracle Communicator Configuration File

This appendix includes the `customize-sample.xml` file for Oracle Communicator described in Chapter 5, " Configuring Oracle Communicator".

## The customize-sample.xml File

`customize-sample.xml` (Example A-1) is the template file for `customize.xml`.

Example A-1 customize-sample.xml

    <?xml version="1.0" encoding="UTF-8" ?>

    <Customize>

    <!-- in order to provide default settings for the installation,
         this file should be edited and renamed customize.xml,
         then included in the Oracle Communicator installation
         self-extracting RAR (i.e. OracleCommunicatorSetup.exe)

         for true/false values, 0 means false, 1 means true

         it is expected that most administrators will need
         to modify at least the proxy and XDMS settings to
         reflect the site topology, and that most administrators
         will choose to modify the STUN and LDAP settings
         as well

         this file lists default values; any property in this
         file may be removed with no impact on the installation;
         it is recommended that an administrator only keep
         those properties for which they intend to use
         non-default values
    -->

      <!-- the Vendor section contains properties that will
           remain the same for all user accounts in the
           installation and is not editable through the
           UI by the user -->
      <Vendor>

        <!-- if 1, the "Service Settings" menu option will
            be visible, which will open the URL specified
            in Account/Provisioning/Location in a browser -->
         <SelfProv>0</SelfProv>
      </Vendor>

      <Account>
      <!-- whether or not to use the outbound proxy -->
      <UseOutboundProxy>1</UseOutboundProxy>

      <!-- the address of the proxy server, preceded by sip:
          if this is not specified, the default is
          outbound.<host> where <host> comes from the user's
          SIP address -->
      <OutboundProxyAddress>sip:outbound.example.com</OutboundProxyAddress>

      <!-- the default UI theme to use -->
      <Theme>Slate</Theme>

      <!-- the default save password state; the user can toggle this -->
      <SavePasswordPreference>1</SavePasswordPreference>

        <!-- the XDMS server, presence rule and hard state settings;
         if this is not specified the default for the Host is
         xcap.<host> where <host> comes from the user's SIP address;
         the other values are the same as default except RootContext
         defaults to services instead -->
     <XDMSSettings>
     <UseHttps>0</UseHttps>
     <Host>xcap.example.com</Host>
     <Port>8888</Port>
     <RootContext>aggregationproxy</RootContext>
     <PresRuleAUID>pres-rules</PresRuleAUID>
     <PresRuleDocName>presrules</PresRuleDocName>
     <HardStateAUID>pidf-manipulation</HardStateAUID>
     <HardStateDocName>hardstate</HardStateDocName>
     <ResourceListsAUID>resource-lists</ResourceListsAUID>
     <ResourceListsDocName>index</ResourceListsDocName>
     </XDMSSettings>

     <!-- whether to use rport as described in RFC 3581 for
         NAT traversal; the default is 0; rport may
          not be supported by OCMS in a cluster environment,
          in which case this should be 0 -->
     <UseRPortForNatTraversal>1</UseRPortForNatTraversal>

     <!-- the STUN server -->
     <UseStun>0</UseStun>
     <StunServerAddress>stun.example.com</StunServerAddress>
     <StunServerPort>3478</StunServerPort>

     <!-- the LDAP server(s) to use for contact searching; by
          default no LDAP server is provided -->
     <LdapServers>
     <LdapServer>
     <Name>ldap.example.com</Name>
     <Ip>ldap.example.com</Ip>
     <Port>389</Port>
     <BaseObject>dc=example,dc=com</BaseObject>
     <Default>yes</Default>
     <UseTLS>0</UseTLS>
     <UseAuthentication>0</UseAuthentication>

     <!-- the attribute to use as the distinguished name
         for authorization -->
     <AuthorizationAttribute>uid</AuthorizationAttribute>

     <!-- the SipUriAttribute indicates which
         LDAP schema attribute, if any, should be
          mapped to the SIP address of a contact -->
     <SipUriAttribute>mail</SipUriAttribute>

     <!-- if true, indicates the SIP address
       of the contact returned by the LDAP server
         will have the sip: protocol prepended -->
     <SipUriProtocolPrefix>0</SipUriProtocolPrefix>

     <!-- if true, this will cause the SIP address
         of the contact returned by the LDAP server
         to be made lowercase -->
     <SipUriLowercaseTransform>1</SipUriLowercaseTransform>

     </LdapServer>
     </LdapServers>

     <!-- the URL to launch if the user selects "Service Settings"; that
          option will only be available to the user if Vendor/SelfProv
         is 1 -->
     <Provisioning>
     <Location>http://example.com/selfprovisioning</Location>
     </Provisioning>

     <!-- Notifications has two functions: (1) to control client upgrades and
          (2) to provide client-side notification messages.  This information is
          contained in a notification.xml document on the server.  Enable/disable
          this feature here and provide the URL location of this xml document.
          by default, VersionControl is disabled -->
     <Notifications>
     <!-- 0 disabled, 1 enabled -->
     <UseNotifications>0</UseNotifications>
     <!-- xml document location -->
     <Location>http://notification.example.com/notification.xml</Location>
     </Notifications>

     <!-- enables/disables the file transfer functionality; in order
         to support file transfer you must have the FileTransferServlet
          deployed; the Location should be the full URL of the
          FileTransferServlet (e.g. http://example.com/filetransfer) -->
     <FileTransferEnabled>0</FileTransferEnabled>
     <FileTransfer>
     <Location></Location>
     </FileTransfer>

      <!-- enables/disables SMS menu options; if this is true, it is
           assumed there is a server-side piece that can recognize
           and send SMSes (i.e. the client does not handle sending the
           SMS itself) -->
      <SMSEnabled>0</SMSEnabled>

      <!-- enables/disables the history, which logs all calls and IM
           conversations; the user can toggle through the Preferences dialog -->
      <HistoryEnabled>1</HistoryEnabled>

      <!-- the number of days history items will be kept; valid values are:
           -1 - history items never deleted
            0 - history items deleted on signout
           14 - history items deleted after 14 days
           30 - history items deleted after 30 days
           -->

      <HistoryExpirationDays>14</HistoryExpirationDays>

      </Account>
    </Customize>