Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Fields

Using Schema Manager, you can create custom fields for standard or custom objects.

Fields serve as the individual data elements that make up an object. Similar to columns in a spreadsheet, each field is designed to store a specific type of information, such as a name, status, date, or numerical value for every record in that object. For example, in a Contact object, fields might include First Name, Email Address, Phone Number, and Date of Birth.

Fields play a critical role in how data is captured, displayed, validated, and reported. They help ensure consistency in the type and format of information entered into the application, making it easier to organize, search, and analyze data across the application.

Note:

Once a field is created, its data type cannot be changed. If you need a different data type, you must create a new field. Also, fields that are referenced by other objects, fields, workflows, or records cannot be deleted until those dependencies are removed.

Creating a New Field

This task helps administrators to create new Standard and Custom objects fields for capturing and organizing information specific to your business.

  1. Log in to the Conga Advantage Platform as an admin user.
  2. Click the App Launcher () icon from the top-left corner, then go to Admin Console > Schema Manager.
  3. Use Basic Search to locate the object you want to update and click the object name to open object details.
  4. Click Create New Field.
  5. Enter or select values in the following common fields:
    Note:

    A field containing Data Type column information is only visible and appropriate to that specific data type. All other fields without a data type column are displayed for all data types.

    Field

    Description

    Display Name

    Enter a user-friendly display name for the field.

    Data Type

    Select the data type from the list. Other fields are rendered based on the data type selection. For a list of data types, see Custom Field Types.

    Field Name

    Accept this value or change it to override the default, which is auto-populated from the display name. For example, entering Test 123 in the Display Name field auto-populates the field name as "Test_123". You can enter up to 58 characters in this field.

    Description

    Enter a description of the field. This description will appear as additional information about the field's purpose or usage when you enable the Info Icon for the field in CX Studio. To learn more about enabling the info icon, see Managing Content Details View.

    Data Type

    Description

    Default Value

    Enter or select a default value for the field, depending on the data type.

    Note:

    This field is only visible for Boolean, String, Currency, Date Time, Date, Picklist, MultiPicklist, Double, Decimal, Int, and Image data types.

    Picklist Name

    Picklist

    Search and select the pick list that you will use for this new field. For more information on how to create a pick list, see Pick Lists.

    Length

    String

    Enter the string length. The maximum length for the String data type is 2,000, and the maximum length for the LongString data type is 3,84,000.

    Precision

    Currency, Double, and Decimal

    Specify the total length of the value. The maximum precision value is 24.

    Note:

    The application enforces a maximum precision of 24 for formula fields. Any value you enter is automatically reset to 24. To define a specific precision, use the Round(field, value) function in your formula.

    Scale

    Currency, Double, and Decimal

    Specify the total number of digits after the decimal point. The maximum scale value is 23.

    Note:
    • This field is only used for display purposes for the Currency data type.

    • For formula fields, the application enforces a default scale of 5, which automatically resets any value you enter to 5. To define a specific scale, use the Round(field, value) function in your formula.

    AutoNumber Initial Seed

    AutoNumber

    Enter the initial seed value. You can also add a prefix.

    AutoNumber Prefix

    AutoNumber

    Enter the prefix to add to the initial seed value.

    For example, if you add PLI as a prefix and your initial seed value is 00001, the new record will have the incremental number with the PLI prefix, e.g. PLI-00001, PLI-00002, and so on.

    Complex Metadata Name

    Complex and Complex Array

    Search and select the complex metadata. Complex metadata is used to create a complex field by nesting multiple fields with different data types, such as strings or numbers, into a single field.

    For more information on creating complex metadata, see Complex Metadata.

    Reference Object Name

    Reference

    Search and select the object that this field refers to.

    Lookup Object Name

    Lookup

    Search and select the lookup object.

    Lookup Filter Criteria

    Lookup

    Click the Set button to define the filter criteria, allowing users to see only relevant options when selecting values. Based on the Lookup object selection, you can see fields for selection.

    Note:

    When another lookup field is available for the lookup object, only the Name and ID fields of the first-level lookup field can be used for filtering. For example, if a Primary Contact lookup field is available for the Account lookup object, you can only use the Name and ID fields of the Primary Contact for filtering.

    For example: The Agreement object has an account lookup field and you want analysts creating an agreement record to be able to select only accounts in which the "obligor" type is available for selection in the account lookup field. Set the account type to "obligor".

    On the Advanced Filter popup,
    • Click the Add Criteria option to define criteria on more fields. Once you have multiple criteria, you can include the logic in the Filter Expression section using the AND and OR operators.
    • Use the Delete icon to remove the individual criteria.
    • Use the Remove All link to remove all criteria.

    Target Object

    Rollup

    Search and select the object that the roll-up field value depends on. The system shows objects with reference fields that point to the parent object.

    Example: Roll-up from Quote Line Item to Quote.

    Let's say you want to roll up the total net price from all quote line items to the quote. In this case:

    • The quote is the parent object.

    • The quote line item is the child object with a reference field (QuoteId) linking it back to the parent quote. By selecting quote line item, you can configure the roll-up so the total from all line items automatically appears on the quote.

    Target Object Field

    Rollup

    Search and select the field within the target object to be used for computation.

    The target object field must have a double, integer, or decimal data type and have queryable, numeric, non-formula fields.

    Rollup Function

    Rollup

    Select the function that applies to the field that this field targets. This lists options according to the data type of the target object field.

    Is Sortable

    Enable this toggle to indicate that this field can be used as an order-by clause in search criteria.

    Note:
    • This field is enabled by default if you enable the Is Queryable field.
    • This field is visible for all data types except auto-number, long string, complex, and image types.

    Is Required

    Enable this toggle to make this field mandatory.

    Note:

    Except for Auto Number and Rollup, this field is visible for all data types.

    Is Rich Text

    LongString

    Enable this toggle to use rich text formatting with this field.

    Is Unique

    Enable this toggle to mark the field as unique. This prevents the creation of a new field with the same name.

    Note:

    This field is only visible for String, Currency, Reference, Double, Decimal, and Int data types.

    Is Queryable

    Enable this toggle to indicate that this field can be used in the where clause. Queryable fields can be used in order by clauses as well.

    Note:
    • When you enable this field, the Is Sortable field is enabled by default.
    • Except for Auto Number, Complex, Long String, and Image, this field is visible for all data types.

    Is Calculated

    Enable this toggle to indicate that this field is a formula field.

    Note:

    This field is only visible for Boolean, String, Currency, Date Time, Date, Reference, Double, Decimal, and Int data types.

    Formula

    Click Construct a formula here to open the Formula Builder, which allows you to create simple to complex expressions used to calculate field values for your object. For more information on how to create a formula field, see Formula Builder.

    Note:

    This field is only visible if you enable the Is Calculated toggle.

  6. Click Save & Create New to start creating a new field or click Save to save the created field.
