Working with Admin Properties (CPRP)

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

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

In this topic:

Work with Admin Properties Screen

Change Property Screen

Summary of Admin Properties

Email Property Settings

Logging Property Settings

Monitor Property Settings

Printing Property Settings

System Property Settings

Work with Admin Properties Screen

Use this screen to define property settings that are available to an administrator.

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

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

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

Field

Description

Group

The type of property setting. Valid values are:

Email: The property setting is related to email processing.

Logging: The property setting is related to logging.

Monitor: The property setting is related to job monitoring.

Printing: The property setting is related to printing.

System: The property setting is related to a system-wide function.

Enter a full or partial group name to display property settings that contain your entry.

Alphanumeric, 25 positions; optional.

Property

The name of the property.

Enter a full or partial property name to display property settings that contain your entry.

Alphanumeric, 75 positions; optional.

Value

The current setting of the property. If this field is blank, it means a property setting has not been defined.

Enter a full or partial property value to display property settings that contain your entry.

Alphanumeric, 150 positions; optional.

Type

The type of property setting. Valid values are:

Admin = The property setting is a setting available to an administrator.

Customer = The property setting is a setting available to an administrator and 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.

Switch between viewing admin property settings and customer property settings

Select Admin/Customer.

• If you are currently on the Work with Admin Properties screen, the system advances you to the Work with Properties Screen.

• If you are currently on the Work with Properties screen, the system advances you to the Work with Admin Properties Screen.

Change Property Screen

Purpose: Use this screen to change a property setting.

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

Field

Description

Property

The name of the property whose value you wish to update.

Alphanumeric, 75 positions; display-only.

Group

The group assigned to the property.

Alphanumeric, 25 positions; display-only.

Type

The type of property setting. Valid values are:

Admin = The property setting is a setting available to the administrator.

Customer = The property setting is a setting available to the administrator and customer.

Alphanumeric, 10 positions; display-only.

Display

Defines whether you can update the property setting. Valid values are:

C = You can change the value defined for the property.

D = The value defined for the property is display-only.

Alphanumeric, 1 position; display-only.

Value

The current setting of the property. If this field is blank, it means a property setting has not been defined.

Note: The system does not validate your entry.

Alphanumeric, 150 positions; optional.

Summary of Administrator Properties

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

Email Property Settings

Logging Property Settings

Monitor Property Settings

Printing Property Settings

System Property Settings

Email Property Settings

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

Property Name

Description

CWEmailOutQueueName

The output queue to use for emails. Output queues are displayed when you select the My Jobs option in CWSerenade, where you can use them for filtering purposes.

The default output queue is EMAIL.

mail.debug

Indicates whether to log error messages about email generation in the CWDirect Log.

true = Log error messages about email generation in the log.

false = Do not log error messages about email generation in the log.

mail.from

The default “from” email address to use for system-generated emails if there is no address specified at the entity or company level. See “From” Email Address for a discussion.

mail.host

The name or IP address of the mail server. The mail server must be accessible by the CWSerenade application server.

mail.password

The current password for the user ID. Required if the mail server requires authentication.

Note: The password is encrypted so it is not readable in this file.

mail.user

A valid user ID with authority to log into the mail server. Required if the mail server requires authentication.

SUPPORT_EMAILS

The list of email addresses to receive the Serenade Support Notification email when a job is placed in MSG status because an error has occurred, or System Alert email for other errors such as inconsistent system control value setup across companies. Separate each email address with a semi-colon (;), such as: email1@add.com;email2@add.com.

Note: You cannot enter an email distribution list in this field. However, you can use an email program, such as Microsoft Outlook®, to create rules to send emails to a distribution list.

See CWSerenade Support Notifications for more information on error email processing.

Logging Property Settings

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

Property Name

Description

ALERT_LOG_LEVEL

Defines the level of detail to include in the Alert Log. See Logging Level.

ALERT_MAXBACKUP_DAYS

The number of days to store a backup copy of the Alert Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

APP_LOG_LEVEL

