Working with Customer Properties (PROP)

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

When you update a property setting, 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

Property

The name of a property.

You can expand the Property column to review the full name of the property setting.

Current Value

The current value for a setting in one of the CWSerenade properties files on the current CWSerenade application server.

You can expand the Current Value column if its full value does not display.

New Value

The updated value for a setting in one of the CWSerenade properties files on the current CWSerenade application server.

You can expand the New Value column if its full value does not display.

This change does not take effect until you select Change on this screen or stop and restart the SERENADE service (or the application server).

Note: This column displays only if a setting in one of the CWSerenade properties files on the current CWSerenade application server has changed. If you do not see this column, then no changes have been made to any of the CWSerenade properties files on this server.

Screen Option

Procedure

Update all of the property settings that are flagged with an exclamation icon with their new values

Select Change. CWSerenade updates all of the settings that are flagged with an exclamation icon with their new values. These changes take effect on the current server only. The changes take effect immediately.

Multiple application servers: If you use multiple self-contained CWSerenade application servers, you need to maintain the properties files on each application server. If you select to update the settings that have changed for one application server, you should also log in to the other CWSerenade application servers and use System Properties (PROP) to update the settings that have changed for the other servers.

Note: In order to update property settings that are flagged with a restart icon with their new values, you must stop and restart the SERENADE service (or application server) before the changes take effect.

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

APCHECK

 

APCHECK,INCLUDE_DOLLAR_SIGN=Y

Controls whether certain information prints on A/P Checks.

INCLUDE_DOLLAR_SIGN

Defines whether a dollar sign prints on A/P Checks.

Y = A dollar sign prints on the A/P Check.

N = A dollar sign does not print on the A/P Check.

BOCARDS

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.

COMPUPLOADERR

 

COMPONENT_UPLOAD_ERROR_REPORT

Controls whether certain information prints on the Component Upload Error Report. 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.

CRTBCHRCP

 

CART_BATCH_RECAP

Controls whether certain information prints on the Cart Batch Recap. 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 CSV spreadsheet format. Currently, there is no information to define.

DEFMESSAGES

 

DEFAULT_ORDER_MESSAGES_PRINT_LIST

Controls whether certain information prints on the Default Order Message print listing. 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 CSV 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 CSV 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 CSV 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 CSV 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.

FRTCHGDTL

 

FREIGHT_CHARGES_DETAIL

Controls whether certain information prints on the Freight Charges Detail Report. Currently, there is no information to define.

FRTCHGDTLCSV

 

FREIGHT_CHARGES_DETAIL_CSV

Controls whether certain information prints on the Freight Charges Detail Report in CSV spreadsheet format. Currently, there is no information to define.

FRTCHGSUMM

 

FREIGHT_CHARGES_SUMMARY

Controls whether certain information prints on the Freight Charges Summary Report. Currently, there is no information to define.

FRTCHGSUMMCSV

 

FREIGHT_CHARGES_SUMMARY_CSV

Controls whether certain information prints on the Freight Charges Summary Report in CSV spreadsheet format. Currently, there is no information to define.

GCERT

 

GIFTCERT,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical custom gift certificate. This option is available only if your gift certificate print program supports it.

Defines whether images print on the non-graphical Gift Certificate.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical gift certificate.

N = Print images on the non-graphical gift certificate.

Y (default) = Suppress images on the non-graphical gift certificate.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical gift certificate.

GCERTG

 

GIFTCERT,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical custom gift certificate. This option is available only if your gift certificate print program supports it.

Defines whether images print on the graphical Gift Certificate.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical gift certificate.

N (default) = Print images on the graphical gift certificate.

Y = Suppress images on the graphical gift certificate.

Note: The SUPPRESS_IMAGES value should be N for the graphical gift certificate.

GIFTACK and GIFTACKDB

=GIFTACKDB,SUPPRESS_IMAGES=Y,INPUT_TYPE=DB

Note: These settings also apply to your non-graphical custom gift acknowledgement. Each option is available only if your gift acknowledgement print program supports it.

Defines whether images print on the non-graphical Gift Acknowledgement.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical gift acknowledgement.

N = Print images on the non-graphical gift acknowledgement.

Y (default) = Suppress images on the non-graphical gift acknowledgement.

Note: The SUPPRESS_IMAGES value should be Y for the non-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 CWSerenade (CWPickOut) to generate the gift acknowledgement.

DB = The program queries the database to generate the gift acknowledgement.

The INPUT_TYPE setting for the standard printing programs GIFTACKDB and GIFTACK is DB.

GIFTACKDBG and 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 CWSerenade (CWPickOut) to generate the gift acknowledgement.

DB = The program queries the database to generate the gift acknowledgement.

The INPUT_TYPE setting for the standard printing programs GIFTACKDBG and GIFTACKG is DB.

GLSUMMARY

 

GLSUMMARY

Controls whether certain information prints on the General Ledger Interface Summary. Currently, there is no information to define.

GLSUMMARYCSV

 

GLSUMMARY_CSV

Controls whether certain information prints on the General Ledger Interface Summary in CSV spreadsheet format. Currently, there is no information to define.

INVOICE

 

INVOICE,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical custom invoice. This option is available only if your invoice print program supports it.

Defines whether images print on the non-graphical Customer Invoice.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical invoice.

N = Print images on the non-graphical invoice.

Y (default) = Suppress images on the non-graphical invoice.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical invoice.

INVOICEG

 

INVOICE,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical custom invoice. This option is available only if your invoice print program supports it.