A new field is creates to the object and becomes available for use in forms, workflows, and rules.

Editing a Field

As business requirements change, you may need to update a field to ensure it remains relevant and accurate. This can include modifying the display name, description, default value, or other configurable properties. This task walks you through accessing and editing an existing field in the system.

Note:

You cannot change a field's data type after you create it. If you need a different data type, you must create a new field.

  1. Click the More () icon for the relevant field from the list and select Edit.
  2. Modify the required fields as necessary.
  3. Click Save.
The field is updated with the changes you made. These updates are immediately reflected in the interface and apply to all users with access to the field.

Deprecating a Field

Over time, fields may lose relevant to active workflows. Instead of deleting them right away, you can deprecate these fields to prevent further use while preserving existing data. Deprecating a field ensures that historical information remains available for audits, reporting, or reference.

Note:

Only custom fields can be deprecated.

  1. Click the More () icon for the relevant field from the list and select Deprecate.
  2. From the confirmation dialog, click Confirm.

Deleting a Field

To maintain a clean and organized schema, you can delete unused or unnecessary fields from your workflows. Before doing so, ensure the field is not referenced in any object, rule, view, or record. Deleting a field permanently removes it and its associated data from the system, and cannot be undone. Be sure to review carefully before proceeding.

Note:

You cannot delete out-of-the-box (OOTB) fields. Only custom fields can be deleted.

  1. Click the More () icon for the relevant custom field from the list and select Delete.
  2. From the confirmation dialog, click Confirm