Defines the level of detail to include in the Application Log. See Logging Level.

APP_MAXBACKUP_DAYS

The number of days to store a backup copy of the Application Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

CUST_LOG_LEVEL

Defines the level of detail to include in the Customer API Log. See Logging Level.

CUST_MAXBACKUP_DAYS

The number of days to store a backup copy of the Customer API Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

CW_LOG_BACKUP_PATTERN

The file extension added to backup copies of the log file.

The system creates a backup copy of the log file for each day, using the date format from the CW_LOG_DATE_PATTERN setting and file extension from the CW_LOG_BACKUP_PATTERN setting.

For example, for the APP.log file, the system names the backup copy APP.YYYY-DD-MM.log.zip.

The delivered setting is .zip.

Note: The file extension must be lower case.

CW_LOG_DATAQ

Defines whether the system includes messages written to data queues in the log.

Valid values:

true = The system includes messages written to data queues in the log.

false = The system does not include messages written to data queues in the log.

CW_LOG_DATE_PATTERN

The date format for backup copies of the log file.

The system creates a backup copy of the log file for each day, using the date format from the CW_LOG_DATE_PATTERN setting and file extension from the CW_LOG_BACKUP_PATTERN setting.

For example, for the APP.log file, the system names the backup copy APP.YYYY-DD-MM.log.zip.

The delivered setting is .%d{yyyy-MM-dd}.log.

CW_LOG_PATTERN

The format used when naming a log file. The delivered setting is %d{HH:mm:ss,SSS} %-5p %-5c - %m%n.

INTEGRATIONORDER_LOG_LEVEL

Defines the level of detail to include in the IntegrationOrder (ChannelAdvisor) Log. See Logging Level.

INTEGRATIONORDER_MAXBACKUP_DAYS

The number of days to store a backup copy of the IntegrationOrder (ChannelAdvisor) Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

JOB_LOG_LEVEL

Defines the level of detail to include in the Job Log. See Logging Level.

JOB_MAXBACKUP_DAYS

The number of days to store a backup copy of the Job Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

LOCATE_LOG_LEVEL

Defines the level of detail to include in the Locate Log. See Logging Level.

LOCATE_MAXBACKUP_DAYS

The number of days to store a backup copy of the Locate Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

LOG_RETENTION_DAYS

The number of days to store the CWDirect Log before it is eligible for deletion. Each time you restart CWSerenade, it deletes archived copies of the CWDirect log that are older than the number of days indicated here. If you do not specify the number of retention days, logs are eligible for deletion after 30 days.

Note: The log deletion uses both the date and the time in determining whether to purge a log. For example, the current time is 7:00 a.m. and the LOG_RETENTION_DAYS is set to 30. If the log 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.

MANIFEST_LOG_LEVEL

Defines the level of detail to include in the Manifest Log. See Logging Level.

MANIFEST_MAXBACKUP_DAYS

The number of days to store a backup copy of the Manifest Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

MQ_LOG_LEVEL

Defines the level of detail to include in the MQ Message Log. See Logging Level.

MQ_MAXBACKUP_DAYS

The number of days to store a backup copy of the MQ Message Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

ORDER_LOG_LEVEL

Defines the level of detail to include in the Order Log. See Logging Level.

ORDER_MAXBACKUP_DAYS

The number of days to store a backup copy of the Order Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

PAYPAL_LOG_LEVEL

Defines the level of detail to include in the PayPal Log. See Logging Level.

PAYPAL_MAXBACKUP_DAYS

The number of days to store a backup copy of the PayPal Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

PROMOTE_LOG_LEVEL

Defines the level of detail to include in the Promote Log. See Logging Level.

PROMOTE_MAXBACKUP_DAYS

The number of days to store a backup copy of the Promote Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

RELATE_LOG_LEVEL

Defines the level of detail to include in the Relate (Loyalty) Log. See Logging Level.

RELATE_MAXBACKUP_DAYS

The number of days to store a backup copy of the Relate (Loyalty) Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

RESP_LOG_LEVEL

