3 Configuration and Administration

Configuration:

• Order Management System Environment Configuration

• Order Management System Application Configuration

• Regional Settings

• Advanced Queuing

• Properties

• Working with Customer Properties (PROP)

• Working with Admin Properties (CPRP)

• Email Generation Setup

• Image Setup

• Custom Link Setup

• Authorization/Deposit Interface Setup

• PC Manifest Interface Setup

• Avalara AvaTax Setup

• Vertex Setup

• Order Broker Configuration

• Working with Web Service Authentication (WWSA)

• Working with Contact Center (WWCC)

See also Menu Driver Screen.

Administration:

• Logging into Order Management System

• About Application Screen

• Scheduling Jobs

• Document Management (My Docs)

• Job Management (My Jobs)

• Forms Management (My Forms)

• Order Management System Support Notifications

• Restarting Order Management System

Troubleshooting and FAQs

• Reviewing Application Settings in the Jenasys Properties File

• Logs

• Monitoring Jobs

• Caching

• Frequently Asked Questions

Working with Customer Properties (PROP)

Purpose: Use this menu option to define system-wide configuration settings for Order Management System that an administrator type user would update.

When you update a property setting, unless otherwise noted, your update takes effect immediately.

In this topic:

• Work with Properties Screen

• Summary of Customer Properties

• Forms Property Settings

• Integration Property Settings

• System Property Settings

Work with Properties Screen

How to display this screen: Enter PROP in the Fast path field or select Refresh System Properties from a menu.

Authority: Users with ALLOW or DISPLAY authority to this menu option can update the settings in the properties files with the new values.

When you first advance to this screen, property settings display in ascending property name sequence.

Field	Description
Group	The type of property setting. Valid values are: Forms: The property setting is related to forms processing. Integration: The property setting is related to an integration with an external system. System: The property setting is related to a system-wide function. Enter a full or partial group name to display property settings that contain your entry. Alphanumeric, 25 positions; optional.
Property	The name of a property. Enter a full or partial property name to display property settings that contain your entry. You can expand the Property column to review the full name of the property setting. Alphanumeric, 75 positions; optional.
Value	The current setting of the property. If this field is blank, it means a property setting has not been defined. Enter a full or partial property value to display property settings that contain your entry. You can expand the Current Value column if its full value does not display. Alphanumeric, 150 positions; optional.
Type	The type of property setting. This setting is always set to CUSTOMER indicating the property setting is a setting available to the customer. Enter a full or partial property type to display property settings that contain your entry. Alphanumeric, 10 positions; optional.

Screen Option	Procedure
Change the current value defined for a property	Select Change for a property to advance to the Change Property screen.

Summary of Customer Properties

The property settings that display on the Work with Properties Screen are listed below.

• Forms Property Settings

• Integration Property Settings

• System Property Settings

Forms Property Settings

Property Name	Description
BOCARDS	Controls whether certain information prints on the Backorder Card. Currently, there is no information to define.
CAMPAIGNPERF CAMPAIGN_PERFORMANCE	Controls whether certain information prints on the Campaign Performance Report (PCPR). Currently, there is no information to define.
CPGSKUEXUPLOAD CPG_SKU_EXCLUSION_UPLOAD_ERROR	Controls whether certain information prints on the CPG Item/SKU Exclusions Upload Error Records Report. Currently, there is no information to define.
CSHLDORD   HELD_ORDER_BY_REASON_REPORT	Controls whether certain information prints on the Held Order by Reason Code Report. Currently, there is no information to define.
CSHLDORDCSV HELD_ORDER_BY_REASON_REPORT_CSV	Controls whether certain information prints on the Held Order by Reason Code Report in spreadsheet format. Currently, there is no information to define
EMSTSRPT CUSTOMER_EMAIL_STATUS_REPORT	Controls whether certain information prints on the Unmatched Email Status Report. Currently, there is no information to define.
EXCARSNNOITM   EXCHANGE_ALL_REASON_NO_ITEM	Controls whether certain information prints on the Exchange Reason Report when the exchange reason code and item are not defined. Currently, there is no information to define.
EXCARSNNOITMCSV EXCHANGE_ALL_REASON_NO_ITEM_CSV	Controls whether certain information prints on the Exchange Reason Report in spreadsheet format when the exchange reason code and item are not defined. Currently, there is no information to define.
EXCARSNWITM EXCHANGE_ALL_REASON_WITH_ITEM	Controls whether certain information prints on the Exchange Reason Report when an item is defined. Currently, there is no information to define.
EXCARSNWITMCSV EXCHANGE_ALL_REASON_WITH_ITEM_CSV	Controls whether certain information prints on the Exchange Reason Report in spreadsheet format when an item is defined. Currently, there is no information to define.
EXCRSNNOITM EXCHANGE_SPECIFIC_REASON_NO_ITEM	Controls whether certain information prints on the Exchange Reason Report when an exchange reason code is defined. Currently, there is no information to define.
EXCRSNNOITMCSV EXCHANGE_SPECIFIC_REASON_NO_ITEM_CSV	Controls whether certain information prints on the Exchange Reason Report in spreadsheet format when an exchange reason code is defined. Currently, there is no information to define.
EXCRSNWITM EXCHANGE_SPECIFIC_REASON_WITH_ITEM	Controls whether certain information prints on the Exchange Reason Report when an exchange reason code and item are defined. Currently, there is no information to define.
EXCRSNWITMCSV EXCHANGE_SPECIFIC_REASON_WITH_ITEM_CSV	Controls whether certain information prints on the Exchange Reason Report in spreadsheet format when an exchange reason code and item are defined. Currently, there is no information to define.
FLASHPIECHARTS FLASHPIECHARTSFULL	Defines the order statistics that display on the Menu Driver Screen. FLASHPIECHARTS = The order statistics section of the menu screen displays total numbers and dollars of orders created by the current date, current week, current month, year to date, and previous year. Use this setting if the Delay Billing Updates (K85) system control value is selected. FLASHPIECHARTSFULL = The order statistics section of the menu screen displays total numbers and dollars of orders created and shipped by the current date, current week, current month, year to date, and previous year. Use this setting if the Delay Billing Updates (K85) system control value is unselected.
FLASHREPORT FLASHREPORT	Controls whether certain information displays in Reviewing Operations Control Summary (FLSH). Currently, there is no information to define.
GIFTACKG=GIFTACKDB,SUPPRESS_IMAGES=N,INPUT_TYPE=DB Note:  These settings also apply to your graphical custom gift acknowledgement. Each option is available only if your gift acknowledgement print program supports it.	Defines whether images print on the graphical Gift Acknowledgement. SUPPRESS_IMAGES Controls whether the system prints images on the graphical gift acknowledgement. N (default) = Print images on the graphical gift acknowledgement. Y = Suppress images on the graphical gift acknowledgement. Note:  The SUPPRESS_IMAGES value should be N for the graphical gift acknowledgement. INPUT_TYPE Controls the means by which your gift acknowledgement printing program obtains the data to print on the gift acknowledgement. Valid values are: XML = The program uses the Pick Message from Order Management System (CWPickOut) to generate the gift acknowledgment. DB = The program queries the database to generate the gift acknowledgement. The INPUT_TYPE setting for the standard printing program GIFTACKG is DB.
JFLR0393 PICKING_PULLSHEET_CARTBIN	Controls whether certain information prints on the Cart/Bin Batch Picking Pullsheet. Currently, there is no information to define.
JFLR0393CSV PICKING_PULLSHEET_CARTBIN_CSV	Controls whether certain information prints on the Cart/Bin Batch Picking Pullsheet in spreadsheet format. Currently, there is no information to define.
JFLR0397   PICKING_PULLSHEET	Controls whether certain information prints on the Cart/Bin Batch Picking Pullsheet. Currently, there is no information to define.
JFLR0397CSV PICKING_PULLSHEET_CSV	Controls whether certain information prints on the Cart/Bin Batch Picking Pullsheet in spreadsheet format. Currently, there is no information to define.
ORDERRECG ORDERREC,SUPPRESS_IMAGES=N Note:  These settings also apply to your graphical custom order receipt. This option is available only if your order receipt print program supports it.	Defines whether images print on the graphical Order Receipt. SUPPRESS_IMAGES Controls whether the system prints images on the graphical order receipt. N (default) = Print images on the graphical order receipt. Y = Suppress images on the graphical order receipt. Note:  The SUPPRESS_IMAGES value should be N for the graphical order receipt.
ORDERSUM ORDERSUM,SUPPRESS_IMAGES=Y	Not currently implemented.
ORDERSUMG ORDERSUM,SUPPRESS_IMAGES=N	Not currently implemented.
PICKG =PICKDB,SUPPRESS_IMAGES=N,BARCODE_IMAGE=Code39,ORDER_BARCODE_IMAGE=Code39;INPUT_TYPE=XML Note:  These settings also apply to your graphical custom pick slip. Each option is available only if your pick slip print program supports it	Defines whether images and barcodes print on the graphical Pick Slip. SUPPRESS_IMAGES Controls whether the system prints images on the graphical pick slip. N (default) = Print images on the graphical pick slip. Y = Suppress images on the graphical pick slip. Note:  The SUPPRESS_IMAGES value should be N for the graphical pick slip. BARCODE_IMAGE Controls whether the system prints a barcode on the graphical pick slip. Code39 (default) = Print this type of barcode on the graphical pick slip. Code128 = Print this type of barcode on the graphical pick slip. Note:  Code 39 is a low-density format that encodes upper case letters (A to Z), digits (0 to 9), and some special characters. Code 128 is a high-density format that accepts alphanumeric or numeric-only codes, or all 128 ASCII characters. NOT DISPLAYED = Do not print barcodes on the graphical pick slip. Note:  This value is case-sensitive. ORDER_BARCODE_IMAGE Controls whether the system prints the order barcode on the graphical pick slip. The barcode is comprised of the company code, order number, and ship to number. Code39 (default) = Print this type of order barcode on the graphical pick slip. Code128 = Print this type of order barcode on the graphical pick slip. NOT DISPLAYED = Do not print the order barcode on the graphical pick slip. Note:  This value is case-sensitive. INPUT_TYPE Controls the means by which your pick slip printing program obtains the data to print on the pick slip. Valid values are: XML = The program uses the Pick Message from Order Management System (CWPickOut) to generate the pick slip. DB = The program queries the database to generate the pick slip. The INPUT_TYPE setting for the standard printing program PICKG is DB.
PICKAUTH PICK_AUTH_REPORT	Controls whether certain information prints on the Pick Authorization Error Report. Currently, there is no information to define.
PICKLBL PICKLBL,SUPPRESS_IMAGES=Y,BARCODE_IMAGE=Code39 Note:  These settings also apply to your non-graphical custom pick label. Each option is available only if your pick label print program supports it.	Defines whether images and barcodes print on the non-graphical pick label, as defined in the Pick Label Print Program (F28) system control value. SUPPRESS_IMAGES Controls whether the system prints images on the non-graphical pick label. N = Print images on the non-graphical pick label. Y (default) = Suppress images on the non-graphical pick label. Note:  TheSUPPRESS_IMAGES value should be Y for the non-graphical pick label. BARCODE_IMAGE Controls whether the system prints a barcode on the non-graphical pick label. Code39 (default) = Print this type of barcode on the non-graphical pick label. Code128 = Print this type of barcode on the non-graphical pick label. Note:  Code 39 is a low-density format that encodes upper case letters (A to Z), digits (0 to 9), and some special characters. Code 128 is a high-density format that accepts alphanumeric or numeric-only codes, or all 128 ASCII characters. NOT DISPLAYED = Do not print barcodes on the non-graphical pick label. Note:  This value is case-sensitive.
PICKPACK PICKPACK,SUPPRESS_IMAGES=Y	Not currently implemented.
PICKPACKG PICKPACK,SUPPRESS_IMAGES=N	Not currently implemented.
PICKUNIT PICK_UNIT_REPORT	Controls whether certain information prints on the Pick Unit Report. Currently, there is no information to define.
PPRORDERED PRODUCT_PERFORMANCE_ORDERED	Controls whether certain information prints on the Product Performance Report (Ordered Totals). Currently, there is no information to define.
PPRORDEREDF PRODUCT_PERFORMANCE_ORDERED_FAST	Controls whether certain information prints on the Product Performance Report (Ordered Totals). Currently, there is no information to define.
PPRORDEREDFCSV PRODUCT_PERFORMANCE_ORDERED_FAST_CSV	Controls whether certain information prints on the Product Performance Report (Ordered Totals) in spreadsheet format. Currently, there is no information to define.
PPRORDEREDOT PRODUCT_PERFORMANCE_ORDERED_BY_ORDER_TYPE	Controls whether certain information prints on the Product Performance Report (Ordered Totals). Currently, there is no information to define.
PPRSHIPPED PRODUCT_PERFORMANCE_SHIPPED	Controls whether certain information prints on the Product Performance Report (Ordered Totals). Currently, there is no information to define.
PPRSHIPPEDF PRODUCT_PERFORMANCE_SHIPPED_FAST	Controls whether certain information prints on the Product Performance Report (Shipped Totals). Currently, there is no information to define.
PPRSHIPPEDFCSV PRODUCT_PERFORMANCE_SHIPPED_FAST_CSV	Controls whether certain information prints on the Product Performance Report (Shipped Totals) in spreadsheet format. Currently, there is no information to define.
PPRSHIPPEDOT PRODUCT_PERFORMANCE_SHIPPED_BY_ORDER_TYPE	Controls whether certain information prints on the Product Performance Report (Shipped Totals). Currently, there is no information to define.
PRCCDUPLDERR PRICE_CODE_UPLOAD_ERROR_REPORT	Controls whether certain information prints on the Price Code Upload Errors Report. Currently, there is no information to define.
PROMOUPLDERR PROMOTION_UPLOAD_ERROR_REPORT	Controls whether certain information prints on the Promotion Upload Error Records Report. Currently, there is no information to define.
PROVRCIRPT PRICE_OVERRIDE_REASON_BY_CODE_AND_ITEM	Controls whether certain information prints on the Price Override Reason Report by reason code and item. Currently, there is no information to define.
PROVRCIRPTCSV PRICE_OVERRIDE_REASON_BY_CODE_AND_ITEM_CSV	Controls whether certain information prints on the Price Override Reason Report by reason code and item in spreadsheet format. Currently, there is no information to define.
PROVRCRPT PRICE_OVERRIDE_REASON_BY_CODE	Controls whether certain information prints on the Price Override Reason Report by reason code. Currently, there is no information to define.
PROVRCRPTCSV PRICE_OVERRIDE_REASON_BY_CODE_CSV	Controls whether certain information prints on the Price Override Reason Report by reason code in spreadsheet format. Currently, there is no information to define.
PROVRIRPT PRICE_OVERRIDE_REASON_BY_ITEM	Controls whether certain information prints on the Price Override Reason Report by item. Currently, there is no information to define.
PROVRIRPTCSV PRICE_OVERRIDE_REASON_BY_ITEM_CSV	Controls whether certain information prints on the Price Override Reason Report by item in spreadsheet format. Currently, there is no information to define.
PROVRRPT PRICE_OVERRIDE_REASON	Controls whether certain information prints on the Price Override Reason Report. Currently, there is no information to define.
PROVRRPTCSV PRICE_OVERRIDE_REASON_CSV	Controls whether certain information prints on the Price Override Reason Report in spreadsheet format. Currently, there is no information to define.
PROVRUCIRPT PRICE_OVERRIDE_REASON_BY_USER_CODE_AND_ITEM	Controls whether certain information prints on the Price Override Reason Report by user code and item. Currently, there is no information to define.
PROVRUCIRPTCSV PRICE_OVERRIDE_REASON_BY_USER_CODE_AND_ITEM_CSV	Controls whether certain information prints on the Price Override Reason Report by user code and item in spreadsheet format. Currently, there is no information to define.
PROVRUCRPT PRICE_OVERRIDE_REASON_BY_USER_AND_CODE	Controls whether certain information prints on the Price Override Reason Report by user code and reason code. Currently, there is no information to define.
PROVRUCRPTCSV PRICE_OVERRIDE_REASON_BY_USER_AND_CODE_CSV	Controls whether certain information prints on the Price Override Reason Report by user code and reason code in spreadsheet format. Currently, there is no information to define.
PROVRUIRPT PRICE_OVERRIDE_REASON_BY_USER_AND_ITEM	Controls whether certain information prints on the Price Override Reason Report by user code and item. Currently, there is no information to define.
PROVRUIRPTCSV PRICE_OVERRIDE_REASON_BY_USER_AND_ITEM_CSV	Controls whether certain information prints on the Price Override Reason Report by user code and item in spreadsheet format. Currently, there is no information to define.
PROVRURPT PRICE_OVERRIDE_REASON_BY_USER	Controls whether certain information prints on the Price Override Reason Report by user. Currently, there is no information to define.
PROVRURPTCSV PRICE_OVERRIDE_REASON_BY_USER_CSV	Controls whether certain information prints on the Price Override Reason Report by user in spreadsheet format. Currently, there is no information to define.
PURCHORDG PURCHORD,SUPPRESS_IMAGES=N Note:  These settings also apply to your graphical custom purchase order. This option is available only if your purchase order print program supports it.	Defines whether images print on the graphical Purchase Order SUPPRESS_IMAGES Controls whether the system prints images on the graphical purchase order. N (default) = Print images on the graphical purchase order. Y = Suppress images on the graphical purchase order. Note:  The SUPPRESS_IMAGES value should be N for the graphical purchase order.
QUOTE QUOTE,SUPPRESS_IMAGES=Y Note:  These settings also apply to your non-graphical custom quote form. This option is available only if your quote print program supports it.	Defines whether images print on the non-graphical Quote Form. SUPPRESS_IMAGES Controls whether the system prints images on the non-graphical quote form. N = Print images on the non-graphical quote form. Y (default) = Suppress images on the non-graphical quote form. Note:  The SUPPRESS_IMAGES value should be Y for the non-graphical quote form.
QUOTEG QUOTE,SUPPRESS_IMAGES=N Note:  These settings also apply to your graphical custom quote form. This option is available only if your quote print program supports it.	Defines whether images print on the graphical Quote Form. SUPPRESS_IMAGES Controls whether the system prints images on the graphical quote form. N (default) = Print images on the graphical quote form. Y = Suppress images on the graphical quote form. Note:  The SUPPRESS_IMAGES value should be N for the graphical quote form.
REFCHECK REFCHECK,SUPPRESS_IMAGES=Y,TEXT_AMOUNT_UPPERCASE=N,INCLUDE_DOLLAR_SIGN=Y Note:  These settings also apply to your non-graphical custom refund check. This option is available only if your refund check print program supports it.	Defines whether images and a dollar sign print on the non-graphical Refund Check. SUPPRESS_IMAGES Controls whether the system prints images on the non-graphical refund check. N = Print images on the non-graphical refund check. Y (default) = Suppress images on the non-graphical refund check. Note:  The SUPPRESS_IMAGES value should be Y for the non-graphical refund check. TEXT_AMOUNT_UPPERCASE Defines whether the system prints text on the non-graphical refund check in all uppercase. N = Print text on the non-graphical refund check in upper and lower case. Y = Print text on the non-graphical refund check in all uppercase. INCLUDE_DOLLAR_SIGN Defines whether the system prints the dollar sign on the non-graphical refund check. N = Do not print the dollar sign on the non-graphical refund check. Y = Print the dollar sign on the non-graphical refund check.
REFCHECKG REFCHECK,SUPPRESS_IMAGES=N,TEXT_AMOUNT_UPPERCASE=N,INCLUDE_DOLLAR_SIGN=Y Note:  These settings also apply to your graphical custom refund check. This option is available only if your refund check print program supports it.	Defines whether images and a dollar sign print on the graphical Refund Check. SUPPRESS_IMAGES Controls whether the system prints images on the graphical refund check. N (default) = Print images on the graphical refund check. Y = Suppress images on the graphical refund check. Note:  The  SUPPRESS_IMAGES value should be N for the graphical refund check. TEXT_AMOUNT_UPPERCASE Defines whether the system prints text on the graphical refund check in all uppercase. N = Print text on the graphical refund check in upper and lower case. Y = Print text on the graphical refund check in all uppercase. INCLUDE_DOLLAR_SIGN Defines whether the system prints the dollar sign on the graphical refund check. N = Do not print the dollar sign on the graphical refund check. Y = Print the dollar sign on the graphical refund check.
REPLENDTLSHC REPLENDTLSHC,BARCODE_IMAGE=Code128
RESAUDITLOG RESET_AUDIT_LOG	Controls whether certain information prints on the Print Reset Audit Log. Currently, there is no information to define.
RESETBO RESET_AUDIT_LOG_QTY_BACKORDERED	Controls whether certain information prints on the Reset Audit Log for Quantity on Backorder. Currently, there is no information to define.
RESETONHAND RESET_AUDIT_LOG_QTY_ON_HAND	Controls whether certain information prints on the Reset Audit Log for Quantity On Hand. Currently, there is no information to define.
RESETPRT  RESET_AUDIT_LOG_QTY_PRINTED_ITEM_LOC	Controls whether certain information prints on the Reset Audit Log for Quantity Printed. Currently, there is no information to define.
RESETRSV RESET_AUDIT_LOG_QTY_RESERVED	Controls whether certain information prints on the Reset Audit Log for Quantity Reserved. Currently, there is no information to define.
RESETSKU RESET_AUDIT_LOG_SKU_QTYS	Controls whether certain information prints on the Reset Audit Log for SKU Quantities. Currently, there is no information to define.
RETARSNNOITM RETURN_ALL_REASON_NO_ITEM	Controls whether certain information prints on the Return Reason Report. Currently, there is no information to define.
RETARSNNOITMCSV  RETURN_ALL_REASON_NO_ITEM_CSV	Controls whether certain information prints on the Return Reason Report in spreadsheet format. Currently, there is no information to define.
RETARSNWITM RETURN_ALL_REASON_WITH_ITEM	Controls whether certain information prints on the Return Reason Report by item. Currently, there is no information to define.
RETARSNWITMCSV RETURN_ALL_REASON_WITH_ITEM_CSV	Controls whether certain information prints on the Return Reason Report by item in spreadsheet format. Currently, there is no information to define.
RETRSNNOITM RETURN_SPECIFIC_REASON_NO_ITEM	Controls whether certain information prints on the Return Reason Report by reason code. Currently, there is no information to define.
RETRSNNOITMCSV RETURN_SPECIFIC_REASON_NO_ITEM_CSV	Controls whether certain information prints on the Return Reason Report by reason code in spreadsheet format. Currently, there is no information to define.
RETRSNWITM  RETURN_SPECIFIC_REASON_WITH_ITEM	Controls whether certain information prints on the Return Reason Report by reason code and item. Currently, there is no information to define.
RETRSNWITMCSV RETURN_SPECIFIC_REASON_WITH_ITEM_CSV	Controls whether certain information prints on the Return Reason Report by reason code and item in spreadsheet format. Currently, there is no information to define.
SLSJRN SALES_JOURNAL	Controls whether certain information prints on the Standard Sales Journal. Currently, there is no information to define.
SLSJRNCSV SALES_JOURNAL_CSV	Controls whether certain information prints on the Standard Sales Journal in spreadsheet format. Currently, there is no information to define.
SLSJRNDIV SALES_JOURNAL_BY_DIV	Controls whether certain information prints on the Sales Journal by Division. Currently, there is no information to define.
SLSJRNDIVCSV SALES_JOURNAL_BY_DIV_CSV	Controls whether certain information prints on the Sales Journal by Division in spreadsheet format. Currently, there is no information to define.
SLSUPERR SALES_REP_UPDATE_ERROR	Controls whether certain information prints on the Sales Rep Update Errors Report. Currently, there is no information to define.
SOLDOUT SOLDOUT	Controls whether certain information prints on the Soldout Notification Card. Currently, there is no information to define.
STRUPERR  STORE_UPDATE_ERROR	Controls whether certain information prints on the Store Update Errors Report. Currently, there is no information to define.
TAXJUR TAX_JURISDICTION_REPORT	Controls whether certain information prints on the Tax Jurisdiction Report. Currently, there is no information to define.
UTJOBMRPT JOB_MONITOR_STS_TXT	Controls whether certain information prints on the job monitor alert email; see Monitoring Jobs. Currently, there is no information to define.
UTSTSRPT SERENADE_STATUS_REPORT	Controls whether certain information prints on the Order Management System Status report. Currently, there is no information to define.

