| 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 HierarchySystemObject
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesWorkZone
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesWorkZone
Namespace: CorrigoService.Entities
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public class WorkZone : RemovableCorrigoEntity
The WorkZone type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AccessOptionsMask |
Bitmask defining what access/PTE options are allowed for Work Zone; each bit matches PTEType enumeration value (except Unknown). Zero value is not allowed.
|
| AdvanceNotice |
Number of hours from current date/time that the first appointment may be scheduled. Supported values are 0 – 240 (up to 10 days).
|
| AllowTimePreference |
Boolean flag; True means Contact is allowed to choose between morning and afternoon appointments
|
| Asset |
Root of work zone’s asset tree.
|
| AutoAssignEnabled |
Boolean flag; True means routing by Specialty is enabled.
|
| BackupRoutingId | |
| BillingAccount |
Billing Account linked to Work Zone.
|
| BizHours | |
| ContactAddresses | |
| Contract |
Contract linked to Work Zone.
|
| CpThemeId |
Customer Portal Theme associated with Work Zone.
|
| CurrencyTypeId |
Chosen currency.
It is recommended to update currency type separately from modifying other objects
|
| CustomFields |
Custom Fields
|
| DefaultAccess |
Default access/PTE option.
Matches enumeration PTEType. Zero value is not allowed.
|
| DefaultBillToLogic |
Default Bill To Type (f.i. None, Customer, WorkZone, Other);
Bill To Types with rule BillToTypeRule.LogicDisabled are not allowed
|
| DisplayAs |
Name. Max Length=256
|
| EarliestSlot |
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
|
| Entity |
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.
|
| EscalationRules | |
| ExcludeNonCompliantProviders |
COI Super Lockout
|
| IsmSpecGroupId |
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.
|
| IsmUrl | |
| IsNteAuto |
Boolean flag; True means that work orders in this work zone can use Smart NTE functionality;
Default value is true.
|
| IsOffline |
Boolean flag; True means Work Zone is offline/disabled (WO creation limited; PM Schedules suspended; Customer may be deactivated, etc.).
|
| IsPrecalculatedSchedule |
Boolean flag; True means Precalculated (new behavior that provides a choice of N appointments)
|
| LanguageId | |
| LatestSlot |
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
|
| NoIncompleteItem |
Boolean flag. True means WOs with incomplete Items (i.e. WO Item Disposition is not “done”) are not allowed to be completed.
|
| NoIncompleteProcedure |
Boolean flag. True means WOs with incomplete Procedure steps are not allowed to be completed.
|
| Number |
Number (often used as integration key). This value is either empty or unique. Max Length=80.
|
| OnCallRules | |
| Portfolios | |
| Responsibilities | |
| RoundApptTimeTo |
Defines appointment time rounding value in minutes (i.e. “round appointment start time to closest X minutes”). Supported values are 15, 30 and 60.
|
| SchedulingWindow |
Scheduling/appointment window size in minutes. Supported values are 0 – 1440 (i.e. up to 24 hours).
|
| SlaValues |
SLA Values overrides priority values (DueInMinutes, RespondInMinutes, AckInMinutes)
for whole portfolio or certain community
|
| SlotsCount |
Defines up to how many options will be offered for Precalculated type
|
| SpecDispatchRules | |
| TaxRegion |
Tax Region ID, optional.
|
| Teams | |
| TimeZone | Time zone ID used by all work orders and other objects associated with work zone.
|
| TurnKickOffAuto |
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.
|
| TurnKickOffLagDays |
Turns are kicked-off TurnKickOffLagDays days before event date. Values 0 - 120 are allowed.
|
| TurnKickOffOnDays |
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.
|
| TurnTemplateId | |
| UiShowProvidersFirst |
Boolean flag. True means “Providers” tab should appear first when WO Assignment dialog opens (False means “Technicians” tab will appear).
|
| UseBizHours |
True means Work Zones’s Business Hours data will participate in workflow inheritance (even when such data is missing).
|
| UseEscalation |
True means Work Zone’s Escalation List data will participate in workflow inheritance (even when such data is missing).
|
| UseHolidays |
True means Work Zones’s Holidays data will participate in workflow inheritance (even when such data is missing).
|
| UseOnCall |
True means Work Zones’s On Call data will participate in workflow inheritance (even when such data is missing).
|
| WoNumberDigits |
Number of digits in WO number numeric suffix. Supported values are 1 – 10.
|
| WoNumberPrefix |
Used as WO number prefix when creating the Work Order. Max Length=10.
|
| WorkPlanAutoCancel |
Boolean flag; True means child WOs will be automatically cancelled when their parent or root are cancelled.
|
| WorkPlanAutoDependency |
Boolean flag; True means dependent sibling WO will be reopened or put on hold when status of “primary” WO changes in certain way.
|
| WorkPlanChildResolution |
Boolean flag; True means work plan root WO cannot be completed until it has pending child WOs (e.g. not completed/cancelled).
|
See Also