Skip to content

Column Advanced Settings: Option List: Filter, Sort, Display Format

Overview

You can use a customized list of options by writing the "Option List" in JSON format.

Limitations

  1. Cannot be used with columns other than "Owner Column", "Manager Column", and "Class Column".

Prerequisites

  1. "Site Administration Permission" is required to configure settings.

Operation Procedure

Open the advanced settings of the classification in the Editor tab, and write the display method of the options in JSON format in the option list.

For Depts, Groups, and Users

Column name Description
TableName Specify Depts, Groups, and Users to display departments, groups, and users in the option.
MembersOnly Used when Depts, Groups, and Users are specified. Only departments, groups, and users granted access rights are displayed.
SearchFormat Specify the display format when "Use Search Function" is enabled.
View: ColumnFilterHash Use "JSON Data Layout: View" to filter and display options by specific columns. The filter value can be specified as a constant.
View: ColumnFilterExpressions Use "JSON Data Layout: View" to filter and display options by specific columns. The filter value can be specified as a constant.
View: ColumnSorterHash Use "JSON Data Layout: View" to sort and display options by specific columns.

Option List field of a class column's advanced settings, where the JSON is written

The following example displays a list from the user table in the format "Name - Dept", then department and name in ascending order.

JSON
[
    {
        "TableName": "Users",
        "MembersOnly": true,
        "SearchFormat": "[Name] - [Dept]",
        "View": {
            "ColumnSorterHash": {
                "DeptCode": "asc",
                "Name": "asc"
            }
        }
    }
]

The following example displays a list from the user table in the format of "Name - Email Address", in ascending order of name.

JSON
[
    {
        "TableName": "Users",
        "SearchFormat": "[Name] - [MailAddresses]",
        "View": {
            "ColumnSorterHash": {
                "Name": "asc"
            }
        }
    }
]

The following example extracts and displays users belonging to the specified department code from the user table.

JSON
[
    {
        "TableName": "Users",
        "MembersOnly": false,
        "SearchFormat": "[Name] - [Dept]",
        "View": {
            "ColumnFilterHash": {
                "DeptCode":"[\"200600\",\"200610\",\"200620\"]"
            },
            "ColumnFilterSearchTypes":{
                "DeptCode": "ExactMatchMultiple"
            }
        }
    }
]

The following example extracts and displays users belonging to a specified group ID from the user table.

JSON
[
    {
        "TableName": "Users",
        "View": {
            "ColumnFilterHash": {
                "Groups": "[1,2]"
            }
        }
    }
]

Example of Display in Search Dialog

Displayed in the format specified in SearchFormat: "[Name] - [Dept]".
Search dialog showing options in the name and department format specified by SearchFormat

Column name Description
SiteId Specify the site ID of the linked table.
Priority You can use the "Link" function to control the display order of linked tables.
NoAddButton Specify true if you want to hide the create button for the linked column. This column is optional.
SearchFormat Specify the display format when "Use Search Function" is enabled. This column is optional.
View: ColumnFilterHash Use "JSON Data Layout: View" to filter the options by a specific column and display them. The filter value can be specified as a variable. This column is optional.
View: ColumnFilterExpressions Use "JSON Data Layout: View" to filter the options by a specific column and display them. The filter value can be specified as a variable. This column is optional.
View: ColumnSorterHash Use "JSON Data Layout: View" to sort the options by a specific column and display them. This column is optional.
Lookups Use the "Lookup" function to post columns. This column is optional.

In the example below, a list is displayed in ascending order by title for records with CheckA turned on in the table with site ID: 12345. When a value is selected, the linked ClassA is posted to ClassB, and the linked ClassB is posted to ClassC.

JSON
[
    {
        "SiteId": 12345,
        "NoAddButton": false,
        "View": {
            "ColumnFilterHash": {
                "CheckA": true
            },
            "ColumnSorterHash": {
                "Title": "asc"
            }
        },
        "Lookups": [
            {
                "From": "ClassA",
                "To": "ClassB",
                "Type": 0
            },
            {
                "From": "ClassB",
                "To": "ClassC",
                "Type": 0
            }
        ]
    }
]

When you do not want to include yourself or your department in the option

You can exclude yourself and your department from the options by specifying ExcludeMe in the JSON of the option list.
Use this when you do not want the logged-in user to be selected as the approver in an approval workflow using a process button, etc.

JSON
[
    {
        "TableName": "Users",
        "ExcludeMe": true
    }
]
Notes

If you specify [[Self]] as the default value for the editor settings, you and your department will be set, so as a general rule, do not specify it.
FAQ: How to use user, dept, and group options in classification columns

Hide the login user/affiliated department setting button by setting the style "display: none;" or similar.
Manage Table: Editor: Column Advanced Settings: Option List: Login User Settings Button

How to Specify ColumnFilterExpressions

For information on how to specify ColumnFilterExpressions to narrow down the option list by the value of another column, please refer to the following manual.

Manage Table: Editor: Column Advanced Settings: Option List: Filter (narrow the option list by the value of other columns)