Defines whether images print on the graphical Customer Invoice.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical invoice.

N (default) = Print images on the graphical invoice.

Y = Suppress images on the graphical invoice.

Note: The SUPPRESS_IMAGES value should be N for the graphical invoice.

INVUSAGE

 

INVENTORY_USAGE

Controls whether certain information prints on the Inventory Usage Report. Currently, there is no information to define.

INVUSAGEXLS

 

INVENTORY_USAGE_CSV

Controls whether certain information prints on the Inventory Usage Report in CSV spreadsheet format. Currently, there is no information to define.

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 CSV spreadsheet format. Currently, there is no information to define.

JFLR0397

 

PICKING_PULLSHEET

 

Controls whether certain information prints on the Picking Pullsheet. Currently, there is no information to define.

JFLR0397CSV

 

PICKING_PULLSHEET_CSV

Controls whether certain information prints on the Picking Pullsheet in CSV spreadsheet format. Currently, there is no information to define.

MERCHC

 

MERCHCREDIT,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical custom merchandise credit. This option is available only if your merchandise print program supports it.

Defines whether images print on the non-graphical Merchandise Credit.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical merchandise credit.

N = Print images on the non-graphical merchandise credit.

Y (default) = Suppress images on the non-graphical merchandise credit.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical merchandise credit.

MERCHCG

 

MERCHCREDIT,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical custom merchandise credit. This option is available only if your merchandise credit print program supports it.

Defines whether images print on the graphical Merchandise Credit.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical merchandise credit.

N (default) = Print images on the graphical merchandise credit.

Y = Suppress images on the graphical merchandise credit.

Note: The SUPPRESS_IMAGES value should be N for the graphical merchandise credit.

OBAGINGRPT

 

ORDER_BROKER_AGING_REPORT

Controls whether certain information prints on the Order Broker Aging Report. Currently, there is no information to define.

OBAGINGRPTCSV

 

ORDER_BROKER_AGING_REPORT_CSV

Controls whether certain information prints on the Order Broker Aging Report in CSV spreadsheet format. Currently, there is no information to define.

OPNQUOTRPT

 

OPEN_QUOTES_REPORT

Controls whether certain information prints on the Open Quotes Report. Currently, there is no information to define.

OPNQUOTRPTCSV

 

OPEN_QUOTES_REPORT_CSV

Controls whether certain information prints on the Open Quotes Report in CSV spreadsheet format. Currently, there is no information to define.

ORDERREC

 

ORDERREC,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical custom order receipt. This option is available only if your order receipt print program supports it.

Defines whether images print on the non-graphical Order Receipt.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical order receipt.

N = Print images on the non-graphical order receipt.

Y (default) = Suppress images on the non-graphical order receipt.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical order receipt.

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

Note: These settings also apply to your non-graphical custom order summary. This option is available only if your order summary print program supports it.

Defines whether images print on the non-graphical Order Summary.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical order summary.

N = Print images on the non-graphical order summary.

Y (default) = Suppress images on the non-graphical order summary.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical order summary.

ORDERSUMG

 

ORDERSUM,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical custom order summary. This option is available only if your order summary print program supports it.

Defines whether images print on the graphical Order Summary.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical order summary.

N (default) = Print images on the graphical order summary.

Y = Suppress images on the graphical order summary.

Note: The SUPPRESS_IMAGES value should be N for the graphical order summary.

PACKERSTAT

 

PACKER_STATISTICS

Controls whether certain information prints on the Packer Statistics Report. Currently, there is no information to define.

PACKERSTATCSV

 

PACKER_STATISTICS_CSV

Controls whether certain information prints on the Packer Statistics Report in CSV spreadsheet format. Currently, there is no information to define.

PICKANAL

 

PICK_ANALYSIS

Controls whether certain information prints on the Pick Slip Generation Analysis Report. Currently, there is no information to define.

PICKAUTH

 

PICK_AUTH_REPORT

Controls whether certain information prints on the Pick Authorization Error Report. Currently, there is no information to define.

PICKDB and PICK

=PICKDB,SUPPRESS_IMAGES=Y,BARCODE_IMAGE=Code39,ORDER_BARCODE_IMAGE=Code39;INPUT_TYPE=XML

Note: These settings also apply to your non-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 non-graphical Pick Slip.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical pick slip.

N = Print images on the non-graphical pick slip.

Y (default) = Suppress images on the non-graphical pick slip.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical pick slip.

BARCODE_IMAGE

Controls whether the system prints a barcode on the non-graphical pick slip.

Code39 (default) = Print this type of barcode on the non-graphical pick slip.

Code128 = Print this type of barcode on the non-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 non-graphical pick slip.

Note: This value is case-sensitive.

 

ORDER_BARCODE_IMAGE

Controls whether the system prints the order barcode on the non-graphical pick slip. The barcode is comprised of the company code, order number, and ship to number.

Code39 (default) = Prints this type of order barcode on the non-graphical pick slip.

Code128 = Prints this type of order barcode on the non-graphical pick slip.

