Instance Setting Manager API

The Instance Setting Manager API supports create, read, update, and delete operations in a Relativity environment. With the create method, you can set the value for the instance setting, and its initial or default value. For general information, see Instance settings on the Relativity Documentation site.

Sample use cases for the Instance Setting Manager API include:

Updating instance setting values to support behavior implemented by a custom application. You might implement a custom application that sends out email notifications, and want to programmatically update the From and To fields on the messages by setting the EmailFrom and EmailTo instance settings.
Updating instance setting values to modify or customize existing Relativity behavior. For example, you might want to programmatically change the time frame for running off hour agents by updating the AgentOffHourEndTime and AgentOffHourStartTime instance settings.

You can also use the Instance Setting Manager service through the REST API, which supports the same functionality available through .NET. For more information, see Instance Setting Manager service.

This page contains the following information:

Fundamentals for the Instance Settings Manager API

The Instance Setting Manager API contains the following methods, classes, and enumerations.

Methods

The Instance Setting Manager API exposes the following methods on the IInstanceSettingManager interface in the Relativity.Services.Interfaces.InstanceSetting namespace:

CreateAsync() method - adds a new instance setting to a Relativity environment. Its parameters include an integer value of -1 to indicate the admin-level context, and a InstanceSettingRequest object. The method returns the Artifact ID of the new instance setting. See Create an instance setting.
DeleteAsync() method - removes an instance setting from a Relativity environment. Its parameters include an integer value of -1 to indicate the admin-level context, and the Artifact ID of an instance setting. This method returns a task. See Delete an instance setting.
ReadAsync() method - retrieves the properties for an instance setting. Its parameters include an integer value of -1 to indicate the admin-level context, and the Artifact ID of an instance setting. This method returns a InstanceSettingResponse object. See Read an instance setting.
UpdateAsync() method - modifies Machine, Value, Encrypted, Keywords and Notes properties on an instance setting. Its parameters include an integer value of -1 to indicate the admin-level context, the Artifact ID of an instance setting, and an optional DateTime object to restrict the update to the date last modified. This method returns a task. See Update an instance setting.

Classes and enumerations

The Instance Setting Manager API includes the following classes and enumeration available in the Relativity.Services.Interfaces.InstanceSetting.Model namespace:

InstanceSettingRequest class - represents the data used to create or update an instance setting. Its properties include the name of the instance setting, its value and a default value, and others. The CreateAsync() and UpdateAsync() methods take an object of this type.
InstanceSettingResponse class - represents the response from a read operation. Its properties include the name of an instance setting, its Artifact ID, the section of the Instance settings table where it exists, and others. For complete list of properties, see this class in the Services API.
InstanceSettingValueTypeEnum enumeration - indicates the value type of an instance setting, such as text, Integer32, TrueFalse, or other. For a complete list of enums, see the Services API.

Additionally, this API includes the following class in the Relativity.Services.Interfaces.InstanceSetting namespace:

InstanceSettingRouteConstants class - provides routing information about URLs used by the Field Manager service. See this class in the Services API.

Note: You can find information about running the following code samples in Relativity SDK samples. For information about the helper methods used in these code samples, see Helper methods in code samples.

Create an instance setting

Instance settings are used to control specific behavior in Relativity, such as query time outs, time frames for running certain agents, and other configuration options. For more information and a list of available settings, see Instance settings on the Relativity Documentation site.

To create an instance setting, call the CreateAsync() method by passing a workspace ID of -1 and an InstanceSettingRequest object to it. The method returns the Artifact ID of the new instance setting. See the following code sample:

public async Task<bool> Create(Client.SamplesLibrary.Helper.IHelper helper)
{
    bool success = false;

    using (IInstanceSettingManager instanceSettingManager = helper.GetServicesManager().CreateProxy<IInstanceSettingManager>(ExecutionIdentity.User))
    {
        try
        {
            InstanceSettingRequest request = GetRequestTemplate();
            request.ValueType = InstanceSettingValueTypeEnum.Text;
            request.Value = "Sample Text Value";
            request.InitialValue = "Sample Text Initial Value";

            int artifactID = await instanceSettingManager.CreateAsync(ADMIN_WORKSPACE_ID, request);
            if (artifactID != 0)
            {
                DataHelper.DeleteData[Data.Constants.INSTANCE_SETTING_LIST].Add(artifactID);
                success = true;
            }
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while creating Instance Setting");
            throw;
        }
    }

    return success;
}

Read an instance setting

Use the ReadAsync() method to retrieve the properties for an instance setting. Pass the a workspace ID of -1 and the Artifact ID of an instance setting to this method. It returns an InstanceSettingResponse object.

The following code sample illustrates how to create an instance setting, and then read its properties.

