Creating new Custom Fields (AKA: User Defined Fields)

Purpose: Custom Fields (or user-defined fields) can be utilized within Portfolio Audit, custom Reports, and Queries by firms to add fields not previously available. They help organize and track unique values or identifiers for the Representative, Household, Registration, Account, and Product levels. Below you will find steps on how to create Custom Fields.

Simple Use Case: A firm tracks several notable details about their clients for which Orion does not have a specific field. They would like to include those details on an Orion Household for tracking and plan to update this through the API. They create a NEW Custom Field and set up a form within a process to update these fields within Orion.

Scope and Outputs: This workflow will step through creating NEW Custom Fields. It is recommended to create the Custom Fields in the UI, however, you can also create these via the API.

To download the Creating Custom Fields help document, click https://api.orionadvisor.com/orionconnectapp/index.html?orionSupportRedirect=%2Fs%2Farticle%2FCreating-Custom-Fields

Process Overview:

Determine what entity this new Custom Field will be tied to and then send the corresponging data in a payload for the creation of your new Custom Fields.

Process Steps:

1. Determine for which entity in Orion this new Custom Field is being created.

2. Create a payload that provides data for the entity, code, default value, description (name), options, type, sequence, pages to include (where applicable), and time sensitivity.

3. POST payload to /Settings/UserDefinedFields/Definitions/{entity:userDefinedOptionLevel}

Example of a payload sent to create new Client/Household level option POST: /Settings/UserDefinedFields/Definitions/client

{"entity":"Household",
"code":"test11",
"defaultValue":"test11",
"description":"APItest11",
"options":[],
"type":"Multi-line editor",
"sequence":24,
"pageCodes":["ClientDto","BillClientDto","GroupingViewClientDto"],
"isTimeSensitive":false,
"category":"No Category"}

Process Tips or Controls:

The Type can be one of the following:

Multi-Line Editor : open text field for longer explanations;
List: list of the available options to choose from;
Check Box: Creates True/False option;
Currency: dollar value; Date: specific date;
Date/Time: specific date and/or time;
Integer: Numerical value;
String: Open field;
Double: Numerical value;
Time: Hours and minutes;
Long: Numerical value

2. The pageCodes for each entity are listed below.
Household/Client pageCodes: ClientDto; BillClientDto; GroupingViewClientDto
Registration pageCodes: RegistrationDto; BillRegistrationDto; GroupingViewRegistrationDto
Account pageCodes: AccountDto; BillAccountDto; GroupingViewAccountDto; NewPortfolioAccountDto; RmdDashboardDto
Product pageCodes: LocalProductDto

3. When creating a list type, include the list in the options section of the payload as shown in the example.

"options":[{"isDefault":true,"listValue":"test list","sequence":1},{"isDefault":false,"listValue":"test list 2","sequence":2}]

Development Guides

Creating new Custom Fields (AKA: User Defined Fields)