Integration Property Settings

Property Name	Description
ADDRESS_SERVICE_ENDPOINT_URL	Verify the URL used to connect to EDQ. This setting is delivered with the application and should not be changed.
ADDRESS_SERVICE_RETURN_LAYOUT	The name of the custom layout used for data mapping. This layout resides with Experian and should be set to Serenade. Do not change this setting.
API_SERVER_URL	Information will be provided at a later date.
API_TENANT_ACCESS_KEY	Information will be provided at a later date.
API_TENANT_SECRET_KEY	Information will be provided at a later date.
ASSOCIATE_FILE_PATH	The directory the Salesman Associate Upload Process monitors for new Salesman Associate files to process, if the File Storage API is not in use. However, even if the file storage API is enabled, the process still uses this folder to place files that have been uploaded prior to additional processing, so this property must be set up even if you use the file storage API. An example directory on the application server is /domain/conf/OMSFiles/File/Associate/, where domain is the WebLogic domain directory for Order Management System. Note:  The name of the file must start with SR and have a .TXT file extension; for example: SR00001.txt and SR00002.txt. If there are multiple eligible files, they are processed sequentially based on file name; SR00001 processes before SR00002. If you use the File Storage API, you can upload a zip file that contains a single text file with the same name, for example: SR00001.ZIP containing a text file named SR00001.TXT.
AVATAX_ACCOUNT	The account ID used for communication with the AvaTax tax interface when a company-specific account ID has not been provided in the AvaTax Account (M37) system control value. See Avalara AvaTax Setup for more information.
AVATAX_LICENSE	The license ID used for communication with the AvaTax tax interface when a company-specific license ID has not been provided in the AvaTax License (M38) system control value. The system encrypts this entry. See Avalara AvaTax Setup for more information.
CA_INVENTORY_FILE_LOCAL_FOLDER	The folder on the Order Management System server where the CAINV periodic function writes the inventory file. See Sending Current Inventory Information to ChannelAdvisor for background.
CA_INVENTORY_FILE_NAME	The file name for the CAINV periodic function to use when creating a file of current inventory levels for items. See Sending Current Inventory Information to ChannelAdvisor for background.
CA_PRODUCT_SERVICE_SUFFIX	The suffix to include in the URL used for the ChannelAdvisor price and inventory integration. The CAINV and CAPRICE periodic functions use a web service request to pass the generated price and inventory files to ChannelAdvisor. The URL is composed of the CA_SERVICES_URL_PREFIX concatenated with the CA_PRODUCT_SERVICE_SUFFIX, for example: https://api.channeladvisor.com/v1/ProductUpload. Defaults to vi/ProductUpload and should not ordinarily be changed. See Sending Current Inventory Information to ChannelAdvisor and Sending Current Prices to ChannelAdvisor for background.
CA_SERVICES_URL_PREFIX	The prefix to include in the URL used for the ChannelAdvisor price and inventory integration, as described above under the CA_PRODUCT_SERVICE_SUFFIX. Defaults to https://api.channeladvisor.com and should not ordinarily be changed. Note:  It is not necessary for this prefix to include a trailing slash in order to create the full URL of https://api.channeladvisor.com/v1/ProductUpload. The CAINV and CAPRICE functions insert the slash. See Sending Current Inventory Information to ChannelAdvisor and Sending Current Prices to ChannelAdvisor for background.
CHANNELADVISOR_ORDER_URL	The URL for: the CAORDUP periodic function to use when requesting new orders from ChannelAdvisor; see Importing Orders from ChannelAdvisor for background. Processing Refunds (MREF) to use when sending refund information to ChannelAdvisor; see Submitting Refunds for ChannelAdvisor Orders for background.
CHANNELADVISOR_SHIPPING_URL	The URL for the CASHIP periodic function to use when sending shipment confirmations to ChannelAdvisor; see Sending Shipment Confirmations to ChannelAdvisor for background.
CHANNELADVISOR_ PULL_ORDERS_MAX	The maximum number of orders that the GetOrderList function processes at once before sending the notification to ChannelAdvisor that the orders were successfully received and created. Each batch can include up to 50 orders. For example, if you set this property to 100, the function imports two batches of 50 orders. If no maximum is specified, a default of 50 orders applies.
CW_MANIFST_ENVIRONMENT_ID	The environment ID that identifies the Order Management System database environment associated with the Manifest Web Service. The environment ID associated with a database environment is defined in the dbconfig.properties file. You can locate the environment ID in this file by locating the database; the number in the first column for the database represents the environment ID. The default environment ID is 1. Required.
CW_MANIFST_USER_ID	The user ID that the Manifest Web Service uses to connect to the Order Management System database environment specified in the CW_MANIFEST_ENVIRONMENT_ID property. Note:  You must also create this user ID in Order Management System: as a valid user ID with administrator authority in Work with Users (WUSR), and See User Configuration in the Administration Guide for more information on creating a user ID. Required.
CW_POS_LOG_FILE_NAME	Specifies the name of the POSLog file, with the pound sign (#) indicating where to insert the three-position Default Location for ORCE Integration (K69). For example, if you set this property to Store #.POL, the file is named Store #123.POL, where 123 is the Default Location for ORCE Integration (K69).
CWDIRECTCP_ USPS_UPLOAD_ FILE	The location on the application server where the system should look for the City State data file when you use the Load USPS Zip Code File (LZPS) to update postal code data, if the File Storage API is not in use. However, even if the file storage API is enabled, the process still uses this folder to place files that have been uploaded prior to additional processing, so this property must be set up even if you use the file storage API. An example directory is /domain/conf/OMSFiles/LZIP/ctystate.txt, where domain is the WebLogic domain directory for Order Management System. Note:  If you are using multiple application servers, you need to update this setting on each server where you plan to use the Load USPS Zip Code File (LZPS) to update postal code data.
CYB_PAY_LINK_DECISION_MANAGER_ENABLED	Defines whether Cybersource Decision Manager Fraud Scoring processing is enabled in the Order Management System Point-to-Point integration with Cybersource. false = the Order Management System Point-to-Point integration with Cybersource does not support Decision Manager processing in Cybersource. Order Management System sends all authorization transactions to Cybersource with the decisionManager_enabled tag set to false, indicating Decision Manager processing should not occur. However, you can use Cybersource’s Decision Manager for authorization transactions you process on your web storefront. true = the Order Management System Point-to-Point integration with Cybersource supports Decision Manager processing in Cybersource. Order Management System sends all authorization transactions to Cybersource with the decisionManager_enabled tag set to true, indicating Decision Manager processing should occur. See Cybersource Point-to-Point Decision Manager Process for more details.
CYB_PAY_LINK_DECISION_MANAGER_MERCHANT_ID_OVERRIDE	The merchant ID provided by Cybersource to use during Decision Manager Fraud Scoring processing. Used as the portfolio merchant ID in the URL, and the child merchant ID is e passed as report parameter. If this setting is blank, the system uses the following hierarchy to determine the merchant ID to use: Merchant # field in the CC Paytype Cross Ref table Merchant ID field in the Merchant ID Override table Merchant ID field in the Authorization Services table
CYB_PAY_LINK_DECISION_MANAGER_PASSWORD	Note:  The Cybersource Decision Manager Update periodic function no longer uses this property, and the property has been discontinued.
CYB_PAY_LINK_DECISION_MANAGER_SEND_TO_PRODUCTION	Defines whether transactions are sent to the Cybersource Decision Manager TEST server or PRODUCTION server. true = Order Management System sends transactions to the Cybersource Decision Manager PRODUCTION server. false = Order Management System sends transactions to the Cybersource Decision Manager TEST server.
CYB_PAY_LINK_DECISION_MANAGER_USER_ID	Note:  The Cybersource Decision Manager Update periodic function no longer uses this property, and the property has been discontinued.
CYB_PAY_LINK_SERVICE	The name of the external system. Set this to Cybersource.
CYB_PAY_LINK_SERVICE_ENABLE_LOG	Defines whether the web service logs request and response messages. true = Order Management System writes request and response messages to the Cybersource log. false = Order Management System does not write request and response messages to the Cybersource log. Data security: Set this value to false unless you are troubleshooting the Order Management System integration with Cybersource. Once you are done troubleshooting, delete any log files that are created.
CYB_PAY_LINK _SERVICE_LOG_DIRECTORY	The location of the log written by the web service API program. Use this log to review the transactions processed between Order Management System and Cybersource. Data security: For data security, Order Management System masks credit card information in this log. An example directory is domain/conf/OMSFiles/Integrations/Cybersource/Log, where domain is the WebLogic domain directory for Order Management System.
CYB_PAY_LINK_ SERVICE_KEY_ DIRECTORY	The location of the encrypted security key file used by the web service API program to validate and secure transactions from Order Management System. An example directory is domain/conf/OMSFiles/Integrations/Cybersource/Key, where domain is the WebLogic domain directory for Order Management System.
CYB_PAY_LINK_SERVICE_SEND_TO_PRODUCTION	Defines whether transactions are sent to the Cybersource TEST server or PRODUCTION server. true = Order Management System sends transactions to the Cybersource PRODUCTION server. false = Order Management System sends transactions to the Cybersource TEST server.
DELETE_DUPLICATE_INVOICE_OUT_TRIGGERS	efines whether to delete duplicate invoice trigger records. This new property applies only when the Consolidate Invoice (B49) system control value is selected: If you consolidate invoices and do not run the INVOICE_OUT job all day, you should set this property to Y to remove duplicate trigger records. If you consolidate invoices and run the INVOICE_OUT job all day, you should leave this property set to N to prevent sending incomplete invoice data. Otherwise, if you do not consolidate invoices, this property is not used. Note: If you change the setting of this property, the new setting is effective immediately.
FILE_STORAGE_EXPORTS_ENABLED	Defines whether to place file data for export in the FILE_STORAGE table rather than placing the files in a folder for FTP. Set to true if the file storage API is enabled for exports; otherwise, false. See File Storage API for information.
FILE_STORAGE_IMPORTS_ENABLED	Defines whether to use the FILE_STORAGE table and the file storage API, rather than Work with File Uploads (WUPL), to upload files. Set to true if the file storage API is enabled for imports; otherwise, false. See File Storage API for information.
FILE_STORAGE_MAX_SIZE	The maximum size, in bytes, of a file that can be uploaded to the FILE_STORAGE table. Applies only if the FILE_STORAGE_IMPORTS_ENABLED property is set to true. If a file’s size exceeds this maximum, the API returns a 403 error and the upload fails. Uploaded files should be less than 1G in size, so this property should be set to 1073741824 or less.
IMAGE_URL_PREFIX	Specifies the prefix to use for the URL of a company logo, entity logo, at the Home page in Modern view, and the menu driver image to display on menu screens or print on forms, including the pick slip, purchase order, quote form, gift acknowledgment, and order receipt. Must point to a publicly available server. For example, set this property to https://SERVER:7500/images where SERVER is the name of the server, 7500 is the port, and images is the folder where company and entity logo images are stored. The URL for image.png might then be https://SERVER:7500/images/image.png. See Setting Up Company Logos for Menu Screens and the Modern View Home Page, Setting Up Menu Driver Images for Companies, and Setting Up Company Logos for Forms for more information. Note:  This URL is not used for item images. You need to specify the complete URL. See Setting Up Item Images for background.
JOB_NOTIFICATION_ENDPOINT_URL	Defines the URL to receive the Job Notification Outbound Message. When you set this URL, the change takes effect immediately. Required to generate the Job Notification message. See Using the Job Notification Outbound REST Message for more information. If the endpoint is not valid or cannot be reached for any reason, an error is written to the CWDirect.log. However, if the property is blank, a message such as the following is written to the APP log: DEBUG APP - message: Job Notification Outbound Webservice URL not mentioned in Property. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
LOYALTY_REWARDS_ACCOUNT_INQUIRY_PROCESSING	Not implemented.
LOYALTY_REWARDS_REDEEM_CERTIFICATE_PROCESSING	Not implemented.
LOYALTY_REWARDS_VOID_CERTIFICATE_PROCESSING	Not implemented.
MASS_CUSTDWNLD_CUSTOMER_CLASSES	The customer class used to determine which sold to customers to include in the Mass Customer Download. To define more than one customer class, separate the values with a comma. Example:  CL,NR Note:  You cannot add a blank value to this setting to include sold to customers that do not have a customer class defined. For example, you cannot enter CL, ,NR or CL,’’,NR. Leave this setting blank if you wish to include all sold to customers, regardless of the assigned customer class, in the Mass Customer Download.
MASS_CUSTDWNLD_ DOWNLOAD_ DIRECTORY	Required. The directory where Order Management System places the Mass Customer Download file to be sent to an external system. This can be a directory on the Order Management System application server or on another server. An example directory is domain/conf/OMSFiles/Integrations/Xlink, where domain is the WebLogic domain directory for Order Management System. Note:  If you define a directory on an external server, the remote destination folder must be a shared folder. See Mass Customer Download in the Web Services Guide on My Oracle Support (ID 2149144.1) for more information.
MASS_CUSTDWNLD_FILE_NAME	Required. The name of the Mass Customer Download file. The delivered setting is MassCustomerDownload. During processing, Order Management System adds the prefix TEMP to the name of the file; for example: TEMP_MassCustomerDownload Once processing is complete, Order Management System adds a date and time stamp to the file name; for example: MassCustomerDownload.20110128.170150340 Order Management System also archives the file in zip format; for example: MassCustomerDownload.20110128.170150340.zip
MASS_CUSTDWNLD_MESSAGE_WRAPPER	The XML root element name Order Management System adds to the beginning and end of the Mass Customer Download file to make the contents of the file a valid XML document. If you leave this setting blank, the file will not be a valid XML document; however, each message in the file will be a valid XML message.
ORCE_ALT_ID_OROMS	Indicates the Alt Key Type of the alternate key in Oracle Retail Customer Engagement that maps to the Order Management System customer number. Defaults to OROMS_ID, but you can override it. If the alternate key record of this type does not already exist in Customer Engagement for a customer, it is created when Customer Engagement receives an add or update customer message. Also, Customer Engagement adds a row to the CST_ALT_KEY_TYPCODE table in the Customer Engagement database if it does not already exist. An example of this setting in the Customer Engagement database is: ORCE_ALT_ID_OROMS=OROMS_ID An entry here is required to identify the customers for POSlog transactions. This alternate key type is passed in the POSlog transaction message as the TypeCode for the AlternateKey, in order to assign POSlog data with existing customers in Customer Engagement. Important: Consult your Oracle representative before you change the setting of this property if you have already enabled the customer integration between Order Management System and Customer Engagement, as previously assigned alternate keys in Customer Engagement will not match up when searching for customers.
ORCE_ALT_ID_WEB	Indicates the Alt Key Type of the alternate key in Oracle Retail Customer Engagement that maps to the e-commerce site’s customer number. How to define in Oracle Retail Customer Engagement? You can create a alternate key type such as EONE_USER_ID in Oracle Retail Customer Engagement by: sending the Customer Engagement Add or Update Customer Message from your e-commerce system with an AlternateKey whose TypeCode is EONE_USER_ID adding a row to the CST_ALT_KEY_TYPCODE table in the Oracle Retail Customer Engagement database Note:  See the Customer Engagement Customer Integration for information on how the e-commerce customer ID is used to identify the customer in the order API. An example of this setting is: ORCE_ALT_ID_WEB=OCP_CUST_ID
ORCE_CARD_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Oracle Retail Customer Engagement Card Services API. Set this to /OrceWebServices/v3_2/CardServicesApiService?wsdl where 3_2 is the version of the Card Services API. The highest supported version is 3_2.
ORCE_CUSTOMER_ID_DIRECTORY_PATH	Defines the location on the Order Management System application server where the Update Customer with Relate ID periodic function (program name PFRCIU) looks for the Oracle Retail Customer Engagement query results comma separated value file (CSV) to process. See Customer Engagement Update Customer with Relate ID Process. This setting must be a valid location on the Order Management System application server. An example directory setting is /domain/conf/OMSFiles/RelateData/customerID/, where  domain is the installed location of Order Management System.
ORCE_CUSTOMER_SERVICE_PREFIX	The system uses this property to build the URL for communication with Oracle Retail Customer Engagement. Set this to https://server:8447/ where: server = the name of your Oracle Retail Customer Engagement server 8447 = the port to use on the Oracle Retail Customer Engagement server
ORCE_CUSTOMER_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Customer Services API. Set this to /OrceWebServices/v2_3/CustomerServicesApiService?wsdl where 2_3 is the version of the Customer Services API. The highest supported version is 2_3.
ORCE_DAY_PHONE_LABEL	Indicates the Telephone Type in Oracle Retail Customer Engagement that maps to the daytime phone number in Order Management System. Should be set to BUSINESS. How to define in Oracle Retail Customer Engagement? You can create a telephone type of BUSINESS in Oracle Retail Customer Engagement by: sending the Customer Engagement Add or Update Customer Message with a ContactType of Phone and a SubTypeCode BUSINESS adding a row to the CST_PHONE_TYPCODE table in the Oracle Retail Customer Engagement database An example of this setting is: ORCE_DAY_PHONE_LABEL=BUSINESS
ORCE_DIRECTORY_PATH	Defines the location where Order Management System places the batch files to send to Oracle Retail Customer Engagement. If this setting is blank or an invalid path, the system writes a message to the Application Log: Order Management System: Item Feed not run because the ORCE_DIRECTORY_PATH was not set up on this server. Note:  Not related to the Customer Engagement Customer Integration. Order Management System application server example:  /domain/conf/OMSFiles/RelateData/ where, domain is the WebLogic domain directory for Order Management System. Note:  Because Order Management System uses this directory to stage files before executing a transfer through the file transfer service, this setting still needs to specify a valid path if you use Customer Engagement File Transfer Service (FTS).
ORCE_EVE_PHONE_LABEL	Indicates the Telephone Type in Oracle Retail Customer Engagement that maps to the evening phone number in Order Management System. Should be set to HOME. How to define in Oracle Retail Customer Engagement? You can create a telephone type of HOME in Oracle Retail Customer Engagement by: sending the Customer Engagement Add or Update Customer Message with a ContactType of Phone and a SubTypeCode HOME adding a row to the CST_PHONE_TYPCODE table in the Oracle Retail Customer Engagement database An example of this setting is: ORCE_EVE_PHONE_LABEL=HOME
ORCE_FAX_PHONE_LABEL	Indicates the Telephone Type in Oracle Retail Customer Engagement that maps to the third phone number in Order Management System. Should be set to MOBILE. The Third Phone Number Type (L53) system control value controls whether the third phone number is labeled as the mobile or fax number in Order Management System. Note: The name entered in the Third Phone Number Type (L53) system control value should match the value defined for the ORCE_FAX_PHONE_LABEL. How to define in Oracle Retail Customer Engagement? You can create a telephone type of FAX or MOBILE in Oracle Retail Customer Engagement by: sending the Customer Engagement Add or Update Customer Message with a ContactType of Phone and a SubTypeCode FAX or MOBILE adding a row to the CST_PHONE_TYPCODE table in the Oracle Retail Customer Engagement database An example of this setting is: ORCE_FAX_PHONE_LABEL=MOBILE
ORCE_LOYALTY_AWARD_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Oracle Retail Customer Engagement Award Account Services API. Set this to /OrceWebServices/v3_1/AwardAccountServicesApiService?wsdl where 3_1 is the version of the Award Account Services API. The highest supported version is 3_1.
ORCE_LOYALTY_PROMPT_ATTRIBUTE	The text to display on the in Modern View when prompting for loyalty enrollment. Defaults to Does the customer want to join the loyalty program? Up to 55 positions.
ORCE_LOYALTY_REG_MESSAGE	The text to display on the Customer Loyalty Registration Window, up to 55 positions.
ORCE_LOYALTY_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Oracle Retail Customer Engagement Loyalty Account Services API. Set this to /OrceWebServices/v3_4/LoyaltyAccountServicesApiService?wsdl where 3_4 is the version of the Loyalty Account Services API. The highest supported version is 3_4.
ORCE_REGISTRY_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50)ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Oracle Retail Customer Engagement Registry Service API. Set this to /v3_1/RegistryServices?wsdl where 3.1 is the version of the Registry Service API. The highest supported version is 3_1.
ORCE_SECURITY_USER_ID	The Oracle Retail Customer Engagement user ID with Security Group permission included in the Oracle Retail Customer Engagement API messages. This setting must be a valid user ID in Oracle Retail Customer Engagement that has Security Group permission.
ORCE_SVC_SERVICE_SUFFIX	The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Oracle Retail Customer Engagement Stored Value Card Transaction Services API. Set this to /OrceWebServices/v3_1/SvcTransactionServicesApiService?wsdl where 3_1 is the version of the Stored Value Card Transaction Services API. The highest supported version is 3_1.
OROB_DISCOVERY_SERVICES_WSDL_LOCATION	The endpoint for the Discovery Services web service. This entry should be set to https://SERVER:8443/Locate/DiscoveryServices, where SERVER is the name of your Oracle Retail Order Broker server. See Importing Store Cross Reference Locations through Order Broker’s Discovery Web Service.
OROB_IMPORTS_ENABLED	Defines whether the system uses the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory import files to the OROB-Imports location on the Order Broker application server. true = The system uses the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory files to the OROB-Imports location in Order Broker. Note: Set this value to true only if you are use Order Broker version 18.0 or higher. false = The system does not use the Order Broker Import RESTful web service to automatically upload product, product location, and incremental inventory files to Order Broker. Instead, the system places the generated file in the location on the application server defined in the OROB_DIRECTORY_PATH property and you must use sFTP to move the files to the OROB-Imports location in Order Broker. Once the import file is in the OROB-Imports location in Order Broker, you must use the Schedule Import Process screen in Order Broker to process the import. You can also run the import on demand from this screen. See Importing Store Cross Reference Locations through Order Broker’s Discovery Web Service.
OROB_INVENTORY_AVAILABILITY_SKU_LIMIT	The maximum number of items/SKUs flagged as Active PO to include in each inventory availability request to Order Broker. The ACTPO periodic function generates this request message as part of future receipts and pre-order processing. The maximum number of records that Order Broker will process per request is 500. When this property is blank or is set to a number higher than 500, the request can include up to 500 records if there are that many Active PO items/SKUs evaluated by the periodic function. If there are more than 500 records, the next group of records is included in the next request message. Defaults to 500.
OROB_INVENTORY_AVAILABILITY_URL	The URL to use when submitting the inventory availability request to Order Broker through the ACTPO periodic function. Should be set to https://<SERVER>:<PORT>/Locate/adws/ProductService/1.0/getInventoryAvailability, where <SERVER> is the name of the Order Broker server, <PORT> is the port, and 1.0 is the version.
OROB_LIMITED_STATUS_BEG_TIME OROB_LIMITED_STATUS_END_TIME	Defines settings for the Daily Status Inquiry Time Window (all versions). These settings apply to retail pickup and ship-for-pickup orders. Overview: For certain Order Broker statuses, it is not necessary to send a status inquiry as frequently as the Order Broker Status Update Interval (K10), because no immediate action is required in Order Management System. These statuses apply to retail pickup and ship-for-pickup orders: In transit: the order has been shipped to the store location. received: the order has been received at the store location, but the customer has not yet picked it up. partially fulfilled: the customer has picked up some of the items, or quantity of items on the order, but has not yet received the entire order. In order to avoid including orders in these statuses in the status list request more often than necessary, if the Use OROB for Ship for Pickup Fulfillment Assignment (M34) system control value is set to NEVER or blank, the BROKER process checks their status once daily during a specified time window. It uses the following two additional properties to determine the start and end of the window: OROB_LIMITED_STATUS_BEG_TIME=123456 OROB_LIMITED_STATUS_END_TIME=123456 Each time is indicated in HHMMSS format, military time. For example, if you set these properties to: OROB_LIMITED_STATUS_BEG_TIME=180000 OROB_LIMITED_STATUS_END_TIME=210000 Then the BROKER process can send status inquiry list requests for these orders between 6:00 p.m. and 9:00 p.m. daily. Orders are eligible for status inquiry if an inquiry has not taken place in the previous 12 hours. You should set the time window long enough to process status inquiries for all orders in the related statuses; also, the time window should not cross midnight.
OROB_MAXIMUM_STATUS_LIST_REQUEST_ORDERS	Defines the maximum number of request IDs to include in a single Status List request message to Order Broker. Defaults to 500, and should not exceed 1000. If you do not set this property to a number of 1 or higher, the maximum number of request IDs to use is set to 1, indicating to send requests for one request ID at a time. You need to stop and restart the BROKER job to apply a change to this property. Pick slip generation also uses this property to determine the maximum number of request IDs to include in a single status list request. For more information: See Order Broker Configuration.
OROB_MESSAGE_VERSION	Defines the message version to include in Order Broker and merchandise locator request messages that Order Management System sends to Order Broker. Version requirements: A message version of 5.0 or higher is required to use the status list request message and streamlined allocation at pick slip generation. See Use OROB Status Inquiry List Web Service (M05) and Use Streamlined Allocation (L63) for background. A message version of 16.0 or higher is required to use the Ship-for-Pickup Orders integration with Order Broker. A message version of 19.0 or higher is required to include the shipment_date tag in the status inquiry response message from Order Broker. This date indicates the actual date when the order line was shipped by the fulfilling location, provided the fulfilling system passed this date when it submitted the status update to Order Broker when reporting the fulfillment. The shipment date is available to include in shipment notifications to the customer; see Outbound Email API for more information. This property cannot be set higher than 19.9 for integration with Order Broker 19.x, or higher than 21.1 for integration with Order Broker 22.2.301.0 or higher. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Note:  To avoid unpredictable results, do not leave this property blank.
OROB_PURCHASING_SERVICES_MAX_UPDATES	Indicates the maximum number of drop ship updates for Oracle Retail Order Broker to include in drop ship status inquiry responses. For example, you might set this number to 100 to prevent a large number of status updates from impeding system performance. If this property is blank, Oracle Retail Order Broker does not limit the number of updates included in the response message.
OROB_PURCHASING_SERVICES_MESSAGE_VERSION	Specifies the outbound message version to send to Oracle Retail Order Broker for integration with the Supplier Direct Fulfillment module. Should be set to 4.5 or higher.
OROB_PURCHASING_SERVICES_WSDL_LOCATION	The endpoint for the Purchasing Services web service. This entry should be set to https://SERVER:8443/Locate/PurchasingServices, where SERVER is the name of your Oracle Retail Order Broker server.
OROB_SERVICES_WSDL_LOCATION	The endpoint for the Services web service. This entry should be set to https://SERVER:8443/Locate/LocateServices, where SERVER is the name of your Oracle Retail Order Broker server.
PMD_PAY_LINK_SERVICE	The name of the external system. Note:  This field is not currently implemented.
PMD_PAY_LINK_SERVICE_BATCH_DEPOSIT_PORT	The port number used to connect to Paymentech to process batch deposit transactions. Note:  Defining a separate port number to process batch deposit transactions allows you to run pick slip generation (batch authorizations) and deposits at the same time. Leave this setting blank if you wish to use the port number defined for the PMD_PAY_LINK_SERVICE_BATCH_PORT property to process both batch authorization and deposit transactions; if you use the same port number to process batch authorization and deposit transactions, you cannot run pick slip generation and deposits at the same time. Note:  This setting is not currently implemented.
PMD_PAY_LINK_SERVICE_BATCH_IP_ADDRESS	The IP address used to connect to Paymentech to process batch transactions. Note:  This setting is not currently implemented.
PMD_PAY_LINK_SERVICE_BATCH_PORT	The port number used to connect to Paymentech to process batch transactions. Note:  This setting is not currently implemented.
PMD_PAY_LINK_SERVICE_ONLINE_IP_ADDRESS	The IP address used to connect to Paymentech to process online transactions. Note:  This setting is not currently implemented.
PMD_PAY_LINK_SERVICE_ONLINE_PORT	The port number used to connect to Paymentech to process online transactions. Note:  This setting is not currently implemented.
QAS ADDRESS SERVICE TOKEN	Enter the address service token used by EDQ to identify a customer; this is a token you created in the EDQ self service portal.
STORE_FILE_PATH	The directory the Store Upload Process monitors for new Store files to process. Note:  The name of the file must start with ST and have a .TXT file extension; for example: ST00001.txt and ST00002.txt. An example directory on the application server is /domain/conf/OMSFiles/File/Store/, where domain is the WebLogic domain directory for Order Management System. See Store Upload. Note:  The File Storage API does not support uploading stores. If the file storage API is enabled, you need to use Work with File Uploads (WUPL) to upload stores.
UPDATE_ON_ORDER_FROM_PO_LAYERING	Select this property to have the warehouse on-order quantity updated through the purchase order layering process. Default = false. You should set this property to TRUE if you upgrade to 19.0 or higher from a release prior to 18.0, in order to have PO layering update the on-order quantity consistently with prior functionality. You should leave this property set to FALSE if you use the enterprise order integration for future receipts and pre-order processing. See Purchase Order Layering for background on the purchase order layering process.
VERTEX_PASSWORD, VERTEX_USER	The user ID and password used to connect to Vertex. The password is encrypted. See Vertex Setup.
VERTEX_SERVICE_ENDPOINT_URL	The URL used to communicate with Vertex, such as http://example.com/vertex-ws/services/CalculateTax90, where 90 indicates the version of Vertex, such as 9.0. See Vertex Setup.
XLINK_DIRECTORY_ARCHIVE_PATH	The directory where the POSLOGX periodic function archives a copy of the custom POSlog sent to Xlink. This directory is used if the FILE_STORAGE_EXPORTS_ENABLED property is set to false. Otherwise, if file storage exports are enabled, the function adds a record to the OMS-POSLOG container of the FILE_STORAGE table with a zip file containing the POSlog file, and you can use the file storage API to retrieve the file. The zip file has the same name as the POSlog file, except for the .zip extension. See File Storage API for background.
XLINK_DIRECTORY_PATH	The directory where the POSLOGX periodic function places a custom POSlog to send to Xlink if you are not using the file storage API, as described above.
XLINK_POSLOG_FILE_DATETIME XLINK_POSLOG_FILE_EXTENSION XLINK_POSLOG_FILE_FORMAT XLINK_POSLOG_FILE_PREFIX XLINK_POSLOG_FILE_TRIGGER_EXTENSION	Used to create the name of a custom POSLog: the date and time format. the file extension. the file format. the file prefix. the file trigger extension.

