TimeWindow - smbc-digital/form-builder GitHub Wiki

The TimeWindow feature gives the developer the ability to release a form at a specific date and time or remove a form at a specific date and time.

Note: DateTime supplied must be in UTC.

Note: when EnabledFor is supplied the IsAvailable flag is obsolete

*NOTE - You can supply 'Start' and 'End' values or just one of the two values.

  • Only 'Start' date is provided, the form will only be available after that date.
  • Only 'End' date is provided, the form will only be available before that date.
  • Both values are provided, the form will be available only between the Start and End date.

DSL properties

Property Type Required Default Value Description
Type enum ✔️ Unknown Current List of EnabledFor types
Start DateTime ✔️❌ 0001-01-01T12:00:00 Date and time to release the form in UTC format
End DateTime ✔️❌ 9999-12-31T11:59:59 Date and time to disable the form in UTC format

NOTE: DateFormat is ISO 8601

NOTE: Dates are in UTC

Example

 "EnvironmentAvailabilities": [
    {
      "Environment": "local",
      "EnabledFor": [
        {
          "Type": "TimeWindow",
          "Properties": {
            "Start": "2021-05-18T01:00:00",
            "End": "2022-05-18T01:00:00"
          }
        }
      ]
    }
  ]