Field Definition Behaviour Settings

These settings control how a Field in an object behaves.

Additional Submitters Grouping Field

Sometimes, it can be useful to grant users, other than the submitter, access to certain submissions.

The Additional Submitters Grouping Field can be used to allow submitters of submissions with a common field value to see all the submissions with that common value.

Example

Submitters needs to be able to see all submissions that have the same value for the CompanyName field as the CompanyName value for their own submission.

Use this setting to control which users are granted the Submission Additional Submitter Role

All submitters for submissions that share the same value for the Field will have the Submission Additional Submitter Role applied for those submitters to those submissions.

Note

This settings is required when using Validated Content Sharing.

Warning

It is recommended that this is only applied to a Field Definition that is Read Only for Submitters, otherwise submitters will be able to gain access to submissions by editing the field value.

Example A Field Definition called CompanyName has the Additional Submitters Grouping Field turned on.

Submitter A of Submission 0001 has a CompanyName of Firebird
Submitter B of Submission 0002 has a CompanyName of Firebird
Submitter C of Submission 0003 has a CompanyName of Microsoft

Submitter A is granted the Submission Additional Submitter role on Submission 0001 and Submission 0002 but not Submission 0003
Submitter B is granted the Submission Additional Submitter role on Submission 0001 and Submission 0002 but not Submission 0003
Submitter C is granted the Submission Additional Submitter on Submission 0003 but not Submission 0001 nor Submission 0002

Object Types Data Types
Submission Multiple Choice

Allow File Overwrite

Allows the last file (within the range) to be overwritten when a new file is uploaded. Without this sett!!! failure "Not Finished" This section has not been completed.

Object Types Data Types
Submission File

Display Time Zone

Control the time zone for date times displayed to a user.

Stored

Display and edit in the same time zone that the field is stored in (See Time Zone).

All users will see exactly the same time irrespective of their own Time Zone.

Example

12/06/2020 08:00

Stored Plus Name

Same as Stored but with the name of the Time Zone added to the end

Example

12/06/2020 08:00 Pacific Standard Time

The time zone name is added to the end when both displaying and editing the datetime.

UTC

Display and edit in UTC.

All users will see exactly the same time irrespective of their own Time Zone.

Example

12/06/2020 15:00

UTC Plus Name

Same as UTC but the text UTC is added to the end

Example

12/06/2020 15:00 UTC

The UTC text is added to the end when both displaying and editing the datetime.

Local

Display and edit in the user's own timezone irrespective of the timezone it is stored in.

Example

09:00 UTC will display as 04:00 to a user in New York but as 10:00 to a user in Paris

No timezone information is displayed to the user.


Note

If the Display Time Zone is not set then the system will default to using Local.

For most scenarios, Local is the best choice so that users always see the date and time in their own Time Zone.

For some scenarios, using Stored Plus Name will ensure that all users see exactly the same time and that there is no ambiguity for the time.

Example

Programme times are normally displayed as Stored. This means that users can see the actual times at the venue.
However, for a live virtual event that is accessed from around the world, programme times should be
displayed as Local so that users can easily determine when different sessions start/end.

Daylight Savings

The TimeZone automatically adjusts for Daylight Savings Time. So if you enter a date in the summer months then it should be entered as the Daylight Savings Time.

Example

Entering a DateTime of 5th June 2020 8:00pm into a field marked as GMT Standard Time will automatically enter it as GMT Daylight Time

When a DateTime is displayed as Stored Plus Name then the correct winter or summer label will also be displayed

Example

5th Jun 2020 8:00pm will be displayed as 5th Jun 2020 8:00pm GMT Daylight Time
5th Jan 2020 8:00pm will be displayed as 5th Jan 2020 8:00pm GMT Standard Time

Object Types Data Types
All DateTime, Time

File Name Template

Allows setting a custom File Name Handlebars Template to be used for files uploaded to the objects from the selected type

Example

{{OwnerType}} {{FileId}} {{Project.Code}} {{Submission.ReferenceNumber}} {{FieldDefinition.Name}} {{OriginalFileName}}