System Property Settings

The settings below define configuration settings for the Order Management System application server.

Property Name	Description
CWDIRECTCP_ USPS_UPLOAD_ FILE	The location on the Order Management System application server where the system should look for the City State data file when you use the Load USPS Zip Code File (LZPS) to update postal code data. An example directory is /domain/conf/OMSFiles/LZIP/ctystate.txt/, where domain is the WebLogic domain directory for Order Management System. Note that even if you use the File Storage API, the upload process uses the folder specified in this property, so you must set it up. Note:  If you are using multiple application servers, you need to update this setting on each server where you plan to use the Load USPS Zip Code File (LZPS) to update postal code data.
DECIMAL_SEPARATOR	The character format used to indicate the decimal place in a number on screens. Valid value are: . (period); default , (comma) For example, if you enter . (period) as the decimal separator, a number with decimals displays as 123.45. If you enter , (comma) as the decimal separator, a number with decimals displays as 123,45. During installation, the system prompts for the default decimal separator of Order Management System. The system stores the default decimal separator in this property. Important: If you change the default decimal separator from the decimal separator selected during installation, the new default decimal separator applies only to new data; seed data provided during installation will not be translated to the new decimal separator format. The decimal separator used on reports generated through Oracle Analytics Cloud is based on the BI Date and Separator Format defined for the company. See Regional Settings for an overview, and see Where are Number Format Applied? for more information on the decimal separator that defaults to different areas of the application.
DEFAULT_DATE_FORMAT	The default date format used in the application. Valid values are: MY (DDMMYY) = If the date is December 25 2018, the date displays as 251218. MDY (MMDDYY) = If the date is December 25 2018, the date displays as 122518. YMD (YYMMDD) = If the date is December 25 2018, the date displays as 161228. During installation, the system prompts for the default date format of Order Management System. The system: Stores the default date format in this property. Important: If you change the default date format from the date format selected during installation, the new default date format applies only to new users and companies; seed data provided during installation will not be translated to the new default date format. Defaults this date format to the admin user that is created during installation. Defaults this date format to the Date format field in the Company table for the companies delivered with Order Management System. However, you can change the date format for a company in the Work with Company (WCMP) menu option. When you create a new user or company, the system assigns the default date format to the user or company. However, you can change the date format defined for a user in the Work with Users (WUSR) menu option and you can change the date format for a company in the Work with Company (WCMP) menu option. Note:  Regardless of the date format that displays on screens, dates are stored in the database in CYYMMDD format. The date format to use on reports generated through Oracle Analytics Cloud is based on the BI Date and Separator Format defined for the company. Note:  In order to have a consistent date format on all reports, this property and the Date Format defined for the company should be the same. See Regional Settings for an overview and see Where are Number Format Applied? for more information on the date format used for different areas of the application.
DEFAULT_LOCALE	The default locale used in the application, indicating the default language for the application. During installation, the system: Stores the default locale in this property. Defaults this locale to the admin user that is created during installation. Defaults this locale to the Locale field in the Company table for the companies delivered with Order Management System. When you create a new user or company, this default locale defaults, but you can override it. See: Regional Settings for an overview. Where are Date Formats Applied? for more information on which date format the system uses in different areas of the application. Where are Number Format Applied? for more information on the decimal and thousand separators the system uses in different areas of the application.
ECOMMERCE_AVAILABILITY_XML_VERSION	The XML version of the Availability Web XML message received from an external system; see E-Commerce Availability Web API. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
ECOMMERCE_PRODUCT_XML_VERSION	The XML version of the ProductWeb XML message generated through Downloading E-Commerce Offer Files (EOFR) when the Generate E-Commerce Offer Tables (M29) system control value is unselected.
oms.ui.session.timeout	The number of minutes before an inactive user session times out in either Classic View or Modern View. Your entry can be a whole number from 15 to 1440. Defaults to 30 minutes, and an inactivity timeout interval of 30 minutes applies if this property is blank.
THOUSAND_SEPARATOR	The character format used to separate groups of thousands. Valid value are: , (comma); default . (period) For example, if you enter . (decimal) as the thousand separator, a number with thousand displays as 1.000. If you enter , (comma) as the thousand separator, a number with thousand displays as 1,000. During installation, the system prompts for the default thousand separator of Order Management System. The system stores the default thousand separator in this property. Important: If you change the default thousand separator from the thousand separator selected during installation, the new default thousand separator applies only to new data; seed data provided during installation will not be translated to the new thousand separator format. The thousand separator used on reports generated through Oracle Analytics Cloud is based on the BI Date and Separator Format defined for the company. See Regional Settings for an overview and see Where are Number Format Applied? for more information on the thousand separator that defaults to different areas of the application.

Working with Admin Properties (CPRP)

Purpose: Use this menu option to define system-wide configuration settings for Order Management System that an administrator would update.

When you update a property setting, your update takes effect immediately.

In this topic:

• Work with Admin Properties Screen

• Change Property Screen

• Summary of Admin Properties

  • Email Property Settings

  • Forms Property Settings

  • Integration Property Settings

  • Logging Property Settings

  • Monitor Property Settings

  • System Property Settings

Work with Admin Properties Screen

Use this screen to define property settings that are available to an administrator user in the application.

How to display this screen: Enter CPRP in the Fast path field or select Work with Admin Properties from a menu.

When you first advance to this screen, property settings display on this screen in ascending property name sequence.

Column sort: You can sort on any column on this screen by clicking the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.

Field	Description
Group	The type of property setting. Valid values are: Email: The property setting is related to email processing. Logging: The property setting is related to logging. Integration: The property setting is related to an integration with an external system. Monitor: The property setting is related to job monitoring. Printing: The property setting is related to printing. System: The property setting is related to a system-wide function. Enter a full or partial group name to display property settings that contain your entry. Alphanumeric, 25 positions; optional.
Property	The name of the property. Enter a full or partial property name to display property settings that contain your entry. Alphanumeric, 75 positions; optional.
Value	The current setting of the property. If this field is blank, it means a property setting has not been defined. Enter a full or partial property value to display property settings that contain your entry. Alphanumeric, 150 positions; optional.
Type	The type of property setting. Valid values are: Admin = The property setting is a setting available to an administrator user in the application. Customer = The property setting is a setting available to a user in the application. Enter a full or partial property type to display property settings that contain your entry. Alphanumeric, 10 positions; optional.

Screen Option	Procedure
Change the current value defined for a property	Select Change for a property to advance to the Change Property screen.
Switch between viewing admin property settings and customer property settings	Select Admin/Customer. If you are currently on the Work with Admin Properties screen, the system advances you to the Work with Properties Screen. If you are currently on the Work with Properties screen, the system advances you to the Work with Admin Properties Screen.

Change Property Screen

Purpose: Use this screen to change a property setting.

How to display this screen: Select Change for a property on the Work with Admin Properties Screen.

Field	Description
Property	The name of the property whose value you wish to update. Alphanumeric, 75 positions; display-only.
Group	The group assigned to the property. Alphanumeric, 25 positions; display-only.
Type	The type of property setting. Valid values are: Admin = The property setting is a setting available to the administrator user. Customer = The property setting is a setting available to customer. Alphanumeric, 10 positions; display-only.
Display	Defines whether you can update the property setting. Valid values are: C = You can change the value defined for the property. D = The value defined for the property is display-only. Alphanumeric, 1 position; display-only.
Value	The current setting of the property. If this field is blank, it means a property setting has not been defined. Note:  The system does not validate your entry. Alphanumeric, 150 positions; optional.

Summary of Admin Properties

The property settings that display on the Work with Admin Properties Screen are listed below.

• Email Property Settings

• Forms Property Settings

• Integration Property Settings

• Logging Property Settings

• Monitor Property Settings

• System Property Settings

Email Property Settings

See Email Generation Setup for more information on the required and optional setup for generating email notifications through Order Management System.

Property Name	Description
CWEMAIL_TEMPLATE_PATH	The location of the folder containing the template files used to generate HTML-based emails. An example location is domain/conf/OMSFiles/EmailTemplates, where domain is the WebLogic domain directory for Order Management System. Not used for shipment emails generated through the Narvar integration.
CWEmailOutQueueName	The output queue to use for emails. Output queues are displayed when you select the My Jobs option in Order Management System, where you can use them for filtering purposes. The default output queue is EMAIL. Not used for shipment emails generated through the Narvar integration.
SUPPORT_EMAILS	The list of email addresses to receive the Support Notification email when a job is placed in MSG status because an error has occurred, or System Alert email for other errors such as inconsistent system control value setup across companies. Separate each email address with a semi-colon (;), such as: [e-mail];[e-mail]. Note:  You cannot enter an email distribution list in this field. However, you can use an email program, such as Microsoft Outlook®, to create rules to send emails to a distribution list. See Order Management System Support Notification for more information on error email processing.

Forms Property Settings

