This section contains information about each of the Records Manager controls. The following tables provide additional details for several of the most common Records Manager controls.
Criteria Picker
Helps the user select one or more items from a validated metadata table, such as users, record status, or location types. In most instances, the list of available selections is controlled in Library Manager.
The following table lists the additional details for the criteria picker control.
Table: Criteria Picker Details
Properties | Default | Required Input | Description |
|---|---|---|---|
Relationship | Not Set | Required | This property needs to be set only for the parent table and not for the child table. For example, with custom metadata for State and City, set the relationship property only for the Criteria Picker for the State property. |
DoRequiredValidation | False | Required. But set false by default. | This ensures that this field is entered in the form. |
CriteriaType | NoCriteria | Required. This field needs to be set to one of the types in the drop-down list. | This specifies the type of metadata that'll be displayed in the picker. When adding an extended metadata property, select the object to which it belongs. For example, if you extended the file parts object with a new User property, set this field to User. |
EditBoxWidth | 218 | No | This allows the user to specify the width of the edit box in the control. |
FieldType | Integer | This required input must be set to Integer in most cases. | This specifies the data type of the field. For metadata tables, set this to Integer. When selecting properties within the metadata table, the system uses the ID (an integer) of the property. |
IncludeAllChildren | False | Not required. | Include all children for the search. This is specific to Criteria Picker controls for location properties in search forms. |
IsMultiValued | True | Required for multi-valued pickers. | This flag indicates that the picker will allow multi-selection. |
IsSingleValued | False | Required for single-valued pickers. | This flag indicates that the picker will allow single-selection. |
LookupButtonTabStop | True | Not required. | This ensures that the Tab stop is enabled for the lookup button on the picker. |
LookupVisible | True | Not required. | This ensures that the lookup button is visible. |
MultiValuedSeperator | ; | Not required. | This is used as a separator for multi-valued items. |
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value and will be used to display and modify the value. |
Profile | Not set | This is a required input. Select an item from the Assign a schema value dialog. | This specifies the metadata property related to the picker.
|
Display Format | True | This is required input. | When setting the User value of a CriteriaPicker, such as Responsible Attorney, the DisplayFormat appears by default as "UID <RDN>". You can customize this format to something different, such as "RDN <LastName, FirstName>" |
Date Range
Enables a user to select a date or date range. This control should be used only in search forms for the data type Date.
The following table lists all the additional details for the criteria picker control.
Table: DateRange Details
Properties | Default | Required Input | Description |
|---|---|---|---|
Required | False | Required. | This ensures that this field is entered in the form. |
EnableMacros | True | NA. | This enables and disables the selection of date macros like Today, Last Month, and This Year. |
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value. |
Profile | Not set | This is a required input. Select an item from the pop-up dialog—for example, Create Date. | This specifies the date property related to the picker. |
Search Location Picker
This control helps the user select a location, and sub-locations during searches.
The following table lists all the additional details for the location picker control.
Table: Search Location Picker Details
Properties | Default | Required Input | Description |
|---|---|---|---|
Required | False | Required. But set false by default. | This ensures that this field is entered in the form. |
IncludeAllChildren | False | No. | This ensures all children are included in the search. |
PickerLabel | Label: | No. | This specifies the label for the search location picker control. |
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value. |
Profile | Not set | This is a required input. Select an item from the pop-up dialog—for example, Current Location/Home Location. | This specifies the property related to the picker. |
Nullable Date Picker
This control helps the user select a date, but also to clear the date that was entered and leave the field blank. This control is appropriate for New and Edit forms to display and modify values for Date type properties.
The following table lists all the additional details for the nullable date picker control.
Table: NullableDatePicker Details
Properties | Default | Required Input | Description |
|---|---|---|---|
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value. |
Profile | Not set | This is a required input. Select an item from the pop-up dialog—for example, Open Date. | This specifies the property related to the picker. |
Validated Text Box
This control is useful for text type properties, and can require user input with simple settings.
The following table lists all the additional details for the validated text box control.
Table: ValidatedTextBox Details
Properties | Default | Required Input | Description |
|---|---|---|---|
IsRequired | False | Required. But set false by default. | This ensures that this field is entered in the form. |
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value. |
Profile | Not set | This is a required input. Select an item from the pop-up dialog—for example, Name. | This specifies the property related to the picker. |
Required Info | None | No | Sets the message displayed to the user when the required input isn't entered. |
Default Hint Text Box
This control helps users enter values like in any other text box, but it also displays a message to the user while it has no input. This can give the user information about the expected input—for example, "Enter a new ID here or one will be assigned.”
The following table lists all the additional details for the default hint text box picker control.
Table: DefaultHintTextBox Details
Properties | Default | Required Input | Description |
|---|---|---|---|
Required | False | Required. But set false by default. | This ensures that this field would be entered in the form. |
HintText |
| No. | This will give a hint to the user about the intended use of this control. |
Role | Value | This is a required input for setting the Profile property. | This specifies if the profile is a value. |
Profile | Not set | This is a required input. Select an item from the pop-up dialog. For example ID. | This specifies the property related to the picker. |
Default Value | None | No | This specifies the effective value if the user doesn't enter any value. |
MetadataSecurityPolicy
Lets a user select a membership policy for a client or matter.