The correct extension will be added automatically.

See How to use File Name Templates for more information.

Object Types Data Types
Project Single Line Text

Format String

DateTime fields can be formatted to display the date and time in any format

Example

12/11/2020 8:56 PM
Thur, 12 Nov 20:56
Thur 12 8:56PM

By default, DateTimes are displayed in the Locale of the user's browser using the ll LT format.

Tip

Format Strings only control the format when a datetime is displayed and not when it is edited.

Type Token Example
Month M 1 2 ... 11 12
Mo 1st 2nd ... 11th 12th
MM 01 02 ... 11 12
MMM Jan Feb ... Nov Dec
MMMM January February ... November December
Quarter Q 1 2 3 4
Qo 1st 2nd 3rd 4th
Day of Month D 1 2 ... 30 31
Do 1st 2nd ... 30th 31st
DD 01 02 ... 30 31
Day of Year DDD 1 2 ... 364 365
DDDo 1st 2nd ... 364th 365th
DDDD 001 002 ... 364 365
Day of Week d 0 1 ... 5 6
do 0th 1st ... 5th 6th
dd Su Mo ... Fr Sa
ddd Sun Mon ... Fri Sat
dddd Sunday Monday ... Friday Saturday
Day of Week (Locale) e 0 1 ... 5 6
Day of Week (ISO) E 1 2 ... 6 7
Week of Year w 1 2 ... 52 53
wo 1st 2nd ... 52nd 53rd
ww 01 02 ... 52 53
Week of Year (ISO) W 1 2 ... 52 53
Wo 1st 2nd ... 52nd 53rd
WW 01 02 ... 52 53
Year YY 70 71 ... 29 30
YYYY 1970 1971 ... 2029 2030
Y 1970 1971 ... 9999 +10000 +10001
Era Year y 1 2 ... 2020 ...
Era N, NN, NNN BC AD
Note: Abbr era name
NNNN Before Christ, Anno Domini
Note: Full era name
NNNNN BC AD
Note: Narrow era name
Week Year gg 70 71 ... 29 30
gggg 1970 1971 ... 2029 2030
Week Year (ISO) GG 70 71 ... 29 30
GGGG 1970 1971 ... 2029 2030
AM/PM A AM PM
a am pm
Hour H 0 1 ... 22 23
HH 00 01 ... 22 23
h 1 2 ... 11 12
hh 01 02 ... 11 12
k 1 2 ... 23 24
kk 01 02 ... 23 24
Minute m 0 1 ... 58 59
mm 00 01 ... 58 59

Locale Formats

Users in different countries expect to see DateTimes displayed differently.

Example

In the USA, months are displayed before dates. In the UK, dates are displayed before months

By using the Locale formats, the browser will automatically display the standard way for the user.

Type Token US Example UK Example
Time LT 8:30 PM 20:30
Month numeral, day of month, year L 09/18/2020 18/09/2020
l 9/18/2020 18/9/2020
Month name, day of month, year LL September 18, 2020 18 September 2020
ll Sep 18, 2020 18 Sep 2020
Month name, day of month, year, time LLL September 18, 2020 8:30 PM 18 September 2020 20:30
lll Sep 18, 2020 8:30 PM 18 Sep 2020 20:30
Month name, day of month, day of week, year, time LLLL Friday, September 18, 2020 8:30 PM Friday, 18 September 2020 20:30
llll Fri, Sep 18, 2020 8:30 PM Fri, 18 Sep 2020 20:30

By default, DateTimes are displayed in the Locale of the user's browser using the ll LT format.

Example

US: Sep 18, 2020 8:30 PM
UK: 18 Sep 2020 20:30

Object Types Data Types
All DateTime

Label

When an object, like a Submission, is displayed in a page or other places, it needs a heading that summarises what the submission is.

Example

A submission for an academic conference may have a Title
An award application may have the Nominee Name

An object will use all Fields that have a Field Definition with the Label set to produce the label.

If a Data Definition has more than one Field Definition with the Label setting then all of those Field Definitions will be used when determining the Label for an object.