Property Name	Description
BI_BYPASS_CACHE_ENABLE	Defines whether the system bypasses caching for reports generated using Oracle Business Intelligence Publisher. true = Bypass caching for reports generated using Oracle Business Intelligence Publisher. false = Cache reports generated using Oracle Business Intelligence Publisher.
BI_REST_REPORTS_FOLDER	The location in Oracle Analytics Cloud where Order Management System reports are stored. Needs to be set to OMSCS/Reports/.
BI_REST_URL	The name of the host where Oracle Business Intelligence Publisher is running. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/reports  where: host is the setting in the BI_REST_URL. port is the setting in the BI_REST_PORT. xmlpserver/service/rest/reports is the setting in the BI_REST_SERVER_PATH.
BI_REST_PORT	The IP port number where Oracle Business Intelligence Publisher is running. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/reports  where: host is the setting in the BI_REST_URL. port is the setting in the BI_REST_PORT. xmlpserver/service/rest/reports is the setting in the BI_REST_SERVER_PATH.
BI_REST_SERVER_PATH	The fixed prefix for Oracle Business Intelligence Publisher REST report resource. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/v1/reports  where: host is the setting in the BI_REST_URL. port is the setting in the BI_REST_PORT. xmlpserver/service/rest/v1/reports is the setting in the BI_REST_SERVER_PATH.
BI_REST_USER	The user ID used to connect to Oracle Business Intelligence Publisher.
BI_REST_PASSWORD	The password for the user ID used to connect to Oracle Business Intelligence Publisher. For security, the system encrypts the password.

Integration Property Settings

See Integrations for more information on the set up required for integrations with Order Management System.

Property Name	Description
CWDIRECTCP_UPLOAD_ BATCH_SIZE	Defines the number of records to process in an upload file at a time. The default setting is 2500, indicating the system inserts records from the upload file into the Order Management System database in batches of 2500. If a record in a batch contains an error, the system does not insert any of the records in the batch into the Order Management System database and places the upload file in an error status. For troubleshooting purposes, you can decrease the UPLOAD_BATCH_SIZE and reprocess the file upload to help you determine which record contains the error. Example:  In this example, the CWDIRECTCP_UPLOAD_BATCH_SIZE is 10. You process an upload file containing 30 records. In this situation, the system processes the upload file in 3 batches: the first batch contains records 1-10; the second batch contains records 11-20; and the third batch contains records 21-30. If a record in the second batch fails, the system does not process any of the records in the second batch, but does process all of the records in the first batch and third batch. See Work with File Uploads (WUPL) for more information.
	Setting for pick slip forms generated through the database: If you use a pick slip form that is generated directly through the database, set this value to 999999. The INPUT_TYPE setting for your pick slip form in the Forms Properties indicates the means by which your pick slip printing program obtains the data to print on the pick slip. Valid values are: XML (default) = The program uses the Pick Message from Order Management System (CWPickOut) to generate the pick slip. DB = The program queries the database to generate the pick slip. This option is available only if your pick slip printing program supports it. Note:  If no INPUT_TYPE is specified, the program uses the CWPickOut message.
ELO_CONFIG_URL	Defines the URL to use to establish a connection with Oracle Retail EFTConnect when you open the Payment Configurations page in Modern View. Contact your Oracle representative if this property is not defined, or if the Payment Configurations page in Modern View displays an error.
ELO_IDCS_ENDPOINT_URL	Defines the URL to use when requesting the token for OAuth authentication for the integration with EFTConnect. Setup of the EFTConnect outbound web service authentication is required in Work with Web Service Authentication (WWSA). Contact your Oracle representative if this property is not defined.
ELO_POLL_COUNT_THRESHOLD	Indicates how many times a Capture, Refund, or Auth+Capture can be resubmitted to EFTConnect before its status changes to Unconfirmed. The current poll count is tracked on the Credit Card Deposit record. If the poll count is equal to or greater than the setting of this property, the Credit Card Deposit record is deleted and the deposit is unconfirmed. You can then use Resubmit Rejected Deposits in Modern View to attempt to resubmit the deposit. Defaults to 3. Must be at least 1 and cannot be higher than 99. A change to this setting takes effect immediately.
ELO_PAYMENT_URL	Defines the URL to use for any transactional communication with EFTConnect, such as obtaining a form token, authorization, or deposit. Required for use of the Payment Configurations page in Modern View. Contact your Oracle representative if this property is not defined.
ELO_THRESHOLD_TIME	Information will be provided by Oracle at a later date.
ELO_TIMEOUT	Defines the number of milliseconds to wait before requests from Order Management System to EFTConnect time out. Defaults to 12000 milliseconds (12 seconds). Depending on the type of request and the payment provider, the record might stay in SENT status or RDY status; or, in the case of a new payment method, the payment information might not be saved and an error displayed.
IDCS_ENABLED	Defines whether the IDCS (Oracle Identity Cloud Service) or OCI IAM (Oracle Cloud Infrastructure Identity and Access Management) integration is enabled. false = The system uses internal password authentication. true (default) = The system uses IDCS or OCI IAM for password authentication. Note: Once you change this property to true, the setting can no longer be changed. If you need to change this setting back to false, you must contact your support representative to disable IDCS or OCI IAM. New cloud installations of Order Management System version 17.1 and later will have this setting delivered as true. When you enable the IDCS or OCI IAM integration, the system no longer creates records in the Password Audit table to track when a user’s password is updated. Before you change this value to true, make sure your admin user and other users in Order Management System are set up in IDCS or OCI IAM and match the exact format of the user name.    When this property is set to true, multi-factor authentication is disabled. See Multi-Factor Authentication in the Administration Guide for background. When defining a user ID in IDCS or OCI IAM, the user ID is NOT case-sensitive. If this property is set to true, when users sign out of Order Management System or OMS Modern View, they return to the IDCS or OCI IAM login page. When this property is set to true, working with User Control records is not available through the Advanced Commands option. See Oracle Authentication (IDCS or OCI IAM) in the Administration Guide for more information.
IDCS_SERVICE_ ENDPOINT_URL	The endpoint to use when requesting information from IDCS or OCI IAM through the Manage External Application Access page in Modern View.
IDCS_ACCESS_ APPLICATION_ID	Not currently implemented.
IDCS_ACCESS_CLIENT_ID	The client ID that identifies Order Management System in requests to IDCS or OCI IAM through the Manage External Application Access page in Modern View. If no Client ID is specified in Work with Web Service Authentication for an outbound web service to Order Broker or Customer Engagement, and it is assigned an Authentication Type of OAUTH, then this client ID is used for authentication of the web service.
IDCS_ACCESS_CLIENT_SECRET	The client secret to use when requesting a token for OAuth authentication. If no Client Secret is specified in Work with Web Service Authentication for an outbound web service to Order Broker or Customer Engagement, and it is assigned an Authentication Type of OAUTH, then this client secret is used for authentication of the web service.
INVOIC_OUT_MAX_THREADS	Controls the maximum number of threads that the INVOIC_OUT job spawns to process invoice trigger records. Defaults to 10. Optionally, set it to a higher number to enhance performance. If this property is not set to a whole number larger than 0, a setting of 1 applies. See the Generic Invoice Download API for more information on the INVOIC_OUT process in the  Web Services Guide on My Oracle Support (ID 2149144.1)
OCDS_RESPONSE_BATCH_SIZE	The number of records to request at a time for different types of data imported through the integration with Omnichannel Cloud Data Service (OCDS). Background: The OCDSITM periodic function requests merchandise hierarchy information, item information, item image information, item location attribute information, and pricing information, if the related system control value for each type of data is configured. Limiting the number of records in the response: For each of these types of data (with the exception of merchandise hierarchy information), the function requests the number of records specified in this property; for example, it requests up to 15,000 pricing information records when this property is set to 15,000. Oracle recommends that you set this property no higher than 100,000. The default setting is 10,000. If property not set: if this property is blank, the import requests the number of records defined in the INT_OCDS_CONFIG table for the import type. For example, if this property is blank and the quantity defined in the table for the item image import is 10,000, then the item image request specifies a quantity of 10,000. INT_OCDS_CONFIG defaults: The default settings in this table are 10,000 for each type of imported information. Note:  This setting does not control the number of records requested for the merchandise hierarchy import; instead, it always uses the setting from the INT_OCDS_CONFIG table. For more information: See Importing Enterprise Foundation Data through Omnichannel Cloud Data Service (OCDS).
OKM_ACCESS_PASSWORD	The OMS Key Management (OKM) password. For security, the system encrypts the password. See Credit Card Encryption Initial Setup and Execution in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for more information.
OKM_ACCESS_ALIAS	The OMS Key Management (OKM) alias used to retrieve the encryption key. For security, the system encrypts the alias. See Credit Card Encryption Initial Setup and Execution in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for more information.
OKM_ACCESS_ALIAS_SWITCH	The OMS Key Management (OKM) alias used to retrieve the encryption key during the encryption key switch process. For security, the system encrypts the alias. See Credit Card Encryption Initial Setup and Execution in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for more information.
OKM_ENABLED	Indicates whether OMS Key Management (OKM) encryption is enabled. true = OMS Key Management (OKM) encryption is enabled. false = OMS Key Management (OKM) encryption is not enabled. See Credit Card Encryption Initial Setup and Execution in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for more information.
OKM_KEY_SWITCH_TYPE	The type of encryption key switch currently in process. The system automatically updates this property during the encryption key switch process. Once the encryption key switch process is complete, you must manually remove the value to indicate that an encryption key switch is not currently being performed. Valid values are: Blank = Encryption key switch is not in process. OMS-OKM = Encryption key switch is in process, where the current encryption uses the Order Management System encryption key and the new encryption uses the OMS Key Management (OKM) encryption key. During this process, the system generates a new encryption key and alias. OKM-OMS = Not currently supported. OKM-OKM = Encryption key switch is in process, in which both the current encryption and the new encryption key use an OMS Key Management (OKM) encryption key and alias. OMS-OMS = Encryption key switch is in process in which both the current encryption and the new encryption use an Order Management System encryption key. See Encryption Key Switch Process in the Data Security and Encryption Guide on My Oracle Support (1988467.1) for more information.
OKM_PATH_1	See the Data Security and Encryption Guide on My Oracle Support (1988467.1) for information.
OKM_PATH_2	See the Data Security and Encryption Guide on My Oracle Support (1988467.1) for information.
QAS SERVICES WSDL LOCATION	The location of the ProOnDemandService.wsdl file. The recommended location is file:///domain/conf/cwdirectcpproperties/ProOnDemandService.wsdl, where domain is the WebLogic domain directory for Order Management System. The ProOnDemandService.wsdl is delivered with Order Management System and should not be changed.

Logging Property Settings

See Logs for more information on the logs that are available to help troubleshoot Order Management System processing.

Property Name	Description
CUST_FILE_NAME	The name of the log that stores Customer API transaction information. The delivered setting is CUST.log. If you Use Multiple Application Servers If you use multiple application servers, rename the log so that it identifies the server where the log is located. For example, if you use two application servers named SERVER1 and SERVER2, rename the CUST log on each server to CUSTSERVER1.log and CUSTSERVER2.log.
OCDS_JOB_HISTORY_RETENTION_DAYS	Defines the number of days to retain records in the INT_OCDS_STATUS table. This table tracks activity of the  and the OCDSFA periodic function (see Importing Future Available Information (OCDSFA Periodic Function) for background). You can review these records at the Enterprise Data Import History page in Modern View. The OCDSITM periodic function purges records older than the number of days specified here. Default = 30 days. If this property is blank, the periodic function does not purge records.
OROB_DIRECTORY_PATH	Defines the location on the application server where the system downloads the Product, Product Location, and Incremental Inventory output files to send to Order Broker. An example directory is /domain/conf/OMSFiles/OROBData, where domain is the WebLogic domain directory for Order Management System. Note: If the OROB_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not generate the output files and writes a message to the Application lo.g See Order Broker’s Product, Product Location, and Incremental Inventory Import Process for more information..
oms.db.query.log.threshold	Oracle staff can use this property to control when to log longer-running queries for troubleshooting purposes. Queries that run for longer than the number of milliseconds defined here create log entries that include terms such as Query Timer and took longer than logging threshold. Defaults to 4000 milliseconds.

Monitor Property Settings

The settings below are used by Oracle staff to manage system processing.

For more information: See:

• Monitoring Jobs for more information on how the system monitor jobs to ensure that they are running correctly.

• Long Running Jobs Monitor for more information on how the system watches the batch jobs running on the Job Management Screen and sends a Long Running Job Email to a specified email address if a job runs without ending longer than a specified time.

• Working with Required Responses (WREQ) and Required Response Processing for more information on how to respond to Order Management System jobs that require user intervention in order to proceed.

• Running a Periodic Process on Server Startup for more information on how to run a periodic process when the Order Management System application server is restarted.

Property Name	Description
ACTIVE_PROCEDURES	Used to filter data on the Managed Services report.
ALERT_EMAILS	The email addresses that receive Managed Services reports. Separate email addresses with a semi-colon.
ALLOW_JOB_MONITOR	Indicates whether the job monitor runs on this application server. Valid values: Y = The job monitor runs on this server. N (default) or blank = The job monitor does not run on this server. In this situation, the only option on the Work with Job Monitor Rules Screen is to display a rule’s settings. Note:  Set this value to Y for all application servers that you wish to collect data on the Work with Job Monitor Screen (WJMO).
INTEGRATION_PROCESS	Used to filter data on the Managed Services report.
JOB_HISTORY_PURGE_ DAYS	Defines how long to retain a batch job in the Job History table before the system purges it automatically based on the job’s End date. The default setting is 30 days. The system submits the Job History purge process each time you start the application server. Job History records that do not have an End Date (indicating the job did not end) are not purged. Note: This setting does not apply to the history records in the job_run_history table. These records are not currently purged. The job_run_history table contains records for the BILLUPD and SCHDDEP periodic functions. See Display Job History (DJHY) for more information.
JOB_MONITOR_QUERY_ DIRECTORY	The directory on the application server where you store queries used by the job monitor. An example directory is domain/conf/OMSFiles/JobMonitorQueries/, where domain is the installed location of Order Management System.
REPORT_TYPE	Indicates the format of the Managed Services report. pdf = Generate the Managed Services report in .pdf portable document format. rtf = Generate the Managed Services report in .rtf rich text format. txt = Generate the Managed Services report in .txt text format.
RESPONSE_EMAILS	The list of email addresses that receive the Response Required Email when a job requires user intervention. Each email address entered must be separated by a semi-colon (;). For example: [e-mail];[e-mail].
RESPONSE_RETRIES	The number of times Order Management System looks for a response to a job that requires user intervention before using the default response in order to proceed with the job. For example, if this setting is 5, Order Management System will look for a user response five times, waiting 60 seconds between each timeSee Working with Required Responses (WREQ).
SUBJECT_LINE	The text that displays in a Managed Services email.
SUPPRESS_EMAIL	Defines whether a Managed Services email is generated. Y = Do no generate Managed Services emails. N = Generate Managed Services emails.
TRACK_ALERTS_IN_LOG	Indicates whether you log all alerts generated by the job monitor. Valid values: Y = Log all alerts generated by the job monitor in the Alert Log. N or blank = Do not log alerts generated by the job monitor.
TRACK_ALERT_EMAILS_ IN_FOLDER	The directory on the application server where the system stores a copy of the alert emails generated by the job monitor. This directory is not delivered; an example location is /domain/conf/OMSFiles/JobMonitorEmails/, where domain is the installed location of Order Management System. Each alert email is stored in this directory using the following naming convention: ALERT_JOBNAME_RULENAME_DDMMYY_HHMMSS.txt, where: JOBNAME is job monitor name RULENAME is the job monitor rule name DDMMYY is the date the email alert was sent HHMMSS is the time the email alert was sent Example:  ALERT_BILL_ASYNC_BILLASYNCACTIVE_032713_083000 indicates the email alert was generated for the BILL_ASYNC job monitor and BILLASYNCACTIVE job monitor rule on March 27 at 8:30. Note:  The system does not save an alert email in this directory if the job monitor rule name contains any special characters.

System Property Settings

The settings below define configuration settings for the Order Management System application server.