Defines the level of detail to include in the Response Log.

Valid values are:

DEBUG = Generates fine-grained informational events.

INFO = Generates informational messages.

WARN = Generates warning messages.

ERROR = Generates messages that indicate a serious issue.

FATAL = Only generates messages that will cause the application to abort.

The delivered logging level is INFO.

RESP_MAXBACKUP_DAYS

The number of days to store a backup copy of the Response Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

TRACE_LOG_LEVEL

Defines the level of detail to include in the Trace Log. See Logging Level.

TRACE_MAXBACKUP_DAYS

The number of days to store a backup copy of the Trace Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

UEP_LOG_LEVEL

Defines the level of detail to include in the User Exit Point Log. See Logging Level.

UEP_MAXBACKUP_DAYS

The number of days to store a backup copy of the User Exit Point Log before deleting it. See Archived Logs.

To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Monitor Property Settings

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

For more information: See:

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

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

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

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

Property Name

Description

ACTIVE_PROCEDURES

Used to filter data on the Managed Services report.

ALERT_EMAILS

The email addresses that receive Managed Services reports. Separate email addresses with a semi-colon.

ALLOW_JOB_MONITOR

Indicates whether the job monitor runs on this application server.

Valid values:

Y = The job monitor runs on this server.

N (default) or blank = The job monitor does not run on this server. In this situation, the only option on the Work with Job Monitor Rules Screen is to display a rule’s settings.

Note: Set this value to Y for all application servers that you wish to collect data on the Work with Job Monitor Screen (WJMO).

CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT

Required; must be numeric. Indicates how long, in minutes, a job must be running before the system sends a Long Running Job Email to the email address defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_TO_ EMAIL_ADDRESS.

Note: The system applies this time to all batch jobs not included in the CWDIRECTCP_LR_JOB_MONITOR_EXCLUDE_JOBS list or the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE list.

The default setting is 30 minutes.

CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE

Optional. A list of batch jobs that the Long Running Jobs Monitor watches using a time other than the default time defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT setting.

The format for this setting is BATCH_JOB_NAME,99, where BATCH_JOB_NAME is the name of the batch job, and 99 is how long, in minutes, the job must run before the system sends a Long Running Job Email.

Separate each batch job name and its time with a comma; for example: BATCH_JOB_NAME1,120,BATCH_JOB_NAME2,30.

Example: The default time is 60 minutes, indicating a job must be running for 60 minutes before the system sends a Long Running Job email. However, the PICK_GEN job runs longer than 60 minutes on a regular basis and you don’t want to be notified about this job unless it runs longer than 120 minutes. In this situation, enter PICK_GEN,120.

The default setting is blank.

CWDIRECTCP_LR_JOB_MONITOR_ALERT_FROM_EMAIL_ADDRESS

Required. The “from” email address for the Long Running Job Email.

CWDIRECTCP_LR_JOB_MONITOR_ALERT_TO_EMAIL_ADDRESS

Required. The list of email addresses that receive the Long Running Job Email when a job requires user evaluation. Each email address entered must be separated by a semi-colon (;).

For example: email1@add.com;email2@add.com.

CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER

Optional. Allows changes to the Monitor Properties file without having to stop and restart the SERENADE service (or the application server). See Applying Changes to the Monitor Properties for instructions.

RELOAD = The next time the Long Running Jobs Monitor wakes up, reload the settings in the Monitor Properties file and restart the Long Running Jobs Monitor to use the new settings.

EXIT = Stop the Long Running Jobs Monitor and do not send alerts until the SERENADE service (or the application server) is stopped and restarted. When you stop and restart the SERENADE service (or the application server), the new settings will take effect.

RUN or any other value, including blank = Run the Long Running Jobs monitor using the current settings.

Important: If you make a change to the properties file and change this setting to RELOAD or EXIT, after your change takes effect, make sure you change this setting back to RUN, blank, or any other value other than RELOAD or EXIT.

The default setting is blank.

CWDIRECTCP_LR_JOB_MONITOR_EXCLUDE_JOBS