The text in the field's will be concatenated together to form the label.

Example

A submission has a Title and Topic field. These are both marked as Label and so both are used when displaying a heading for the submission.

Note

The label is used in other places too e.g. Programme Editor, Mobile App to provide a short label for the object that makes it easy to identify the object.

Warning

At least one Field Definition should have the Label setting to avoid unusual results.

Object Types Data Types
Any Any

Maximum Submissions Per Submitter

This setting limits the number of Submissions per Submitter per value of the multiple choice field.

Example

A multiple choice field called Track has the options Track A, Track B and Track C and this setting is applied with a value of 1. Each submitter will only be allowed to add up to three submissions. One with Track = Track A, one with Track = Track B and one with Track = Track C. The could not add two submissions with Track = Track A etc.

Object Types Data Types
Submission Multiple Choice

Project Error Email Address

This setting enables a project field to specify an email address that will be sent error reports when they occur in the project.

This setting is useful when testing out Integrations in a project and feedback is needed.

Example

When setting up Single Sign On, user details need to be put into the correct order and correctly hashed in order to be accepted by the Firebird software. The error email will help identify problems in the data being sent to the Firebird software.

Object Types Data Types
Project Single Line Text

Publish Filter

This setting is available for MultipleChoice fields that are displayed in the Online Programme.

It will make the Filter in the Online Programme display this field in the Filter toolbox so that the content on screen can be filtered out.

Object Types Data Types
Submission
Contributor
Submission Contributor
Location
Participant
Entry
Attendee
Organisation
Multiple Choice

Using this setting you can allow submitters to link their submission to other submissions.

Example

You have Submission Types called 'Symposium' and 'Submission'. You add a field called 'LinkedSymposium' to your 'Submission' Data Definition with this Submission Link setting set to linking 'Symposium'. Then submitters can choose their 'Symposium' in the 'Submission'.

The available submissions in the list is automatically created based on what submissions the user has permissions to view. You can add static options which will be displayed before the submissions.

Object Types Data Types
Submission Multiple Choice
Multiple Select

Use this setting to link a Field Definition to a Submission Status.

Each Field Definition can be linked to zero, one or more statuses.

The Status Link is used for:

  • Completeness
  • Validation

Both a submission and review need to determine if they have been Completed or not.

Submission Completeness

For a submission, this means determining if the submission has been completed for its current status. Different fields can be configured to control completeness at different stages

Some fields need to be completed when the submission is one one status but different fields need to be completed at other statuses.

Example

The Abstract field needs to be complete when the submission is in Abstract status. The Paper field needs to be complete when the submission is in Paper status.

Any fields that are linked to the current status of the submission are checked when determining if the submission is complete or not (for that status).

Review Completeness

Each review is for a single submission. Each review is linked to a submission status (See Review Linked Submission Status).

If a field has a Status Link that matches the review's linked submission status then the field is are checked when determining if the review is complete or not.

Example

The Abstract Score field is linked to the Abstract Review submission status
The Paper Score field is linked to the Paper Review submission status

This is useful when a review is used in more than one round of reviewing. The review can contain one set of fields used in the first round and another set of fields used in subsequent rounds.

In this way, a review can be used for multiple rounds without having to re-assign reviewers and create new reviews.

Validation

Field Validation can also be applied for certain submission statuses.

Example

Paper field could be optional when the submission is in Abstract status
Paper field could be mandatory when the submission is in Paper status

Status Linked Validation can be applied to both submissions and reviews.

Object Types Data Types
Submission
Review
Any

Time Zone

The Time Zone setting enables you to select the time zone for storing a DateTime.

By default DateTime fields are stored in Coordinated Universal Time (UTC) but it is possible to store DateTimes in any timezone around the world.

Example

Pacific Standard Time

Once stored, a DateTime can be displayed and edited in either this Stored TimeZone, UTC or the Local timezone of the user's browser.

Timezones automatically adjust for Daylight Savings so if you are entering a DateTime in the summer months, enter the Daylight Savings Time. See Daylight Savings.

Object Types Data Types
All DateTime

Comments