Property Name	Description
CC_TOKENIZATION_DEFAULT_LOG_LEVEL	Information will be provided at a later date.
CC_TOKENIZATION_LOG_NAME	Information will be provided at a later date.
CHECK_AUTHS_IN_PICKS	Defines whether you can process Streamlined Pick Slip Generation (WSPS) when records exist for your company in the CC Authorization Transaction table. Valid values are: Y or this setting does not exist = Before processing Streamlined Pick Slip Generation (WSPS), the system first looks for records in the CC Authorization Transaction table for the company for which you are generating pick slips. If records exist in the CC Authorization Transaction table, the system does not continue with pick slip generation and instead generates a Pick Authorization Error Report and a Order Management System Support Notification. Review the records in the CC Authorization Transaction table to determine if you need to use the Reprocess Authorizations Screen (RPAA) to reprocess authorizations and clear the records from the CC Authorization Transaction table. N = The system allows you to run Streamlined Pick Slip Generation (WSPS) when records exist for your company in the CC Authorization Transaction table. Any records in the CC Authorization Transaction table will be resent for authorization. See Pick Slip Generation Overview.
COMMIT_RATE	The number of records that the Batch Inventory Overlay Upload should process at a time. Normally set to 1000.
CWDIRECTCP_FTP_FOLDER	The location of the FTP script for the POSLog integration (poslog_ftp_commands.script file). The script consists of: open | server | userID | passwd put | /poslog/FTP_REMOTE_FILE_NAME where: server = the name of the destination server userID = a valid user ID for the destination system passwd = the user ID’s password Note:  You should not modify the second line of the command file. This folder is also used for the following integrations: Integration with the Sales Audit Module of the Oracle Retail Merchandising Foundation Cloud Service Working with the Marketing Download Extract See these integrations for more information.
The CWDIRECTCP_LINK_TEXT and CWDIRECTCP_LINK_URL settings below allow you to add a link to all screens in Order Management System (with the exception of the menu screens, the DITH and MMCM menu options, and the administrative screens such as Job Management and Document Management).	Example:  If you enter Go To Google in the CWDIRECTCP_LINK_TEXT setting and http://www.google.com in the CWDIRECTCP_LINK_URL setting, then each screen will have a link that reads Go To Google that will open a new browser window and launch the URL to the Google web site.
CWDIRECTCP_LINK_TEXT	Defines the text to display on the Order Management System screens for the link. Example:  If you enter Go To CNN, then each screen will have a link that reads Go To CNN. If you are Using Multiple Application Servers If you are using multiple application servers, you will need to update this setting on each server.
CWDIRECTCP_LINK_URL	Defines the URL to launch when a user clicks the link on a Order Management System screen. Example:  If you enter http://www.cnn.com, the system opens a new browser window and launches the URL to advance to the CNN web site. If you are Using Multiple Application Servers If you are using multiple application servers, you will need to update this setting on each server.
Password Rules	The following settings identify the requirements for user passwords, including the minimum and maximum length and any required numeric, uppercase, or special characters. Note:  These settings are not currently used. When you change password rules: Your new password rules take effect for new users the next time you reboot Order Management System or the server itself. However, your password rules do not prevent existing users from logging in using passwords created under the previous rules. The new rules apply only when you attempt to change user control record settings or change the password itself. To make sure a user will change the password to conform to the new rules upon the next login, set the user’s Password Expired field to a date that is earlier than the current date. See User Configuration in the Administration Guide for more information.
CWDIRECTCP_UPLOAD_ DIRECTORY	The location on the application server where files are initially uploaded to Order Management System if the File Storage API is not enabled for imports. However, even if the file storage API is enabled for imports, the process still uses this folder to place files that have been uploaded prior to additional processing. See Work with File Uploads (WUPL) for more information.
CWMQ_TARGET_CLIENT	The default setting is 1.
CWMQ_WAIT_TIME	The default setting is -1.
CW_SECURITY_LEVEL	Information will be provided at a later date.
DEPOSIT_MAX_THREADS	Controls the number of threads available to process deposits. The default setting is 1. Optionally, set it to a higher number to enhance performance. You can enter any positive integer. If the property is empty, missing, or not set to an integer, a setting of 1 defaults. For more information: See Processing Auto Deposits (SDEP).
ECOMMERCE_DIRECTORY_PATH	Defines the location on the application server where the system downloads product offer and customer merge information if the FILE_STORAGE_EXPORTS_ENABLED property is set to false. An example directory is /domain/conf/OMSFiles/WebData/, where domain is the installed location of Order Management System. Note:  If the FILE_STORAGE_EXPORTS_ENABLED property is set to false: The system downloads product offer information to this directory when you download e-commerce offer files (EOFR) and the Generate E-Commerce Offer Tables (M29) system control value is unselected. See Downloading E-Commerce Offer Files (EOFR) for processing details. The system downloads customer merge information to this directory when Performing a Merge using the Working with Merge/Purge Sold-to Names (MMCS) menu option if the Generate E-Commerce Customer Merge Staging Files (H86) system control value is selected. The system downloads the AvailabilityWeb XML file to this directory when it receives the E-Commerce Availability Web Request XML Message (AvailabilityWebRequest). For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Note:  If the FILE_STORAGE_EXPORTS_ENABLED property is set to true, these files are not placed in this directory; instead, they are each included in a zip file of the same name and placed in the OMS-ECOMMERCE container of the FILE_STORAGE table.
END_ORDERIN_IJCT_ON_CONNECTION_ERROR	Indicates the action to take when the order API generates an Invalid XML error response, since this error can indicate a database connection problem. If this property is set to Y, when the order API generates an Invalid XML error response, it attempts to verify the database connection. If the attempt is unsuccessful, the system ends the ORDER_IN job and sends a support notification. Otherwise, if this property is set to N or blank or does not exist, the order API continues trying to process order messages in the event of an Invalid XML error response.
JOB_RETENTION_DAYS	The number of days to store jobs and generated reports and forms before they are eligible for deletion. Each time you restart Order Management System, the start up process deletes the following if they are older than the number of days specified here: archived reports, including PDF files, XML files, and text files. job logs. entries in the dbo.Jenasysjob table. This table is used to track submitted jobs. If you do not define the retention days, Order Management System does not delete outdated documents. Note:   The deletion uses both the date and the time in determining whether to purge a document. For example, the current time is 7:00 a.m. and the JOB_RETENTION_DAYS is set to 30. If the report was created earlier than 7:00 30 days ago, it is eligible for deletion; otherwise, if it was created later than 7:00 30 days ago, it is not currently eligible. Certain text files might have a later date than the related PDF files, and so might not be eligible to purge at the same time as the related PDF. For example, if you view a PDF file for a form a day after creating it, Order Management System creates a text file logging that activity for the date when you viewed the PDF.
OROB_DIRECTORY_PATH	The location on the application server where the system creates Order Broker product, product location, and incremental inventory files to import into Order Broker. An example directory is /domain/conf/OMSFiles/OROBData/, where domain is the WebLogic domain directory for Order Management System. Note: If the OROB_DIRECTORY_PATH is not valid or is blank, or the specified folder does not exist, the system does not create any output files and writes a message to the Application log. See Order Broker’s Product, Product Location, and Incremental Inventory Import Process.
OROB_IMPORTS_URL	The URL used to call the Order Broker RESTful web service when sending product, product location, and incremental inventory data to Order Broker if the OROB_IMPORTS_ENABLED property is set to true. For example: https://order_broker_url:port, where order_broker_url is the URL used to connect to Order Broker and port if the port number used to connect to Order Broker. See Order Broker’s Product, Product Location, and Incremental Inventory Import Process.
OVERLAY_DEBUG	If this property is set to Y, the Batch Inventory Overlay Upload writes entries in the Job.log file, for example: File: INV_OVERLAY_005.TXT Rows: 4 Success: 1 Errors: 3 Start Time: Mon Mar 04 16:03:11 EST 2019 End Time: Mon Mar 04 16:03:11 EST 2019 Time In Seconds: 0.041420431 Time In Minutes: 6.903405166666667E-4
PICKS_IN_SPOOL_FILE	The maximum number of pick slips in a single PDF document. The system continues to break pick slips into separate PDF documents using the criteria outlined under Sorting Pick Slips into Separate PDF Documents; however, if the number of pick slips in a PDF document reaches the number defined in the PICKS_IN_SPOOL_FILE setting, the system creates a new PDF document. Note:  The system uses the PICKS_IN_SPOOL_FILE setting when printing pick slips through Streamlined Pick Slip Generation (WSPS) and Reprinting and Voiding Pick Slips (WVRP or WSVP). Also, the system uses this setting when printing Gift Acknowledgements. Working with the pick slip form: Once the system finishes processing one pick slip PDF document, you can open and print the pick slips in the document using the Forms Management Screen; you do not have to wait until all of the PDF documents for the pick slip generation run have generated. When printing pick slips, the system includes a PDF document sort number in the name of the document generated for the pick slip. For example, if the system generates two pick slip documents for warehouse 1, ship via priority 5, the system names the documents PICKG.KBROWN.20090804.103001456_001.PDF and PICKG.KBROWN.20090804.103001456_002.PDF, where PICKG is the name of the print program, KBROWN is the user ID of the person who generated the pick slips, 20090804.103001456 is the date and time stamp, and 001 and 002 is the PDF document sort number. See Form Naming Conventions for more information. Recommended setting: The recommended setting is 250 picks. The system also uses 250 as the default value if this setting is blank or missing.
	Example:  When the PICKS_IN_SPOOL_FILE setting is 600, the system creates the following spool files for a pick slip generation run: 50 pick slips for warehouse 1, ship via priority 1 (PICKG.KBROWN.20090804.103000123_001.PDF) 300 pick slips for warehouse 1, ship via priority 5 (PICKG.KBROWN.20090804.103001456_001.PDF) 510 pick slips for warehouse 1, ship via priority 9 (PICKG.KBROWN.20090804.103003789_001.PDF) 75 pick slips for warehouse 2, ship via priority 1 (PICKG.KBROWN.20090804.103006912_001.PDF) 225 pick slips for warehouse 2, ship via priority 5 (PICKG.KBROWN.20090804.103007134_001.PDF) 25 pick slips for warehouse 2, ship via priority 9 (PICKG.KBROWN.20090804.103008112_001.PDF)
	When the PICKS_IN_SPOOL_FILE setting is 250, the system creates the following spool files for the same pick slip generation run: 50 pick slips for warehouse 1, ship via priority 1 (PICKG.KBROWN.20090804.103000123_001.PDF) 250 pick slips for warehouse 1, ship via priority 5 (PICKG.KBROWN.20090804.103001456_001.PDF) 50 pick slips for warehouse 1, ship via priority 5 (PICKG.KBROWN.20090804.103001456_002.PDF) 250 pick slips for warehouse 1, ship via priority 9 (PICKG.KBROWN.20090804.103003789_001.PDF) 250 pick slips for warehouse 1, ship via priority 9 (PICKG.KBROWN.20090804.103003789_002.PDF) 10 pick slips for warehouse 1, ship via priority 9 (PICKG.KBROWN.20090804.103003789_003.PDF) 75 pick slips for warehouse 2, ship via priority 1 (PICKG.KBROWN.20090804.103006912_001.PDF) 225 pick slips for warehouse 2, ship via priority 5 (PICKG.KBROWN.20090804.103007134_001.PDF) 25 pick slips for warehouse 2, ship via priority 9 (PICKG.KBROWN.20090804.103008112_001.PDF) Notice that the system creates multiple spool files for pick slips in warehouse 1, ship via priority 5 and for pick slips in warehouse 1, ship via priority 9, based on 250 in the PICKS_IN_SPOOL_FILE setting.

Clearing the Cache for HTML Email Templates (CEML)

Purpose: To improve performance, Order Management System saves HTML email templates to a cache, and does not refresh the cache until you restart Order Management System. On occasions when you edit an HTML email template and would like to clear the cache without restarting Order Management System, you can use the Clear Email Template Cache option.

Does not apply to shipment emails generated through the Narvar Integration.

How to display this screen: Enter CEML in the Fast path field at the top of any screen, or select Clear Email Template Cache from a menu.

Completing this screen:

1. Select All templates from the Template cache name field.

2. Select Clear cache.

Working with Web Service Authentication (WWSA)

Web service authentication allows you to define a valid web service authentication user for each web service used by Order Management System.

Which web services are eligible? You can define web service authentication for the following:

• Inbound: Web services used to process inbound messages to Order Management System. See Inbound Web Service Authentication Process for Order Management System.

• To Order Broker: Web services used to process messages from Order Management System to Order Broker. See Web Service Authentication Process for Order Broker.

• To Customer Engagement: Web services used to process messages from Order Management System to Customer Engagement. See Web Service Authentication Process for Customer Engagement.

• To OCDS: Web services used for authentication for RESTful web service requests sent to the Omnichannel Cloud Data Service (OCDS). See Importing Enterprise Foundation Data through Omnichannel Cloud Data Service (OCDS)I for background.

• To RICS: Web services used for authentication for the pre-order (backorder quantity update) notification message (RICS). See Enterprise Order Integration (Future Receipts and Active PO/Pre-Order Processing) for background.

• Job notifications: A web service to send a job notification to an external system. See Using the Job Notification Outbound REST Message in the Web Services Guide on My Oracle Support (ID 2149144.1) for more information.

Authentication types: Order Management System supports both basic and OAuth 2 authentication for inbound and outbound messages, although not all integrating systems support OAuth. See Basic or OAuth Authentication for a discussion.

For more information: See Setting Up Web Service Authentication for an overview and a discussion of the different types of authentication, and see the Oracle Retail Omnichannel Web Service Authentication Configuration Guide on My Oracle Support (2728265.1) for web service authentication configuration instructions.

In this topic:

• Basic or OAuth Authentication

• Inbound Web Service Authentication Process for Order Management System

  • Order Management System Web Services Eligible for Authentication

• Work with Inbound Web Service Authentication Screen

• Work with Inbound Web Service Authentication Users Screen

• Add User Window

• Work with Outbound Web Service Authentication Screen

• Change Outbound Web Service Authentication Screen

Basic or OAuth Authentication

Basic authentication requires the requesting system to pass a user ID and a password to authenticate a web service request. The destination system validates the user ID and password.

OAuth requires the requesting system to provide an access token with the web service request. Oracle Cloud Services use IDCS (Oracle Identity Cloud Service) or OCI IAM (Oracle Cloud Infrastructure Identity and Access Management) as the authenticating service. The requesting system will use its configured client ID and secret to request an OAuth token from IDCS or OCI IAM and then include that token in service requests.

In addition to being more secure, OAuth provides better performance than basic authentication.

Note:

Only OAuth authentication is supported for inbound messages. You can use basic authentication for outbound messages if the external system requires it.

How Requests are Validated with OAuth

OAuth enables web service communication between applications using a token provided by IDCS or OCI IAM rather than a password, providing greater security. The requesting application first passes its:

• Client ID: Similar to a user ID in that it identifies a client application to the authentication service, in this case IDCS or OCI IAM. You can create client IDs through the Manage External Application Access page, in IDCS or OCI IAM, or through other applications, such as Customer Engagement.

• Client secret: A secure code that IDCS or OCI IAM creates for a client application, and that the client application passes to IDCS or OCI IAM for authentication. The client secret should be known only to the requesting application and to IDCS or OCI IAM.

When IDCS or OCI IAM receives the valid client ID and client secret, it then provides the token to the requesting application. The requesting application can then include the token in the web service request to the destination system, which validates the token with IDCS or OCI IAM.

For example, if your ecommerce system will communicate with Order Management System using OAuth, you can use this page to:

• Create a client ID and secret, which you can then provide to the ecommerce system.

• Create the associated web service authentication records for the ecommerce system.

With OAuth authentication:

The requesting system first passes a client ID and a client secret to an authenticating service, such as IDCS or OCI IAM.

• The authenticating service, such as IDCS or OCI IAM, generates a short-lived token.

• The requesting system submits the token to the destination system, rather than a password and user ID as with basic authentication.

• The destination system validates the token and client ID.

The following is required in order to support OAuth with Omnichannel products:

• The IDCS or OCI IAM client ID and client secret for the integrating system must be created through an Omnichannel cloud service, if it does not already exist.

• The system receiving the web service request needs to have a record of the client ID with assigned access for the web service API.

• A system sending the web service request needs to be able to request the token from IDCS or OCI IAM.

• The system sending the web service request needs to include the token so the system receiving the web service request can validate the request.

Configuration for outbound web service authentication: You need to specify an authentication type of either BASIC or OAUTH for each outbound web service from Order Management System. OAuth is supported for the following outbound web services:

• Order Broker 18.2 or higher

• Customer Engagement 18.0 or higher

• Job Notification

OAuth is not currently supported for the RICS Service.

OAuth summary by product:

Product	Supports Receiving OAuth	Supports Sending OAuth
Order Broker	19.0 or higher	19.1.1 or higher
Order Broker Cloud Service	18.2 or higher	19.1 or higher
Order Management System	18.3 or higher; 19.0 or higher supports XOffice OnPrem validation of stores with parent ID. 19.0 or higher. See the Manage External Application page in Modern View for background.	19.1 or higher
Customer Engagement	18.0 or higher; 18.3or higher supports XOffice OnPrem validation of stores with parent ID.	not currently supported

For more information: See the Oracle Retail Omnichannel Web Service Authentication Configuration Guide on My Oracle Support (2728265.1) for web service authentication configuration instructions.

Inbound Web Service Authentication Process for Order Management System

When an external system calls an Order Management System web service, the external system sending the message to Order Management System must send authentication information in the HTTP header of the message.

Oracle Identity Cloud Service: When you use IDCS (Oracle Identity Cloud Service) or OCI IAM (Oracle Cloud Infrastructure Identity and Access Management) for password authentication, you do not define passwords in Work with Web Service Authentication (WWSA) for inbound web services; instead, you can use the Manage External Application Access page in Modern View to create web service authentication records for client applications created in IDCS or OCI IAM that use OAuth authentication. See Basic or OAuth Authentication for a discussion, and see Oracle Authentication (IDCS or OCI IAM) in the Administration Guide.

When Order Management System receives an inbound web service request:

• If the web service passes authentication, the web service continues with regular processing.

• If the web service fails basic authentication, the web service returns a 401 error.

Order Management System Web Services Eligible for Authentication

You must define web service authentication, either through this menu option or through the Manage External Application Access page in Modern View, for the following Order Management System web services.

• CWCustomer: This web service is used to process an Inbound Customer Message (CWCustomerIn) received from an external system. See Generic Customer API for more information.

  For more information see the Web Services Guide on My Oracle Support (ID 2149144.1).

• CWEmailRequest: this web service is used to process an Email Request Message (CWEmailRequest) received from an external system. See Store Pickup Confirmation Email Program (L48) for more information.

• CWMessageIn: This web service works with any of the integration layer processes set up through Working with Integration Layer Processes (IJCT). See XML Messages Processed By the CWMessageIn Web Service for a list of the messages processed by the CWMessageIn web service and see CWMessageIn Web Service for an overview.

• CWOrderIn: This web service is used to process an Inbound Order XML Message (CWORDERIN) from an external system. See Generic Order Interface (Order API) for more information.

• CWPickIn: This web service is used to process a CWPickIn XML Message from an external system. See Generic Pick In API (Shipments, Voids, and Backorders) for more information.

• CWReceiptIn: This web service is used to process a PO Receipt In XML Message (CWReceiptIn) from an external system. See Purchase Order Receipt In API for more information.

• CWServiceIn: This web service is used to process the following messages received from an external system:

  For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)

  • Order Transaction History Message (CWOrderTransactionHistory) if its type attribute is CWOrderTransactionHistory. See Generic Order Transaction History API for more information.

  • Order Line History In Message (CWOrdLnHstIn) if its type attribute is CWOrdLnHstIn. See Order Line History In API for more information in the Web Services Guide on My Oracle Support (ID 2149144.1).

  • Item Availability Request XML Message (CWItemAvailabilityWeb) if its type attribute is CWItemAvailabilityWeb. See Item Availability API for more information.

  • E-Commerce Cancel Request Message (CWCancel) – ) if its type attribute is CWCancel. and see E-Commerce Cancel Process for more information.

  • E-Commerce Catalog Request Message (CWCatRequest) if its type is CWCatRequest. See E-Commerce Catalog Requests for more information.

  • CWProcessIn Message if its type attribute is CWProcessIn. See  Using the CWProcessIn Message to Start a Periodic Process for more information.

  See the Web Services Guide on My Oracle Support (ID 2149144.1)

• JMSQueue. This web service is used during Advanced Queuing to read from a queue in the queuing database.

• OrderMaintenance. These web services are available to lock or unlock orders, add an order detail line, or cancel an order detail line or an order ship-to. See the Order Maintenance Web Service Guide on My Oracle Support (ID 2149144.1) for more information.

• PrivateDataRequest RESTful web service. This web service is used to process a Get Personal Data Request and Forget Personal Data Request from an external system. See the Personal Data API in the Data Security and Encryption guide on My Oracle Support (1988467.1) for more information.

• ProcessIn. This RESTful web service is used to start a periodic process. See Using the ProcessIn REST Message to Start a Periodic Process for more information.

• Storage. This RESTful web service is used to upload, download, delete, or inquire on files imported or exported through the File Storage API.

Job Notification Outbound Message. This web service is used to notify an external system of a periodic process or job completion. See Using the Job Notification Outbound REST Message for more information.

See the Web Services Guide on My Oracle Support (ID 2149144.1)

Work with Inbound Web Service Authentication Screen

Purpose: You can use this screen to review inbound web services, and advance to the Work with Inbound Web Service Authentication Users screen, where you can review the client IDs that have been configured for inbound web service authentication.

Note:

Only OAuth authentication is supported for inbound web services. You should use the Manage External Application Access option in Modern View to generate a client ID, obtain the client secret, and define web service access, rather than the Work with Inbound Web Service Authentication screen.

How to display this screen: Enter WWSA in the Fast path field at the top of any menu or select Work with Web Service Authentication from a menu.

Field

Description

Web Service

An Order Management System web service that requires web service authentication. Valid web services are: CWCustomer CWEmailRequest CWMessageIn CWOrderIn CWPickIn CWReceiptIn CWServiceIn JMSQueue OrderMaintenance PrivateDataRequest ProcessIn Storage Enter a full or partial web service name to display web services that contain your entry. See Order Management System Web Services Eligible for Authentication for a summary of each web service. Alphanumeric, 50 positions; optional.

Screen Option	Procedure
Review existing client IDs that are configured for web service authentication for each inbound web service.	Optionally, select Authentication for a web service to advance to the Work with Inbound Web Service Authentication Users Screen, described below, to review existing client IDs. Note: Instead of configuring web service authentication here, you should use the Manage External Application Access option in Modern View to generate a client ID, obtain the client secret, and define web service access, rather than the Work with Inbound Web Service Authentication screen.
Configure web service authentication for an external web service	Select Outbound Svcs to advance to the Work with Outbound Web Service Authentication Screen.

Work with Inbound Web Service Authentication Users Screen

Purpose: Optionally, use this screen to review the existing client IDs that have been configured for authentication for inbound web services.

Note:

Only OAuth authentication is supported for inbound web services. You should use the Manage External Application Access option in Modern View to generate a client ID, obtain the client secret, and define web service access. However, you can use this screen to review the existing client IDs that have been configured for web service authentication of inbound web services.

How to display this screen: Select Authentication for a web service on the Work with Inbound Web Service Authentication Screen.

Field	Description
Web Service	The web service requiring authentication. Alphanumeric, 50 positions; display-only.
User	The IDCS or OCI IAM Client ID of the client that requests the OAuth token. About OAuth: OAuth is a standard for web service authentication through the use of access tokens rather than passwords. When OAuth is used, the inbound web service request specifies a client ID and a temporary token for authentication, rather than a user ID and a password. You can use the Manage External Application Access page in Modern View to create web service authentication records for applications created in IDCS or OCI IAM that use OAuth authentication. Enter a full or partial user ID to display users that contain your entry. Alphanumeric, 100 positions; optional.

Screen Option	Procedure
Create a web service authentication user	You should not use this option to create a web service user. Instead, use the Manage External Application Access page in Modern View to create web service authentication records for client applications created in IDCS or OCI IAM and using OAuth authentication.
Delete a web service authentication user	Select Delete for a user. At the Are you sure you want to delete the web service user? window, select Yes to delete the user; otherwise, select No to cancel. You can also use the Manage External Application Access page in Modern View to delete web service authentication records for client applications created in IDCS or OCI IAM, if necessary,

Add User Window

Purpose: You should not use this window

How to display this screen: Select Create on the Work with Inbound Web Service Authentication Users Screen.

Field

Description

User

The web service authentication user ID. When you use IDCS (Oracle Identity Cloud Service) or OCI IAM (Oracle Cloud Infrastructure Identity and Access Management) for password authentication, this is the user ID or client ID defined in IDCS or OCI IAM. About OAuth: OAuth is a standard for web service authentication through the use of access tokens rather than passwords. When OAuth is used, the inbound web service request specifies a client ID and a temporary token for authentication, rather than a user ID and a password. Use the Manage External Application Access page in Modern View to create web service authentication records for client applications created in IDCS or OCI IAM that use OAuth, such as XOffice on premises. When OAuth not used: OAuth is not currently supported for web service requests to Order Management System from older versions of Order Broker. When OAuth is not supported, you should use the Work with Inbound Web Service Authentication screen (WWSA) rather than the Manage External Application Access page in Modern View. Alphanumeric, 100 positions. Add window: required.

Work with Outbound Web Service Authentication Screen

Purpose: Use this screen to define a valid web service authentication user and password for an external web service that requires web service authentication.

You must define web service authentication for each of your Order Management System companies that communicates with the external system. Unlike inbound web service authentication, outbound web service authentication is defined at the company level.

Web service authentication for messages to Order Broker or Customer Engagement occurs when the message is received in that application. The web service user for web service authentication on inbound messages to Order Broker or Customer Engagement must be defined in that application.

How to display this screen: Select Outbound Svcs at the Work with Inbound Web Service Authentication Screen.

