Work Order Interface: Table Driven Method
Use the Work Order Interface to load vendor records using data from external applications. Information you load using this interface adds to the data already stored in PENTA.
Data files you load must have Request Types assigned to the WO Interface Type.
Note that there is no pipe delimited interface method available; the table method is the only way to interface work order data.
Where to View Loaded Data
You can review interfaced data in the Work Orders window.
Available Tables
Line Item Detail Record
The following information relates to the INTR_WOMSTR_LINE_ITEM table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Identify the work order record you wish to modify. |
LINE_ITEM_NUM | Req | I 6 | Assign a unique 1 to 6 digit number. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
LI_TYPE_CD | Req | C! 1 | Enter the value that corresponds with the Line Item Type that you wish to associate with the line item number. |
DESCR | Req | C 30 | Note or comment that will display on the invoice for the line item number. |
LUMP_SUM_AMT | Opt | F 15.2 | Enter the Amount for a line item that is a Lump Sum Line Item Type. |
UNIT_PRICE | Opt | F 11.2 | Enter the Unit Price for a line item that is a Unit Price Line Item Type. |
PCT | Opt | F 8.5 | Enter the % for a line item that is either a Fee or a Sales Tax Line Item Type. |
SALES_ACCT_NUM | Opt | X | Enter the Revenue Account # associated with the line item. |
TAX_ACCT_NUM | Opt | X | Enter the Tax Liability Account # associated with the line item. |
REV_CAT_CD | Opt | C! 6 | Enter the Revenue Category associated with the line item. |
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This USER_ID must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Line Item Unit Billing Detail Record
The following information relates to the INTR_WOMSTR_LI_UNIT_BILL table.
Column | Entry | Format | Description | |||
---|---|---|---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. | |||
WO_ID | Req | C! 25 | Id of the work order. | |||
LINE_ITEM_NUM | Req | I 6 | Id of the work order line item. | |||
UNIT_BILL_CD | Req | C! 15 | Id of the unit billing associated with unit rate billing line item types. | |||
SORT_SEQ_NUM | Opt | I 10 | The sort order of unit billing codes on the work order invoice. | |||
UM | Opt | C 5 | Indicate how you measure the Units. | |||
REV_CAT_CD | Opt | C! 6 | Associate a revenue category with this unit billing code. One possible use of the revenue category is to associate an internal unit billing code with the customer unit billing code for reporting purposes. PENTA displays the associated Revenue Category Description. | |||
UNITS | Opt / Req | F 12.3 | Quantify the contract units for this line item. Required if an Effective Date exists; otherwise, do not enter a value. | |||
D_UNITS_EFF_DATE | Opt | D | Enter the effective date of the initial contract units for this unit billing code. Use the Update Units button for subsequent contract unit entries for a unit billing code. | |||
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
| |||
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. | |||
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. | |||
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Work Order Master Detail Record
The following information relates to the INTR_WOMSTR_DTL table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Id of the work order. |
SEQ_NUM | Req | I 10 | Sequence number uniquely identifying this row within interface request. |
CUS_EQ_ID | Opt | C! 15 | The piece of customer equipment that requires service. |
FA_ID | Opt | X | The fixed asset that requires service. |
CUS_LOC_CD | Opt | C 8 | Use the Location column to specify whether the work is for a particular customer site. |
MAINT_SCHD_NUM | Opt | I 6 | Associate a maintenance schedule with the piece of equipment. |
WO_TASK_ID | Opt | C! 10 | Enter the Id of the task necessary to maintain the piece of equipment. |
LONG_DESCR | Opt | C 2000 | Enter any information not addressed in previous columns. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
MAINT_CONTRACT_ID | Opt | C 15 | Id of the maintenance contract linked to the Task. |
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Work Order Master Record
The following information relates to the INTR_WOMSTR_MASTER table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Use the Work Order Id column to enter a unique identifier that is 1-25 characters in length. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
OU_ID | Req | X | Use the OU Id column to identify which organizational unit has ownership of the work order. |
DESCR | Req | C 30 | A note or comment about the work order. |
TEXT_3 | Opt | LONG | Use the Description of Problem column to record a more detailed description of the requested work. The column has no character limit. |
CUS_ID | Req | X | Use the Customer Id column to specify the account for which the service work will be performed. |
CUS_LOC_CD | Opt | C 8 | Use the Location column to specify whether the work is for a particular customer site. |
ADDR_1 | Opt | C 30 | First line of the work site’s street address. |
ADDR_2 | Opt | C 30 | Second line of the work site’s street address. |
ADDR_3 | Opt | C 30 | Third line of the work site’s street address. |
CITY | Opt | C 20 | The city of the work site. |
ST_CD | Opt | C! 4 | The state or providence of the work site. |
POSTAL_CD | Opt | C! 10 | The postal code of the work site. |
COUNTRY_CD | Opt | C! 3 | The country of the work site. |
CALLER_LAST_NAME | Opt | C 20 | Last name of the individual who made the call requesting service work. |
CALLER_FIRST_NAME | Opt | C 15 | First name of the individual who made the call requesting service work. |
CALLER_PHONE_ | Opt | C 3 | The area code of the person who made the call requesting service work. |
CALLER_PHONE_NUM | Opt | C 11 | The 7-digit telephone number of the person who made the call requesting service work. |
WO_SERVICE_TYPE_ | Req | C! 8 | Id of the Service Type describing the nature of the service needed for the work order. |
WO_CALL_PRIORITY_CD | Opt | C! 8 | Id of the Priority characterizing a work order’s need for attention. The user is responsible for establishing and interpreting the hierarchical logic behind the values. |
D_CALL_TAKEN_ | Opt | D | Use the Call taken on column to enter the date on which the customer called. |
CALL_TAKER_EMP_ID | Opt | X | Use the Call taken by column to identify the employee who received the call. |
WO_CALL_TYPE_CD | Opt | C! 8 | Id of the Call Type characterizing the nature of the service call. |
WO_SERVICE_ZONE_CD | Opt | C! 10 | Id of the Zone specifying the geographical region where service work will take place. |
SALESPERSON_EMP_ | Req/ Opt | X | Salesperson Id. Id of the employee credited with making the sale. |
SALESPERSON_NAME | Req/ Opt | C 30 | Name of the employee credited with making the sale. |
MAINT_CONTRACT_ | Opt | C! 15 | Use the Contract Id column when a relationship exists between the work order and an existing maintenance contract with the customer. |
CONTACT_NUM | Opt | I 3 | Use the Contact # column to associate a work order with a specific employee at the customer site. |
CONTACT_LAST_ | Opt | C 20 | Use the Last Name column to display the last name of the contact person. |
CONTACT_FIRST_ | Opt | C 15 | Use the First Name column to display the first name of the contact person. |
CONTACT_PHONE_ | Opt | C 3 | Use the first block of the Phone # column to display the 3-digit area code for the contact number. |
CONTACT_PHONE_ | Opt | C 30 | Use the second block of the Phone # column to display the 7-digit phone number for the contact number. |
CONTACT_PHONE_ | Opt | C 5 | Use the Ext column to display the extension to the contact phone number. |
CUS_PO_REF | Opt | C 30 | Use the Customer PO # column if there is a purchase order number associated with the work order. |
PO_LIMIT_AMT | Opt | F 12.2 | Use the PO Limit Amount column to establish the maximum amount that a purchase order cannot exceed. |
CUS_AMT_ | Opt | F 12.2 | Use the Cus Price Threshold column to set the maximum dollar amount that you are willing to pay a customer for their product. |
D_RQST_DATE | Opt | D | Date the customer would like the service completed. |
D_RQST_TIME | Opt | D | Time the customer would like the service completed. |
D_NEEDED_DATE | Opt | D | Date the customer must have the service completed. |
D_NEEDED_TIME | Opt | D | Time the customer must have the service completed. |
D_PROMISED_DATE | Opt | D | Date by which you promised to have your technicians complete the service work. |
D_PROMISED_TIME | Opt | D | Time by which you promised to have your technicians complete the service work. |
D_PROMISED_LATEST_TIME | Opt | D | Latest date that completion of the service work will occur. |
EST_HRS | Opt | F 10.3 | Estimated Hours identifies the total number of hours expected to complete the service work. |
NUM_TECHS | Opt | I 3 | # of Technicians identifies the total number of technicians needed to complete the service work. |
SERVICE_TECH_EMP_ | Opt | X | The preferred lead technician on the service call. |
TAXABLE_INDICATOR | Opt | C! 1 | Indicates whether a work order is taxable. |
TAX_EXEMPT_ | Opt | C! 3 | Identifies the basis for excluding the work order from taxes. The Tax Exempt Reason column is non-enterable when the Tax Exempt column is No. |
TAX_CERTIFICATE | Opt | C 15 | Use the Tax Exempt Certificate column to include proof of the exemption if a party other than PENTA requires you to do so. |
INVOICE_CUS_ID | Opt | X | Use the Invoice Cus Id column to identify the customer whom you plan to bill for the service work. The customer receiving the invoice may not be the same customer that requests the service work. |
INVOICE_CYCLE_ | Opt | I 3 | Use the Invoice Cycle column to establish the frequency at which customer billings will occur. |
PAY_TERM_NUM | Opt | I 3 | This value you enter indicates the number of days a customer has to pay their account in full and whether the customer receives a discount for early payment. |
BILL_WHEN_CMPL_ | Opt | C! 1 | Use the Bill Only When Complete column to indicate whether a customer will receive invoices before completion of the work order. |
CALC_SERVICE_ | Opt | C! 1 | Place a checkmark in the Calculate Service Charges box to allow for a surcharge on all line items on a work order for an invoice that is not paid within the agreed upon terms. |
LIMIT_AMT | Opt | F 15.2 | Use the Limit Amount column to set the maximum dollar amount a customer can expect to pay for work performed. |
BILL_TAXABLE_ | Opt | C! 1 | Use the Taxable column to indicate whether an invoice is subject to tax. |
LAB_RATE_SCHD_ | Opt | I 3 | Use the Labor column to assign the desired set of pricing rules that PENTA is to apply when charging costs for labor time card entries made against that particular work order/maintenance contract. |
EQ_RATE_SCHD_NUM | Opt | I 3 | The desired set of pricing rules that PENTA is to apply when charging costs for equipment timecard entries made against that particular work order/maintenance contract. |
INV_MKUP_SCHD_ | Opt | I 3 | Use the Inventory column to assign the desired set of pricing rules that PENTA is to apply when charging costs for inventory transfers made against that particular work order/maintenance contract. |
CT_MKUP_SCHD_NUM | Opt | I 3 | Use the Other Costs column to assign the desired set of pricing rules that PENTA is to apply when charging costs for work order/maintenance contract related items not categorized as labor, equipment, or materials. |
INVOICE_OH_CD | Opt | C! 1 | Use the Overhead box to include or exclude charges from any overhead rule associated with the work order/maintenance contract as a billable cost to the customer. |
FRNG_CD | Opt | C! 1 | Place a checkmark in the Taxable Fringes box to include add-to-gross fringe expenses related to the work order/maintenance contract as a billable cost to the customer. |
BURDEN_CD | Opt | C! 1 | Use the Payroll Burden box to include or exclude charges from payroll burden as a billable cost to the customer. |
NT_FRNG_CD | Opt | C! 1 | Place a checkmark in the Non-Taxable Fringes box to include add-to-net fringe expenses charged to the work order/maintenance contract as a billable cost to the customer. |
OTH_PAY_CD | Opt | C! 1 | Place a checkmark in the Other Pay box to include miscellaneous expenses charged to the work order/maintenance contract as a billable cost to the customer. |
REIMB_CD | Opt | C! 1 | Place a checkmark in the Reimbursements box to include reimbursable item expenses charged to the work order/maintenance contract as a billable cost to the customer. |
NUM_COPIES | Opt | I 3 | Use the Number of Copies column to specify how many invoice copies will be printed and sent to the customer. |
INVOICE_CUS_LOC_ | Opt | C 8 | Use the Invoice Loc. Code column to associate a work order with a customer site that receives invoices. |
INVOICE_NAME | Opt | C 30 | Use the Send Invoice To column to list the name of the customer that received the invoice. |
INVOICE_NAME_ | Opt | C 15 | Use the Name Prefix column if the name of the customer that received the invoice has a prefix. |
INVOICE_ADDR_1 | Opt | C 30 | Street address where the customer will receive the invoice. |
INVOICE_ADDR_2 | Opt | C 30 | Street address where the customer will receive the invoice. |
INVOICE_ADDR_3 | Opt | C 30 | Street address where the customer will receive the invoice. |
INVOICE_CITY | Opt | C 20 | City where the customer will receive the invoice. |
INVOICE_ST_CD | Opt | C! 4 | State or province where the customer will receive the invoice. |
INVOICE_POSTAL_CD | Opt | C! 10 | Postal code for the address where the customer will receive the invoice. |
INVOICE_COUNTRY_ | Opt | C! 3 | Country where the customer will receive the invoice. |
INVOICE_CONTACT_NUM | Opt | I 3 | Telephone number used to contact the customer who receives the invoices. |
INVOICE_CONTACT_ | Opt | C 20 | Last name of the contact person for the customer receiving the invoice. |
INVOICE_CONTACT_ | Opt | C 15 | First name of the contact person for the customer receiving the invoice. |
INVOICE_CONTACT_ | Opt | I 4 | Title of the contact person for the customer receiving the invoice. |
REMIT_TO_ADDR_ | Opt | I 5 | Remit to Address # identifies the location to which customers can send their payments. |
PMGR_EMP_ID | Opt | I 9 | Employee Id of the Work Order’s project manager. |
SIT_ST_CD | Opt | C! 4 | Enter the Work Order’s tax jurisdiction for state income tax. |
SUT_ST_CD | Opt | C! 4 | Identify the Work Order tax jurisdiction for the following calculations:
|
LCL_CD | Opt | C! 3 | Identify the Work Order’s tax jurisdiction for local taxes. |
WORK_PROV_CD | Opt | C! 4 | Enter the work province. This value determines the workers compensation province and work location-related tax province (e.g., NWT payroll tax). This value defaults on timecards, but you can override it during timecard entry for individual timecards. Note: You can only enter this value for a Canadian Payroll Employee. |
PAR_WO_ID | Opt | C! 25 | Assigns a parent work order to the current work order. |
PAR_WO_OU_ID | Opt | I 9 | OU of the parent work order. |
PAR_WO_INVOICE_CD | Opt | C! 1 | Indicate if you want to bill the child work order on the parent work order's invoice. |
IC_AP_EMAIL_CD | Opt | C! 1 | Indicates whether PENTA sends an email to the Work Order’s Manager when PENTA generates an “arm’s length” inter-company AP transaction with the charge going to the Work Order. |
UNIT_BILL_SCHD_ | Opt | I 8 | Id of the rate schedule resembling unit rate billing rules PENTA applies when calculating invoice amounts for unit rate billing line items for the Work Order. |
REGION_ID | Opt | C 8 | The physical region of the customer requesting service. |
WO_STAT_UDF_CD | Opt | C! 10 | PENTA will create Work Orders with an Unassigned status, and any Status code you enter here will result in an additional WO Status History entry. If you entered a SERVICE_TECH_EMP_ID and enter a type of “assigned” status here, PENTA adds the preferred lead technician to the Work Order. |
D_STAT_DATE | Opt | D | The effective date of the Status assignment. Only enter a Status Date if you entered a Status. |
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
OT_APPROVED_CD | Req | C! 1 | Use the Overtime Approved column to specify if the work order is approved for overtime. |
Note Detail Record
The following information relates to the INTR_WOMSTR_NOTE table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Use the Work Order Id column to identify the work order record you wish to modify. |
SEQ_NUM | Req | I 10 | Sequence number uniquely identifying this row within interface request. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
NOTE_ID | Opt | I 10 | Id of the note associated with the Work Order. |
WO_NOTE_TYPE_CD | Req | C! 8 | Use the Note Type column to classify the note by its origin. |
TEXT_3 | Req | LONG | Enter the text for the note. The column is not limited to any maximum number of characters entered. |
WO_PRINT_CD | Opt | C! 1 | Use the Print On Work Order column to indicate whether PENTA should include the note on a paper hard copy of the work order. |
WO_INVOICE_PRINT_CD | Opt | C! 1 | Use the Print On Invoice column to indicate whether PENTA should include the note on a printed invoice for the work order. |
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Task Union Detail Record
The following information relates to the INTR_WOMSTR_TASK_UNION table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Id of the work order. |
WO_TASK_ID | Req | C! 10 | Id of the task associated with the work order. |
SEQ_NUM | Req | I 10 | Sequence number uniquely identifying this row within interface request. |
UNION_NUM | Opt | C! 8 | The union authorized to work on the Task. If multiple unions have authorization to work on the task, you must add multiple rows. |
ALL_UNION_CD | Req | C! 1 | Use this checkbox to indicate that a task is open and not restricted to the union(s) with jurisdiction over the work order. If you place a checkmark in this box:
|
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Tax Detail Record
The following information relates to the INTR_WOMSTR_TAX table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Use the Work Order Id column to identify the work order record you wish to modify. |
JURIS_ID | Req | C 10 | Enter the tax jurisdiction that will determine which tax rules to apply to the taxable amounts for the work order. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
Union Local Detail Record
The following information relates to the INTR_WOMSTR_UNION_LCL table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Id of the work order. |
UNION_NUM | Req | C! 8 | Id of the union. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |
User Defined Fields Detail Record
The following information relates to the INTR_WOMSTR_UDF table.
Column | Entry | Format | Description |
---|---|---|---|
INTR_RQST_ID | Req | C! 13 | The interface request value that you enter to initiate the interface process. The value must be consistent for all records PENTA should process together. |
WO_ID | Req | C! 25 | Id of the work order. |
UDF_COLUMN_NAME | Req | C 30 | Name of the user defined field. |
ALPHA_VALUE | Opt | C 2000 | Value of the user defined field. |
D_EFF_DATE | Req | D | The effective date. |
ACTIVITY_CD | Req | C! 1 | Required for all activity. Possible values are:
|
RECORD_NUM | Opt | I 10 | Do not assign this value. PENTA assigns this record number, which you can use to identify records with errors or warning messages. |
USER_ID | Req | C 6 | Id of the employee performing the load process. This user_id must exist in PENTA. |
MODIFICATION_ | Opt | D | Once the process completes, this displays the date PENTA marked the record as modified in the database. The current date is the default value. |