Working with Customer Properties (PROP)
Purpose: Use this menu option to define system-wide configuration settings for Order Administration 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
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:
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
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.
|
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.
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:
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.
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.
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.
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.
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.
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:
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. |
SUPPRESS_IMAGES Controls whether the system prints 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.
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.
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.
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.
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.
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.
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.
INCLUDE_DOLLAR_SIGN Defines whether the system prints 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.
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.
INCLUDE_DOLLAR_SIGN Defines whether the system prints 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 Administration 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. |
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_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:
|
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 Administration 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 Administration database environment specified in the CW_MANIFEST_ENVIRONMENT_ID property. Note: You must also create this user ID in Order Administration:
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 l53Default 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 folder where the system places files that have been uploaded prior to additional processing. This setting is defined by Oracle and cannot be changed. 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. |
DELETE_DUPLICATE_INVOICE_OUT_TRIGGERS |
Defines whether to delete duplicate invoice trigger records. This new property applies only when the Consolidate Invoice (B49) system control value is selected:
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_MAX_SIZE |
The maximum size, in bytes, of a file that can be uploaded to the FILE_STORAGE table. 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 2953017.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 |
Not currently implemented. |
MASS_CUSTDWNLD_FILE_NAME |
Not currently implemented. |
MASS_CUSTDWNLD_MESSAGE_WRAPPER |
Not currently implemented. |
oms.car.service.url |
The prefix URL for Oracle Retail Collect and Receive Cloud Service (CaR). Provided by your Oracle representative. Defaults to http://hostname:port/. |
oms.car.service.version |
The message version for the CaR services. A value of ‘2’ is required. Any other value will cause a communication failure. |
oms.car.status.enabled |
Not currently implemented. Default value of false (blank). |
oms.promotion.engine.service.url |
The URL entered to store the full URL for the Oracle Retail
Promotion Engine (ORPE) Cloud Service with a value of https://[SERVER]/promote/services/dealServices/v2/applyDeals where
[SERVER] is replaced with actual server details.
Note: Only v2 applyDeals is supported. |
oms.tax.generic.oauth.client.id |
The client ID to use, together with the client secret, to generate the token to use for OAuth 2.0 authentication. |
oms.tax.generic.oauth.client.secret |
The client secret to use, together with the client ID, to generate the token to use for OAuth 2.0 authentication. |
oms.tax.generic.oauth.scope |
The scope to use when generating the token for authentication. |
oms.tax.generic.oauth.url |
The URL of the OAuth service to use when generating the token for authentication. Must conform to the OpenId OAuth 2.0 specification to get an authorization token. It also must support the "Client Credentials" Grant Type and accept the client ID and client secret as a Basic Authentication header. |
oms.tax.generic.timeout |
The number of milliseconds to wait before timing out the tax call. If this property is not set to a number, a default of 30 seconds applies. Optional. |
oms.tax.generic.url |
oms.tax.generic.url: The URL to use when generating
the generic tax request. Must:
|
oocs.return.locations.service |
The prefix URL for the OOCS Eligible Return Location service. Provided by your Oracle representative. Defaults to https://server:port/Locate/rest. |
orce.coupon.service.url.suffix |
|
ORCE_ALT_ID_OROMS |
Indicates the Alt Key Type of the alternate key in Oracle Retail Customer Engagement that maps to the Order Administration 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 Administration 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:
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_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:
|
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. Both version 2.3 and version 3.1 are supported. Set this to /OrceWebServices/v2_3/CustomerServicesApiService?wsdl where 2_3 is the version of the Customer Services API or /OrceWebServices/v3_1/CustomerServicesApiService?wsdl where 3_1 is the version of the Customer Services API. Note: This property is not updated automatically, and there is no additional functionality provided by changing the version number to version 3.1. |
ORCE_DAY_PHONE_LABEL |
Indicates the Telephone Type in Oracle Retail Customer Engagement that maps to the daytime phone number in Order Administration. 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:
An example of this setting is: ORCE_DAY_PHONE_LABEL=BUSINESS |
ORCE_EVE_PHONE_LABEL |
Indicates the Telephone Type in Oracle Retail Customer Engagement that maps to the evening phone number in Order Administration. 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:
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 Administration. 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 Administration. 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:
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. |
ORCE.COUPON.SERVICE.URL.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 Promotion Engine for the ORCE Serialized Coupon Service. |
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 Orchestration server. See Importing Store Cross Reference Locations through Order Orchestration’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 Orchestration. The ACTPO periodic function generates this request message as part of future receipts and pre-order processing. The maximum number of records that Order Orchestration 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 Orchestration 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 Orchestration 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 Orchestration 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 Administration. These statuses apply to retail pickup and ship-for-pickup orders:
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:
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 Orchestration. 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 Orchestration Configuration. |
OROB_MESSAGE_VERSION |
Defines the message version to include in Order Orchestration and merchandise locator request messages that Order Administration sends to Order Orchestration. Version requirements:
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 Orchestration 22.2.301.0 or higher. For more information see the Order Administration Web Services Guide on My Oracle Support (ID 2953017.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 Orchestration 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 Orchestration 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 Orchestration 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 Orchestration 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 Orchestration 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. |
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.
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_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:
|
System Property Settings
The settings below define configuration settings for the Order Administration application server.
Property Name | Description |
---|---|
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 Administration. 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:
During installation, the system prompts for the default date format of Order Administration. The system:
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:
See:
|
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 Order Administration Web Services Guide on My Oracle Support (ID 2953017.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 Administration. 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. |