Optional. A list of batch jobs excluded from the Long Running Jobs Monitor evaluation. Typically, these are jobs that run all day, such as the Async, ECommerce, and Drop Ship Integration jobs, or jobs that do not require a Long Running Job Email if they run too long.

Separate each job in the list with a comma. For example:

IX_CDC,CNTL_ASYNC,ORDR_ASYNC,OTHR_ASYNC,BILL_ASYNC.

The default setting is

IX_CDC,CNTL_ASYNC,ORDR_ASYNC,OTHR_ASYNC,BILL_ASYNC,EBO_ASYNC,EC_STS_INQ,EC_RETURNS,EC_CANCELS,EC_CLEANUP,EC_CAT_REQ.

Note: If you enter a batch job name here and the job is also defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE setting, the system considers the job an override and it is not excluded from the Long Running Jobs monitor.

CWDIRECTCP_LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES

Required; must be numeric. Indicates how many times the Long Running Jobs Monitor must find the same running batch job before sending another Long Running Job Email.

Example: The Long Running Jobs Monitor configuration is as follows:

LR_JOB_MONITOR_RUNS_EVERY_X_MINUTES = 15

LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES = 5

If the PICK_GEN job runs longer than 15 minutes, the system sends a Long Running Job email. The system will not send another Long Running Job email unless the PICK_GEN job is still running after an additional 75 minutes (15 minutes x 5 cycles = 75).

CWDIRECTCP_LR_JOB_MONITOR_RUNS_EVERY_X_MINUTES

Required; must be numeric. How often, in minutes, the Long Running Jobs Monitor wakes up and looks at the running batch jobs on the Job Management Screen to determine if a job has been running longer than the number of minutes defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT setting.

The default setting is 15 minutes.

INTEGRATION_PROCESS

Used to filter data on the Managed Services report.

JOB_HISTORY_PURGE_DAYS

Defines how long to retain a batch job in the Job History table before the system purges it automatically based on the job’s End date. The default setting is 30 days.

The system submits the Job History purge process each time you start the application server. Job History records that do not have an End Date (indicating the job did not end) are not purged.

See Display Job History (DJHY) for more information.

REPORT_TYPE

Indicates the format of the Managed Services report.

.pdf = Generate the Managed Services report in .pdf portable document format.

.rtf = Generate the Managed Services report in .rtf rich text format.

.txt = Generate the Managed Services report in .txt text format.

RESPONSE_EMAILS

The list of email addresses that receive the Response Required Email when a job requires user intervention. Each email address entered must be separated by a semi-colon (;).

For example: email1@add.com;email2@add.com.

RESPONSE_RETRIES

The number of times CWSerenade looks for a response to a job that requires user intervention before using the default response in order to proceed with the job.

For example, if this setting is 5, CWSerenade will look for a user response five times, waiting 60 seconds between each time. See Working with Required Responses (WREQ).

STARTUP_COMPANY_TO_RUN_PERIODIC_PROCESS

The company number used to run a periodic function that requires a company to be defined.

If none of the periodic functions require a company number, enter your default company number or 1.

Valid values are 1-999. The system does not validate that your entry is a valid company number.

Required if a periodic process is defined in the STARTUP_PERIODIC_PROCESS_TO_RUN setting.

STARTUP_NBR_MINUTES_TO_WAIT_BEFORE_RUNNING_PERIODIC_PROCESS

The number of minutes after system startup that the periodic process should be scheduled to start.

This time allows CWSerenade to start up completely before running the periodic process.

Valid values are 1-999 minutes.

The delivered setting is 5 minutes.

Required if a periodic process is defined in the STARTUP_PERIODIC_PROCESS_TO_RUN setting.

STARTUP_PERIODIC_PROCESS_TO_RUN

The name of the periodic process to run when you restart the SERENADE service or CWSerenade application server.

The process you enter must be a valid periodic process with assigned periodic functions. See Working with Periodic Processes (WPPR) for more information on creating a periodic process and how to assign periodic functions to it.