NOT DISPLAYED = Do not print order barcode on the non-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 CWSerenade (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 programs PICKDB and PICK is DB.

PICKDBG and 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 CWSerenade (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 programs PICKDBG and PICKG is DB.

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: The SUPPRESS_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

Note: These settings also apply to your non-graphical custom pack slip. Each option is available only if your pack slip print program supports it.

Defines whether images print on the non-graphical Pack Slip.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical pack slip.

N = Print images on the non-graphical pack slip.

Y (default) = Suppress images on the non-graphical pack slip.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical pack slip.

PICKPACKG

 

PICKPACK,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical custom pack slip. This option is available only if your pack slip print program supports it.

Defines whether images print on the graphical Pack Slip.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical pack slip.

N (default) = Print images on the graphical pack slip.

Y = Suppress images on the graphical pack slip.

Note: The SUPPRESS_IMAGES value should be N for the graphical pack slip.

PICKUNIT

 

PICK_UNIT_REPORT

Controls whether certain information prints on the Pick Unit Report. Currently, there is no information to define.

PISCANERR

 

PI_SCAN_ERROR

Controls whether certain information prints on the Physical Inventory Scan Errors Report. Currently, there is no information to define.

PORCPRPT

 

PO_RECEIPTS_REPORT

Controls whether certain information prints on the PO Receipts Report. Currently, there is no information to define.

PORCPRPTCSV

 

PO_RECEIPTS_REPORT_CSV

Controls whether certain information prints on the PO Receipts Report in CSV spreadsheet format. 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 CSV 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 (Shipped 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV spreadsheet format. Currently, there is no information to define.

PURCHORD

 

PURCHORD,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical custom purchase order. This option is available only if your purchase order print program supports it.

Defines whether images print on the non-graphical Purchase Order.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical purchase order.

N = Print images on the non-graphical purchase order.

Y (default) = Suppress images on the non-graphical purchase order.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical purchase order.

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.

RCVWRKSHT167

=RCVWRKSHT167,PO_BARCODE_IMAGE=Code39,ITEM_SKU_BARCODE_IMAGE=Code39

RCVWRKSHT167=RCVWRKSHT167,PO_BARCODE_IMAGE=Code128,ITEM_SKU_BARCODE_IMAGE=Code128

Defines which type of barcode prints on the PO Receiving Worksheet (POR0167, POR0167BC) and whether the worksheet prints the PO barcode and the Item and SKU barcode.

PO_BARCODE_IMAGE

Controls whether the system prints the purchase order number barcode on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

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 the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

 

ITEM_SKU_BARCODE_IMAGE

Controls whether the system prints the item and sku barcode on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

• NOT DISPLAYED = Do not print the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

RCVWRKSHT740

=RCVWRKSHT740,PO_BARCODE_IMAGE=Code39,ITEM_SKU_BARCODE_IMAGE=Code39

RCVWRKSHT740=RCVWRKSHT740,PO_BARCODE_IMAGE=Code128,ITEM_SKU_BARCODE_IMAGE=Code128

Defines which type of barcode prints on the PO Receiving Worksheet (POR0740, POR0740BC), and whether the worksheet prints the PO barcode and/or the Item and SKU barcode.

PO_BARCODE_IMAGE

Controls whether the system prints the purchase order number barcode on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

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 the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

 

ITEM_SKU_BARCODE_IMAGE

Controls whether the system prints the item/sku code on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

• NOT DISPLAYED = Do not print the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

RCVWRKSHTSHC

 

RCVWRKSHTSHC,PO_BARCODE_IMAGE=Code128,ITEM_SKU_BARCODE_IMAGE=Code128

Defines which type of barcode prints on the PO Receiving Worksheet, and whether the worksheet prints the PO barcode and/or the Item and SKU barcode.

PO_BARCODE_IMAGE

Controls whether the system prints the purchase order number barcode on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

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 the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

 

ITEM_SKU_BARCODE_IMAGE

Controls whether the system prints the item/sku code on the PO receiving worksheet.

Code39 = print this type of barcode on the PO receiving worksheet.

Code128 = print this type of barcode on the PO receiving worksheet.

• NOT DISPLAYED = Do not print the barcode on the PO receiving worksheet.

Note: This value is case-sensitive.

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 CSV 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 CSV 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 CSV 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 CSV 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 CSV 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 CSV spreadsheet format. Currently, there is no information to define.

SLSJRNSUMOT

 

SALES_JOURNAL_SUMMARY_BY_ORDER_TYPE

Controls whether certain information prints on the Sales Journal Summary by Order Type. Currently, there is no information to define.

SLSJRNSUMOTCSV

 

SALES_JOURNAL_SUMMARY_BY_ORDER_TYPE_CSV

Controls whether certain information prints on the Sales Journal Summary by Order Type in CSV 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.

STMT

 

STATEMENT,SUPPRESS_IMAGES=Y

Note: These settings also apply to your non-graphical A/R statement. This option is available only if your A/R statement print program supports it.

Defines whether images print on the non-graphical A/R Statement.

SUPPRESS_IMAGES

Controls whether the system prints images on the non-graphical A/R statement.

N = Print images on the non-graphical A/R statement.

Y (default) = Suppress images on the non-graphical A/R statement.

Note: The SUPPRESS_IMAGES value should be Y for the non-graphical A/R statement.

STMTG

 

STATEMENT,SUPPRESS_IMAGES=N

Note: These settings also apply to your graphical A/R statement. This option is available only if your A/R statement print program supports it.

Defines whether images print on the graphical A/R Statement.

SUPPRESS_IMAGES

Controls whether the system prints images on the graphical A/R statement.

N = Print images on the graphical A/R statement.

Y (default) = Suppress images on the graphical A/R statement.

Note: The SUPPRESS_IMAGES value should be N for the graphical A/R statement.

STRCPRPT

 

STORE_TRANSFER_RECEIPTS

Controls whether certain information prints on the Store Transfer Receipt Report. Currently, there is no information to define.

STRCPRPTCSV

 

STORE_TRANSFER_RECEIPTS_CSV

Controls whether certain information prints on the Store Transfer Receipt Report in CSV spreadsheet format. 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.

TAXCREDCSV

 

TAX_CREDIT_REPORT_CSV

Controls whether certain information prints on the Tax Credit Report in CSV spreadsheet format. Currently, there is no information to define.

TAXCREDRPT

 

TAX_CREDIT_REPORT

Controls whether certain information prints on the Tax Credit Report. Currently, there is no information to define.

TAXEXCEPTION

 

TAX_EXCEPTION_REPORT

Controls whether certain information prints on the Tax Exception 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 CWSerenade Status report. Currently, there is no information to define.

Integration Property Settings

Property Name

Description

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.

Note:

• The directory entry must use a double forward slash.

• The name of the file must start with SR and have a .TXT file extension; for example: SR00001.txt and SR00002.txt.

The recommended directory on the CWSerenade application server is C://CWSerenade//Associate//, where C: is the root directory where CWSerenade is installed.

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.

CAV_USE_ASTERISK_IN_SALES_FEED_ITEM

Defines whether the system includes asterisks or spaces in the ItemID in the Relate Post POSlog Transaction Message sent to Relate.

If this property is Y, the system uses the following logic to populate the ItemID.

For non-SKUed items, the item number defaults.

For SKUed items, the item number + the first SKU element + the second SKU element + the third SKU element defaults, truncated to 14 positions with any trailing spaces changed to asterisks.

• The system truncates the first SKU element to 3 characters. If the first SKU element is shorter than 3 characters, the system replaces the code with asterisks.

• The system passes all 4 positions of the second SKU element. If the second SKU element is shorter than 4 positions, the system replaces the code with asterisks.

• The system truncates the third SKU element to 3 characters. If the third SKU element is shorter than 3 characters, the system replaces the code with asterisks.

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_ 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.

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.

CW_ADDRESS_SERVICE_ENDPOINT_URL

Verify the name of the server and port number where you have installed QAS Pro Web.

For example, if you have installed QAS Pro Web on SERVER1 and port 2021, the URL would be:

http://SERVER1:2021/

Note: The URL you enter here must match the URL defined for the ServerAddress setting in the Qawserve.ini File.

CW_ADDRESS_SERVICE_RETURN_LAYOUT

Information will be provided at a later date.

POSLog Property Settings

Defines the information required to transmit the POSLog file from CWSerenade via FTP for integration with a point-of-sale system. You use a periodic function to extract transaction information to a file named Store#123.POL, where 123 is the store number assigned in the Default Location for Sales Download (K69) system control value.

Required properties: If you use a unique POSLog integration, you must specify the following settings.

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 Sales Download (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 Sales Download (K69).

CW_FTP_POS_LOG_FILE

If set to Y, indicates to FTP the POSLog file using the poslog_ftp_commands.script, described below.

FTP script: The FTP script for POSLog integration is defined in the poslog_ftp_commands.script file. This file is located in the CWDIRECTCP_FTP_FOLDER specified in the CWDirectCP Server Properties 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.

CW_DELETE_POS_LOG_FILE_AFTER_FTP

If set to Y, indicates to delete the POSLog file after sending it by FTP.

CW_LIMITED_STATUS_BEG_TIME

Defines settings for the Daily Status Inquiry Time Window (all versions). These settings apply to retail pickup and ship-to-store 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 CWSerenade. These statuses apply to retail pickup or ship-to store 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 sending unnecessary status inquiry messages for orders in these statuses, 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:

• CW_LIMITED_STATUS_BEG_TIME=123456

• CW_LIMITED_STATUS_END_TIME=123456

Each time is indicated in HHMMSS format, military time. For example, if you set these properties to:

CW_LIMITED_STATUS_BEG_TIME=180000

CW_LIMITED_STATUS_END_TIME=210000

Then the BROKER process can send status inquiry requests for these orders between 6:00 p.m. and 9:00 p.m. daily. Orders are eligible for status inquiry if one 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.

CW_LIMITED_STATUS_END_TIME

CW_LOCATE_DISCOVERY_SERVICES_WSDL_LOCATION

Defines the endpoint for the location discovery web service, used to create new Store Cross Reference records in CWSerenade based on existing location records in Locate. This entry should be set to http://SERVER:8080/Locate/DiscoveryServices?WSDL, where SERVER is the name of your Locate server.

For more information: See Importing Store Cross Reference Locations through Locate’s Discovery Web Service.

For more information:

CW_LOCATE_MESSAGE_VERSION

Defines the message version to include in Order Broker and merchandise locator request messages that CWSerenade sends to Locate.

Set this property to 3.0 or 3.1 if you integrate with Locate version 3.0 or 3.1; otherwise, set this property to 5.0 or higher, based on the corresponding Locate version.

Required for status list request and streamlined allocation: 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 Locate Status Inquiry List Web Service (M05) and Use Streamlined Allocation (L63) for background.

Important: To avoid unpredictable results, do not leave this property blank.

CW_LOCATE_PURCHASING_SERVICES_MAX_INVOICES

Indicates the maximum number of drop ship invoices for Locate to include in invoice request responses. For example, you might set this number to 5 to prevent a large number of invoices from impeding system performance, since invoices can include a variable number of drop order shipments. If this number is blank, Locate does not limit the number of invoices in the response message.

CW_LOCATE_PURCHASING_SERVICES_MAX_UPDATES

Indicates the maximum number of drop ship updates for Locate 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, Locate does not limit the number of updates included in the response message.

CW_LOCATE_PURCHASING_SERVICES_MESSAGE_VERSION

Specifies the outbound message version to send to Locate for integration with the Supplier Direct Fulfillment module. Should be set to 4.5 or higher.

CW_LOCATE_PURCHASING_SERVICES_WSDL_LOCATION

Needs to specify the URL for the Locate drop ship (purchasing services) wsdl, such as http://server:8280/LOCATE/PurchasingServices?WSDL, where server is the name of your Locate server and LOCATE is the name of the Locate database and LOCATE is the account specified in the Locate Account (K49)system control value. Required if you are integrating with Locate’s Supplier Direct Fulfillment module.

CW_LOCATE_SERVICES_WSDL_LOCATION

Specify the URL for the Locate Order Broker wsdl, such as http://server:8280/Locate/LocateServices?WSDL, where server is the name of your Locate server and LOCATE is the account specified in the Locate Account (K49)system control value. This entry is required even if you are integrating with Locate’s Supplier Direct Fulfillment module but not the Order Broker module.

CW_MANIFST_ENVIRONMENT_ID

The environment ID that identifies the CWSerenade 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 CWSerenade database environment specified in the CW_MANIFEST_ENVIRONMENT_ID property.

Note: You must also create this user ID inCWSerenade:

• as a valid user ID with administrator authority in Work with Users (WUSR), and

• as a user with advanced commands and all job authority in User Control (creating a user control record is available by selecting Advanced Commands > User Control under My Docs, My Forms, or My Jobs).

See the User Configuration guide for more information on creating a user ID in CWSerenade.

Required.

CYB_PAY_LINK_DECISION_MANAGER_ENABLED

Defines whether Cybersource Decision Manager Fraud Scoring processing is enabled in the CWSerenade Point-to-Point integration with Cybersource.

false = the CWSerenade Point-to-Point integration with Cybersource does not support Decision Manager processing in Cybersource. CWSerenade 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 CWSerenade Point-to-Point integration with Cybersource supports Decision Manager processing in Cybersource. CWSerenade 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.

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

The password for the Cybersource user that has authority to retrieve Cybersource information for the Cybersource Decision Manager Update periodic function. See below for encryption steps.

Note: Password expiration can be controlled in Cybersource Decision Manager by setting the user to Report Download authority.

CYB_PAY_LINK_DECISION_MANAGER_SEND_TO_PRODUCTION

Defines whether transactions are sent to the Cybersource Decision Manager TEST server or PRODUCTION server.

true = CWSerenade sends transactions to the Cybersource Decision Manager PRODUCTION server.

false = CWSerenade sends transactions to the Cybersource Decision Manager TEST server.

CYB_PAY_LINK_DECISION_MANAGER_USER_ID

The user ID of the Cybersource user that has authority to retrieve Cybersource information for the Cybersource Decision Manager Update periodic function.

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 = CWSerenade writes request and response messages to the Cybersource log.

false = CWSerenade does not write request and response messages to the Cybersource log.

Data security: Set this value to false unless you are troubleshooting the CWSerenade integration with Cybersource. Once you are done troubleshooting, delete any log files that are created.

CYB_PAY_LINK_SERVICE_SEND_TO_PRODUCTION

Defines whether transactions are sent to the Cybersource TEST server or PRODUCTION server.

true = CWSerenade sends transactions to the Cybersource PRODUCTION server.

false = CWSerenade sends transactions to the Cybersource TEST server.

LOYALTY_REWARDS_ACCOUNT_INQUIRY_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

 

LOYALTY_REWARDS_CUSTOMER_ADD_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

LOYALTY_REWARDS_CUSTOMER_INQUIRY_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

LOYALTY_REWARDS_CUSTOMER_SEARCH_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

LOYALTY_REWARDS_REDEEM_CERTIFICATE_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

LOYALTY_REWARDS_VOID_CERTIFICATE_PROCESSING

Related to Rewards Customer Membership Program; not currently implemented.

LTD_PAY_LINK_SERVICE

The name of the external system. Set this to Litle.

LTD_PAY_LINK_SERVICE_BATCH_PORT

The port number used to connect to Litle using point-to-point communication.

LTD_PAY_LINK_SERVICE_IP_ADDRESS

The web address used to connect to Litle using point-to-point communication.

LTD_PAY_LINK_SERVICE_REMOTE_SOURCE_DIRECTORY

The directory on the Litle server where response transactions are placed to send to CWSerenade for processing. The directory is supplied by Litle and should not be changed unless specified by Litle.

outbound

LTD_PAY_LINK_SERVICE_REMOTE_TARGET_DIRECTORY

The directory on the Litle server where request transactions are placed for Litle to process. The directory is supplied by Litle and should not be changed unless specified by Litle.

inbound

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_FILE_NAME

Required. The name of the Mass Customer Download file. The delivered setting is MassCustomerDownload.

• During processing, CWSerenade adds the prefix TEMP to the name of the file; for example:

TEMP_MassCustomerDownload

• Once processing is complete, CWSerenade adds a date and time stamp to the file name; for example:

MassCustomerDownload.20110128.170150340

• CWSerenade also archives the file in zip format; for example:

MassCustomerDownload.20110128.170150340.zip

MASS_CUSTDWNLD_MESSAGE_WRAPPER

The XML root element name CWSerenade 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.

PMD_PAY_LINK_SERVICE

The name of the external system. Set this to Paymentech.

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.

PMD_PAY_LINK_SERVICE_BATCH_IP_ADDRESS

The IP address used to connect to Paymentech to process batch transactions.

PMD_PAY_LINK_SERVICE_BATCH_PORT

The port number used to connect to Paymentech to process batch transactions.

PMD_PAY_LINK_SERVICE_ONLINE_IP_ADDRESS

The IP address used to connect to Paymentech to process online transactions.

Note: If you change this setting you must stop and restart the PMD_ONLINE Integration Layer Job.

PMD_PAY_LINK_SERVICE_ONLINE_PORT

The port number used to connect to Paymentech to process online transactions.

PROXY_HOST

The IP address and port number used to connect to the proxy server during payment processing.

See Proxy Server Properties.

PROXY_PORT

RELATE_ALT_ID_POS

Not currently implemented.

RELATE_ALT_ID_SERENADE

Indicates the Alt Key Type of the alternate key in Relate that maps to the CWSerenade customer number.

Relate automatically creates this entry for a customer when you send the customer to Relate if it does not already exist. Also, Relates adds a row to the CST_ALT_KEY_TYPCODE table in the Relate database if it does not already exist.

An example of this setting is: RELATE_ALT_ID_SERENADE=SERENADE_ID

RELATE_ALT_ID_WEB

Indicates the Alt Key Type of the alternate key in Relate that maps to the ecommerce site’s customer number.

How to define in Relate? You can create a alternate key type such as EONE_USER_ID in Relate by:

• sending the Relate Add or Update Customer Message from your ecommerce system with an AlternateKey whose TypeCode is EONE_USER_ID

• adding a row to the CST_ALT_KEY_TYPCODE table in the Relate database

Note: See the Relate Customer Integration for information on how the ecommerce customer ID is used to identify the customer in the order API.

An example of this setting is: RELATE_ALT_ID_SERENADE=EONE_USER_ID

RELATE_CARD_SERVICE_SUFFIX

The system uses this property, along with the RELATE_CUSTOMER_SERVICE_PREFIX, to build the URL for communication with Relate using the Relate Card Services API.

Set this to /v2_1/CardServices?wsdl where 2_1 is the version of the Card Services API.

RELATE_CUSTOMER_ID_DIRECTORY_PATH

Defines the location on the CWSerenade application server where the RLTCSID Update Customer with Relate ID periodic function (program name PFRCIU) looks for the Relate query results comma separated value file (CSV) to process. See Relate Update Customer with Relate ID Process.

This setting must be a valid location on the CWSerenade application server; for example: C://CWSerenade//RelateData//customerId//

RELATE_CUSTOMER_SERVICE_PREFIX

The system uses this property to build the URL for communication with Relate during the Relate Customer Integration, Relate Loyalty Integration, Relate Purchase History Integration, and Relate Customer Wish List Integration.

Set this to http://relateserver:8084/ soap where:

relateserver = the name of your Relate server

8084 = the port to use on the Relate server

RELATE_CUSTOMER_SERVICE_SUFFIX

The system uses this property, along with the RELATE_CUSTOMER_SERVICE_PREFIX, to build the URL for communication with Relate using the Customer Services API.

Set this to /v2_3/CustomerServices?wsdl where 2_3 is the version of the Customer Services API.

RELATE_CUSTOMER_WITHOUT_RELATE_ID_DIRECTORY_PATH

Defines the location on the CWSerenade application server where the RLTNOID Report Customer with No Relate ID Report periodic function (program name PFRCNI) generates the Serenade Customers without Relate IDs report. See Relate CWSerenade Customer without Relate ID Report.

This setting must be a valid location on the CWSerenade application server; for example: C://CWSerenade//RelateData//customerWithoutRelateIdReports//

RELATE_DAY_PHONE_LABEL

Indicates the Telephone Type in Relate that maps to the daytime phone number in CWSerenade. Should be set to BUSINESS.

How to define in Relate? You can create a telephone type of BUSINESS in Relate by:

• sending the Relate 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 Relate database

An example of this setting is: RELATE_DAY_PHONE_LABEL=BUSINESS

RELATE_DIRECTORY_PATH

Defines the location where CWSerenade places the batch files to send to Relate.

If this setting is blank or an invalid path, the system writes a message to the CWSerenade Application Log: Relate Item Feed not run because the RELATE_DIRECTORY_PATH was not set up on this server.

See Working with Customer Properties (PROP).

Note: Not related to the Relate Customer Integration.

Important: MICROS recommends setting the RELATE_DIRECTORY_PATH to a location on the Relate application server and using the Relate Transfer Script to process the files. However, if the RELATE_DIRECTORY_PATH is a location on the CWSerenade application server, you will need to manually copy the batch files over to the Relate application server. To process the batch files immediately, place the files in the following location: C:\srv\relate-services-deploy\apache-tomcat\dtvclients\ORG\auto_fileset, where C: is the root drive where Relate is installed and ORG is the Relate organization descriptor.

This setting can be a location on the CWSerenade application server or the Relate application server.

CWSerenade application server example:

C://CWSerenade//RelateData// where:

CWSerenade = the name of the CWSerenade application server

RelateData = the name of the folder on the application server where the files to send to Relate are placed.

Relate application server example:

////relateoms//srv//CRMData//ORG// where:

relateoms = the name of the Relate application server.

CRMData = the name of the folder on the Relate application server where the batch files are placed.

ORG = the organization descriptor associated with the data in the batch file.

RELATE_EVE_PHONE_LABEL

Indicates the Telephone Type in Relate that maps to the evening phone number in CWSerenade.

How to define in Relate? You can create a telephone type of HOME in Relate by:

• sending the Relate 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 Relate database

An example of this setting is: RELATE_EVE_PHONE_LABEL=HOME

RELATE_FAX_PHONE_LABEL

Indicates the Telephone Type in Relate that maps to the third phone number in CWSerenade.

The Third Phone Number Type (L53) system control value controls whether the third phone number is labeled as the mobile or fax number in CWSerenade. Note: MICROS recommends the name entered in the Third Phone Number Type (L53) system control value match the value defined for the RELATE_FAX_PHONE_LABEL.

How to define in Relate? You can create a telephone type of FAX or MOBILE in Relate by:

• sending the Relate 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 Relate database

An example of this setting is: RELATE_FAX_PHONE_LABEL=MOBILE

RELATE_LOYALTY_AWARD_SERVICE_SUFFIX

The system uses this property, along with the RELATE_CUSTOMER_SERVICE_PREFIX, to build the URL for communication with Relate using the Relate Award Account Services API.

Set this to /v1_2/AwardAccountServices?wsdl where 1_2 is the version of the Award Account Services API.

RELATE_LOYALTY_PROMPT_ATTRIBUTE

Defines the corresponding Relate custom attribute to identify whether Serenade should automatically display the Customer Loyalty Registration Window for a customer that is not already assigned to a loyalty card.

See Relate PROMPT_TO_JOIN_LOYALTY Attribute Definition for setup instructions.

RELATE_LOYALTY_REG_MESSAGE

The text to display on the Customer Loyalty Registration Window, up to 55 positions.

RELATE_LOYALTY_SERVICE_SUFFIX

The system uses this property, along with the RELATE_CUSTOMER_SERVICE_PREFIX, to build the URL for communication with Relate using the Relate Loyalty Account Services API.

Set this to /v1_2/LoyaltyAccountServices?wsdl where 1_2 is the version of the Loyalty Account Services API.

RELATE_REWARDS_URL

The URL used to connect to the Rewards system. See Rewards Customer Membership Program.

RELATE_SECURITY_USER_ID

The Relate user ID with Security Group permission included in Relate’s API messages.

This setting must be a valid user ID in Relate that has Security Group permission.

RELATE_SVC_SERVICE_SUFFIX

The system uses this property, along with the RELATE_CUSTOMER_SERVICE_PREFIX, to build the URL for communication with Relate using the Relate Stored Value Card Transaction Services API.

Set this to /v1_1/SvcTransactionServices?­wsdl where 1_1 is the version of the Stored Value Card Transaction Services API.

RELIC_INI

The location on the CWSerenade application server where Relic is installed.

The recommended directory is C:/Serenade/CWSerenade/CWData/relic/relic.ini, where C is the root drive where CWSerenade is installed.

Note: Populating this property setting indicates that the Relic job is installed on the CWSerenade application server and runs immediately after the system completes an initial or incremental load.

Important: Leave this setting blank to indicate that the Relic job is installed on the CWData server and at defined intervals monitors the DW Common Reference table for the end-of-file record to trigger the transfer of records. See Running Relic as a Stand-Alone Application in the CWData Reference Guide for more information.

RELIC_LOG_DIRECTORY

The location on the CWSerenade application server where the Relic log files are stored.

The recommended directory is C:/Serenade/CWSerenade/CWData/relic/logs/, where C is the root drive where CWSerenade is installed.

Note: Enter a log directory only if you have installed Relic on the CWSerenade application server.

RLT_PAY_LINK_SERVICE

The name of the external system. Set this to RELATE. See Relate Stored Value Card Integration.

RLT_PAY_LINK_SERVICE_URL

The URL used to connect to the Relate system.

The delivered setting is the following; however, contact your MICROS representative to verify the correct path.

http\://relateoms\:8084/xmlapi/REL/

WMSKUBLOCKER_HOST

Defines the IP address used to connect to the external system that determines item eligibility for an order. See Second Compatibility Code used to Trigger SKU Blocking (K84) for more information.

Contact your MICROS representative for more information about creating a unique program to transmit SKU Blocking messages between CWSerenade and an external system.

WMSKUBLOCKER_PORT

Defines the port number used to connect to the external system that determines item eligibility for an order. See Second Compatibility Code used to Trigger SKU Blocking (K84) for more information.

Contact your MICROS representative for more information about creating a unique program to transmit SKU Blocking messages between CWSerenade and an external system.

XLINK_POSLOG_FILE_DATETIME

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.

XLINK_POSLOG_FILE_EXTENSION

XLINK_POSLOG_FILE_FORMAT

XLINK_POSLOG_FILE_PREFIX

XLINK_POSLOG_FILE_TRIGGER_EXTENSION

System Property Settings

Property Name

Description

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.

When you change password rules: Your new password rules take effect for new users the next time you reboot CWSerenade 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.

For more information: See the User Configuration guide for more information.

Note: These rules apply only to users who do not use LDAP authentication.

CWDIRECTCP_ALLOW_PASSWORD_REUSE

Defines whether a user is able to reuse previous passwords.

Y = users are able to reuse previous passwords.

N = the system saves a record of previously used passwords to prevent their reuse.

Example: Setting of

CWDIRECTCP_ALLOW_PASSWORD_REUSE=N

User cannot specify a password that has already been used.

CWDIRECTCP_MAXIMUM_PASSWORD_LENGTH

Indicates the maximum number of positions allowed in a user’s password. Leave this setting blank if there is no maximum.

Example: Setting of

CWDIRECTCP_MAXIMUM_PASSWORD_LENGTH=12

Password must be no longer than 12 positions

Swordfish9999 = invalid password

Swordfish999 = valid password

CWDIRECTCP_MINIMUM_PASSWORD_LENGTH

Indicates the minimum number of positions required for a user’s password. Leave this setting blank if there is no minimum.

Example: Setting of

CWDIRECTCP_MINIMUM_PASSWORD_LENGTH=6

Passwords must be six characters or longer

sword = invalid password

swordfish = valid password

CWDIRECTCP_PASSWORD_EXPIRATION_DAYS

Indicates the number of days after which a user’s password expires.

*NO = you do not want user passwords to expire automatically.

Example: Setting of

CWDIRECTCP_PASSWORD_EXPIRATION_DAYS=30

When a user changes his or her password, the Password Expired date is reset to 30 days after the current date. For example, if a user changes her password on June 30, the Password Expired date is reset to July 30. The next time the user logs in after July 30, she will need to change her password.

CWDIRECTCP_REQUIRE_DIGIT_IN_PASSWORD

Indicates if a numeral is required in a user’s password.

Y = a numeral is required.

N or blank = a numeral is not required.

Example: Setting of

CWDIRECTCP_REQUIRE_DIGIT_IN_PASSWORD=Y

Password must include a numeral

swordfish = invalid password

swordfish9 = valid password

CWDIRECTCP_REQUIRE_SPECIAL_CHAR_IN_PASSWORD

Defines whether a special character is required in a user’s password.

Y = a special character is required.

N or blank = a special character is not required.

Special characters are: !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~.

Example: Setting of

CWDIRECTCP_REQUIRE_SPECIAL_CHAR_IN_PASSWORD=Y

Password must include a special character

Swordfish999 = invalid password

Swordfish99! = valid password

CWDIRECTCP_REQUIRE_UPPERCASE_CHAR_IN_PASSWORD

Defines whether an uppercase (capital) letter is required in a user’s password.

Y = an uppercase (capital) letter is required.

N or blank = an uppercase letter is not required.

Example: Setting of

CWDIRECTCP_REQUIRE_UPPERCASE_CHAR_IN_PASSWORD=N

Password must include an uppercase (capital) letter

swordfish9 = invalid password

Swordfish9 = valid password

Link Settings

The CWDIRECTCP_LINK_TEXT and CWDIRECTCP_LINK_URL settings allow you to add a link to all screens in CWSerenade (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 website.

CWDIRECTCP_LINK_TEXT

Defines the text to display on the CWSerenade 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 CWSerenade 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 website.

If you are Using Multiple Application Servers

If you are using multiple application servers, you will need to update this setting on each server.

Additional Settings

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 CWSerenade 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 CWSerenade 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 Working with File Uploads (WUPL) for more information.

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 CWSerenade, 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 (but not the properties.properties files). These files are located in the QPRINT folder in C:\serenade\CWSerenade\serverconfig\outputqueues, provided the config.dir setting in the Jenasys Properties Files is set to C:\CWSerenade.

• job logs, typically located at C:\Serenade\server\log\jobs, where C: is the default drive of your server.

• entries in the dbo.Jenasysjob table. This table is used to track submitted jobs.

If you do not define the retention days, CWSerenade 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, CWSerenade creates a text file logging that activity for the date when you viewed the PDF.

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.KBOTTGER.20090804.103001456_001.PDF and PICKG.KBOTTGER.20090804.103001456_002.PDF, where PICKG is the name of the print program, KBOTTGER 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.

Delivered setting: The delivered value is 250 picks. The system also uses 250 as the default value if this setting is blank or missing. MICROS recommends setting this value to 250.

 

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 CWSerenade (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.

 

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.KBOTTGER.20090804.103000123_001.PDF)

300 pick slips for warehouse 1, ship via priority 5 (PICKG.KBOTTGER.20090804.103001456_001.PDF)

510 pick slips for warehouse 1, ship via priority 9 (PICKG.KBOTTGER.20090804.103003789_001.PDF)

75 pick slips for warehouse 2, ship via priority 1 (PICKG.KBOTTGER.20090804.103006912_001.PDF)

225 pick slips for warehouse 2, ship via priority 5 (PICKG.KBOTTGER.20090804.103007134_001.PDF)

25 pick slips for warehouse 2, ship via priority 9 (PICKG.KBOTTGER.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.KBOTTGER.20090804.103000123_001.PDF)

250 pick slips for warehouse 1, ship via priority 5 (PICKG.KBOTTGER.20090804.103001456_001.PDF)

50 pick slips for warehouse 1, ship via priority 5 (PICKG.KBOTTGER.20090804.103001456_002.PDF)

250 pick slips for warehouse 1, ship via priority 9 (PICKG.KBOTTGER.20090804.103003789_001.PDF)

250 pick slips for warehouse 1, ship via priority 9 (PICKG.KBOTTGER.20090804.103003789_002.PDF)

10 pick slips for warehouse 1, ship via priority 9 (PICKG.KBOTTGER.20090804.103003789_003.PDF)

75 pick slips for warehouse 2, ship via priority 1 (PICKG.KBOTTGER.20090804.103006912_001.PDF)

225 pick slips for warehouse 2, ship via priority 5 (PICKG.KBOTTGER.20090804.103007134_001.PDF)

25 pick slips for warehouse 2, ship via priority 9 (PICKG.KBOTTGER.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.

properties file summary OROMS 5.0 2018 OTN