Recurrence Fields

Recurrence Record

Field	Id	Type	Options	Description	Visible on Instances
Type	custrecord_nx_recurrence_type	List/Record	Daily,Weekly, Monthly, Yearly	Defines whether a recurrence in Daily, Weekly, Monthly, or Yearly. If set to nothing, the recurrence is not created	Always
Interval	custrecord_nx_recurrence_interval	Integer Number	—	Defines the interval between instances	Always
Month	custrecord_nx_recurrence_month	List/Record	January, February, March, April, May, June, July, August, September, October, November, December	Defines which month the recurrence will occur in	When the ‘Type’ field is set to ‘Yearly’
Month Pattern	custrecord_nx_recurrence_month_pattern	List/Record	Day, First, Second, Third, Fourth, Last	If set to Day, the recurring instances' start dates will be set to the particular day of the month eg: 6th, 13th, 25th…The other options define the day of the week the recurrence instances start dates will be set to. eg: First Monday, Second Thursday, Fourth Tuesday….	When the ‘Type’ field is set to ‘Monthly’ or ‘Yearly’
Day of Month	custrecord_nx_recurrence_day_of_month	Integer Number	—	Defines the day of the month the recurrence instances start dates will be set to. Eg: 6th, 13th, 25th…Validated to a valid day of the month dependent on which month, if any, is selected. If no month is selected it must be a number between 1 and 31	When the ‘Month Pattern' is set to Day
Day of Week	custrecord_nx_recurrence_day_of_week	Multiple Select	Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday	Defines the day of the week that the recurrence instances start dates get set to. eg: Wednesday, Thursday, Friday…	When ‘Type’ is set to ‘Weekly’ or when ‘Month Pattern’ is set to ‘First’, ‘Second’, ‘Third’, ‘Fourth’ or ‘Last’
Start Date	custrecord_nx_recurrence_start_date	Date	—	Defines the date that the recurrence will start creating instances from. Set to the primary instance's start date.	No
End Type	custrecord_nx_recurrence_end_type	List/Record	None, After, By	Defines when the recurrence will stop creating instances. If set to ‘None’ will indefinitely create instances. If set to ‘After’ will stop creating instances when the number of instances created equals the value of ‘End Count.’ If set to ‘By’ will stop creating instances when the date is equal to the date set in ‘End Date.’	Always
End Date	custrecord_nx_recurrence_end_date	Date	—	Used in conjunction with ‘End Type' being set to 'By’. Defines the date the recurrence will stop creating instances.	When ‘End Type’ is set to ‘By’
End Count	custrecord_nx_recurrence_end_count	Integer Number	—	Used in conjunction with ‘End Type’ being set to ‘After’. Defines the maximum number of instances that will be created by a recurrence.	When ‘End Type’ is set to ‘After’
Last Create Date	custrecord_nx_recurrence_lst_create_date	Date/Time	—	Defines the last time instances where created for this record. Is uses in scheduled scripts to indicate when to create the next batch of recurrences.	No
Create/Update Instances	custrecord_nx_recurrence_update	Check Box	—	When ticked, triggers the scheduled script to check if instances need updating or creating.	No
Deleted Instances	custrecord_nx_recurrence_deleted	Text Area	—	Tracks the indexes of instances that have been deleted in a series. These instances will not be recreated.	No
Created From	custrecord_nx_recurrence_created_from	List/Record	—	Tracks the link between recurrences when a recurrence is copied.	No
Primary Type	custrecord_nx_recurrence_primarytype	Free-Form Text	—	Defines the record type of instances. Set to the primary instance's type.	No
For Deletion	custrecord_nx_recurrence_for_deletion	Check Box	—	If ticked, the schedule script will delete this recurrence.	No
Idempotency Key	custrecord_nx_recurrence_idempotency_key	Free-Form Text	—	Used to determine whether a recurrence update/create job has been completed.	No

Instance Fields

Field	Id	Type	Description
Field Service Recurrence	Task/Case: custevent_nx_recurrence	List/Record	Holds the link to the recurrence record.
Field Service Instance Index	Task/Case: custevent_nx_recurrence_index	Integer Number	Defines the sequence number of the current instance.
Field Service Exempt Sync	Task/Case: custevent_nx_recurrence_exempt	Text Area	Tracks any fields that are edited on the current instance that the user did not want to copy to future instances. Prevents these fields from being overwritten when the recurrence record updates the instances.
Field Service Recurrence Updates	Task/Case: custevent_nx_recurrence_updates	Text Area	Holds the JSON data of updates that are to be applied across the series.
Field Service Propagate Changes	Task/Case: custevent_nx_recurrence_propagate	Check Box	If ticked, triggers the scheduled script to copy the update data to future instance in the series.
Field Service Propagate Complete	Task/Case: custevent_nx_recurrence_propcomplete	Check Box	Used by the scheduled script to determine if a propagation has been completed and the updates field can be cleared.
Field Service Delete Future Instances	Task/Case: custevent_nx_recurrence_delete	Check Box	Tick via the ‘Delete Future Instances’ button and triggers the scheduled script to delete all future instances including the current one and end the recurrence.
Field Service Recurrence Data	Task/Case: custevent_nx_recurrence_data	Long Text	Hold the JSON data for recurrence updates.
Field Service Copy with Parent	Task/Case: custevent_nx_recurrence_copy	Check Box	Not Yet Implemented

General Notices