Important: In order to run this periodic process at server startup, the CWDIRECTCP_ALLOW_SCHEDULING_ON_THIS_SERVER property must be set to Y on the application server. See How to Schedule a Job for more information.

STARTUP_USER_TO_RUN_PERIODIC_PROCESS

The user ID to run the periodic process; enter the user ID in all caps, for example JSMITH and not jsmith. This is the user ID that displays on the Scheduled Jobs Screen for the periodic process; any jobs submitted for the periodic process are also assigned to this user ID.

This must be a valid user ID in the User table.

Required if a periodic process is defined in the STARTUP_PERIODIC_PROCESS_TO_RUN setting.

SUBJECT_LINE

The text that displays in a Managed Services email.

SUPPRESS_EMAIL

Defines whether a Managed Services email is generated.

Y = Do no generate Managed Services emails.

N = Generate Managed Services emails.

TRACK_ALERT_EMAILS_IN_FOLDER

The directory on the application server where the system stores a copy of the alert emails generated by the job monitor.

This directory is not delivered; the recommended location is C:\\CWSerenade\\JobMonitorEmails\\.

Each alert email is stored in this directory using the following naming convention: ALERT_JOBNAME_RULENAME_DDMMYY_HHMMSS.txt, where:

JOBNAME is job monitor name

RULENAME is the job monitor rule name

DDMMYY is the date the email alert was sent

HHMMSS is the time the email alert was sent

Example: ALERT_BILL_ASYNC_BILLASYNCACTIVE_032713_083000 indicates the email alert was generated for the BILL_ASYNC job monitor and BILLASYNCACTIVE job monitor rule on March 27 at 8:30.

Note: The system does not save an alert email in this directory if the job monitor rule name contains any special characters.

TRACK_ALERTS_IN_LOG

Indicates whether you log all alerts generated by the job monitor.

Valid values:

Y = Log all alerts generated by the job monitor in the Alert Log.

N or blank = Do not log alerts generated by the job monitor.

Printing Property Settings

The settings below are used to print labels, forms, and reports.

• See RF Printer for more information on printing RF labels.

• See Printing Price Tags for more information on printing price tags.

Property Name

Description

BIN_PTR

The Printer IP Address of the printer used to print the RF Bin Location Label. See RF Bin Label Setup for more information on the setup required to print this label.

CAR_PTR

The Printer IP Address of the printer used to print the RF Carton Label. See RF Carton Label Setup for more information on the setup required to print this label.

ITEM_PTR

The Printer IP Address of the printer used to print the RF Item Label. See RF Item Label Setup for more information on the setup required to print this label.

LPN_PTR

The Printer IP Address of the printer used to print the RF LPN Label. See RF LPN Label Setup for more information on the setup required to print this label.

MONARCH_PTR_TYPE

Enter the type of Monarch printer used to print price tags.

The recommended Monarch printer type is MON_9855. See Printing Price Tags.

PADDL_PTR

The Printer IP Address of the printer used to print additional pick control labels. See Addl Pick Label Printer ID (L66) for more information on the setup required to print this label.

PPITM_PTR

The Printer IP Address of the printer used to print the Pick Pack Item Label. See Printer for Pick/Pack Item Labels (K47) for more information on the setup required to print this label.

PRINTER_CONNECTION

WIN = The RF printer is set up as a Windows Print Service; see Setting Up the RF Printer Using Windows Print Service. You must complete the Window Service - Printer Names property settings.

TCP = The RF printer is set up with a TCP/IP socket connection. You must complete the Printer IP Address settings.

If you change the PRINTER_CONNECTION setting: Check the label printer settings defined for each user on the Work with User Label Printers Screen and the associated system control values to make sure the label printer defined is a valid printer based on the printer connection setting.

Important: If you print a high volume of labels at a time, MICROS recommends you set up the RF printer as a Windows Print Service.

RET_PTR

The Printer IP Address of the printer used to print the RF Return Label. See RF Return Label Setup for more information on the setup required to print this label.

