Skip to main content
Kinetic Community

Submission Model

The submission object represents the Submission that is being accessed. Many of the properties and methods are accessible within the bundle.

Properties

anonymous

Indicates whether the submission will capture the username in the metadata fields (closedBycreatedBysubmittedBy, andupdatedBy) or not. If the submission is set to anonymous, the ‘anonymous’ username will be stored in the metadata fields. Returns true if the anonymous, otherwise false.

${submission.anonymous}

closedAt

The date/time the submission was closed. This value will be null if the submission hasn’t been closed yet. The value is relative to UTC.

${submission.closedAt}

closedBy

The username of the User that closed the submission. This value will be null if the submission hasn’t been closed yet. This value will be the internal anonymous user ‘anonymous’ if the submission is marked as anonymous.

${submission.closedBy}

coreState

Indicates the state of the submission. The value will be one of the three available submission state values:

  • Draft - all pages haven’t been processed, or the submission is in a ‘Save for Later’ state.
  • Submitted - which means all pages have been processed, but post-submission processing in not yet finished.
  • Closed - which means all post-submission processing has been completed.

    ${submission.coreState}

createdAt

The date/time the submission was created. The value is relative to UTC.

${submission.createdAt}

createdBy

The username of the User that created the submission. This value will be the internal anonymous user ‘anonymous’ if the submission is marked as anonymous.

${submission.createdBy}

currentPage

The Page object that is currently being displayed.

${submission.currentPage}

currentPageIndex

The index value in the list of Page objects that make up the form the submission belongs to of the current page being displayed.

${submission.currentPageIndex}

form

The Form the submission belongs to.

${submission.form}

label

The label for the submission as defined on the submissionLabelExpression Form property. Default is to use the submission id, which is a time based UUID value.

${submission.label}

submittedAt

The date/time the submission core state was set to submitted. This value will be null if the submission hasn’t been submitted yet. The value is relative to UTC.

${submission.submittedAt}

submittedBy

The username of the User when the submission core state was set to submitted. This value will be null if the submission hasn’t been submitted yet. This value will be the internal anonymous user ‘anonymous’ if the submission is marked as anonymous.

${submission.submittedBy}

updatedAt

The date/time the submission was updated. The value is relative to UTC. NOTE: This value will be set to the createdAt date/time value when the submission is created.

${submission.updatedAt}

updatedBy

The username of the User that updated the submission. This value will be the internal anonymous user ‘anonymous’ if the submission is marked as anonymous. NOTE: This value will be set to the createdAt value when the submission is created.

${submission.updatedBy}

values

A list of submitted field values (answers). Each field value is represented as a String, and complex field values will use the JSON form.

${submission.values}

valuesMap

A map (hash or dictionary) of submitted field values (answers), with the name of the field as the key, and the field value as the value.

${submission.valuesMap}

Methods

getValue(fieldName)

Returns the field value (answer) for the field on the form identified by the fieldName parameter. The field value is represented as a String, and complex field values will use the JSON format.

${submission.getValue(fieldName)}

Related