Production Placeholder Manager (.NET)

The Production Placeholder Manager API exposes the following methods on the Services.<VersioNumber>.IProductionPlaceholderManager interface:

• CreateSingleAsync() method - adds a new image or custom placeholder to a specific workspace. See Create a placeholder.
• DeleteSingleAsync() method - removes a placeholder from Relativity. See Delete a placeholder.
• GetProductionPlaceholderDefaultFieldValues() method - retrieves default field values for a production placeholder in a workspace. See Retrieve default field values for a placeholder.
• ReadSingleAsync() method - retrieves a production placeholder. See Read a placeholder.
• UpdateSingleAsync() method - modifies an image placeholder or a custom placeholder in a specific workspace. See Update a placeholder.

The Production Placeholder Manager API includes multiple classes and enumerations. The following list highlights key features:

• ProductionPlaceholderRef - represents a reference to a placeholder. The properties on a ProductionRef object include the Artifact ID and placeholder name.
• ProductionPlaceholder - represents a Relativity production placeholder. The ReadSingleAsync() method returns an object of this type. It has the following properties:
  • ArtifactID - the artifact ID of the placeholder.
  • ArtifactTypeID - the Relativity artifact type ID of the placeholder.
  • CustomText - the custom HTML text for the placeholder.
  • FileData - the contents of the placeholder image.
  • FileID - the internal identifier of the placeholder preview image.
  • Filename - the file name of the placeholder image.
  • FileSize - the size of the uploaded file.
  • Name - a user-friendly name for the placeholder.
  • PlaceholderType - the type of the placeholder. The PlaceholderType enumeration defined valid values for this property.
• PlaceholderType - the enumeration defines valid values for placeholder type. Values include:
  • 0 - Custom - indicates custom text with formatting.
  • 1 - Image - indicates image files. Relativity supports TIF, JPEG, PNG, BMP, and GIF files.