Field	Description
Web Service	An external web service for which you can define a valid web service authentication user and password. EFTConnect: The web service used for payment definition and processing, including defining merchant accounts with payment processors and supported payment types. See the Payment Configurations screen in Modern View for more information. Job Notification: The Job Notification web service is used to notify an external system about the completion of a periodic process or a job. See Using the Job Notification Outbound REST Message in the Web Services Guide on My Oracle Support (ID 2149144.1) for more information. Narvar Service: Used for authentication of RESTful web service requests to generate shipment notification emails through the Narvar Integration. Note:  Narvar currently supports only Basic authentication. OCDS Service: Used for authentication for RESTful web service requests sent to the Omnichannel Cloud Data Service. See Importing Enterprise Foundation Data through Omnichannel Cloud Data Service (OCDS) for background. Customer Engagement: Web services listed for Oracle Retail Customer Engagement are: ORCE Customer ORCE File Service ORCE Loyalty ORCE Purchase History ORCE Stored Value Card ORCE Registry See Oracle Retail Customer Engagement Web Services Eligible for Authentication for a summary of each web service.
	Order Broker: Web services listed for Order Broker are: OROB Discovery OROB Locate OROB Purchasing See Order Broker Web Services Eligible for Authentication for a summary of each web service. RICS Service: Used for authentication for the pre-order (backorder quantity update) notification message that is part of the Enterprise Order Integration (Future Receipts and Active PO/Pre-Order Processing). Note:  RICS Service does not support OAuth authentication. See Basic or OAuth Authentication for more information on using OAuth. Sales Audit File Service: Used for OAuth authentication for submission of the RTLOG file to object storage for the Sales Audit module of the Oracle Retail Merchandising Foundation Cloud Service. Note that object storage is supported for version 21.0 or higher of the Sales Audit module. See Transmitting the RTLOG File to Object Storage for more information. Default client ID and secret for Order Broker and Customer Engagement: You can use the IDCS_ACCESS_CLIENT_ID and IDCS_ACCESS_CLIENT_SECRET defined in Working with Admin Properties (CPRP) for outbound OAuth authentication to Order Broker and Customer Engagement if the client ID and secret are not defined in Working with Web Service Authentication (WWSA). Otherwise, these defaults are not used for other outbound web service authentication, Alphanumeric, 50 positions; optional.
User/Client ID	The web service authentication user defined for the web service, or the client ID to use for the web service for OAuth authentication. Enter a full or partial user name or client ID to display web service users that contain your entry. See Basic or OAuth Authentication for background. Alphanumeric, 100 positions; optional.
Authentication Type	Indicates the type of authentication to use for the outbound web service: BASIC: Requests pass a user ID and a password for authentication of the web service. OAUTH: Requests pass a client ID and a client secret for authentication of the web service. See Basic or OAuth Authentication for background.

Screen Option	Procedure
Define a valid web service authentication user and password or client ID and client secret	Select Change for a web service to advance to the Change Outbound Web Service Authentication Screen.
Configure web service authentication for an Order Management System web service	Select Inbound Svcs to advance to the Work with Inbound Web Service Authentication Screen.

Change Outbound Web Service Authentication Screen

Purpose: Use this screen to define whether the service uses basic or OAuth authentication, and to define a valid:

• User and password if using basic authentication for the web service.

• Client ID and client secret if using OAuth for the web service.

See Basic or OAuth Authentication for background.

Default client ID and secret for Order Broker and Customer Engagement: You can use the IDCS_ACCESS_CLIENT_ID and IDCS_ACCESS_CLIENT_SECRET defined in Working with Admin Properties (CPRP) for outbound OAuth authentication to Order Broker and Customer Engagement if the client ID and secret are not defined in Working with Web Service Authentication (WWSA). Otherwise, these defaults are not used for other outbound web service authentication,

How to display this screen:Select Change for a web service on the Work with Outbound Web Service Authentication Screen.

Field	Description
Web Service	The web service for which you wish to define web service authentication. Alphanumeric, 50 positions; display-only.
Authentication Type	Indicates the type of authentication to use for the outbound web service: BASIC: Requests pass a user ID and a password for authentication of the web service. OAUTH: Requests pass a client ID and a client secret for authentication of the web service. See Basic or OAuth Authentication for background. Also, see the Work with Outbound Web Service Authentication Screen for information on which outbound web services support basic or OAuth authentication. If you have difficulty seeing both authentication types: Both options for this field may be difficult to see in Internet Explorer if the Enable syncing Internet Explorer settings and data option is not selected at the Advanced tab of the Internet Options window for Internet Explorer.
User/Client ID	Depending on the setting of the Authentication Type, this field is: User (basic authentication): A valid web service authentication user that can authenticate the web service using basic authentication. You must enter the user ID in the correct case. This user must be defined in the destination system, such as Order Broker or Customer Engagement. Client ID (OAuth authentication): A valid client ID that you can use, along with the client secret, to generate a temporary token for OAuth authentication. In IDCS or OCI IAM, this field is labeled as the Display Name for the client, for example, RGBU_OBCS_<RANDOM>_APPID, where OBCS identifies the application, and <RANDOM> is a series of 8 random characters. The client ID must be defined in the authentication service, such as IDCS or OCI IAM, as well as the destination system. If you use IDCS or OCI IAM, you create the user in IDCS or OCI IAM and import the user into the destination system. Alphanumeric, 10 positions; required.
Password/Client Secret	Depending on the setting of the Authentication Type, this field is: Password (basic authentication): A valid web service authentication user that can authenticate the web service using basic authentication. You must enter the user ID in the correct case. The password assigned to the web service authentication user. Must match the password in the destination system. You can define both upper and lower case letters for the password. Client secret (OAuth authentication): The client secret defined for the client ID in the authentication service, such as IDCS or OCI IAM, to generate a temporary token for OAuth authentication. You can regenerate the client secret For security reasons, the system masks the password or client secret on the screen and encrypts it in the database. Alphanumeric, 50 positions; required.

Working with Contact Center (WWCC)

Contact Center is a module of Order Management System where you can review and maintain orders. Contact Center is available in OMS Modern View.

Use this menu option to configure which fields display in Contact Center and the order in which fields display on the Order Search page in Contact Center.

In this topic:

• Contact Center Field Display Screen

• Contact Center Order Search Field Sequence Screen

Contact Center Field Display Screen

Purpose: Use this screen to configure which fields display in Contact Center. In addition, you can use this screen to define whether the Phone Number and Email fields in Contact Center display as a hyperlink to directly call or email the customer.

How to display this screen:

• Enter WWCC in the Fast path field at the top of any menu or select Work with Contact Center from a menu.

• Select Configure Field Display on the Contact Center Order Search Field Sequence Screen.

Available Fields to Display

The Available Fields to Display section of the screen lists the fields that are available to display in Contact Center that currently will not display in Contact Center.

To select fields for display: Highlight one or more fields that you wish to select and drag the fields over to the Selected Fields to Display section of the screen.

Selected Fields to Display

The Selected Fields to Display section of the screen lists the fields that will display in Contact Center.

To remove fields from display: Highlight one or more fields that you wish to select and drag the fields over to the Available Fields to Display section of the screen.

Select to set as a hyperlink

The Select to set as a hyperlink section of the screen allows you to define whether the Phone Number and Email fields in Contact Center display as a hyperlink to directly call or email the customer.

Phone set as a hyperlink: 

• Selected = The Phone Number field in Contact Center displays as a hyperlink. When you select the Phone Number field in Contact Center, the system advances you to the default application used to initiate phone calls. If a default application is not defined, a window displays where you can select the application to use to call the customer.

• Unselected (default) = The Phone Number field in Contact Center displays as text only.

Email set as a hyperlink: 

• Selected (default) = The Email field in Contact Center displays as a hyperlink. When you select the Email field in Contact Center, the system advances you to the default application used for email. If a default application is not defined, a window displays where you can select the application to use to email the customer.

• Unselected = The Email field in Contact Center displays as text only.

Fields Available for Configuration

The following fields are available to display or hide in Contact Center.

Field	Description
Affect Inventory	Defines whether the system reserves an item and reduces inventory for the item after shipment. Valid values are: Selected = Reserve the item and reduce inventory. Unselected = Do not affect inventory.
Arrival Date	The date an item is scheduled to be shipped to the customer. Alphanumeric, 6 positions, in user date format.
Backorder Priority	The backorder priority defined for a source code. The system defaults the backorder priority to orders assigned to the source code. 9 = highest priority 0 = lowest priority The Evaluate Backorders program runs in the background and matches available inventory to backorders. Numeric, 1 position.
Broker Delivery Type	Defines whether the order is fulfilled through the Order Broker Integration. Possible settings are: Retail Pickup = The order originated in an external system and Order Management System ships the order to the originating retail store location, where the customer picks it up Delivery = The order originated in an external system, and Order Management System ships the order directly to the customer Ship for Pickup = The order originated in Order Management System, and Order Management System ships the order ships the order to a designated retail store location, where the customer picks it up Store Pickup = The order originated in Order Management System, and the customer picks up the order in a designated retail store location where the inventory is currently available Note:  This setting does not indicate whether the order includes any brokered backorder lines (in which Order Management System assigns backordered items to the Order Broker for fulfillment).
Calculate Shipping	Defines whether the system calculates and adds shipping charges to the order. Selected = The system calculates shipping charges for the order. Unselected = The system does not calculate shipping charges for the order; the freight method for the source code is ignored.
Cancel Backorder	Defines whether to automatically cancel items that are unavailable (backordered) with the first shipment on the order. Valid values are: Selected = Cancel backordered items with first shipment. Unselected = Do not cancel backordered items. If this field is selected, any unshipped line on an order is canceled during billing using the Auto Soldout Cancel Reason (C20), provided this system control value specifies a valid cancel reason code.
Cancel Date	The date the customer wants the order canceled if it has not been shipped. The order is not canceled automatically, but is listed on the Order Cancellation List. You can cancel the order manually or contact the customer to extend the deadline. Numeric, 6 positions (in user date format).
Coordinate Group	A number assigned to two or more items to ensure that they ship together. Numeric, 2 positions; display-only.
Coupon	A code that identifies the coupon applied to an order or order detail line. Alphanumeric, 6 positions; optional.
Coupon Amount	Indicates the amount of the discount. If the coupon’s Discount type is D, this is the dollar discount for the coupon; if this is an order-level coupon, the total dollar discount applies to the eligible order detail line with the highest unit price; if this is a detail-level coupon, the total dollar discount applies to this order line. The total discount amount is prorated against the quantity of the order line. If the coupon’s Discount type is %, this is the percentage discount for the coupon to apply to the eligible items on the order (order-level coupons) or the order detail line (detail-level coupons). Numeric, 13 positions with a 2-place decimal.
Customer Class	A code that categorizes customers at a high level for reporting purposes. You can use customer class codes to: send offers to a limited group of customers. restrict item sales to a group of customers. bypass normal item reservation (If the customer is assigned to a class flagged to bypass reservation, then the bypass setting applies even if the Bypass reservation setting for the customer is unselected). determine whether to prompt for user-defined fields in order entry. Alphanumeric, 2 positions.
Gift Wrap	A flag that identifies whether an item is gift wrapped. Valid values are: Selected = Gift wrap the item. Unselected = Do not gift wrap the item.
Offer Code	A code for the catalog, space, or television advertisement from which you accept quotes and orders. The offer defined for the quote or order controls how to calculate shipping and price items. However, if you override the offer for an item (if the customer is ordering from more than one catalog, for example), demand for the item is attributed to the offer associated with the item rather than the order. Demand represents the number and dollar value of orders placed against an offer. Offers are defined in and validated against the Offer table. You can create and work with offers using the Work with Offers (WOFR) menu option. Alphanumeric, 3 positions.
Phone	The customer’s telephone number. Alphanumeric, 14 positions.
Priority	Used by the Evaluate Backorders program to match items to backorders. Immediate Reservation If you use Immediate Reservation, this value determines the sequence in which orders with backordered items receive inventory. The Evaluate Backorders program uses the priority to determine which backorders receive stock first. Numeric, 1 position.
Purchase Order Number	The customer's purchase order number. Alphanumeric, 15 positions.
Quote Origin	Defines whether the order originated from a pre-order quote. Selected = The order originated from a pre-order quote. Unselected = The order did not originate from a pre-order quote.
Recalculate Shipping	Defines whether to recalcuate shipping charges. Selected = Recalculate shipping charges. Unselected = Do not recalculate shipping charges.
Sales Representative Number	The person who is credited for making the sale. This is the person who is responsible for obtaining the customer's order; this may not be the same person who enters the order on the system. Sales representatives are defined in and validated against the Salesman table. You can create and work with sales representatives in the Work with Sales Representatives (WSLS) menu option. Numeric, 7 positions.
Shipping	The total charge for shipping the quote or order, not including additional shipping charges. You can define additional shipping charges for a carrier to include standard freight; in this case, this field is blank. See the Add'l freight (Additional freight charges) field. This field also includes service charges by ship via, if any. This field also includes order weight charges based on the ship via defined for each ship to customer on the order. See Working with Ship Via Codes (WVIA). The system calculates shipping charges based on the freight method defined for the source code. If the system calculates freight as a percentage of the merchandise charges, there might be a penny variation in total freight amount due to rounding differences. Numeric, 13 positions with a 2-place decimal.
Source Code	The source code from the order header. Source codes are unique codes used to identify segments of your customer base or a rented list. Each source code is assigned to one offer and one division. Source codes control the freight and pricing method used on an order. Alphanumeric, 7 positions.
Warehouse	A code that identifies the warehouse from which merchandise on the order ships. A value appears in this field only if it was entered during order entry or order maintenance or was passed through the Order Broker Integration for a retail pickup or delivery order. Warehouse code: numeric, 3 positions.
Weight	The total shipping weight of the items on the order, excluding soldout, cancelled, and returned items. Numeric, 13 positions with a 3-place decimal.
Discount Percent	The percentage discount to apply to an order in Contact Center order entry. Controls whether this field is available at the Select Shipping Option and Enter Other Details step in Contact Center order entry. Does not control whether a discount percentage field is available anywhere else in Contact Center, such as through the Order Summary page. Note:  The Discount Percent option is available after the Weight field at the Contact Center Field Display Screen; it is not listed alphabetically. Numeric, 5 positions with a 2-place decimal.

Contact Center Order Search Field Sequence Screen

Purpose: Use this screen to define the order in which fields display on the Search for Orders and Customers page in Contact Center, as well as on the Home page.

How to display this screen: Select Configure Search Field Sequence on the Contact Center Field Display Screen.

When you advance to this screen, the system displays the configuration that is currently defined.

Delivered Order Information Settings: The delivered sort order for the Search for Orders panel in Contact Center is:

• Order Number

• Order Date

• Invoice Number

• Alternate Order Number

• Last 4 Digits of Payment Card

• Item ID and SKU

• Order Status

• Origin

• Pick Control Number

• User ID

• Sales Rep Number

The delivered number of Order Quick Search fields is 1.

The delivered setting of the Use Oracle Retail Customer Engagement Customer Number on Search is unselected.

Delivered Customer Information Settings: The delivered sort order for the Search for Customers panel on the Search for Orders and Customers page, Home page, and search page of Contact Center Order Entry is:

• Email Address

• Phone Number

• First Name

• Last Name

• Company Name

• Postal Code

• Customer Number

• Match Code

The delivered number of Customer Quick Search fields is 6.

Field	Description
Search by Order Information Fields	The order in which to display the fields in the Search for Orders panel of the Search for Orders and Customers page, as well as the Home page in Contact Center. You can define the sort order of the following fields: Order Number Order Date Invoice Number Alternate Order Number Last 4 Digits of Payment Card Item ID and SKU Order Status Origin Pick Control Number User ID Sales Representative Number Note: The Sales Representative Number field displays only if it has been selected for display on the Contact Center Field Display Screen.
Use Oracle Retail Customer Engagement Customer Number on Search	Indicates whether to search for customers at the Home page or the Search for Orders or Customers page in Contact Center, as well as in Contact Center Order Entry, based on the Order Management System customer number or the Customer Engagement customer number. Note:  This setting applies only when the ORCE Customer Integration (L37) system control value is set to INTERACT. With this setting, Customer Engagement is the system of record for customers, so Order Management System searches for customers in Customer Engagement, and then uses the information returned from Customer Engagement to update the customer record in Order Management System. About customer mapping between Order Management System and Customer Engagement: The mapping of customer records between Order Management System and Customer Engagement uses the following fields: The customer ID in Customer Engagement is stored as the customer’s ORCE Customer ID (RELATE_ID) in Order Management System.  The Order Management System customer number is stored as an alternate key for the customer in Customer Engagement. Because a customer record in Customer Engagement can have multiple alternate keys, the ORCE_ALT_ID_OROMS in Working with Customer Properties (PROP)defines the alternate key used for the Order Management System customer number. How this flag affects searching for a customer record at the Home page or the Search for Orders or Customers page in Contact Center and requesting a match from Customer Engagement: If this flag is:  Selected, when the user enters a customer number while searching, Order Management System sends a request to Customer Engagement for a customer who is assigned that Customer Engagement customer ID. Unselected, when the customer enters a customer number while searching, Order Management System sends a request to Customer Engagement for a customer who is assigned that number as an alternate key, based on the ORCE_ALT_ID_OROMS property setting. Which customer number displayed in Modern View? When the ORCE Customer Integration (L37) system control value is set to INTERACT and this flag is: selected, the customer number displayed in Modern View is the Customer Engagement customer ID.  unselected, the customer number displayed in Modern View is the Order Management System customer number. Things to note: Before selecting this setting, it is important to evaluate any potential confusion that might be caused by displaying the different number for the customer.  This setting does not affect how to update customers in Order Management System based on the information received from Customer Engagement. If Customer Engagement returns information on the customer, the customer record is still created or updated regardless of whether the flag is selected. When this flag is not selected but the ORCE Customer Integration (L37) system control value is set to INTERACT, Customer Engagement returns any customer found that is assigned the entered customer number as an Order Management System alternate key, even if that customer did not previously exist in your Order Management System company. In this case, the customer record is created in Order Management System; or if a customer record already existed in your company with that customer number, the customer’s name and address are updated with the information from Customer Engagement. This flag is also used to determine the customer to retrieve through the Direct Link to Modern View option described in the Modern View online help.
Number of Order Quick Search Fields	The number of fields in the Search for Orders panel of the Search for Orders and Customers page, as well as the Home page in Contact Center in Contact Center. Based on this number, the system displays fields in the sort order sequence that you have defined, and once the maximum number is reached, you must select the Additional Order Search Fields link to display the remaining fields in the defined sort order. Example:  If you have defined the following sort order: Order Number Order Date Invoice Number Alternate Order Number Last 4 Digits of Payment Card Item ID and SKU Order Status Origin Pick Control Number User ID Sales Representative Number And you have entered 4 in the Number of Order Quick Search Fields, the system initially displays the Order Number, Order Date, Invoice Number, and Alternate Order Number fields in the Search for Orders panel. You must select the Additional Order Search Fields link to display the Last 4 Digits of Payment Card, Item ID and SKU, Order Status, Origin, Pick Control Number, User ID, and Sales Representative Number fields. Note:  You must enter a number greater than 0 and equal to or less than the number of fields that display in the Search for Orders panel. Numeric, 2 positions; required.
Search by Customer Information Fields	The order in which to display the fields in Contact Center in the Search for Customers panel of the: Search for Orders and Customer page Home page Contact Center Order Entry You can define the sort order of the following fields: Email Address Phone Number Note: The Phone Number field displays only if it has been selected for display on the Contact Center Field Display Screen. First Name Last Name Company Name Postal Code Customer Number Match Code
Number of Customer Quick Search Fields	The number of fields to display in Contact Center in the Search for Customers panel. Based on this number, the system displays fields in the sort order sequence that you have defined, and once the maximum number is reached, you must select the Additional Customer Search Fields link to display the remaining fields in the defined sort order. Example:  If you have defined the following sort order: Email Address Phone Number Last Name Company Name Postal Code Customer Number Match Code And you have entered 4 in the Number of Customer Quick Search Fields, the system initially displays the Email Address, Phone Number, Last Name, and Company Name fields when you are searching for a customer in Contact Center. You must select the Additional Customer Search Fields link to display the Postal Code, Customer Number, and Match Code fields. Note:  You must enter a number greater than 0 and equal to or less than the number of fields that display in Contact Center for searching. Numeric, 2 positions; required.

Screen Option	Procedure
Change the sort order of the Search by Order Information Fields	Highlight one or more fields that you wish to move and drag the fields up or down to the preferred sort order.
Change the number of fields to initially display in the Search for Orders panel in Contact Center	Enter a number in the Number of Order Quick Search Fields field and select OK.
Change the sort order of the Search by Customer Information Fields	Highlight one or more fields that you wish to move and drag the fields up or down to the preferred sort order.
Change the number of fields to initially display in the Search for Customers panel in Contact Center	Enter a number in the Number of Customer Quick Search Fields field and select OK.

Display Active Batch Jobs (DABJ)

Purpose: Use the Display Active Batch Jobs Screen to determine which batch jobs on the Job Management Screen are running successfully.

• Which Jobs are Active Batch Jobs?

• If a Batch Job is not on the Display Active Batch Jobs Screen

• Display Active Batch Jobs Screen

Display Active Batch Jobs

Which Jobs are Active Batch Jobs?

