WorkZone

Property NameProperty ValueProperty Description
DisplayAsStringGets or sets DisplayAs field value.
Asset{Location entity reference}Root of work zone's asset tree; references InvItemObject.ID.
TimeZoneIntegerTime zone ID used by all work orders and other objects associated with work zone.
LanguageIdIntegerUsage is not clear.
WoNumberPrefixStringUsed as WO number prefix when creating the Work Order.
EntityStringIdentifies larger entity Work Zone belongs to; used by integration and by JLL WON setup (aggregator instance keeps requestor name in that field).
SchedulingWindowIntegerScheduling/appointment window size in minutes. Supported values are 15 - 1440 (i.e. up to 24 hours).
NoIncompleteProcedureBooleanBoolean flag. True means WOs with incomplete punch list are not allowed to be completed.
AccessOptionsMaskIntegerBitmask defining what access/PTE options are allowed for Work Zone; each bit matches PTEType enumeration value (except Unknown). Zero value is not allowed.
NumberStringNumber (often used as integration key). This value is either empty or unique.
AdvanceNoticeIntegerNumber of hours from current date/time that the first appointment may be scheduled. Supported values are 0 - 240 (up to 10 days).
TaxRegion{TaxRegion entity reference}Tax Region ID, optional. References DefTaxObject.ID.
WoNumberDigitsIntegerNumber of digits in WO number numeric suffix. Supported values are 1 - 10.
RoundApptTimeToIntegerDefines appointment time rounding value in minutes (i.e. "round appointment start time to closest X minutes"). Supported values are 15, 30 and 60.
WorkPlanAutoCancelBooleanBoolean flag; True means child WOs will be automatically cancelled when their parent or root are cancelled.
WorkPlanChildResolutionBooleanBoolean flag; True means work plan root WO cannot be completed until it has pending child WOs (e.g. not completed/cancelled).
WorkPlanAutoDependencyBooleanBoolean flag; True means dependent sibling WO will be reopened or put on hold when status of "primary" WO changes in certain way.
CpThemeIdIntegerCustomer Portal Theme associated with Work Zone; references CPThemeObject.ID.
DefaultAccessPTEType enumeration memberDefault access/PTE option; references vlangPTETypeLookup.ID; also matches enumeration PTEType. Zero value is not allowed.
AutoAssignEnabledBooleanBoolean flag; True means routing by Specialty is enabled.
BackupRoutingIdBackupRouting enumeration member
BillingAccount{BillingAccount entity reference}Billing Account linked to Work Zone; references lsGroupObject.ID.
Contract{Contract entity reference}Contract linked to Work Zone; references WOCostDefaultObject.ID.
NoIncompleteItemBooleanBoolean flag. True means WOs with incomplete Items (i.e. WO Item Disposition is not "done") are not allowed to be completed.
UiShowProvidersFirstBooleanBoolean flag. True means "Providers" tab should appear first when WO Assignment dialog opens (False means "Technicians" tab will appear).
CurrencyTypeIdCurrencyType enumeration memberChosen currency, references LangLookup.ID. Regarding UPD#2, it is recommended to update currency type separately from modifying other objects
IsOfflineBooleanBoolean flag; True means Work Zone is offline/disabled (WO creation limited; PM Schedules suspended; Customer may be deactivated, etc.).
ContactAddresses[{ContactInfo entity reference}, ...]
CustomFields[{CustomField2 entity reference}, ...]
Portfolios[{LinkPortfolioAndWorkZone entity reference}, ...]
SlaValues[{SlaValuesOverride entity reference}, ...]
Teams[{LinkTeamAndWorkZone entity reference}, ...]
BizHours[{BusinessHours entity reference}, ...]
BlackoutDays[{BlackoutDay entity reference}, ...]
Holidays[{Holiday entity reference}, ...]
EscalationRules[{EscalationRule entity reference}, ...]
SpecDispatchRules[{SpecDispatchRule entity reference}, ...]
OnCallRules[{OnCallRule entity reference}, ...]
Responsibilities[{Responsibility entity reference}, ...]
UseBizHoursBooleanTrue means Work Zones's/Portfolio's Business Hours data will participate in workflow inheritance (even when such data is missing).
UseHolidaysBooleanTrue means Work Zones's/Portfolio's Holidays data will participate in workflow inheritance (even when such data is missing).
UseBlackoutDaysBooleanTrue means Work Zones's/Portfolio's Blackout Date data will participate in workflow inheritance (even when such data is missing).
UseOnCallBooleanTrue means Work Zones's/Portfolio's On Call data will participate in workflow inheritance (even when such data is missing).
UseEscalationBooleanTrue means Work Zone's/Portfolio's Escalation List data will participate in workflow inheritance (even when such data is missing).
DefaultBillToLogicIntegerBill To Type; references vlangBillToTypeLookup.ID; there is also related enumeration BillToType. Bill To Types with rule BillToTypeRule.LogicDisabled are not allowed
TurnKickOffAutoBooleanBoolean flag indicating automatic kick-off for Turns is allowed. True means scheduler will automatically kick-off pending Turns (i.e. create work plans) when they are due.
TurnKickOffLagDaysIntegerTurns are kicked-off TurnKickOffLagDays days before event date. Values 0 - 120 are allowed.
TurnKickOffOnDaysByteBitmask indicating on which weekdays turns and work template WOs can be scheduled to start. Each bit matches one weekday. Bit 0x01 is Sunday, 0x02 is Monday, 0x04 is Tuesday and so forth. Zero value (no days selected) is allowed; in this case application behavior is the same as if all days are selected.
EarliestSlotIntegerNumber of working days an offset for starting from which day (Today = 0, Tomorrow = 1, etc.) the search for the first available slot shall be performed. Default = 1; Min = 0; Max = 100
LatestSlotIntegerNumber of working days how many days out, starting with the Earliest slot setting, the latest appointment might be scheduled (1 meaning just for the day selected in the previous setting). Default = 7; Min = 1; Max = 7
SlotsCountIntegerDefines up to how many options will be offered for Precalculated type
IsPrecalculatedScheduleBooleanBoolean flag; True means Precalculated (new behavior that provides a choice of N appointments)
AllowTimePreferenceBooleanBoolean flag; True means Contact is allowed to choose between morning and afternoon appointments
TurnTemplateIdInteger
IsmSpecGroupIdInteger
IsmUrlString
ExcludeNonCompliantProvidersExcludeCoi enumeration memberCOI Super Lockout
IsNteAutoBoolean or NULLIsNteAuto
CriticalFacilitiesCriticalFacilitiesSettingValues enumeration memberIf set to "Yes," then all {!{Work Orders}!} manually created in a Critical Facilities {!{Property}!} will go through the Approval flow
UnitTemplateIDIntegerAsset Template ID, optional. References InvTopLevel.ID.
RegulatoryFrameworkIDInteger or NULLRegulatory Framework
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
Properties[{PropertyTreeNode object reference}, ...]List of filled properties
LimitMultipleEntitiesNumberBehaviourBooleanReturn exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API