RTN_PTR

Information will be provided at a later date.

STOCK_PTR_TYPE

Enter the type of Zebra printer used to print labels.

The delivered Zebra printer type is TLP_2844. A Zebra printer is required to print RF labels; see RF Printer.

TIME_DELAY

The number of seconds to wait between each print job. Use this delay to prevent the RF printer from skipping labels; this may occur if you have set up your RF printer to use a TCP/IP socket connection (the PRINTER_CONNECTION setting is set to TCP). The default time delay is 2 seconds (2000).

WBIN_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the RF Bin Location Label.

Enter the name of the server and the name of the RF printer in the following format:

WBIN_PTR=\\\\server_name\\RFPrinter_name

See RF Bin Label Setup for more information on the setup required to print this label.

WCAR_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the RF Carton Label.

Enter the name of the server and the name of the RF printer in the following format:

WCAR_PTR=\\\\server_name\\RFPrinter_name

See RF Carton Label Setup for more information on the setup required to print this label.

WITM_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the RF Item Label.

Enter the name of the server and the name of the RF printer in the following format:

WITM_PTR=\\\\server_name\\RFPrinter_name

See RF Item Label Setup for more information on the setup required to print this label.

WLPN_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the RF LPN Label.

Enter the name of the server and the name of the RF printer in the following format:

WLPN_PTR=\\\\server_name\\RFPrinter_name

See RF LPN Label Setup for more information on the setup required to print this label.

WMON_PTR

The name of the server where the Monarch Print Driver is installed and the name of the Monarch printer used to print the price tag label.

Enter the name of the server and the name of the Monarch printer in the following format:

WMON01_PTR=\\\\server_name\\Monarch_printer_name

WPADDL_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the additional pick control label.

Enter the name of the server and the name of the RF printer in the following format:

WPADDL_PTR=\\\\cwdevtest\\TLP2844

See Addl Pick Label Printer ID (L66) for more information on the setup required to print this label.

WPPITM_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the Pick/Pack Item Label.

Enter the name of the server and the name of the RF printer in the following format:

WPPITM_PTR=\\\\server_name\\RFPrinter_name

See Printer for Pick/Pack Item Labels (K47) for more information on the setup required to print this label.

WPTW_PTR

The name of the server where the Print Driver is installed and the name of the printer used to print the price ticket.

Enter the name of the server and the name of the Monarch printer in the following format:

WPTW_PTR=\\\\server_name\\TicketPrinter_name

WRET_PTR

The name of the server where the Zebra Print Driver is installed and the name of the RF printer used to print the RF Return Label.

Enter the name of the server and the name of the RF printer in the following format:

WRET_PTR=\\\\server_name\\RFPrinter_name

See RF Return Label Setup for more information on the setup required to print this label.

System Property Settings

The settings below define configuration settings for the CWSerenade application server.

Property Name

Description

CHECK_AUTHS_IN_PICKS

Defines whether you can process Streamlined Pick Slip Generation (WSPS) when records exist for your company in the CC Authorization Transaction table. Valid values are:

Y or this setting does not exist = Before processing Streamlined Pick Slip Generation (WSPS), the system first looks for records in the CC Authorization Transaction table for the company for which you are generating pick slips. If records exist in the CC Authorization Transaction table, the system does not continue with pick slip generation and instead generates a Pick Authorization Error Report and a Serenade Support Notification. Review the records in the CC Authorization Transaction table to determine if you need to use the Reprocess Authorizations Screen (RPAA) to reprocess authorizations and clear the records from the CC Authorization Transaction table.

N = The system allows you to run Streamlined Pick Slip Generation (WSPS) when records exist for your company in the CC Authorization Transaction table. Any records in the CC Authorization Transaction table will be resent for authorization.

See Pick Slip Generation Overview.

COMPARE_AND_DELETE_PURGE_DAYS

Defines how long to retain records in the Deleted Order table and E-Commerce Order Comparison table based on the Date deleted for the Deleted Order record and the Date processed for the E-Commerce Order Comparison record.

