Chapter 113: Generic Invoice Download API | Contents | SCVs | Search | Glossary | Reports | XML | Index | Chapter 115: Generating Outbound Interface Triggers (GOIT) |
Chapter 114: Working with Outbound Interface Transactions (WOIT)
Purpose: Use this option to review triggers in the IL Outbound Trigger file.
Certain actions in CWDirect triggers the system to create IL outbound triggers.
In this chapter:
• Work with Outbound Interface Transactions Screen
You can create triggers for:
• item/SKUs if the Create Generic Item Download Trigger Records (I15) system control value is set to Y; see Generic Item Download API.
• vendors if the Create Generic Vendor Download Trigger Records (I16) system control value is set to Y; see Generic Vendor Download API.
• invoices if the Create Generic Invoice Download Trigger Records (I17) system control value is set to Y; see Generic Invoice Download API.
• pick slips if the Create Generic Pick Download Triggers (I31) system control value is set to Y; see Generic Pick Out API.
• stored value card activations if a stored value card item is processed through billing; see Stored Value Card Overview and Setup.
• stored value card remote fulfillments if a pick slip is generated for a stored value card item whose SVC type is R (Remote Fulfillment Card); see Stored Value Card Remote Fulfillment.
• stored value card authorization reversals if a cancellation is processed against a stored value card payment or the stored value card payment is deactivated and an open, unused authorization amount exists; see Stored Value Card Authorization Reversal.
• inventory if the Create Generic Inventory Download Triggers (I32) system control value is set to Y; see Generic Inventory Download API.
• store fulfillment requests if the Use Store Pickup (I41) and/or the Use Store Shipment (J02) system control values are set to Y; see Merchandise Locator and Store Fulfillment API through .NET.
• item transaction history if the Create Generic Item Transaction Download Trigger Records (J52) system control value is set to Y; see Generic Item Transaction History Outbound API.
• Order Broker requests if the Send B/O to Locate (K08) system control value is set to Y; see Order Broker Integration.
Additionally, you can create triggers for all item/SKUs, vendors, item warehouses (inventory), and/or invoices using the Generating Outbound Interface Triggers (GOIT) menu option.
Jobs in the Working with Integration Layer Processes (IJCT) menu option monitor the triggers in the IL Outbound Trigger file. At certain intervals the jobs process the triggers and generate a download XML message to send to another system.
Each trigger in the IL Outbound Trigger file contains a File code, indicating the CWDirect file(s) associated with the trigger, the key fields necessary to retrieve the information, and which IL Process job processes the trigger record.
Trigger rules: You can define trigger rules for the following IL Process jobs to determine when the system generates a trigger, based on criteria defined. The record for which you wish to create a trigger must meet the trigger rule criteria in order to create a trigger in the IL Outbound Trigger file; see Defining Outbound Interface Trigger Rules.
Example: If a trigger rule for the Item Outbound job is that the item’s Allow SKU field must equal ’Y’, the system creates a trigger only for SKU’ed items.
If you generate triggers for: |
look at trigger rules for IL Process job: |
trigger rules are based on criteria for this file: |
item |
Item Outbound |
Item (INITEM) SKU (INSKU) |
vendor |
Vendor Outbound |
Vendor (POVEND) |
invoice |
Invoice Outbound |
Invoice Header (OEINHD) Order Header (OEORDR) |
inventory |
Inventory Download |
Item (INITEM) Item Warehouse (INIWRE) SKU (INSKU) Warehouse (INWRHS Item UPC (ITMUPC) |
order broker |
Order Broker Request |
Item (INITEM) SKU (INSKU) See Rules for Generating Order Broker Triggers for Brokered Backorders. |
pick slips |
Pick Outbound |
Pick Control Header (FLPCTH) See Pick Out Processing. |
item transaction history |
Item Transaction History Outbound |
Item Transaction History (INITHS) |
Note: Changes from upddta and other direct file updates are not captured in the IL Outbound Trigger file.
This table indicates:
• when the system creates a trigger
• the File code assigned to each trigger created
• the referenced files, based on the File code
• the key data captured in the Key field
• the IL Process job that processes the trigger.
File code |
Created when |
Refers to file(s) |
Key |
IL Process job |
AHR |
A cancellation is processed against a stored value card payment or the stored value card payment is deactivated and an open, unused authorization amount exists. |
Auth History SVC Reversal |
11122222222333444555 where: 111 is the company code 22222222 is the order number 333 is the order payment method sequence number 444 is the authorization sequence number 555 is the authorization reversal sequence number |
SVC_REVRSL |
IHD |
An invoice is created or updated, if the Create Generic Invoice Download Trigger Records (I17) system control value is selected |
Invoice Header Order Header |
111222222223333333 where: 111 is the company code 22222222 is the order number 33333333 is the invoice number |
INVOIC_ OUT |
ITH |
A record is created in the Item Transaction History file if the Create Generic Item Transaction Download Trigger Records (J52) system control value is selected |
Item Transaction History |
111222222222222333333333333334445555555666666777 where: 111 is the company code 222222222222 is the item number 33333333333333 is the SKU code 444 is the warehouse code 5555555 is the date 666666 is the time 777 is the item transaction history sequence number |
INVTRAN OUT |
ITW |
The item/SKU’s availability threshold is breached, if the Create Generic Inventory Download Triggers (I32) system control value is selected |
Item Warehouse |
11122222222222233333333333333 where: 111 is the company code 222222222222 is the item number 33333333333333 is the SKU code |
INV_ DOWNLD |
OBR |
You enter an order that includes a backordered item, subject to the Order Broker Values (K15), or use the periodic function to generate the triggers |
Order Detail |
1112222222233344444 where: 111 is the company code 22222222 is the order number 333 is the ship-to number 44444 is the order detail line sequence number (not the order line number) |
BROKER_ ORD |
PCH |
A pick slip is generated, if the Create Generic Pick Download Triggers (I31) system control value is selected |
Pick Control Header |
1112222222 where: 111 is the company code 2222222 is the pick control number |
PICK_OUT |
SKU |
An item or SKU is added, updated or deleted, if the Create Generic Item Download Trigger Records (I15) system control value is selected |
Item SKU |
11122222222222233333333333333 where: 111 is the company code 222222222222 is the item number 33333333333333 is the SKU code |
ITEM_OUT |
SPU |
You generate a store fulfillment request in order entry or order maintenance; see Merchandise Locator and Store Fulfillment API through .NET |
Store Pickup Detail |
11122222222aaaaaaaaaa3333333333444 where: 111 is the company code 22222222 is the order number aaaaaaaaaa is the location system ID 3333333333 is the pickup (fulfillment) location ID 444 is the pickup (fulfillment) sequence number |
STORE_ PKUP |
SRF |
A pick slip is generated for a stored value card item whose SVC type is R (Remote Fulfillment Card). |
Pick Control Header |
1112222222 where: 111 is the company code 2222222 is the pick control number |
SVC_ REMOTE |
SVC |
An order containing a stored value card item that is assigned a number is processed through the Billing Async; see Stored Value Card Purchase and Activation |
Stored Value Card |
111222222223334444455555 where: 111 is the company code 22222222 is the order number 333 is the ship to number 44444 is the order detail line sequence number 55555 is the stored value card sequence number |
SVC_OUT |
VND |
A vendor is added, updated or deleted, if the Create Generic Vendor Download Trigger Records (I16) system control value is selected |
Vendor Vendor Extended |
1112222222 where: 111 is the company code 2222222 is the vendor code |
VENDOR_ OUT |
Work with Outbound Interface Transactions Screen
Purpose: Use this screen to review the triggers in the IL Outbound Trigger file.
How to display this screen: Enter WOIT in the Fast path field or select Work with Outbound Interface Transactions from a menu.
ILR0021 DISPLAY W/W Outbound Interface Transactions 6/21/04 10:12:56 KAB Co. ---- Capture ---- -- Orig Process - -- Last Process - Opt File S Date Time Date Time Date Time From A/C
Key:
Type options, press Enter. 4=Delete 7=Reset
SVC X 6/15/04 16:42:39 0:00:00 0:00:00 CSR1361 Key: 555000075490010000100001 A IHD R 6/15/04 16:42:39 0:00:00 0:00:00 FLR0265 Key: 555000075490002277 A SKU R 6/16/04 10:43:18 0:00:00 0:00:00 POR0223 Key: 5552004SKU1 RED WMNS MEDM C SKU R 6/16/04 10:43:18 0:00:00 0:00:00 POR0223 Key: 5552004SKU1 RED WMNS SMLL C SKU R 6/16/04 10:43:18 0:00:00 0:00:00 POR0223 Key: 5552004SKU1 YELW WMNS LRGE +
F3=Exit F7=Reset all F12=Cancel |
Field |
Description |
File |
A code identifying the CWDirect file(s) containing records you wish to download. This code also indicates which IL Process job processes the trigger record. AHR: Stored value card authorization reversal (SVC_REVRSL job) IHD: Invoice (INVOIC_OUT job) ITH: Item transaction history record (INVTRANOUT job) ITW: Item warehouse (INV_DOWNLD job) OBR: Order Broker request (BROKER_ORD job) PCH: Pick slip (PICK_OUT job) SKU: Item/SKU (ITEM_OUT job) SPU: Store fulfillment request (STORE_PKUP job) SRF: Stored value card remote fulfillment request (SVC_REMOTE job) SVC: Stored value card. (SVC_OUT job) VND: Vendor. (VENDOR_OUT job) Example: If you create an item, the system creates an item download trigger in the IL Outbound Trigger file with a File code of SKU, indicating a change has been made to the Item and SKU file and an item download message should be generated. The Key field identifies the particular CWDirect company and data, in this example, item and SKU record, that has been updated. Alphanumeric, 3 positions; optional. |
S (status) |
The status of the IL outbound trigger. R = Trigger record is ready to be processed. P = Trigger record processing is pending. X = Trigger record has been processed. The system purges processed (X) trigger records, based on the number of days defined in the Outbound Interface Trigger File Purge Days (I14) system control value, when you run the PURGIJT periodic function (program name ILR0026). Alphanumeric, 1 position; optional. |
Capture date |
The date the activity occurred which created the trigger. Numeric, 6 positions (MM/DD/YY format); optional. |
Capture time |
The time the activity occurred which created the trigger. Numeric, 6 positions (HH:MM:SS format); display-only. |
Orig process date |
The date the trigger was originally processed by the system. This value is blank if the trigger has not yet been processed. Numeric, 6 positions (MM/DD/YY format); display-only. |
Orig process time |
The time the trigger was originally processed by the system. This value is blank if the trigger has not yet been processed. Numeric, 6 positions (HH:MM:SS format); display-only. |
Last process date |
The date the trigger was last re-processed by the system. You can reprocess a specific trigger by entering 7 next to a trigger. You can reprocess a group of triggers by pressing F7. You can only reprocess triggers that are in a pending (P) or processed (X) status. Numeric, 6 positions (MM/DD/YY format); display-only. |
Last process time |
The time the trigger was last re-processed by the system. Numeric, 6 positions (HH:MM:SS format); display-only. |
From |
The name of the program associated with the CWDirect action that created the trigger. Alphanumeric, 8 positions; display-only. |
A/C |
A code that indicates whether the CWDirect activity represents creation of a new record, a change to an existing record, or a delete of an existing record. A = a new record was added C = an existing record was maintained D = an existing record was deleted Alphanumeric, 1 position; display-only. |
Key |
A code used to identify the CWDirect company and data that has been updated. The File field identifies the file where the updated data is located. The Key is then used to identify the record in the file that has been updated. See IL Outbound Triggers for a listing of the keys for each trigger type. Alphanumeric, 30 positions; optional. |
Screen Option |
Procedure |
Delete an IL outbound trigger |
Enter 4 next to a trigger to advance to the Confirm Delete window; press Enter to delete it. Note: The system allows you to delete any trigger, regardless of whether the status is ready (R) or processed (X). |
Reprocess a processed trigger |
Enter 7 next to a trigger to update the status of the trigger from pending (P) or processed (X) to ready (R). The system also updates the Last processed date and Last processed time fields once the trigger is reprocessed. The next time the IL Process job monitors the IL Outbound Trigger file for unprocessed triggers, the job reprocesses the trigger. |
Reprocess a group of triggers |
Press F7 to advance to the Reset All Window. |
Use this window to update the status of a group of triggers from pending (P) or processed (X) to ready (R).
Step-by-step instructions:
1. Enter the File code, Capture date, and Status of the group of triggers you wish to reprocess and press Enter.
2. The CONFIRM prompt appears at the bottom of the window. Enter Y in this field to confirm the group of triggers you wish to reprocess.
3. The system changes the status of the group of trigger to R (ready).
The next time the IL Process job monitors the IL Outbound Trigger file for unprocessed triggers, the job reprocesses the triggers.
How to display this screen: Press F7 at the Work with Outbound Interface Transactions Screen.
Reset All
File code . . . . Capture date . . . Status . . . . . .
F3=Exit |
Field |
Description |
File code |
A code identifying the type of triggers you wish to reprocess. AHR: Stored value card authorization reversal (SVC_REVRSL job) IHD: Invoice (INVOIC_OUT job) ITH: Item transaction history record (INVTRANOUT job) ITW: Item warehouse (INV_DOWNLD job) OBR: Order Broker request (BROKER_ORD job) PCH: Pick slip (PICK_OUT job) SKU: Item/SKU (ITEM_OUT job) SPU: Store fulfillment request (STORE_PKUP job) SRF: Stored value card remote fulfillment request (SVC_REMOTE job) SVC: Stored value card. (SVC_OUT job) VND: Vendor. (VENDOR_OUT job) Alphanumeric, 3 positions; required. |
Capture date |
The date the activity occurred creating the group of triggers you wish to reprocess. Numeric, 6 positions (MM/DD/YY format); required. |
Status |
The status of the group of triggers to reprocess. R = Triggers are ready to be processed. Selecting this status does not perform any updates since the group of triggers will already be processed the next time the IL Process job monitors for unprocessed triggers. P = Trigger processing is pending. X = Triggers have been processed. Enter P or X in this field to change the status of the group of triggers to R (ready). The next time the IL Process job monitors the IL Outbound Trigger file for unprocessed triggers, the job reprocesses the triggers. Alphanumeric, 1 position; required. |
Chapter 113: Generic Invoice Download API | Contents | SCVs | Search | Glossary | Reports | XML | Index | Chapter 115: Generating Outbound Interface Triggers (GOIT) |
ST01_06 CWDirect 18.0 August 2015 OTN