public async Task<bool> Read(Client.SamplesLibrary.Helper.IHelper helper)
{
    bool success = false;

    using (IInstanceSettingManager instanceSettingManager = helper.GetServicesManager().CreateProxy<IInstanceSettingManager>(ExecutionIdentity.User))
    {
        int artifactID;

        try
        {
            InstanceSettingRequest request = GetRequestTemplate();
            request.ValueType = InstanceSettingValueTypeEnum.Integer32;
            request.Value = "32768";
            request.InitialValue = "16384";

            artifactID = await instanceSettingManager.CreateAsync(ADMIN_WORKSPACE_ID, request);
            DataHelper.DeleteData[Data.Constants.INSTANCE_SETTING_LIST].Add(artifactID);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while creating Instance Setting");
            throw;
        }

        try
        {
            InstanceSettingResponse response = await instanceSettingManager.ReadAsync(ADMIN_WORKSPACE_ID, artifactID);
            if (response != null && response.ArtifactID == artifactID)
            {
                success = true;
            }
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while reading Instance Setting");
            throw;
        }
    }

    return success;
}

Update an instance setting

You can update the Machine, Value, Encrypted, Keywords and Notes properties of an instance setting. To update an instance setting, call the UpdateAsync() method by passing a workspace ID of -1 and an InstanceSettingRequest object to it. See the following code sample.

Additionally, you can restrict the update of an instance setting to the date that it was last modified, Pass the value of LastModifiedOn property as an argument to one of the overloaded update methods. You can get the value of this property from an InstanceSettingResponse object, which is returned by the ReadAsync() method.

public async Task<bool> Update(Client.SamplesLibrary.Helper.IHelper helper)
{
    bool success = false;

    using (IInstanceSettingManager instanceSettingManager = helper.GetServicesManager().CreateProxy<IInstanceSettingManager>(ExecutionIdentity.User))
    {
        string name = GenerateRandomName();
        int artifactID;

        try
        {
            InstanceSettingRequest request = GetRequestTemplate();
            request.ValueType = InstanceSettingValueTypeEnum.Integer64;
            request.Value = "-1";
            request.InitialValue = "0";

            artifactID = await instanceSettingManager.CreateAsync(ADMIN_WORKSPACE_ID, request);
            DataHelper.DeleteData[Data.Constants.INSTANCE_SETTING_LIST].Add(artifactID);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while creating Instance Setting");
            throw;
        }

        try
        {
            InstanceSettingRequest request = new InstanceSettingRequest
            {
                ArtifactID = artifactID,
                Value = "2"
            };

            await instanceSettingManager.UpdateAsync(ADMIN_WORKSPACE_ID, request);
            success = true;
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while updating Instance Setting");
        }
    }

    return success;
}

Delete an instance setting

To delete an instance setting, call the DeleteAsync() method by passing a workspace ID of -1 and the Artifact ID of an instance setting to it. The following code sample illustrates how to create and then delete an instance setting.

public async Task<bool> Delete(Client.SamplesLibrary.Helper.IHelper helper)
{
    using (IInstanceSettingManager instanceSettingManager = helper.GetServicesManager().CreateProxy<IInstanceSettingManager>(ExecutionIdentity.User))
    {
        int artifactID;

        try
        {
            InstanceSettingRequest request = GetRequestTemplate();
            request.ValueType = InstanceSettingValueTypeEnum.TrueFalse;
            request.Value = "True";
            request.InitialValue = "False";

            artifactID = await instanceSettingManager.CreateAsync(ADMIN_WORKSPACE_ID, request);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Exception while creating Instance Setting");
            throw;
        }

        try
        {
            await instanceSettingManager.DeleteAsync(ADMIN_WORKSPACE_ID, artifactID);
        }
        catch (Exception ex)
        {
            DataHelper.DeleteData[Data.Constants.INSTANCE_SETTING_LIST].Add(artifactID);
            _logger.LogError(ex, "Exception while deleting Instance Setting");
            throw;
        }
    }
}

Helper methods in code samples

The code samples for the Instance Setting Manager API use the following helper methods to demonstrate how to make calls to this service:

GenerateRandomName() method - sets a general sample name for an instance setting.

private static string GenerateRandomName()
{
    return $"Instance Setting {Random.Value.Next():x8}";
}

GetRequestTemplate() method - sets general properties for a sample instance setting.

private static InstanceSettingRequest GetRequestTemplate(string name = null)
{
    return new InstanceSettingRequest
    {
        Name = !string.IsNullOrWhiteSpace(name) ? name : GenerateRandomName(),
        Section = SECTION,
        Machine = "",
        Encrypted = false,
        Description = "Sample Description",
        Keywords = "Sample Keywords",
        Notes = "Sample Notes"
    };
}

Note: You can obtain the complete code sample by installing the Install the Relativity SDK. To run the code sample, see Relativity SDK samples.

Additional Resources
DevHelp Community	GitHub	Release Notes	NuGet
Share knowledge with the Relativity developer community.	Access tools and resources to build an application.	Review the most recent product release notes.	Create .NET Apps faster with NuGet.