.relativityClient Files

The .relativityClient can be a part of your client application and contains information about the server that the client is interacting with. The XML structure contains the server name or URI, the domain, schema and any relevant login information.

<?xml version="1.0" encoding="utf-8"?>
<RelativityClient>
  <Server>
    <Name>ALEXWIN8VM</Name>
    <ServerUri>http://alexwin8vm:7099/bin</ServerUri>
  </Server>
  <Domain>Finance</Domain>
  <Schema>Finance</Schema>
  <AdminLogin />
  <DataLogin />
</RelativityClient>

Note that the Server tag in the relativityClient file can hold a Name tag, which contains Bonjour (ZeroConf) name of the Relativity server, or the exact ServerUri. If the .relativityClient file contains a ServerUri, then its Bonjour name will be ignored.

The AdminLogin & DataLogin tags can store the admin user name and data user name accordingly. Any passwords (including AES passwords) will, for security reasons, be encrypted and stored in a separate *.user file. If you are using a version control system you can easily avoid tracking the files that contain passwords.

Getting a .relativityClient file

A .relativityClient file is generated for you by Visual Studio or Delphi during the creation of a project using the New Project Templates.

If you are using Mac OS X you can easily create a .relativityClient file for a domain in an instance of Relativity Server using the Server Explorer for Mac application. Open Server Explorer, drill down the Server tree till you get to the Setup node of the domain you are interested in and then click on the Save .relativityClient File button.

Using a .relativityClient file

When you open a .relativityClient file in the Schema Modeler (Windows), it will ask you to provide administrator login and password. You need to have administrator rights to be able to upload changed schema files back to the relativity. If the relativity server is encrypted with AES password you'll need to provide it too.

After you login, the Schema Modeler will download the schema and connection manager info and open it. Note that all data will be kept in memory, no temporary files will be created.

Note that the any changes inside the Connection Manager, including those to the connection string are immediately applied by the Relativity server without any confirmation. The reason for this behaviour is that Relativity should always use updated connection info for getting the list of database objects and their metadata.

While Server Explorer for Mac can generate a .relativityClient file, it is currently unable to open one.