The Display Active Jobs screen displays the batch jobs that are running in the Order Management System application server across all servers, including jobs submitted through the ProcessIn message; see Using the ProcessIn REST Message to Start a Periodic Process in the Web Services Guide on My Oracle Support (ID 2149144.1).

If a job is listed but is not actually running, use the JOBCLN periodic function to correct. See Using the JOBCLN Function to Resolve Job Status Across Servers.

If a Batch Job is not on the Display Active Batch Jobs Screen

If the batch job is not displayed on the Display Active Batch Jobs Screen for any of the Order Management System application servers, the batch job is not really running, regardless of the status of the job on the Job Management Screen or the status of the process that submitted the job.

Display Active Batch Jobs Screen

How to display this screen: Enter DABJ in the Fast path field at the top of any menu or select Display Active Batch Jobs from a menu.

Column sort: You can sort on any column on this screen by clicking on the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.

Active batch jobs are listed on this screen in job number sequence.

Field	Description
Job	A code identifying the batch job. See Periodic Functions Available to Schedule in the Implementation Guide for information on submitted job names. Note:  Interactive jobs, such as the job started for each user session (for example, QPADEV0B9A), are not listed on this screen.
User	The user ID of the person who submitted the batch job.
Job Nbr	A system-assigned identification number to track the job. Note:  The job_number returned to the ProcessIn Messageidentifies the job that starts the process; this number may not match the one displayed here, which identifies the job that was generated. Also, note that the job number changes when the job switches to a different host. See the Web Services Guide on My Oracle Support (ID 2149144.1).
Start Time	The date and time when the job went into RUN status on the currently displayed Hostname, even if the job first started on a different host. In Thu Nov 19 15:03:58 EDT 2013 format, where: Thu = the day of the week Nov = the month 18 = the day of the month 15:03:58 = the time when the job started, in hour, minute, and second format UTC = the time zone 2020 = the year
Status	The status of the batch job on the Job Management Screen. Valid values are: RUN = The batch job is running and the status of the job on the Job Management Screen is accurate. MSG = The batch job is running, but the status of the job on the Job Management Screen is not accurate. END = The batch job is running, but a user has manually ended the job on the Job Management Screen. ERR = The batch job is running, but a user has manually ended the job on the Job Management Screen while its status was MSG. RMV* = The batch job is running, but a user has removed the job from the Job Management Screen.
Hostname	Indicates where the job is currently running. This information is available to Oracle staff for troubleshooting purposes. Alphanumeric, 50 positions.
Last Program	The last program called by the job. Included for troubleshooting information. Not included for the billing update job (for example, BILL_UPD123, where 123 is the company number) or the deposit job (for example, AUTO_DEP123, where 123 is the company number). Alphanumeric, 50 positions.

Screen Option	Procedure
Refresh data listed on the screen	Select Refresh: Newly running batch jobs are added to the screen. Batch jobs that are no longer running are removed from the screen. The status of batch jobs are updated. The last program used by batch jobs are updated. Note:  You receive the error Function key not allowed if you press F5 to refresh the screen; you must select Refresh in order to refresh the data on the screen.

Display Job History (DJHY)

Purpose: Use the Display Job History Screen to research the history of completed batch jobs. Job history displays in descending chronological order (newest to oldest).

Combining search criteria: When searching on this screen, you can combine search criteria to restrict the display to jobs that match all of your entries. For example, you can enter a Job name of PICK_GEN, a Start date of the previous Sunday, and a Start time of 2:00 p.m. (14:00:00) to display pick slip generation jobs started on the previous Sunday at 2:00 p.m. or later.

Tracking the total records evaluated and processed: The DEP_UPDATE (deposits) job and the PICK_GEN (pick slip generation) job also track the Total number of records evaluated and the Total number of records processed. If either of these numbers is equal to or greater than 1, the totals display when you place your cursor over the Job name for these jobs.

Note:

The system does not track total records evaluated and processed when you use the Reprocess Authorizations Screen (RPAA).

Display Job History Screen

How to display this screen: Enter DJHY in the Fast path field or select Display Job History from a menu.

Default sort: The job history records are sorted by default in descending chronological order (newest to oldest) based on start date and time. If multiple jobs have the same start date and time, they are sorted in ascending alphanumeric order.

Column sort: You can sort on any column on this screen by clicking on the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.

Field	Description
Hostname	Indicates where the job is currently running. This information is available to Oracle staff for troubleshooting purposes. Optionally, enter a complete, valid host name to display jobs run on that server. Enter a full or partial server name to display job history records that start with your entry. Alphanumeric, 50 positions.
Job No	The system-assigned identification number to track the job. Optionally, enter a job number to display job history records that match your entry exactly. Numeric, 19 positions.
Job Name	The name of the job, such as PICK_GEN or CNTL_ASYNC. The BILL_UPD and AUTO_DEP jobs include the company number as a suffix, for example: BILL_UPD123 or AUTO_DEP123. For the DEP_UPDATE, and PICK_GEN jobs, place your cursor over the job name to display the Total number of records evaluated and the Total number of records processed. These totals display for a job only if at least one of the totals is equal to or greater than 1. Optionally, enter a full or partial job name to display job history records that contain your entry. Alphanumeric, 50 positions.
Job Queue	The job queue where the job runs, such as QSYSNOMAX or QBATCH. Not included for the BILL_UPD or AUTO_DEP jobs. Optionally, enter a full or partial job queue name to display job history records that match your entry. Alphanumeric, 10 positions.
Submitted By	The user ID of the person who submitted the job. Optionally, enter a full or partial user name to display job history records that contain your entry. Alphanumeric, 10 positions.
Start date	The date the job first started, even if it started originally on a different host than the displayed Hostname. Optionally, select a date and press Enter to display job history records from this date or later. Numeric, 6 positions (in user date format).
Start time	The time the job first started, even if it started originally on a different host than the displayed Hostname. Optionally, enter a full or partial time to see job history records with this start time or later. Numeric, 6 positions (HH:MM:SS, 24-hour format).
End date	The date when the job ended, if any. No date is displayed if the job is currently running, or if the BILL_UPD or AUTO_DEP job was submitted while another instance of the job for the same company was running. Numeric, 6 positions (in user date format).
End time	The time when the job ended, if any. No time is displayed if the job is currently running, or if the BILL_UPD or AUTO_DEP job was submitted while another instance of the job for the same company was running. Numeric, 6 positions (HH:MM:SS, 24-hour format).

Monitoring Jobs (WJMO)

The system collects the monitoring information in the Job Monitor Status table. You can review the monitoring information on the Work with Job Monitor Screen (WJMO)

Overview: Job Monitoring provides the ability to monitor jobs to ensure that they are running correctly.

The Job Monitor:

Collects monitoring information, such as:

•  Last heartbeat date/time: the last date and time when the system verified the job was running.

• ast transaction date/time: the last date and time when a transaction was processed by the job.

The system collects the monitoring information in the Job Monitor Status table. You can review the monitoring information on the Work with Job Monitor Screen (WJMO).

Note:

If you use multiple application servers, the system collects monitoring information in the Job Monitor Status table across all application servers.

Performs an action when job monitor rules you set up for a job are met, such as:

• receiving an email so that you can react to the condition.

• running a periodic function. For example, you can define a job monitor rule that if the Controlling Async goes down, to run the periodic function that starts the Controlling Async. If you define a periodic function, you can also have the system notify you by email if the condition for the job monitor rule still exists after running the periodic function.

The monitor rules defined for a job can be based on the last update date and time, the last transaction date and time, or query results.

You can define monitor rules for a job on the Work with Job Monitor Rules Screen. When you schedule a job monitor rule, the rule becomes a scheduled job that you can review on the Scheduled Jobs screen.

Additional Job Monitoring

• The Long Running Jobs Monitor watches the batch jobs running on the Job Management Screen and sends a Long Running Jobs Monitor to a specified email address if a job runs without ending longer than a specified time. See Long Running Jobs Monitor for more information on this process and the setup requirements.

• Running a Periodic Process on Server Startup provides the ability when you restart Order Management System (see Restarting Order Management System) for the system to look at the settings in the Monitor Property Settings to determine the periodic process and its assigned periodic functions to run on server startup. See Running a Periodic Process on Server Startup for more information about this process and the setup requirements.

In this topic:

• Job Monitor Setup

• Which Jobs are Monitored?

• Job Monitor Examples

• Work with Job Monitor Screen (WJMO)

• Work with Job Monitor Rules Screen

• Create Job Monitor Rule Screen

Job Monitor Setup

Before you can use the Job Monitor, you must complete the required setup.

• Monitor Properties

• Job Monitor Rules

• Job Monitor Queries

Monitor Properties

The Monitor Properties in Working with Admin Properties (CPRP) contain the settings required to enable the Job Monitor.

Property Name	Description
ALLOW_JOB_ MONITOR	Indicates whether you wish to run the job monitor. Valid values: Y = Run the job monitor. N (default) or blank = Do not run the job monitor. In this situation, the only option on the Work with Job Monitor Rules Screen is to display a rule’s settings. Note:  Set this value to Y for all application servers.
JOB_MONITOR_QUERY_ DIRECTORY	The directory on the application server where you store queries used by the job monitor. An example directory is /domain/conf/OMSFiles/JobMonitorQueries/, where domain is the WebLogic domain directory for Order Management System.
TRACK_ALERTS_IN_LOG	Indicates whether you log all alerts generated by the job monitor. Valid values: Y = Log all alerts generated by the job monitor in the Alert Log. N or blank = Do not log alerts generated by the job monitor.
TRACK_ALERT_ EMAILS_IN_ FOLDER	The directory on the application server where the system stores a copy of the alert emails generated by the job monitor. This directory is not delivered; an example location is /domain/conf/OMSFiles/JobMonitorEmails/, where domain is the WebLogic domain directory for Order Management System. Each alert email is stored in this directory using the following naming convention: ALERT_JOBNAME_RULENAME_DDMMYY_HHMMSS.txt, where: JOBNAME is job monitor name RULENAME is the job monitor rule name DDMMYY is the date the email alert was sent HHMMSS is the time the email alert was sent Example:  ALERT_BILL_ASYNC_BILLASYNCACTIVE_032713_083000 indicates the email alert was generated for the BILL_ASYNC job monitor and BILLASYNCACTIVE job monitor rule on March 27 at 8:30. Note:  The system does not save an alert email in this directory if the job monitor rule name contains any special characters.

Job Monitor Rules

Use the Work with Job Monitor Rules Screen to define monitor rules for a job. For each rule, you can define:

• how often the system evaluates the rule to determine if its condition is met.

• whether the system uses the last update date and time, the last transaction date and time, or query results to determine whether to act on the rule.

• the type of action to perform if the rule’s conditions are met, such as:

  • receiving an email so that you can react to the condition.

  • running a periodic function. For example, you can define a job monitor rule that if the Controlling Async goes down, to run the periodic function that starts the Controlling Async. If you define a periodic function, you can also have the system notify you by email if the condition for the job monitor rule still exists after running the periodic function.

Job Monitor Queries

Create any queries for which you wish to receive an alert if the query results come back true. Once you create the query:

• Store these queries in the directory defined for the JOB_MONITOR_QUERY_ DIRECTORY property.

• Create a job monitor rule for the Query job monitor on the Work with Job Monitor Rules Screen. For this job monitor rule:

• Select to Alert On Query and enter the name of the query that you created.

• Define a schedule when the system determines if the query results come back true.

• Define the action to take if the query results come back true.

Job Monitor Query Examples

Job Monitor Rule	Query Example
receive an alert when the number of records in the billing data queue is equal to or greater than 100	select 'Y' from dual where (Select COUNT(*) from Billing_Header_Data_Queue)>=100
receive an alert if the number of running jobs for the INVTRAN_IN integration layer job is not equal to 3	select 'Y' from dual where (Select COUNT(*) from JenasysJob where jobName in (select ilq_job_name from Integration_Process_Queue where ILP_Process='INVTRAN_IN' and ILQ_Enabled='Y') and status='RUN')=3
receive an alert if no orders were created for the current date	select 'Y' from dual where (select COUNT(*) from Order_Header where CMP_Company=555 and OHD_Order_date=FNSYNONDATE)>0

Which Jobs are Monitored?

The table below lists the jobs you can monitor on the Work with Job Monitor Screen (WJMO). For each job, this table lists:

• The name of the job.

• The type of information collected for each job.

• Heartbeat Only = the job is associated with a heartbeat that the system uses to verify that the job is still active. Currently, there are no jobs associated with a heartbeat only.

• Transactions Only = the job processes transactions.

• Heartbeat and Transactions = the job is associated with a heartbeat and processes transactions.

• Query = the job runs queries not related to the other jobs listed on the Work with Job Monitor screen.

• When the system collects the type of information.

• The purpose of the job.

• The menu option where you can work with the job.

Note:

• If you have the same job running more than once; for example, you have multiple Billing Async jobs running at the same time, the job displays on the Work with Job Monitor Screen (WJMO) only once.

• If you have the same integration layer job running more than once; for example, you have multiple stored value card activation jobs, each job displays on the Work with Job Monitor Screen (WJMO).

