Form Editor

Fields can be defined in order to be used for different source-specific forms that are used for the Registration, Submission and Browse page.

For each source, a form can be defined, where different additional data sections can be collected. The sections consist of fields that can be defined by the system administrator.

Fields can be edited, deleted through the dropdown menu. Reordering (in and between the fields and the sections) or adding fields to the form is possible by drag and drop technique.

Forms

Forms can be configured in order to be used on the Registration, Submission and Browse pages.

Sections

Sections can be defined to group related fields together.

The following section types are available:

• Section: Each field appears in the section in the configured order;

• Collection: The values are displayed in a table with the field names in the table header. The fields in a collection are always stored as list.

Fields

The list of fields can be broadened, new fields can be defined.

• Field label

• Field identifier

• Input type

• Placeholder

• Default value

• Possible field values fetched from URL

• Possible field values

• Validation rules

• Levels and actions

• Generator and Generator Parameters

  • Chemical terms

  • User properties

Field label

The system administrator can set a name for the field that will be created.

Field identifier

A unique identifier must be given, but it won't be displayed anywhere.

Input type

The following field types are available:

• Single-line text

• Text area

• Select

• Select (typeahead)

• Select (editable)

• Password field

• Date field

• Link (URL)

• Checkbox

• On/Off toggle

If the default value for the date selector

• • is an empty string, the input box will remain empty

    • is an invalid date string, the input box will default to today's date

    • is a valid string date, the input box will convert the date to the desired format and display it

If the default value for the Checkbox and the On/Off toggle

• is an empty string, the checkbox/toggle will remain unchecked/off

• is a case insensitive variant of the 'false' value, the checkbox/toggle will remain unchecked/off

• is another valid string, the checkbox/toggle will be checked/on

{info} Select input types can be configured to use the new external dictionaries.

Placeholder

A short hint that describes the expected value of the input field.

Default value

A default value can be set for the field.

Possible field values fetched from URL

In the case of "Select" type inputs, a relative or absolute path can be specified here.

Possible field values

In the case of "Select" type inputs, a list of values can be added here.

Validation rules

The following validation rules are available:

• required

• int

• uint

• int32

• uint32

• float

• notzero

• positive

• dateTime: The provided date and time must be in the format specified in the general settings.

• validjson

• unique

• fromList

{info} Since CompReg version 19.12.0-1906121608 a new validator, "fromList" has been introduced to check if the value of the additional data is amongst the dictionary items. If the value is not present the compound falls to the staging area. This is useful for example to enforce the input of a valid "Project" field.

Levels and actions

• Store as list: The field can have multiple distinct values that can be added via a special list input on the Registration, Submission and Browse pages.

• Append data to version on match: If a new lot has been registered which is a match of an existing version, then the content of this configured field has been added to the version's field

• Append data to parent on match: If a new lot has been registered which is a match of an existing parent, then the content of this configured field has been added to the parent's field

Generator and Generator Parameters

Generated field ( e.g. IUPAC name, aromatic atom count or logS) can be used as additional data that are accompanying the registered compounds. When setting these field you always have to make sure that the field is stored on the correct level (parent, version or preparation). If you store the IUPAC name for version level, then the field will be always regenerated when a new version is created.

Please find a few generator examples below:

Chemical terms

ChemAxon's "chemicalterms" can be used as field generator. For the full list of chemical terms check out this page.

If you want to generate a IUPAC name, you can have to set chemicalterms as the generator and name("i") as the parameter:

User properties

If you want to generate a user property field during registration you have to create a field that uses the userproperty generator. The user property generator supports the built in user properties ( email, firstName, lastName, fullName, username ) and your custom user attributes synchronized from LDAP or AD. To read more on how to synchronize custom user properties from authentication providers read this page.

As an example if you want to capture the e-mail address of the user for each of your compound you have to configure a field using the following settings: