Extended Field
Overview¶
Place an input field on the screen that does not exist in the standard function. It has the function of adding any input field to the Filter of the Screen Index.
Limitations¶
- After updating the JSON file of the extended field, it will not be reflected until "Restart The Application".
Setting Method¶
Create a JSON file containing the following contents under .¥Pleasanter¥App_Data¥Parameters¥ExtendedFields¥ and "Restart The Application". The file extension must be json. It is possible to organize the hierarchy under ExtendedFields with folders. In this case, all JSON files under it will be loaded as configuration files.
Parameter List¶
The parameters to specify in the JSON file are as follows.
| Parameter name | Type | e.g. | Description |
|---|---|---|---|
| Name | string | "ExtendedField" | Specify the name of the extended function. |
| SpecifyByName | bool | false | Specify true if you want to specify the name of the extended function from the server script. |
| Description | string | "Sample" | Describe the description of the extension. |
| Disabled | bool | false | Specify true to disable the extension. |
| DeptIdList | List\ | [ 5 ] | Specify the dept ID if you want the extension to work only for a specific department. |
| GroupIdList | List\ | [ 12 ] | Specify group ID if you want the extension to work only for a specific group. |
| UserIdList | List\ | [ 3 ] | Specify the user ID if you want the extension to work only for a specific user. |
| SiteIdList | List\ | [ 115 ] | Specify site ID if you want the extension to work only for a specific site. |
| IdList | List\ | [ 87 ] | Specify the record ID if you want the extension to work only for a specific record. |
| Controllers | List\ | [ "items" ] | Specify the controller name if you want the extension to work only for a specific controller. |
| Actions | List\ | [ "index" ] | Specify the action name if you want the extension to work only for a specific action. |
| ColumnList | List\ | [ "ClassX" ] | Specify the column name if you want the extension to work for a specific column. |
| FieldType | string | "Filter" | Specify the placement area for the column to be added with the extended field function. See the FieldType list below for possible values. |
| TypeName | string | "nvarchar" | Specify the type of column to be added with the extended field function. Possible values are bit, int, long, decimal, float, datetime, nchar, and nvarchar. |
| LabelText | string | "sample label" | Specify the label of the column to be added with the extended field function. |
| ChoicesText | string | "A\nB\nC" | Specify the option list for the class column to be added with the extended field function. This parameter is valid when ChoicesText is set in ControlType. |
| DefaultInput | string | "default value" | Specify the default value for the column added with the extended field function. |
| EditorFormat | string | "Ymdhm" | Specify the display format for the date column added with the extended field function. |
| ControlType | string | "Spinner" | Specify the control type for the column added with the extended field function. See the ControlType list below for specifiable values. The specifiable values are TextBox, Id, Slider, Spinner, Attachments, MarkDown, and ChoicesText. |
| ValidateRequired | bool | false | Specify true for the column added with the extended field function to require input. |
| ValidateNumber | bool | false | Specify true to validate the numeric value input of the column added with the extended field function. Check whether the input value is a numerical value. |
| ValidateDate | bool | false | Specify true to validate the date input of the column added with the extended field function. Check whether the input value is a date. |
| ValidateEmail | bool | false | Specify true if you want to validate the email input of the column added with the extended field function. Check whether the input value is an address. |
| MaxLength | decimal | 100 | Specify the maximum number of characters that can be entered in the column added with the extended field function. |
| ValidateEqualTo | string | "#Sample" | Specify the element to be compared with the column added with the extended field function. Check whether the added column's value and the compared element's value are equal. |
| ValidateMaxLength | int | 50 | Specify a numerical value if you want to validate the number of input characters of the column added with the extended field function. Check whether the input value is within the specified number of characters. |
| DecimalPlaces | int | 3 | Specify the number of decimal places to display for the numerical value column added with the extended field function. |
| Nullable | bool | false | Specify true if you want to allow NULL for the column added with the extended field function. |
| Unit | string | "yen" | Specify the unit of the column added with the extended field function. |
| Min | decimal | 0 | Specify the minimum value of the numerical value column added with the extended field function. |
| Max | decimal | 1000 | Specify the maximum value of the numerical value column added with the extended field function. |
| Step | decimal | 2 | Specify the number of steps when the ControlType of the numerical value column added with the extended field function is set to Spinner. |
| AutoPostBack | bool | false | Specify true if you want to use automatic postback for the column added with the extended field function. |
| FieldCss | string | "sample-field-css" | Specify the field CSS of the column added with the extended field function. |
| CheckFilterControlType | int | 1 | Specify the control type of the check column added with the extended field function. See the CheckFilterControlType list below for the values that can be specified. |
| DateTimeStep | int | 10 | Specify the time interval (minutes) of the date column added with the extended field function. |
| ControlCss | string | "sample-control-css" | Specify the field CSS of the column added with the extended field function. |
| After | string | "ClassA" | Specify which column in the filter to add after using the extended field function. |
| SqlParam | bool | false | Specify true if you want to use the input value of the column to be added using the extended field function in extended SQL. |
FieldType List¶
The following values can be specified for the parameter FieldType.
| Value | Description |
|---|---|
| Filter | The column is added within the filter. |
| ViewExtensions | The column is added outside (below) the filter. |
CheckFilterControlType List¶
The following values can be specified for the parameter CheckFilterControlType.
| Value | Description |
|---|---|
| 1 | Specify only when "on". |
| 2 | Specify if "on" and "off". |
Code Samples¶
In the example below, the "Client Name" column is added after ClassA (ClassA) in the filter on the Screen Index for site ID: 12345
JSON¶
{
"SiteIdList": [ 12345 ],
"Name": "ClientName",
"FieldType": "Filter",
"TypeName": "nvarchar",
"LabelText": "ClientName",
"After": "ClassA",
"SqlParam": true
}