Predefined constants in the System Library

Predefined constants appear in:

  • The Constants tab of the System Library.
  • The Rule Wizard > Expression tab > Constants tab in the System Library or in a study. Predefined constants do not appear in this location for user-created libraries.

When your Libraries Browser searches include the System Library, the predefined constants are included in the search.

In the Rule Wizard, when you drag a function to the Expression workspace, the Invoke Function dialog box appears. In the dialog box, you can expand the Constants tab, and drag the appropriate constant to the Value field for the parameter.

DateTimeParts constants—Use the following constants to specify a parameter in a predefined function that requires a date part. For example, the following functions include date part parameters:

  • _CalculateDateTime
  • _CompareDatesWithRange
  • _GetDateDifference
    Name Description Data type

    Years, Months, Days, Hours,

    Minutes, Seconds

    Date time part for years, months, days, hours, minutes, or seconds.

    Integer

FormStates constants—Use the following constants to specify a form state using HasState(Integer).

Name Description Data type

Deleted

(Available only for repeating forms) The repeating form instance has been deleted.

Integer

Frozen

The form is frozen.

Integer

HasComment

The form has a comment at the form level.

Integer

HasData

The form has data.

Integer

HasMissingData

The form has missing data.

Integer

HasQueries

The form has queries.

Integer

Locked

The form is locked.

Integer

SdvComplete

The form has been marked source verified.

Integer

SdvPartial

The form has been partially source verified.

Integer

SdvReady

The form has been marked ready for source verification.

Integer

Signed

The form has been signed.

Integer

Skipped

The form has been marked not completed with a form-level comment.

Integer

Started

The form was started with subject data, comments, or queries.

Integer