public partial class Example
{
    public async Task CreateImagePlaceholder_Example()
    {
        var workspaceID = 11111;                // ArtifactID of Workspace where Placeholder exists
        var userName = "user@test.com";      // User's login
        var userPassword = "abc123456!";         // User's password
 
        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        string fileLocation = @"\\servername\share\Placeholder.jpg";
        string filename = Path.GetFileName(fileLocation);
        byte[] fileData = ReadFully(fileLocation);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
 
                ProductionPlaceholder placeholder = new ProductionPlaceholder()
                {
                    Name = "Placeholder for excel sheets",
                    PlaceholderType = PlaceholderType.Image,
                    Filename = filename,
                    FileData = fileData
                };
                placeholder.ArtifactID = await productionPlaceholderManager.CreateSingleAsync(workspaceID, placeholder);
 
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
 
 
    private byte[] ReadFully(string fileLocation)
    {
        MemoryStream ms = new MemoryStream();
        byte[] buffer = new byte[16 * 1024];
        int read;
        using (FileStream reader = new FileStream(fileLocation, FileMode.Open))
        {
            while ((read = reader.Read(buffer, 0, buffer.Length)) > 0)
            {
                ms.Write(buffer, 0, read);
            }
        }
        return ms.ToArray();
    }
}

public partial class Example
{
    public async Task CreateCustomPlaceholder_Example()
    {
        var workspaceID = 11111; // ArtifactID of Workspace where Placeholder exists
        var userName = "user@test.com"; // User's login
        var userPassword = "abc123456!"; // User's password
 
        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        using (IProductionPlaceholderManager productionPlaceholderManager =
            serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
 
                ProductionPlaceholder placeholder = new ProductionPlaceholder()
                {
                    Name = "Placeholder for excel sheets",
                    PlaceholderType = PlaceholderType.Custom,
                    CustomText = "This is an excel sheet."
                };
                placeholder.ArtifactID =
                    await productionPlaceholderManager.CreateSingleAsync(workspaceID, placeholder);
 
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
}

public partial class Example
{
    public async Task ReadPlaceholder_Example()
    {
        int workspaceID = 11111;            // ArtifactID of Workspace where Placeholder exists
        int placeholderID = 22222;            // ArtifactID of Placeholder to read
        var userName = "user@test.com";  // User's login
        var userPassword = "abc123456!";     // User's password
 
        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
                ProductionPlaceholder productionPlaceholder = await productionPlaceholderManager.ReadSingleAsync(workspaceID, placeholderID);
 
                if (productionPlaceholder.PlaceholderType == PlaceholderType.Custom)
                {
                    // Read the custom text
                    var customText = productionPlaceholder.CustomText;
                    Console.WriteLine(customText);
                }
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
}

public partial class Example
{
    public async Task UpdateImagePlaceholder_Example()
    {
        var workspaceID = 11111;            // ArtifactID of Workspace where Placeholder exists
        int placeholderID = 33333;            // ArtifactID of Image Placeholder to update
        var userName = "user@test.com";  // User's login
        var userPassword = "abc123456!";     // User's password
 
        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        string fileLocation = @"\\servername\share\Placeholder.jpg";
        string filename = Path.GetFileName(fileLocation);
        byte[] fileData = ReadFully(fileLocation);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
                // Read the placeholder you would like to update, so we get the fully filled object
                ProductionPlaceholder placeholder = await productionPlaceholderManager.ReadSingleAsync(workspaceID, placeholderID);
 
                // Update the placeholder (change the name, change uploaded image)
                fileLocation = @"\\servername\share\ReplacementPlaceholder.jpg";
                filename = Path.GetFileName(fileLocation);
                fileData = ReadFully(fileLocation);
 
                placeholder.Name = "Placeholder for excel sheets - No redactions";
                placeholder.Filename = filename;
                placeholder.FileData = fileData;
                await productionPlaceholderManager.UpdateSingleAsync(workspaceID, placeholder);
 
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
 
    private byte[] ReadFully(string fileLocation)
    {
        MemoryStream ms = new MemoryStream();
        byte[] buffer = new byte[16 * 1024];
        int read;
        using (FileStream reader = new FileStream(fileLocation, FileMode.Open))
        {
            while ((read = reader.Read(buffer, 0, buffer.Length)) > 0)
            {
                ms.Write(buffer, 0, read);
            }
        }
        return ms.ToArray();
    }
}

public partial class Example
{
    public async Task UpdateCustomPlaceholder_Example()
    {
        var workspaceID = 11111;               // ArtifactID of Workspace where Placeholder exists
        int placeholderID = 22222;               // ArtifactID of Custom Placeholder to update
        var userName = "user@test.com";     // User's login
        var userPassword = "abc123456!";        // User's password
 
        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
                // Read the placeholder you would like to update, so we get the fully filled object
                ProductionPlaceholder placeholder = await productionPlaceholderManager.ReadSingleAsync(workspaceID, placeholderID);
 
                // Update the placeholder (change the name, change the custom text)
                placeholder.Name = "Placeholder for excel sheets - No redactions";
                placeholder.CustomText = "<P><B>This is an excel sheet for document: [Control Number].</B></P>";
                await productionPlaceholderManager.UpdateSingleAsync(workspaceID, placeholder);
 
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
}

public partial class Example
{
    public async Task DeletePlaceholder_Example()
    {
        int workspaceID = 11111;            // ArtifactID of Workspace where Placeholder exists
        int placeholderID = 22222;            // ArtifactID of Placeholder to delete
        var userName = "user@test.com";  // User's login
        var userPassword = "abc123456!";     // User's password
 

        var relativityRestUri = @"http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userName, userPassword);
        ServiceFactorySettings settings = new ServiceFactorySettings(new Uri(relativityRestUri), usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
                await productionPlaceholderManager.DeleteSingleAsync(workspaceID, placeholderID);
                // Delete is successful if exception was not thrown
            }
            catch (ValidationException e)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", e.Message);
            }
            catch (ServiceException es)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", es.Message);
            }
        }
    }
}

public partial class Example
{
    public async Task GetProductionPlaceholderDefaultFieldValues_Example()
    {
        int workspaceId = 12345; // Workspace containing the Production Placeholder
 
        var userEmail = "user@test.com"; // User login
        var password = "abc123456!"; // User password
 
        var relativityServicesUri = "http://localhost/relativity.services";
        var relativityRestUri = "http://localhost/relativity.rest/api";
 
        var usernamePasswordCredentials = new UsernamePasswordCredentials(userEmail, password);
        ServiceFactorySettings settings = new ServiceFactorySettings(
            new Uri(relativityServicesUri),
            new Uri(relativityRestUri),
            usernamePasswordCredentials);
        ServiceFactory serviceFactory = new ServiceFactory(settings);
 
        using (IProductionPlaceholderManager productionPlaceholderManager = serviceFactory.CreateProxy<IProductionPlaceholderManager>())
        {
            try
            {
                ProductionPlaceholderDefaultFieldValues values = await productionPlaceholderManager.GetProductionPlaceholderDefaultFieldValues(workspaceId);
 
                Console.WriteLine("Found default Choice Artifact ID for Type field: {0}.", values.Type.DefaultValue.ID);
                Console.WriteLine("Found default Choice Name for Type field: {0}.", values.Type.DefaultValue.Name);
                Console.WriteLine("Found Type field GUID: {0}.", values.Type.Guid);
                Console.WriteLine("Found Type field Artifact ID: {0}.", values.Type.ID);
            }
            catch (ValidationException ex)
            {
                // Log validation exception details
                Console.WriteLine("There were validation errors: {0}", ex.Message);
            }
            catch (ServiceException ex)
            {
                // Log service exception details
                Console.WriteLine("There were errors: {0}", ex.Message);
            }
        }
    }
}