A.2 DirXML-nwoWorkOrder Object
The DirXML-nwoWorkOrder object (sometimes referred to as the work order object in this guide) is used to tell the driver what tasks to perform in the PBX and to allow the driver to record the results.
If your configuration is intended to update phone information for user objects after PBX tasks are complete, the ObjectID attribute must be filled in correctly on every work order. For example, in the workforce tree configuration explained in Section 7.0, Workforce Tree Configuration, the ObjectID is used to find and update the User object in the Identity Vault, which can subsequently be used to update phone information for the employee in the human resources application. The ObjectID allows this flow of information to take place. Without it, the driver can perform the work order in the PBX, but no user information is updated afterward.
The Avaya driver has two flags to initiate a work order event.
DoItNow Flag
When this flag is set to True for a work order, the Subscriber wakes up the Publisher by sending the work order to the Publisher. The Publisher performs the task immediately instead of waiting for the next polling time or polling interval.
This flag is useful in a situation where you want the work order to be completed right away. You can set this flag to True when you manually create a work order, or in an automated solution you can use policies to determine whether the flag should be set. For example, you could configure the driver to set the DoItNow flag to True for an incoming work order if a corresponding attribute is set in a work order database. As another example, you could configure the driver to set the DoItNow flag to True if an Install work order is triggered by a new user in a human resources application.
SendToPublisher Flag
When this flag is set to True for a work order, the Subscriber sends the work order to the Publisher, and the Publisher writes the work order object in the correct container according to the work order container specified in the Configuration Parameters.
This flag is not necessary in implementations where the work order object is created in the Identity Vault by an administrator (as in Section 5.0, Base Configuration) or an application (like the solution described in Section 8.0, Work Order Database Configuration).
This flag is useful when the work order is triggered by another Identity Vault event through the use of a policy or style sheet, and the work order does not yet exist in the Identity Vault as an object. This kind of scenario is described in Section 7.0, Workforce Tree Configuration.
The following table shows the attributes you need to specify:
Table A-2 nwoWorkOrder Object Attributes
Common Name |
No mapping is necessary for this in the driver namespace |
The naming attribute for eDirectory.
In the sample configurations discussed in this guide, the value comes from the WorkOrderNumber attribute. |
Case ignore string |
WorkOrder1 |
DirXML-nwoExtension |
Extension |
The extension for which the work order is being performed.
If you are installing a new extension, you can request a particular extension by entering a number here. If the extension is not available, the driver assigns the next available extension in numeric order.
If this attribute is blank for an Install work order, the driver assigns the next available extension in numeric order. |
Numeric string |
12345 or no value |
DirXML-nwoDueDate |
DueDate |
Work order due date.
Must be in the format MM/DD/YYYY. |
Case ignore string |
06/12/2003 |
displayName |
UserName |
Name to be displayed on caller ID.
You can automate the creation of this attribute based on the name of the User object.
You can use a work order to change just the display name for an extension, if desired. |
Case ignore string |
Doe, John |
DirXML-nwoObjectID |
ObjectID |
(Required by the policies only) The ID used by policies to associate to the user object.
You can use an ID of your choice, such as the employee ID. |
Case ignore string |
0804F |
DirXML-pbxName |
PbxName |
Local PBX name.
The name of the pbxSite object you created in the Identity Vault. Use the same name as you put in the Site Object DirXML-pbxPbxName attribute. |
Case ignore string |
ProvoPBX |
DirXML-nwoNode |
PbxNode |
Node where the new extension should be placed.
Used only for cold jacks. |
Integer |
Building H East Building H West |
DirXML-nwoPhoneType |
PhoneType |
Phone type recognized by the PBX.
Used by the policies to set up the extension. |
Case ignore string |
8410 |
DirXML-nwoDoItNowFlag |
DoItNowFlag |
When set, do the action now and ignore the due date. This work order is also sent to the Publisher. |
Boolean |
false |
DirXML-nwoStatus |
Status |
Status of the work order: pending, configured, resolved, canceled, error. |
Case ignore string |
pending |
DirXML-nwoWorkOrderNumber |
WorkOrderNumber |
(Optional) Unique work order number assigned by a corporate work order system other than the Identity Vault, such as a work order database. |
Integer |
00001 |
DirXML-nwoAction |
Action |
Work order activity: install, setcor, modify (you can modify display name or objectID), move, remove, disable, disconnect.
For Audix: add, change, remove. |
Case ignore string |
install |
Description |
Description |
(Optional) Description of the work order. If the status is error, this contains a description of the error. |
Case ignore string |
New extension |
DirXML-nwoExtensionType |
ExtensionType |
Type of extension to configure, such as DID or non-DID. |
Case ignore string |
DID |
DirXML-nwoJack |
Jack |
The jack number. Use this to help link a user ID in the Identity Vault with an extension on the PBX. |
Case ignoring string |
12345 |
DirXML-nwoSendToPublisher |
SendToPublisher |
If set, this work order is sent to the Publisher for further action. |
Case ignore string |
false |
DirXML-nwoDupExtension |
DupExtension |
Extension to use to duplicate attributes for new configured extension. |
Numeric string |
19876 |
DirXML-nwoPort |
Port |
Required if you have cold jacks.
Port the extension is wired to. If the port is set, the driver uses that port, whether it is set up as hot or cold jacks.
If you have hot jacks, this information is not necessary; you can leave the attribute blank. |
Case ignore string |
10C0611 |
DirXML-nwoRestrictionClass |
RestrictionClass |
(Optional) Class of restriction used to grant specific calling access to the extension. This is used only on setcor.
If no class of restriction is specified, the extension receives the default class of restriction as defined in the PBX. |
Integer |
01 |
DirXML-nwoRoom |
Room |
The room number. |
Case ignore string |
12345 |
The following table shows the pbxWorkOrder association.
Table A-3 pbxWorkOrder Association
AvayaPBXDriver |
Associated |
/User'sCommonName/Date/Time
|
The following table shows the required attributes for a work order that you do need to specify:
Table A-4 Required Work Order Attributes That Must Be Specified
DirXML-pbxName |
Name of the PBX on which to perform this work order |
ProvoPBX |
DirXML-nwoStatus |
State of the work order so the driver knows what to do with this work order |
pending error warning configured |
DirXML-nwoDoItNowFlag |
When to perform the action on this work order |
True or False |
DirXML-nwoAction |
What action needs to be performed on this work order |
install move disable enable disconnect modify setcor |