Click or drag to resize

WorkZone Class

Work Zone is a grouping or parent entity for Customers, Work Orders and Assets. Some examples of work zones are: An apartment complex with multiple buildings, each with multiple units; A commercial building with multiple floors, each with multiple units in the form of offices or suites of offices; A geographical area with many single-family homes, each of which is considered a unit, or; A city sector or other region with multiple business franchises, each of which is considered a unit.
Inheritance Hierarchy

Namespace: CorrigoService.Entities
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
Syntax
Copy
[SerializableAttribute]
public class WorkZone : RemovableCorrigoEntity

The WorkZone type exposes the following members.

Properties
 NameDescription
Public propertyAccessOptionsMask Bitmask defining what access/PTE options are allowed for Work Zone; each bit matches PTEType enumeration value (except Unknown). Zero value is not allowed.
Public propertyAdvanceNotice Number of hours from current date/time that the first appointment may be scheduled. Supported values are 0 – 240 (up to 10 days).
Public propertyAllowTimePreference Boolean flag; True means Contact is allowed to choose between morning and afternoon appointments
Public propertyAsset Root of work zone’s asset tree.
Public propertyAutoAssignEnabled Boolean flag; True means routing by Specialty is enabled.
Public propertyBackupRoutingId 
Public propertyBillingAccount Billing Account linked to Work Zone.
Public propertyBizHours 
Public propertyBlackoutDays 
Public propertyContactAddresses 
Public propertyContract Contract linked to Work Zone.
Public propertyCpThemeId Customer Portal Theme associated with Work Zone.
Public propertyCriticalFacilities 
Public propertyCurrencyTypeId Chosen currency. It is recommended to update currency type separately from modifying other objects
Public propertyCustomFields Custom Fields
Public propertyDefaultAccess Default access/PTE option. Matches enumeration PTEType. Zero value is not allowed.
Public propertyDefaultBillToLogic Default Bill To Type (f.i. None, Customer, WorkZone, Other); Bill To Types with rule BillToTypeRule.LogicDisabled are not allowed
Public propertyDisplayAs Name. Max Length=256
Public propertyEarliestSlot Number 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
Public propertyEntity Identifies larger entity Work Zone belongs to; used by integration and by JLL WON setup (aggregator instance keeps requestor name in that field). Max Length=80.
Public propertyEscalationRules 
Public propertyExcludeNonCompliantProviders COI Super Lockout
Public propertyHolidays 
Public propertyIsmSpecGroupId Specialty Group defining ISM procedure requirements, optional. Reference to non-empty Specialty Group means Induction and Safety Management (ISM) is required for at least some of Specialties for this Work Zone.
Public propertyIsmUrl 
Public propertyIsNteAuto Boolean flag; True means that work orders in this work zone can use Smart NTE functionality; Default value is true.
Public propertyIsOffline Boolean flag; True means Work Zone is offline/disabled (WO creation limited; PM Schedules suspended; Customer may be deactivated, etc.).
Public propertyIsPrecalculatedSchedule Boolean flag; True means Precalculated (new behavior that provides a choice of N appointments)
Public propertyLanguageId 
Public propertyLatestSlot Number 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
Public propertyNoIncompleteItem Boolean flag. True means WOs with incomplete Items (i.e. WO Item Disposition is not “done”) are not allowed to be completed.
Public propertyNoIncompleteProcedure Boolean flag. True means WOs with incomplete Procedure steps are not allowed to be completed.
Public propertyNumber Number (often used as integration key). This value is either empty or unique. Max Length=80.
Public propertyOnCallRules 
Public propertyPortfolios 
Public propertyRegulatoryFrameworkID Regulatory Framework ID
Public propertyResponsibilities 
Public propertyRoundApptTimeTo Defines appointment time rounding value in minutes (i.e. “round appointment start time to closest X minutes”). Supported values are 15, 30 and 60.
Public propertySchedulingWindow Scheduling/appointment window size in minutes. Supported values are 0 – 1440 (i.e. up to 24 hours).
Public propertySlaValues SLA Values overrides priority values (DueInMinutes, RespondInMinutes, AckInMinutes) for whole portfolio or certain community
Public propertySlotsCount Defines up to how many options will be offered for Precalculated type
Public propertySpecDispatchRules 
Public propertyTaxRegion Tax Region ID, optional.
Public propertyTeams 
Public propertyTimeZoneTime zone ID used by all work orders and other objects associated with work zone.
Public propertyTurnKickOffAuto Boolean 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.
Public propertyTurnKickOffLagDays Turns are kicked-off TurnKickOffLagDays days before event date. Values 0 - 120 are allowed.
Public propertyTurnKickOffOnDays Bitmask 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.
Public propertyTurnTemplateId 
Public propertyUiShowProvidersFirst Boolean flag. True means “Providers” tab should appear first when WO Assignment dialog opens (False means “Technicians” tab will appear).
Public propertyUnitTemplateID 
Public propertyUseBizHours True means Work Zones’s Business Hours data will participate in workflow inheritance (even when such data is missing).
Public propertyUseBlackoutDays 
Public propertyUseEscalation True means Work Zone’s Escalation List data will participate in workflow inheritance (even when such data is missing).
Public propertyUseHolidays True means Work Zones’s Holidays data will participate in workflow inheritance (even when such data is missing).
Public propertyUseOnCall True means Work Zones’s On Call data will participate in workflow inheritance (even when such data is missing).
Public propertyWoNumberDigits Number of digits in WO number numeric suffix. Supported values are 1 – 10.
Public propertyWoNumberPrefix Used as WO number prefix when creating the Work Order. Max Length=10.
Public propertyWorkPlanAutoCancel Boolean flag; True means child WOs will be automatically cancelled when their parent or root are cancelled.
Public propertyWorkPlanAutoDependency Boolean flag; True means dependent sibling WO will be reopened or put on hold when status of “primary” WO changes in certain way.
Public propertyWorkPlanChildResolution Boolean flag; True means work plan root WO cannot be completed until it has pending child WOs (e.g. not completed/cancelled).
Top
See Also