Console event handlers

Note: Console event handlers are ignored when your object type is using Relativity Forms, but the same functionality can achieved within Relativity Forms. For more information, see Relativity Forms API.

Console event handlers execute when a user clicks a console button in Relativity. The details view of an object may display a console, which contains header text and a button collection. When a user clicks a button, a call is made to a method in the event handler that contains the business logic for a specific task. In Relativity, the console has a GetConsole() method that returns a Console event handler. Console event handlers support custom HTML elements. You can use them on Relativity Dynamic Objects.

You can use a console event handler to control the workflow of a job or project. For example, you may expose buttons to insert a job into a queue table for background processing by an agent. Next, you may also want to track the progress of the job. You can display a link in the console so users can review errors if they occur. After resolving the errors, users can resubmit the job.

This page contains the following information:

Guidelines for Console event handlers

Use these guidelines when developing Console event handlers:

  • Create a new class in Visual Studio.

    Note: You can also use a template to create this event handler type. For more information, see Visual Studio templates.

  • Add NuGet packages - ensure your Visual Studio project has installed the relevant NuGet packages, including at a minimum the Relativity.EventHandler and Relativity.Api packages.
  • Add a GUID for the event handler - set the System.Runtime.InteropServices.Guid to the GUID identifying your event handler. Use the GUID generator in Visual Studio.
  • Set the CustomAttributes.Description attribute - provide a description that you want to appear in the Relativity UI for the event handler.
  • Inherit from the ConsoleEventHandler class – extend the ConsoleEventHandler base class.
  • Override the GetConsole() method – returns a console containing buttons and header text.
  • Override the OnButtonClick() method – executes when a button click is detected.
  • Override the RequiredFields property – returns a collection of fields that you need to access. The current layout doesn't need to include the fields .

    Note: The ActiveArtifact.Fields collection includes the fields returned by the RequiredFields property, and those on the current layout. It also includes the values of these fields.

  • Optionally set the CssClass property on the ConsoleButton class – controls the styling used for a console button. If you don't set this property, the default Relativity styles used in console buttons are applied to your new button.
  • Optionally use event handlers to construct HTTP responses - event handlers can't access the request header, cookies, or session information using the HTTPContext object, although they can assisted in constructing an HTTP response.

Code sample for a Console event handler

Review the following code samples for a Console event handler.

using System;
using System.Collections.Generic;
namespace ExampleEventHandlers
    /// <summary>
    /// This event handler creates a console with a button that could be used for
    /// initiating an action related to the RDO being viewed in the UI.
    /// </summary>
    [kCura.EventHandler.CustomAttributes.Description("Example Console Event Handler")]
    class ExampleConsoleEventHandler : kCura.EventHandler.ConsoleEventHandler
        private readonly Guid NAME_FIELD_GUID = new Guid("716DDBA3-405B-48B8-AE9F-695511F7C4BB");
        private const String CONSOLE_TITLE = "Example Console";
        private const String BUTTON_ONE_NAME = "_button1";
        private const String BUTTON_ONE_DISPLAY_TEXT = "Button One";
        private const String BUTTON_ONE_TOOL_TIP = "Performs an action pertaining to this RDO.";
        private const String BUTTON_TWO_BUTTON_NAME = "_button2";
        private const String BUTTON_TWO_DISPLAY_TEXT = "Button Two";
        private const String BUTTON_TWO_TOOL_TIP = "Launches pop-up window.";
        public override kCura.EventHandler.Console GetConsole(kCura.EventHandler.ConsoleEventHandler.PageEvent pageEvent)
            // Construct a console object to build the console appearing in the UI.
            kCura.EventHandler.Console returnConsole = new kCura.EventHandler.Console();
            returnConsole.Items = new List<kCura.EventHandler.IConsoleItem>();
            returnConsole.Title = CONSOLE_TITLE;
            // Construct button to raise post backs.
            kCura.EventHandler.ConsoleButton buttonOne = new kCura.EventHandler.ConsoleButton();
            buttonOne.Name = BUTTON_ONE_NAME;
            buttonOne.DisplayText = BUTTON_ONE_DISPLAY_TEXT;
            buttonOne.ToolTip = BUTTON_ONE_TOOL_TIP;
            buttonOne.Enabled = true;
            buttonOne.RaisesPostBack = true;
            // Construct button to open a new window.
            kCura.EventHandler.ConsoleButton buttonTwo = new kCura.EventHandler.ConsoleButton();
            buttonTwo.Name = BUTTON_TWO_BUTTON_NAME;
            buttonTwo.DisplayText = BUTTON_TWO_DISPLAY_TEXT;
            buttonTwo.ToolTip = BUTTON_TWO_TOOL_TIP;
            buttonTwo.RaisesPostBack = false;
            buttonTwo.Enabled = true;
            // Get the name of the artifact.
            kCura.EventHandler.Field nameField = ActiveArtifact.Fields[NAME_FIELD_GUID.ToString()];
            string rdoName = nameField.Value.Value.ToString();
            // Create the JavaScript for the button and set the button property.
            string pageUrl = $"{rdoName}";
            string windowOpenJavaScript = $"'{pageUrl}', '', 'location=no,scrollbars=yes,menubar=no,toolbar=no,status=no,resizable=yes,width=300,height=400');";
            buttonTwo.OnClickEvent = windowOpenJavaScript;
            // Add the buttons to the console.
            return returnConsole;
        public override void OnButtonClick(kCura.EventHandler.ConsoleButton consoleButton)
            // Determine which button was clicked.
            if (consoleButton.Name == BUTTON_ONE_NAME)
                // Take action...
        /// <summary>
        /// Specify any fields that need to be populated on the
        /// ActiveArtifact when GetConsole() is invoked.
        /// </summary>
        public override kCura.EventHandler.FieldCollection RequiredFields
                kCura.EventHandler.FieldCollection retVal = new kCura.EventHandler.FieldCollection();
                retVal.Add(new kCura.EventHandler.Field(NAME_FIELD_GUID.ToString()));
                return retVal;