When you restart the CWSerenade application server, the system purges records older than the number of days defined in the property. If you do not define a number of days in the COMPARE_AND_DELETE_PURGE_DAYS property, the system purges records once they are 30 days old.

See Running the E-Commerce Order Comparison Program for more information on these two tables.

CW_JDBC_PROVIDER

• If you use IBM WebSphere MQ to communicate with other applications, set this property to openejb:Resource/CWDirectCPDS.

• If you use HornetQ to communicate with other applications, set this property to java:/CWDirectCPDS.

CW_SECURITY_LEVEL

Information will be provided at a later date.

CWDIRECTCP_APPLICATION_SERVER_LOG_DIR_PROPERTY

Information will be provided at a later date.

CWDIRECTCP_FTP_FOLDER_SEPARATOR

Defines the separator used in FTP commands that specify a directory on the remote server. For example, the separator \\ is compatible in a Windows environment and the separator // is compatible in a Unix environment.

If this setting is blank, the default used by the system is \\.

CWDIRECTCP_MAX_THREAD_POOL

Information will be provided at a later date.

CWDIRECTCP_ORDERIN_USERID

Information will be provided at a later date.

CWDIRECTCP_RETAIN_REPORT_XML

Defines whether to retain the XML file for each generated form. Retaining the XML files is useful for troubleshooting form contents, especially when implementing a new type of form; however, disk space can be a consideration if you are retaining many XML files.

Y = The system retains the XML file for each generated form. Use this setting when you are initially testing a form and for troubleshooting purposes.

N = The system does not retain the XML file for each generated form. Use this setting once you are done testing and troubleshooting a form in order to improve performance.

See Forms Management (My Forms) for more information on forms.

CWDIRECTCP_VERSION

The version, or build number, of CWSerenade that the system is currently running. This number displays on the About Application Screen.

CWDIRECTCP_WMS_USERID

Not currently implemented.

CWMQ_JNDI_INITIAL_CONTEXT_FACTORY

• If you use IBM WebSphere MQ to communicate with other applications, set this property to org.apache.openejb.client.LocalInitialContextFactory.

• If you use HornetQ to communicate with other applications, set this property to org.jnp.interfaces.NamingContextFactory.

CWMQ_JNDI_LOOKUP_NAME

• If you use IBM WebSphere MQ to communicate with other applications, set this property to java:/comp/env/.

• If you use HornetQ to communicate with other applications, set this property to /.

CWMQ_JNDI_PROVIDER_URL

• If you use IBM WebSphere MQ to communicate with other applications, set this property to jnp://localhost:1099.

• If you use HornetQ to communicate with other applications, set this property to jnp://ServerName:1199, where ServerName is the name of the server where HornetQ is installed.

CWMQ_TARGET_CLIENT

• If you use IBM WebSphere MQ to communicate with other applications, set this property to 1.

• If you use HornetQ to communicate with other applications, set this property to 0.

CWMQ_WAIT_TIME

• If you use IBM WebSphere MQ to communicate with other applications, set this property to -1.

• If you use HornetQ to communicate with other applications, set this property to 0.

END_ORDERIN_IJCT_ON_CONNECTION_ERROR

Indicates the action to take when the order API generates an Invalid XML error response, since this error can indicate a database connection problem. If this property is set to Y, when the order API generates an Invalid XML error response, it attempts to verify the database connection. If the attempt is unsuccessful, the system ends the ORDER_IN job and sends a support notification. Otherwise, if this property is set to N or blank or does not exist, the order API continues trying to process order messages in the event of an Invalid XML error response.

GWT_RESOURCE_URI

• When TLS communication is turn on, set this property to https://localhost:8443/SerenadeSeam/srs.

• When TLS communication is turned off, set this property to https://localhost:8080/SerenadeSeam/srs.

See Configuring CWSerenade for TLS.

SERENADE_DATA_ACCESS_PATH

Information will be provided at a later date.

CPRP OROMS 5.0 2018 OTN