Job	Information Collected	Updated When
MBJC Use Background Job Control (MBJC) to review and work with these jobs.
BILL_ASYNC background job Processes updates related to shipments and returns.See Working with the BILL_ASYNC Job.	Heartbeat and Transaction date/time	Heartbeat date/time The job reads the billing async data queue every 30 seconds. Transaction date/time The system reads a record from the billing async data queue. Note:  The system also updates the heartbeat date/time and transaction date/time when you end the asyncs.
CNTL_ASYNC background job Starts and ends each of the background ASYNC jobs. When you start the CNTL_ASYNC job, all of the background ASYNC jobs start; when you end the CNTL_ASYNC job, all of the background ASYNC jobs end. You cannot start or end an individual background ASYNC job.See Working with the CNTL_ASYNC Job.	Heartbeat and Transaction date/time	Heartbeat date/time The job reads the controlling async data queue every 30 seconds. Transaction date/time The system reads a record from the controlling async data queue. Note:  The system also updates the heartbeat date/time and transaction date/time when you end the asyncs.
EBO_ASYNC background job Updates the system tables with reservation and backorder information whenever the inventory level for a backordered item increases. Inventory levels for an item increase when you process inventory transactions, receive purchase orders, or transfer merchandise from suspense.See Working with the EBO_ASYNC Job.	Heartbeat and Transaction date/time	Heartbeat date/time The job reads the EBO async data queue every 30 seconds. Transaction date/time The system reads a record from the EBO async data queue. Note:  The system also updates the heartbeat date/time and transaction date/time when you end the asyncs.
ORDR_ASYNC background job Updates the system tables with order and demand information as orders are entered and maintained. See Working with the ORDR_ASYNC Job.	Heartbeat and Transaction date/time	Heartbeat date/time The job reads the order async data queue every 30 seconds. Transaction date/time The system reads a record from the order async data queue. Note:  The system also updates the heartbeat date/time and transaction date/time when you end the asyncs.
OTHR_ASYNC background job Updates the system tables with purchase order information when purchase orders are entered, maintained, or received. See Working with the OTHR_ASYNC Job.	Heartbeat and Transaction date/time	Heartbeat date/time The job reads the other async data queue every 30 seconds. Transaction date/time The system reads a record from the other async data queue. Note:  The system also updates the heartbeat date/time and transaction date/time when you end the asyncs.
APIs
CUSTIN CWCustomer web service Processes an Inbound Customer Message (CWCustomerIn received from an external system, such as a point-of-sale system. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time The CWCustomer web service processes a CWCustomerIn message.
EMAILREQ CWEmailRequest web service Processes an Email Request Message (CWEmailRequest) received from an integrated point-of-sale system.	Transactions Only date/time	Transaction date/time The CWEmailRequest web service processes a CWEmailRequest message.
ORDERINAPI CWOrderIn web service Processes an Inbound Order XML Message (CWORDERIN) received from an external system, such as a web storefront. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time The CWOrderIn web service processes a CWOrderIn message.
PICKINAPI CWPickIn web service Processes a CWPickIn XML Message received from a warehouse management system. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time The CWPickIn web service processes a CWPickIn message.
RECEIPTIN CWReceiptIn web service Processes a PO Receipt In XML Message (CWReceiptIn) received from a warehouse management system. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time The CWReceiptIn web service processes a CWReceiptIn message.
WPBJ Use Working with Drop Ship Background Jobs (WPBJ) to review and work with this job.
COLLAB Processes transactions between Order Broker’s Drop Ship Manager and Order Management System in the Order Broker Drop Ship Integration.	Heartbeat and Transaction date/time	Heartbeat date/time The job looks for transactions to process, based on the Delay Time defined for the job. Transaction date/time The job processes a transaction.
IJCT This list includes: any outbound integration layer job that has program ILR0022 defined as its Outbound program, including any jobs that you create. specific inbound integration layer jobs: CUSTHIST CUSTSRCH INV_INQUIRY INVTRANIN ORDLINHIST ORDTRNHIST PROCESSIN RETURNIN Use Working with Integration Layer Processes (IJCT) to review and work with these jobs.
BILL_UPD At periodic intervals, processes deferred billing updates for records in the Invoice Header table whose Process Date field is 0. The Parameter defined for the BILLUPD periodic function how often the job processes the deferred billing updates. Example: If the Parameter is 60, the system looks for deferred billing updates to process every 60 seconds.See Delay Billing Updates (K85) for processing details.	Heartbeat and Transaction date/time	Heartbeat date/time The BILL_UPD job reads the IL Outbound Trigger table,  based on the Parameter defined for the periodic function. Transaction date/time The BILL_UPD job processes a billing transaction. Note: This job is no longer associated with the IJCT process in Order Management System 21.2 or higher.
BROKER Sends and receives order information and updates using Order Broker’s message formats; see Sample Order Broker Messages for examples.	Heartbeat and Transaction date/time	Heartbeat date/time The BROKER job reads the IL Outbound Trigger table, based on the Outbound delay time defined for the job. Transaction date/time The BROKER job processes a broker transaction.
BROKER_ORD Sends and receives new order, pending cancellation requests, and other status updates using Order Broker’s message formats; see Sample Order Broker Messages for examples.	Heartbeat and Transaction date/time	Heartbeat date/time The BROKER_ORD job reads the IL Outbound Trigger table, based on the Outbound delay time defined for the job. Transaction date/time The BROKER_ORD job processes a broker transaction.
CUST_OUT Generates an outbound CWCustomerDownload XML message when you create, change, or delete a customer. See Generic Customer Download API for an overview. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time The CUST_OUT job reads the IL Outbound Trigger table for CST customer download triggers, based on the Outbound delay time defined for the job. Transaction date/time The CUST_OUT job reads and processes a customer download trigger record in the IL Outbound Trigger table.
CUSTHIST Receives a CustHistRequest for customer order history or information on a specific order, and generates a response (CWCUSTHISTOUT or CWORDEROUT). See Generic Customer History API for an overview. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
CUSTSRCH Receives a CWCustomerInqRequest for information on one or more customers matching specific search criteria, and generates a CWCustomerInqResponse. See Generic Customer Inquiry (Search) API for an overview.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
INV_DOWNLOAD Sends inventory availability information to another system in the CWInventoryDownload message. See Generic Inventory Download API for an overview. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
INV_INQUIRY Receives a CWInventoryInquiryRequest for inventory availability on a specific item/SKU and generates a CWInventoryInquiryResponse. See Generic Customer Inquiry (Search) API for an overview.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
INVOIC_OUT Sends invoice information in the CWInvoiceOut message to another system, such as a retail store, financial system, or warehouse management system. See Generic Invoice Download API for an overview.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
INVTRANIN Receives inventory transactions in the inCreateInvXaction message and updates inventory information, such as in the Item Location and Item Warehouse tables. Any errors create Item Transaction Error records. See Generic Inventory Transaction Upload for an overview.	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
ITEM_OUT Sends item and SKU information in the CWItemOut message to another system, such as a retail store or warehouse management system. See Generic Item Download API.	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
ORDCLNUP Order Cleanup job Rejects any orders that have been “abandoned” on the web storefront if, for example, the customer closes the browser window. This process uses the Time Limit for Suspended E-Commerce Orders (G43) system control value to determine the number of minutes to wait before rejecting an order. Only orders of the type specified in the E-Commerce Order Type (G42) system control value are eligible for cleanup, and the cleanup takes place only if the Get Orders from E-Commerce (G35) system control value is selected. The system generates the E-Commerce Order Cleanup Log each time it deletes a suspended order. Each time the job rejects an order, it writes a record in the Deleted Order Table.	Heartbeat and Transaction date/time	Heartbeat date/time The job looks for orders to clean up every minute. The system also updates the heartbeat date/time when the job deletes an order. Transaction date/time The job deletes an order.
ORDLINHIST Receives order line history activity for a specified order line on an order, based on XML messages from an external system, such as a warehouse management system. See Order Line History In API.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
ORDTRNHIST Receives order transaction records for a specified order, based on XML messages from an external system, such as a warehouse management system. You can review the order transaction history records created on the Display Order History Screen. See Generic Order Transaction History API.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
PICK_OUT Sends a Pick Message from Order Management System (CWPickOut) for each pick slip generated. See Generic Pick Out API for an overview.  For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
PO_OUT Sends a CWPurchaseOrderOut message to a warehouse management system or an EDI vendor. See Generic Outbound Purchase Order API. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
PROCESSIN Uses the CWServiceIn Web Service to receive the CWProcessIn message and submit the specified periodic process received from an external system. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the CWServiceIn web service receives and processes a CWProcessIn message.
RETURN_OUT Sends a Return Authorization Outbound XML Message (CWReturnRAOut) when a return authorization is created, changed, or deleted. See Outbound Return API for an overview. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
RETURNIN Receives an Return Request Message (CWReturnIn) to create and process a return against a specified order line. Optionally, the process sends an Return Response Message (CWReturnOut) to the external system, indicating if the return processed successfully or if an error occurred. See Inbound Return API for an overview. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Transactions Only date/time	Transaction date/time updated when the job receives and processes a transaction.
SVC_OUT Sends a Stored Value Card Activation Request to a service bureau. The service bureau returns a Stored Value Card Activation Response to Order Management System. See Stored Value Card Purchase and Activation.	Heartbeat and Transaction date/time	Heartbeat date/time updated by completing a stored value card activation transaction then then sleeping for 2 seconds. Transaction date/time updated every time the SVC_OUT job processes an activation transaction.
SVC_REVRSL Sends a Stored Value Card Authorization Reversal to the service bureau. The service bureau sends a Stored Value Card Authorization Reversal Response to Order Management System. See Stored Value Card Authorization Reversal.	Heartbeat and Transaction date/time	Heartbeat date/time updated by completing a stored value card authorization reversal transaction then sleeping for 2 seconds. Transaction date/time updated every time the SVC_REVRSL job processes an authorization reversal transaction.
VENDOR_OUT Sends a CWVendorOut message to another system, such as a retail store or warehouse management system. See Generic Vendor Download API. For more information see the Web Services Guide on https://support.oracle.com My Oracle Support (ID 2149144.1).	Heartbeat and Transaction date/time	Heartbeat date/time updated by reading the IL Outbound Trigger table. If the table is empty, the system sleeps for the Outbound delay time and then reads the table again. Transaction date/time updated every time the system reads and processes a record in the IL Outbound Trigger table.
Query
QUERY Runs queries not related to the jobs listed on the Work with Job Monitor screen.	Query Only	The system does not update the heartbeat date/time or transaction date/time for this job. See Job Monitor Queries for more information on how to set up the Query job monitor.

Job Monitor Examples

• Job Monitor Example: PICK_OUT

• Job Monitor Example: ORDER_IN

• Job Monitor Example: Query

Job Monitor Example: PICK_OUT

You want to be notified by email every day between 9AM and 5PM when the system does not update the Update Date and Update Time for the PICK_OUT integration layer job, indicating the job is no longer active. The system should send an email 2 minutes after the conditions for the job monitor rule are met (the update date and update time are NOT updated), and then check every 5 minutes to see if the rule’s conditions are still met. After 10 minutes, the system should send another email.

You create a job monitor rule with the following rule settings:

• Frequency: Daily

• Start Time: 090000

• End Time: 170000

• Alert On: Update Time

• Alert After: 5 minutes

• Sleep Time: 5 minutes

• Re-alert After: every 10 minutes

• Action Type: Email

The system uses the following calculation to determine if the job monitor rule’s conditions are met: current time - alert after minutes > last update time.

At 9:05 the system checks to see if the job monitor rule’s conditions are met (the update date and time are not updated, indicating the job is not active). In this example, the PICK_OUT job is not active. The system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

The job monitor rule sleeps for 5 minutes.

At 9:10 (9:05 + 5 minutes sleep), the system checks to see if the job monitor rule’s conditions are met (the update date and time are not updated, indicating the job is not active). In this example, the PICK_OUT job is not active. Because the 10 minute re-alert time has been reached, the system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

At 9:15 (9:10 + 5 minute sleep), the system checks to see if the job monitor rule’s conditions are met (the update date and time are not updated, indicating the job is not active). In this example, the PICK_OUT job is not active; however, the Re-alert After interval has not been reached.

At 9:20 (9:15 + 5 minutes sleep), the system checks again. If the job monitor rule’s conditions are met again, the system generates the job monitor rule email, based on the Re-alert After interval.

Job Monitor Example: ORDER_IN

You want to be notified by email every day between 9AM and 5PM when the system does not update the Transaction Date and Transaction Time for the ORDER_IN integration layer job, indicating web orders are no longer being received. The system should send an email 15 minutes after the conditions for the job monitor rule are met (the transaction date and time are NOT updated, indicating a web order was not received in the last 15 minutes), and then check every 30 minutes to see if the rule’s conditions are still met. After 15 minutes, the system should send another email.

You create a job monitor rule with the following rule settings:

• Frequency: Daily

• Start Time: 090000

• End Time: 170000

• Alert On: Transaction Time

• Alert After: 15 minutes

• Sleep Time: 15 minutes

• Re-alert After: every 30 minutes

• Action Type: Email

The system uses the following calculation to determine if the job monitor rule’s conditions are met: current time - alert after minutes > last transaction time.

At 9:15 the system checks to see if the job monitor rule’s conditions are met (the transaction date and time are not updated, indicating web orders are no longer being received). In this example, the conditions are met. The system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

At 9:30 (9:15 + 15 minutes sleep) the system checks again, but the Re-alert After interval of 30 minutes has not yet been met.

At 9:45 (9:15 + 30 minutes total sleep), the system checks to see if the job monitor rule’s conditions are met (the transaction date and time are not updated, indicating web orders are no longer being received). In this example, the conditions are met and the 30 minute re-alert time has been reached. The system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

Job Monitor Example: Query

You want to be notified by email every day between 9AM and 5PM when the number of unprocessed billing async records is equal to or greater than 500 records. The system should send an email 5 minutes after the query results are true, and then check every 10 minutes to see if the rule’s conditions are still met. After 30 minutes, the system should send another email.

You create the following query and place the query in the JOB_MONITOR_QUERY_ DIRECTORY:

select 'Y' from dual where (Select COUNT(*) from Billing_Header_Data_Queue )>=500

You create a job monitor rule with the following rule settings:

• Frequency: Daily

• Start Time: 090000

• End Time: 170000

• Alert On: Query

• Query: BILLINGRECORDS.TXT

• Alert After: 10 minutes

• Sleep Time: 10 minutes

• Re-alert After: every 20 minutes

• Action Type: Email

At 9:10, the system checks to see if the job monitor rule’s conditions are met (the results for the BILLINGRECORDS.TXT query in the JOB_MONITOR_QUERY_ DIRECTORY are Y, indicating there are 500 or more unprocessed billing async records). In this example, the query results are met. The system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

The job monitor rule sleeps for 10 minutes.

At 9:20 (9:10 + 10 minutes sleep), the system checks to see if the job monitor rule’s conditions are met (the results for the BILLINGRECORDS.TXT query in the JOB_MONITOR_QUERY_ DIRECTORY are Y, indicating there are 500 or more unprocessed billing async records). However, the Re-alert After of 30 minutes has not yet elapsed.

At 9:30 (9:20 + 10 minutes sleep), the system checks In this example, the conditions are met and the 20 minute re-alert time has been reached. The system sends a job monitor rule email to the specified To Email address and updates the Check date and Check time for the rule.

Work with Job Monitor Screen (WJMO)

Purpose: Use this screen to review and work with the job monitor rules defined for a batch job.

How to display this screen: Enter WJMO in the Fast Path field at the top of any menu or select Job Monitor Status from a menu.

Column sort: You can sort on any column on this screen by clicking on the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.

Jobs first display on this screen in alphanumeric job name sequence.

• To review the job with the most recent update, click on the Update Date field until an arrow pointing down displays next to it to display jobs in descending update date sequence.

• To review the job with the most recent transaction, click on the Transaction Date field until an arrow pointing down displays next to it to display jobs in descending transaction date sequence.

Field	Description
Job Name	The name of the job. Place your cursor over the job name to determine if the job is associated with a heartbeat and/or transactions. Heartbeat Only = the job is associated with a heartbeat that the system uses to verify that the job is still active. Currently, there are no jobs associated with a heartbeat only. Transactions Only = the job processes transactions. Heartbeat and Transactions = the job is associated with a heartbeat and processes transactions. Query = this job runs queries not related to the other jobs listed on the Work with Job Monitor screen. See Which Jobs are Monitored? for a list of jobs that display on this screen and whether the job is associated with a heartbeat and/or transactions. Alphanumeric, 10 positions; display-only.
Update Date	The date when a heartbeat was last processed for the job to verify that the job is still active. If the job also processes transactions, the system also updates this field when a transaction is processed. Note:  If a job uses a heartbeat and processes transactions, the update date and time may be different from the transaction date and time. Numeric, 8 positions (in user date format); display-only.
Update Time	The time when a heartbeat was last processed for the job to verify that the job is still active. If the job also processes transactions, the system also updates this field when a transaction is processed. Note:  If a job uses a heartbeat and processes transactions, the update date and time may be different from the transaction date and time. Numeric, 6 positions (HH:MM:SS format); display-only.
Transaction Date	The date when a transaction was last processed by the job. Note:  If a job uses a heartbeat and processes transactions, the update date and time may be different from the transaction date and time. Numeric, 8 positions (in user date format); display-only.
Transaction Time	The time when a transaction was last processed by the job. Note:  If a job uses a heartbeat and processes transactions, the update date and time may be different from the transaction date and time. Numeric, 6 positions (HH:MM:SS format); display-only.
Process	The menu option where you can work with the job. Click on this value to advance to the specified menu option.
Rules	Indicates whether any condition rules are defined for the job. Once rules are defined for a job, the color of the Rules icon changes to blue ().

Screen Option	Procedure
Work with the condition rules defined for a job	In the Action drop down list, select Rules for a job to advance to the Work with Job Monitor Rules Screen. Note:  Once rules are defined for a job, the color of the Rules icon changes to blue ().
Refresh the screen with the most recent Update Date, Update Time, Transaction Date, and Transaction Time	Select Refresh.
Display all jobs in the Job Monitor Status, including jobs that were previously hidden	Select Show All. Note:  You can use the Hide Job option on the Work with Job Monitor Rules Screen to hide a job so that it does not display on the Work with Job Monitor Screen (WJMO).

Work with Job Monitor Rules Screen

Purpose: Use this screen to define monitoring rules for a job. When these rules are met, you can have the system:

• Notify you by email.

• Run a periodic function, and if the conditions for the rule are still met after the defined sleep time, send an email when the re-alert time is reached.

The condition rules can be based on the last update date and time, the last transaction date and time, or query results.

Note:

If job monitoring does not run on the application server (the ALLOW_JOB_ MONITOR property for the application server is set to N), the only option on this screen is to display a rule’s settings.

How to display this screen: In the Action drop down list, select Rules for a job on the Work with Job Monitor Screen (WJMO).

Column sort: You can sort on the Rule and Status columns on this screen by clicking on the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.

Field	Description
Job Name	The name of the job associated with the monitoring rules. This is the job you selected on the Work with Job Monitor Screen (WJMO). Alphanumeric, 10 positions; display-only.
Rule	The name of the job monitor rule. Note:   When you schedule a job monitor rule, the system uses the first 10 positions of the rule name as the job name that displays on the Scheduled Jobs Screen. In order to save alert emails for the job monitor rule in the TRACK_ALERT_ EMAILS_IN_ FOLDER directory, do not use any special characters in the job monitor rule name. Alphanumeric, 25 positions; display-only.
When	Indicates how often the system monitors the job to see if it meets the rule’s conditions, based on the Frequency, Start Time, and End Time defined for the rule on the Create Job Monitor Rule Screen. Alphanumeric, 40 positions; display-only.
Status	The status of the job monitor rule. Valid statuses are: Unscheduled = The rule has been created, but it not in use. Scheduled = The rule has been created and scheduled, but is not currently running. Running = The rule is actively running. Ending = The rule is in the process of ending. Alphanumeric, display-only.
Check Date	The date when the system last compared this rule to the monitoring information for the job to determine if the rule’s conditions are met. Numeric, 8 positions (in user date format); display-only.
Check Time	The time when the system last compared this rule to the monitoring information for the job to determine if the rule’s conditions are met. Numeric, 6 positions (HH:MM:SS format); display-only.

If you are reviewing the Work with Job Monitor Rules screen from an application server

Screen Option	Procedure
Create a job monitor rule	Select Create to advance to the Create Job Monitor Rule Screen.
Hide this job from the Work with Job Monitor Screen (WJMO)	Select Hide Job. Note:  To redisplay this job, including all other jobs that are hidden, select Show All on the Work with Job Monitor Screen (WJMO).
Review a job monitor rule	Select Display in the Action column for a job monitor rule to advance to the Display Job Monitor Rule screen. All fields on this window are display-only. See the Create Job Monitor Rule Screen for field descriptions. Note:  This option is available if the status of the job is Unscheduled, Scheduled, Running, or Ending.
Change a job monitor rule Note:  This option is available only if the Status of the job monitor rule is Unscheduled.	Select Change in the Action column for a job monitor rule to advance to the Change Job Monitor Rule screen. See the Create Job Monitor Rule Screen for field descriptions. Note:  This option is available if the status of the job is Unscheduled.
Run a job monitor rule Note:  This option is available only if the Status of the job monitor rule is Unscheduled or Scheduled.	Select Start in the Action column for a job monitor rule to change its status to Running. At the Confirm window, select OK to start running the rule; otherwise, select Cancel. Note:  This option is available if the status of the job is Unscheduled or Scheduled and the start time is met. When you start a job monitor rule, the system changes the status of the job to Running.
Stop a job monitor rule Note:  This option is available only if the Status of the job monitor rule is Running.	Select Stop in the Action column for a job monitor rule. At the Confirm window, select OK to stop running the rule; otherwise, select Cancel. Note:  This option is available if the status of the job is Running. When you stop a rule, the system changes its status from Running to Ending, and then to Unscheduled or Scheduled.
Schedule a job monitor rule Note:  This option is available only if the Status of the job monitor rule is Unscheduled.	Select Schedule in the Action column for a job monitor rule to change its status to Scheduled. At the Confirm window, select OK to schedule the rule; otherwise, select Cancel. Note:  This option is available if the status of the job is Unscheduled. When you schedule a job monitor rule, the system displays the job on the Scheduled Jobs Screen. The first 10 positions of the job monitor rule name displays as the job name on the screen. If the job monitor rule runs a periodic process, the system also displays the periodic process on the Scheduled Jobs screen and schedules the periodic process to run 1 minute after the associated job monitor rule. Once the periodic process runs, the system removes it from the Scheduled Jobs screen.
Unschedule a job monitor rule	Select Unschedule in the Action column for a job monitor rule to change its status to Unscheduled. At the Confirm window, select OK to schedule the rule; otherwise, select Cancel. Note:  This option is available if the status of the job is Scheduled.
Delete a job monitor rule	Select Delete in the Action column for a job monitor rule. At the Confirm window, select OK to delete the rule; otherwise, select Cancel. Note:  This option is available if the status of the job is Unscheduled.

Create Job Monitor Rule Screen

Purpose: Use this window to define settings for a job monitor rule.

How to display this screen: Select Create on the Work with Job Monitor Rules Screen.

Field	Description
Job Name	The name of the job associated with the monitoring rule. This is the job you selected on the Work with Job Monitor Screen (WJMO). Alphanumeric, 10 positions; display-only.
Rule	The name of the job monitor rule. Note:  When you schedule a job monitor rule, the system uses the first 10 positions of the rule name as the job name that displays on the Scheduled Jobs Screen. Alphanumeric, 25 positions; required.
Frequency	How often the system monitors the job to see if it meets the rule’s conditions. Valid values: Daily: the system monitors the job for this rule every day. Weekdays: the system monitors the job for this rule every Monday, Tuesday, Wednesday, Thursday, and Friday. Weekends: the system monitors the job for this rule every Saturday and Sunday. Monday: the system monitors the job for this rule every Monday. Tuesday: the system monitors the job for this rule every Tuesday. Wednesday: the system monitors the job for this rule every Wednesday. Thursday: the system monitors the job for this rule every Thursday. Friday: the system monitors the job for this rule every Friday. Saturday: the system monitors the job for this rule every Saturday. Sunday: the system monitors the job for this rule every Sunday. Alphanumeric; required.
Start Time	Defines the start time when the system monitors the job to see if it meets the rule’s conditions. You must enter the start time in HHMMSS military format; for example, enter 07:00:00 to indicate a start time of 7 AM. Note:  Valid entries are 00:00:00 - 23:59:59. The start time must be earlier than the end time. Numeric, 6 positions; required.
End Time	Defines the end time when the system monitors the job to see if it meets the rule’s conditions. You must enter the end time in HHMMSS military format; for example, enter 17:00:00 to indicate an end time of 5 PM. Note:  Valid entries are 00:00:00 - 23:59:59. The end time must be later than the start time. Numeric, 6 positions; required.
User	The user ID associated with the job monitor rule. The user ID defaults to the user that is creating or updating the rule, but you can override it. User IDs are defined in and validated against the User table. Alphanumeric, 10 positions; required.
Alert On	Defines the factor the system evaluates to determine if the job meets the rule’s conditions. Valid values: Update Time: The system evaluates the job’s last update date and time to determine if the job meets the rule’s conditions. Transaction Time: The system evaluates the job’s last transaction date and time to determine if the job meets the rule’s conditions. Query: The system evaluates the results of the query specified for the rule to determine if the job meets the rule’s conditions. Alphanumeric, required.
Query	The name of the query whose results the system evaluates to determine if the job meets the rule’s conditions. The query must be located in the directory defined in the JOB_MONITOR_QUERY_ DIRECTORY property. Alphanumeric, 25 positions; required if Alert On is set to Query.
Alert After	The number of minutes to wait before the system can initially generate an alert. Typically equal to or a multiple of the Sleep Time. Example:   Alert After is set to 10 minutes Sleep Time is set to 5 minutes Start Time is set to 08:00. Result: Based on the Sleep Time, the system first evaluates the job’s status at 8:05 (5 minutes after the start time). The number of minutes specified as the Alert After has not passed. Based on the Sleep Time, the system then evaluates again at 8:10, and at that point the Alert After has been met. The system generates the alert. Note:  If the Sleep Time is greater than the Alert After time, the initial alert is not generated until the Sleep Time elapses. For example, if the Alert After is set to 5 minutes, but the Sleep Time is set to 10 minutes, the system does not check the job’s status until 10 minutes after the start time. For more information: See Job Monitor Examples for more examples. Numeric, 3 positions; required.
Sleep Time	The number of minutes to wait before checking or re-checking the condition to determine whether it is time to generate an alert. Used in combination with: Alert After: How long to wait before generating the initial alert. Re-alert After: How long to wait between checking whether to generate additional alerts. The Alert Time and Re-alert After Time would typically be multiples of the Sleep Time. For example, if the Sleep Time is 5 minutes, the Alert Time and Re-alert After Time might be 10 minutes or 15 minutes. See Alert After, above, and Re-alert After, below, for examples. Also, see Job Monitor Examples for more examples. Numeric, 3 positions; required.
Re-alert After	The number of minutes to wait before generating an alert after the initial alert is generated. Typically equal to or a multiple of the Sleep Time. Example:   Sleep Time is set to 5 minutes Alert After is set to 5 minutes Start Time is set to 8:00 Re-alert After is set to 10 minutes. Result: The system first evaluates the job’s status at 8:05 (based on the Sleep Time) and generates the first alert (based on the Alert After time of 5 minutes). The system checks again at 8:10 (based on the Sleep Time) and finds that the Re-alert After time has not elapsed. The system then checks again at 8:15 (based on the Sleep Time) and finds that the Re-alert After time has elapsed, so it generates another alert. The next time that another alert will be generated is 8:25. The system continues to check every 5 minutes, and generates the re-alert each time an additional 10 minutes has passed. For more information: See Job Monitor Examples for more examples. Numeric, 3 positions; optional.
Action Type	Defines the type of action to take when the job meets the rule’s conditions. Valid values: Email: Send an email to the specified To Email. Periodic Process: Run the specified periodic process. Note: When the Action Type is Periodic Process, define a From Email Alias, Subject, To Email, and Email Text to have the system send an email alert if the condition for the job monitor rule still exists after running the periodic function. The system will continue to send an email alert until the condition is no longer met or the end time is met. Alphanumeric, required.
Periodic Process	The code for the periodic process to run. Periodic processes are defined in and validated against the Periodic Process table. Alphanumeric, 10 positions; required if Action Type is Periodic Process.
Process Company	The code for the company to run the periodic process. Company codes are defined in and validated against the Company table. Numeric, 3 positions; optional.
From Email Alias	The “from” email alias to display with the “from” address for emails, for example, My Email Alias <[e-mail]>. The actual “from” address is set by Oracle and cannot be changed. Alphanumeric, 50 positions; required if Action Type is Email.
Subject	The subject of the job monitor rule email. Alphanumeric, 50 positions; required if Action Type is Email.
To Email	The list of email addresses that receive the job monitor rule email. Each email address entered must be separated by a semi-colon (;). For example: [e-mail];[e-mail]. See Email Address Validation.  Alphanumeric, 200 positions; required if Action Type is Email.
Email Text	The text to display in the body of the job monitor rule email. Alphanumeric, 255 positions; required if Action Type is Email.