Sterling Selling and Fulfillment Foundation



Properties Guide
Release 9.1.0.8
Sterling Selling and Fulfillment Foundation



Properties Guide
Release 9.1.0.8
 Note
Before using this information and the product it supports, read the information in “Notices” on page 77.

Copyright
This edition applies to the 9.1 Version of IBM Sterling Selling and Fulfillment Foundation and to all subsequent
releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 1999, 2014.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. Configuring Properties . . . 1 yfs.properties* . . . . . . . . . . . . . 24
Agent yfs.properties . . . . . . . . . . 24
Chapter 2. Initial Settings for Properties Business Intelligence yfs.properties . . . . . 27
Catalog Management yfs.properties . . . . . 28
Files . . . . . . . . . . . . . . . . 3 Database yfs.properties . . . . . . . . . 29
Exception Management yfs.properties . . . . 30
Chapter 3. Overriding Properties . . . . 5 Implementation yfs.properties . . . . . . . 31
Using the Property Parameters File (sandbox.cfg) . . 5 Inventory Management yfs.properties . . . . 36
Using the Customer_Overrides.properties File . . . 6 JMS yfs.properties . . . . . . . . . . . 37
Locating the Property File Name Prefix . . . . 6 Context-Sensitive Help and Documentation
Creating an Entry in the Library yfs.properties . . . . . . . . . . 39
customer_overrides.properties File . . . . . . 7 Order Management yfs.properties . . . . . . 40
Example 1: Overriding a property from the Parcel Carrier Server yfs.properties . . . . . 41
yfs.properties.in file . . . . . . . . . . . 7 Prints yfs.properties . . . . . . . . . . 44
Example 2: Overriding a property from the Security yfs.properties . . . . . . . . . . 44
dbclassCache.properties file . . . . . . . . 7 Service Definition Framework (SDF)
yfs.properties . . . . . . . . . . . . . 48
Chapter 4. Properties for LDAP User Rich Client Platform (RCP) yfs.properties . . . 50
Authentication . . . . . . . . . . . . 9 IBM Sterling Sensitive Data Capture Server
Setting Properties for LDAP-Based Authentication . . 9 (SSDCS) yfs.properties . . . . . . . . . . 51
System Management yfs.properties . . . . . 52
User Interface yfs.properties . . . . . . . . 55
Chapter 5. Logging Configuration . . . 11 Warehouse Management yfs.properties . . . . 59
Using log4j Inside the EAR . . . . . . . . . 11 dbclassCache.properties.* . . . . . . . . . . 65
Using log4j Outside the EAR . . . . . . . . 11 Sandbox.cfg . . . . . . . . . . . . . . 66
Log4j Configuration XML File . . . . . . . . 11 Sandbox.cfg Installation Properties . . . . . 66
Masking Sensitive Information During Logging Sandbox.cfg Agent Property . . . . . . . . 67
Using log4j . . . . . . . . . . . . . . 12 Sandbox.cfg Internal Properties . . . . . . . 68
Using Custom Layout and Filter . . . . . . 13 Sandbox.cfg SQL Proxy Tool Properties . . . . 69
Setting Up Regular Expressions. . . . . . . 13 Sandbox.cfg Database Properties . . . . . . 70
Sandbox.cfg DB Pooling Properties . . . . . 71
Chapter 6. Enabling Different Sandbox.cfg Product Documentation Library
Properties for Individual Processes . . 17 Properties . . . . . . . . . . . . . . 72
Sandbox.cfg Implementation Properties . . . . 73
Chapter 7. Configuring Cache for Sandbox.cfg Localization Property . . . . . . 73
Sandbox.cfg Multischema Properties . . . . . 74
Catalog Search Index . . . . . . . . 19
Sandbox.cfg Sterling Application Platform
Elements in the cacheoverride.xml File . . . . . 20
Properties . . . . . . . . . . . . . . 74

Chapter 8. Property Files Reference . . 23 Notices . . . . . . . . . . . . . . 77

Making Changes to Properties . . . . . . . . 23
Setting the Database Connection Properties . . . . 23
Datasource Connection Pooling Property . . . . 23 Index . . . . . . . . . . . . . . . 81

© Copyright IBM Corp. 1999, 2014 iii

iv Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 1. Configuring Properties
Property files contain properties that control the operation of IBM® Sterling Selling
and Fulfillment Foundation. By modifying the values of these properties, you can
customize Sterling Selling and Fulfillment Foundation to suit your business and
technical needs.

After installing Sterling Selling and Fulfillment Foundation, most property and
script files do not need any further configuration for basic operation of the system.
However, if you want to customize any specific operations—for example, setting a
different logging level—you will need to edit (and in some cases, create) certain
property or.xml files.

In general, changes to properties are not made in the specific property files
themselves; changes are made to the customer_overrides.properties file or
sandbox.cfg.

Detailed information about each configurable property in sandbox.cfg,

yfs.properties*, management.properties, and dbclassCache.properties is located in
"Property Files Reference".

Note:
v Change only the properties included in this appendix. Changes to any other
properties are not supported.
v This chapter contains the information required for property configuration to use
with databases, agent servers, LDAP servers, and logging. This property
configuration is required during Sterling Selling and Fulfillment Foundation
installation, as described in the Sterling Selling and Fulfillment Foundation:
Installation Guide.
v If you are upgrading from a prior release, see the Sterling Selling and Fulfillment
Foundation: Upgrade Guide that applies to your implementation before continuing
with the setup of Sterling Selling and Fulfillment Foundation. Changes have
been made to the properties files in the Release 8.2, so you must read the
Sterling Selling and Fulfillment Foundation: Upgrade Guide for information about
how this change impacts your system.

© Copyright IBM Corp. 1999, 2014 1

2 Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 2. Initial Settings for Properties Files
In Sterling Selling and Fulfillment Foundation, property files are generated when
the <INSTALL_DIR>/bin/setupfiles.sh (or setupfiles.cmd) script is run from the
corresponding initial settings files. The initial settings files are shipped with the
product and are present in the same <INSTALL_DIR>/properties directory.

The *.in files contain variable placeholders (parameters) for properties that contain
installation- or environment-specific information (such as database host, port, or
credential information).

The installer gathers these parameters (either interactively or using a silent

installation parameter file) and places this initial configuration information into a
special parameters file called sandbox.cfg. Using the parameters contained in the
sandbox.cfg, the *.in files are processed by the setupfiles script to create the final
properties files that are used by the product during runtime.

Do not modify or change any properties in files ending with .in, because newer
versions or fix packs of the product will overwrite your changes. Also, do not
change a property file that has a corresponding .in file because the setupfiles
script will re-create the properties file again, thus causing you to lose your
changes. The following section describes overriding properties.

© Copyright IBM Corp. 1999, 2014 3

4 Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 3. Overriding Properties
Even though it is recommended that you do not change property files directly,
situations do occur that require property changes. For these situations, use the
customer_overrides.properties file, sandbox.cfg file, and log4j.custom.xml file,
which are described below.
v customer_overrides.properties – If you need to change the value of a property
that is not parameterized in the .in file(s), you can override that property by
adding an entry for it to the customer_overrides.properties file. Making
changes to this override file instead of individual property files ensures that
none of your changes are lost in an upgrade or fix pack installation, and lets you
see most of the overrides in your configuration at a glance, rather than having to
check each property file individually. This file is not delivered with the product;
you must create it the first time you have a need for it.
v sandbox.cfg – Contains name-value parameters that are merged with each *.in
file to create the final properties files. For values that are parameterized in the
*.in files, you can supply that parameter in the sandbox.cfg file.
v log4j.custom.xml – For changes to logging properties, you create a file called
log4j.custom.xml. You make changes to basic logging properties in this file.
There are additional logging properties in the yfs.properties.in file. To make
changes to these, you create entries in the customer_overrides.properties file.

Using the Property Parameters File (sandbox.cfg)

The <INSTALL_DIR>/properties/sandbox.cfg file contains name-value parameters
that are merged with each *.in file to create the final properties files. You can
examine any *.in file and if you find a value that is parameterized, you can
supply that parameter in the sandbox.cfg file. A parameter is contained within the
‘&’ and ‘;’ characters. For example, the jdbc.properties.in file contains the
following property:
oraclePool.user=&ORA_USER;

The &ORA_USER; signifies a parameter. If the sandbox.cfg file contains the entry:
ORA_USER=oracle, the resulting jdbc.properties file will contain the following
property:
oraclePool.user= oracle

You can edit the information in the sandbox.cfg file at any time to change values
that have been created by the installer or to reflect changed setup parameters.

Most of the parameters in the sandbox.cfg file and the *.in files are not used at
runtime by the product. Consequently, if you change a parameter in the
sandbox.cfg file, you must run the setupfiles script so that the runtime property
files are re-created with the updated values.

See "Property Files Reference", for a list of properties that can be changed and a
description of each.

© Copyright IBM Corp. 1999, 2014 5

Using the Customer_Overrides.properties File
The sandbox.cfg parameters let you change the properties defined with variables.
However, if you need to change the value of a property that is not parameterized
in the .in file(s), you can override that property by creating a special file called
customer_overrides.properties.

For each property that you want to override, you must have the following
information:
v PROPERTY_FILE_NAME_PREFIX - Name used in the servers.properties file to
reference the actual property file.
v PROPERTY_NAME - The name of the property as used in the specified property
file.
v PROPERTY_VALUE - The value you want to assign to the property.

These values are used to create an entry in customer_overrides.properties that

looks similar to the following example:

PROPERTY_FILE_NAME_PREFIX.PROPERTY_NAME=PROPERTY_VALUE

Locating the Property File Name Prefix

About this task

To find the PROPERTY_FILE_NAME_PREFIX for a property:

Procedure
1. If you do not know the name of the file containing the property you are
overriding, find the file by searching for the property in the
<INSTALL_DIR>/properties directory. For example, if you want to find the file
that contains the api.security.token.enabled property, search the
<INSTALL_DIR>/properties directory for api.security.token.enabled. In this
case, you find the yfs.properties file.
2. In the <INSTALL_DIR>/properties directory, locate the servers.properties file
and open it in a text editor.
3. In the servers.properties file, find the entry for the property file that you
located in step 1. In the example for step 1, you found the yfs.properties file.
In this case, find an entry for the yfs.properties file in the servers.properties
file.
4. The part of the entry before the equal sign (=) is the prefix that you will use in
customer_overrides.properties. Make note of it. For example, locate the entry
for yfs.properties in servers.properties:
yfs=<INSTALL_DIR>/properties/yfs.properties
yfs is the prefix for the yfs.properties property file.

Results

Note: Extensions for property files are not listed in the servers.properties file.
For example, yfs.properties_ycs_ext is listed as yfs.properties in the
servers.properties file.

6 Sterling Selling and Fulfillment Foundation: Properties Guide

Creating an Entry in the customer_overrides.properties File
About this task

To create an entry in the customer_overrides.properties file:

Procedure
1. In the <INSTALL_DIR>/properties directory, locate (or create if necessary) the
customer_overrides.properties file.
2. Open the customer_overrides.properties file in a text editor.
3. Add the properties that you want to override, using the following format:
PROPERTY_FILE_NAME_PREFIX.PROPERTY_NAME=PROPERTY_VALUE
4. Save and close the customer_overrides.properties file.
5. Stop your Sterling Selling and Fulfillment Foundation server.
6. Rebuild the EAR, following the instructions for your application server type, as
described in the Sterling Selling and Fulfillment Foundation: Installation Guide.
7. Restart your Sterling Selling and Fulfillment Foundation server and all agent
and integration servers.

Example 1: Overriding a property from the yfs.properties.in

file
Procedure
1. Check servers.properties to find the PROPERTY_FILE_NAME_PREFIX. In
server.properties, the line for yfs.properties.in is:
yfs=<INSTALL_DIR>/properties/yfs.properties
yfs is the PROPERTY_FILE_NAME_PREFIX.
2. The yfs.properties file contains a property called
yfs.smtp.connectionpool.enable. For an override entry, the PROPERTY_NAME
value would be yfs.smtp.connectionpool.enable. So far, the entry for
customer_overrides.properties so far would be:
yfs.yfs.smtp.connectionpool.enable
3. The default value for yfs.smtp.connectionpool.enable is "true". To override this
default, you would add the value of "false" to the entry. The completed
override entry for the example is shown below.
yfs.yfs.smtp.connectionpool.enable=false

Results

Note: For more information about properties in the yfs.properties files that can be
changed, see "Property Files Reference".

Example 2: Overriding a property from the

dbclassCache.properties file
Procedure
1. Check servers.properties to find the PROPERTY_FILE_NAME_PREFIX. In
server.properties, the line for dbclassCache.properties says:
dbclassCache=<INSTALL_DIR>/properties/dbclassCache.properties
dbclassCache is the PROPERTY_FILE_NAME_PREFIX.
2. The dbclassCache.properties file contains a property called
sci.globalcache.object.size. For an override entry, the PROPERTY_NAME value

Chapter 3. Overriding Properties 7

 would be sci.globalcache.object.size. So far, the entry for
customer_overrides.properties so far would be:
dbclassCache.sci.globalcache.object.size
3. The default value for sci.globalcache.object.size is 10000. To override this
default, you would add the new value (in this example, 15000) to the entry. The
completed override entry for the example is shown below.
dbclassCache.sci.globalcache.object.size=15000

Results

Note:
v For more information about properties in the dbclassCache.properties file that
can be changed, see "Property Files Reference".
v You do not need to run the setupfiles script after making a change to the
customer_overrides.properties file, because no parameters are being replaced.
However, you do need to stop and restart your Sterling Selling and Fulfillment
Foundation server and all agent and integration servers for the changes to take
effect.
v Remember to comment the dbtype, driverclass and jdbcurl that does not pertain
to your configuration.

8 Sterling Selling and Fulfillment Foundation: Properties Guide

Chapter 4. Properties for LDAP User Authentication
This section assumes you understand how LDAP servers work. It is also
recommended that you read the following documents on LDAP technology:
v W. Yeong, T. Howes, and S. Kille, RFC 1777 - Lightweight Directory Access Protocol.
March 1995. Available at http://www.faqs.org/rfcs/rfc1777.html.
v Mark Wilcox, Implementing LDAP. Wrox Press, 1999.

By default, all authentication is performed against the Sterling Selling and

Fulfillment Foundation database. When a user enters a login ID and password, it is
validated against the login ID and password that is stored in the database. This
requires the administrator of the Sterling Selling and Fulfillment Foundation
system to set up login IDs and passwords for each user.

Alternatively, the Application Consoles support LDAP-based user authentication.

You may choose to use an LDAP server for authentication. When using LDAP, the
users, user groups, and access control must be set up in the Sterling Selling and
Fulfillment Foundation system.

Sterling Selling and Fulfillment Foundation also supports password expiration

through LDAP. Your custom code for user authentication is interfaced with the
Sterling Selling and Fulfillment Foundation authentication mechanism. If your
custom code contains ExpireInDays with a numeric value of <X>, then a message to
reset the password appears in the Sterling Selling and Fulfillment Foundation
home page. If the map contains ChangePasswordLink then the message contains a
link to the location specified. Clicking on the link opens a new window with the
given ChangePasswordLink.

Since the various implementations of LDAP, handle password expiration

differently a sample YFSLDAPAuthenticator is modified to provide an example of
one particular implementation. This is located in the <INSTALL_DIR>/xapidocs/
code_examples/java directory.

Setting Properties for LDAP-Based Authentication

About this task

To set properties for LDAP-based authentication:

Procedure
1. Install the LDAP server (see the installation instructions from your LDAP
server vendor).
2. If a JAAS-compliant provider is used, create a JAAS configuration file with the
following lines:
LDAP
{
// refer to the JAAS compliant service provider for the login
module details.
<Class Name of the Login Module as specified by the Security
provider> required
debug=true;
};

© Copyright IBM Corp. 1999, 2014 9

 3. In your customer_overrides.properties file, specify the LDAP properties
described in the following table.

Property Description
In the customer_overrides.properties file, specify:
yfs.yfs.security.authenticator Develop a new class that implements the
com.yantra.yfs.japi.util.YFSAuthenticator
interface and set the new classname as value for this
property.
Note: The Sterling Selling and Fulfillment Foundation
provides a sample
com.yantra.yfs.util.YFSLdapAuthenticator class that
you can use for reference.
yfs.yfs.security.ldap.factory If the default implementation is used, this property
specifies the LDAP context factory classname as in
your LDAP Server configuration. Set this property
value to
com.sun.jndi.ldap.LdapCtxFactory.
yfs.yfs.security.ldap.url If the default implementation is used, this property
specifies the URL used to access your LDAP Server.
For example,
yfs.security.ldap.url=ldap://MyServer:800.
yfs.yfs.security.ldap.o If the default implementation is used, this property
specifies the Sterling Selling and Fulfillment
Foundation organization in your LDAP Server
configuration.
yfs.yfs.security.ldap.ou If the default implementation is used, this property
specifies the Sterling Selling and Fulfillment
Foundation organizational unit in your LDAP Server
configuration.
yfs.yfs.jaas.loginmodule If using JAAS, set this property value to LDAP.
yfs.yfs.security.authenticator If using JASS, set this property value to
com.yantra.interop.services.security.
WebLogic startWLS startup file
-Djava.security.auth.login.config If you are using JAAS and WebLogic, specify the full
path to your JAAS configuration file.
In the Applications Manager
Configure organizations, All the users who need to access the Sterling Selling
organization units, and users. and Fulfillment Foundation system must be set up
under the LDAP server. All Sterling Selling and
Fulfillment Foundation users must belong to the same
organizational unit.

10 Sterling Selling and Fulfillment Foundation: Properties Guide

Chapter 5. Logging Configuration
Sterling Selling and Fulfillment Foundation includes basic logging functionality.
However, you can change logging parameters, if necessary, to better suit your
needs.

Note: Before setting up the logging parameters, ensure that you understand the
log4j utility. For detailed information about this utility, see http://
jakarta.apache.org/log4j.

Using log4j Inside the EAR

About this task

To use a log4j file inside the EAR:

Procedure
1. Create new file in <INSTALL_DIR>/resources, for example
log4jconfig.custom.xml.
2. Modify customer_overrides.properties used by your application server to add
yfs.log4j.configuration=/resources/log4jconfig.custom.xml.
3. Run <INSTALL_DIR>/bin/deployer.sh -t resourcejar. This puts
log4jconfig.custom.xml in resources.jar.
4. Rebuild and redeploy the EAR, following the instructions for your application
server type, as described in the Sterling Selling and Fulfillment Foundation:
Installation Guide.

Using log4j Outside the EAR

About this task

To use a log4j file outside of the EAR:

Procedure
1. Create new file in your classpath, for example /folder/
log4jconfig.custom.xml.
2. Modify customer_overrides.properties used by your application server to add
yfs.log4j.configuration=/folder/log4jconfig.custom.xml. Note that the "/"
in front of the parameter is required.
3. Restart your application server.

Log4j Configuration XML File

The following table describes the properties in the log4j XML file.

Property Description
In the log4j configuration XML File

© Copyright IBM Corp. 1999, 2014 11

 Property Description
<priority> subelement Specify the level of logging desired. The logging level defined in
of the <root> element the log4jconfig.xmlis restrictive. You can control the logging level
criteria either through the System Management Console or by
calling the modifyTraces API.

The following are valid values for logging levels:

v ERRORDTL
v ERROR
v WARN
v INFO
v TIMER
v SQLDEBUG
v DEBUG
v VERBOSE
<appender> At the root level, this attribute specifies the associated name and
subelement class attribute. Choose a valid log4j appender class.

Each subelement can also specify the layout of the message

through the <layout> subelement and can filter for levels through
the <filter> subelement.

Instead of hardcoding the absolute path for the log file under the
appender you plan to use, IBM recommends that customers should
also use a ${LOG_DIRECTORY} parameter in the log4jconfig.xml file
and invoke the JVM with a
-DLOG_DIRECTORY=<application_log_directory>/<logFileName>
option.
<param> subelement This attribute specifies the associated name and value attribute.
of the <appender> You can set the following variables using the <param> attribute:
element v maxLogSize - Specify the maximum number of write operations
to be made to a log file (that is, this is not the memory size limit
of the log file. The size of log file will depend on the size of each
write operation.) By default, the value of this variable is set to
100000.
v rotateLogs - Determines whether the log files should be split or
not. If the value of this variable is set to false, the log files will
not be split, and logger will keep writing in the same file. By
default, the value of this variable is set to true.

Masking Sensitive Information During Logging Using log4j

You can filter log messages when the log4j utility is used for logging. This helps
prevent sensitive information, such as CVV2 codes, from being logged in the
verbose log messages. By default, only the value of Secure Authentication Code is
masked.

Sterling Selling and Fulfillment Foundation provides a custom log4j Layout and
Filter. The custom Layout will first delegate to a normal PatternLayout to get a
formatted message. When the formatted message is received, the custom Layout
will filter the results based on a set of configurable regular expressions, before
finally returning the fixed string. The custom Filter enables you to match the
message against regular expressions and mask the message, if the message
matches.

12 Sterling Selling and Fulfillment Foundation: Properties Guide

 Note:
v Filtering applies only to the messages logged using the log framework that is
provided, which includes both YFCLogCategory and LogService. Messages
logged through other methods, such as direct system.out or other log
framework, will not be affected.
v If filtering is enabled, logging will be slower because it results in the execution
of one or more regular expressions against every log message. This in turn may
have a larger impact with the VERBOSE mode that is enabled for logging.

Using Custom Layout and Filter

Using the log4j utility, you can modify the log messages in the following places:
v Layout - Forms the actual message
v Appender - Writes the message

Sterling Selling and Fulfillment Foundation provides a custom layout,

SCIFilteredPatternLayout, to handle message modification. You must change the
layout class name in your custom logging configuration to
SCIFilteredPatternLayout, for example:
<layout
class=”com.sterlingcommerce.woodstock.util.frame.logex.SCIFilteredPatternLayout”>
<param name=”ConversionPattern” value=”%d:%-7p:%t: %-60m
[%X{AppUserId}]: %-25c{1}%n”/>
<param name=”FilterSet” value=”common-filter”/> <!-- Optional -->
</layout>

Sterling Selling and Fulfillment Foundation provides a custom filter,

SCIPatternFilter, to filter out any messages that match certain regular expressions.
You must change the filter class name in your custom logging configuration, for
example:
<filter class=”com.sterlingcommerce.woodstock.util.frame.logex.SCIPatternFilter” >
<param name=”FilterSet” value=”suppress” /> <!-- Optional -->
</filter>

The following example calls an API with the following element in the input XML:
<Payment PaymentType=”CREDIT_CARD” CreditCardNo=”411kdiwbc6fj1111”
SecureAuthenticationCode=”1234” MaxChargeLimit=”100.00”/>

If the log level is set to VERBOSE, then the XML element will be logged as it
appears above. Using the Log Filter, the following would be entered instead in the
log file:
<Payment PaymentType=”CREDIT_CARD” CreditCardNo=”411kdiwbc6fj1111”
SecureAuthenticationCode=”***” MaxChargeLimit=”100.00”/>

Setting Up Regular Expressions

Sterling Selling and Fulfillment Foundation has introduced a property file,
logfilter.properties, that can be used to set up named sets of regular
expressions for both server-side masking and client-side masking of sensitive data.
Each property is of the following form:
filterset.<name>.pattern.<num>=<pattern>
[optional]filterset.<name>.replace.<num>=<replace>

The pattern property is a Java-style regular expression, and defines the regular
expression against which you want to match the message string. The replace
property is optional, and defines what to replace the expression with. If the replace
property is not defined, the default replacement string will be used. This property

Chapter 5. Logging Configuration 13

 has no effect during a Filter. If the replacement string is invalid, the framework
will catch the exception and print ***INVALID REPLACE VALUE***. The original
unfiltered messages are not logged.

Sterling Selling and Fulfillment Foundation provides the following properties that
enable you to set the default FilterSet parameters for server-side masking:
v default.filter.filterset=<filter_name>
v default.layout.filterset=<layout_name>

Similarly, Sterling Selling and Fulfillment Foundation provides the following

properties that enable you to set the default FilterSet parameters for client-side
masking:
v default.rcp.filter.filterset=<filter_name>
v default.rcp.layout.filterset=<layout_name>

You can also define a common set of patterns across multiple filter sets, for
example:
filterset.<name>.includes=<name1>,<name2>,...

Note: The following sample Log Filter Properties file is included for informational
purposes only. You must set these properties in the
customer_overrides.properties file, rather than editing them in
logfilter.properties.in directly.

Sample Configuration for Log Filter Properties

The following sample configuration creates two sets of regular expression patterns,
suppress and common-filter, and associates them with the default Filter and
Layout configurations:
#Setting default Filter and Layout configurations for server-side masking
default.filter.filterset=suppress
default.layout.filterset=common-filter

#Setting default Filter and Layout configurations for client-side masking

#for Rich Client Platform based Applications
default.rcp.filter.filterset=rcp1
default.rcp.layout.filterset=rcp2

#The string “creditcardnumber” is suppressed in the log messages during

#logging. (?i) indicates case-insensitive matching.

filterset.suppress.pattern.2=Password\\s*\\=
#The string pattern “Password =” is suppressed in the log messages during
#logging.

filterset.common-filter.pattern.1=(Password|CVV|CreditCardNo)\\s*=\\s*([“'
]).*?\\2
#The string pattern “Password =” is replaced with the string pattern
#mentioned in the replace property during logging.

filterset.common-filter.replace.1=$1=****
#The string pattern “Password =” is replaced with the string pattern
#”Password=*******” during logging.

filterset.suppress.includes=common-filter,<any_other_filter>

Notes:

14 Sterling Selling and Fulfillment Foundation: Properties Guide

v An empty pattern will be ignored. The number at the end does not matter, but it
must be unique.
v If there is a loop in the dependencies, or if there is a preference to an invalid
dependency, an exception is thrown. An exception is also thrown if a pattern is
invalid. However, if the logfilter.properties file is missing, no exceptions are
thrown, and nothing is filtered.

Chapter 5. Logging Configuration 15

16 Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 6. Enabling Different Properties for Individual
Processes
About this task

It is possible to specify different properties for each process you are running. To do
this, you must have a different servers.properties and
customer_overrides.properties file for each process that you are running. In the
start scripts for the process, set your -DvendorFile=<your custom
servers.properties>. In your customer servers.properties, change the entry for
customer_overrides.properties to point to your new
customer_overrides.properties.

© Copyright IBM Corp. 1999, 2014 17

18 Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 7. Configuring Cache for Catalog Search Index
About this task

Sterling Selling and Fulfillment Foundation uses Ehcache, a third-party caching

framework, to manage memory that is used by the search index cache. With the
SearchIndexCache configuration provided by Sterling Selling and Fulfillment
Foundation, Least Recently Used (LRU) pre-search results for categories and
filtered attributes in the catalog search index are cached to disk, thereby reducing
the amount of memory usage.

Note: The information in this section describes the out-of-the-box Ehcache

configuration values provided by IBM. For detailed information about Ehcache
functionality and how you can configure the elements and settings to enhance
your cache for catalog search index, see http://ehcache.org/.

If you use catalog search index, you need to override and configure the
out-of-the-box cache XML file provided by Sterling Selling and Fulfillment
Foundation.

To configure the cache for catalog search index:

Procedure
1. Copy the <INSTALL_DIR>/resources/cache.xml as <INSTALL_DIR>/resources/
cacheoverride.xml.
2. Specify the location where the cached data overflow will be stored.
The disk location can be set in either of the following ways:
v Specify the path name in the diskStore element of cacheoverride.xml. For
example:
<diskStore path="/<pathname>"/>
v If you need to override the disk storage path, specify the path name in the
sci.ehcache.disk.store.dir property in the yfs.properties file. The disk
storage path is automatically set to be a unique directory under the directory
you specified. For additional information about the
sci.ehcache.disk.store.dir property, see "Property Files Reference".
Note that the cached data can be stored either on a shared, central disk that
is accessible from all servers, or it can be stored on a local server. If the
cached data is stored on a shared disk, each application server requires its
own disk store directory, which is named based on the system argument
jvmcacheid. If this argument is not passed, the name of the disk store
directory is the ServerID of the server.
Note that if the sci.ehcache.disk.store.dir property is set in the
yfs.properties file, the value of this property will override the value of the
disk store path set in cacheoverride.xml.
3. Sterling Selling and Fulfillment Foundation provides out-of-the-box cache
configuration values for catalog search index in the SearchIndexCache section
of cacheoverride.xml. You can modify the values of these elements to suit your
business needs.
For example, refer to “Elements in the cacheoverride.xml File” on page 20 for
some of the elements that you can modify in the SearchIndexCache section of

© Copyright IBM Corp. 1999, 2014 19

 cacheoverride.xml. In the case of the maxElementsInMemory, an element in the
cache consists of each pre-search result that is represented by a bit set for a
category or a filtered attribute. The maxElementsInMemory described in this
table defaults to 10000, which is a generous estimate. If you would like to
adjust this setting higher or lower for your specific requirements, you can
estimate this memory requirement by using the following equation:
(minimum expected memory consumption in bytes)=(total number of active
catalog items/8) * (maximum elements in memory)
The divisor of 8 is used to derive the result in bytes. After setting this element,
monitor your JVM and consider testing this in a staging environment before
implementing it.

Note: Each pre-search result for a category or a filtered attribute is considered

as an element in the cache. The cache is loaded at the 10-minute interval. The
old cache is used until the new cache is completely loaded.

Elements in the cacheoverride.xml File

The following table describes some of the elements that you can modify in the
SearchIndexCache section of cacheoverride.xml.

Element Description
maxElementsInMemory Required. Specifies the maximum number of elements that can
be stored in memory. If you specify zero (0), there is no limit
on the number of elements that can be stored in memory.

By default, the value is set to 10000.

overflowToDisk Required. Specifies whether or not elements are written to
disk when the memory store has reached the
maxElementsInMemory limit.

Valid values are true or false. If set to true, the elements are
written to disk when the memory store has reached the
maxElementsInMemory limit.
maxElementsOnDisk Required. Specifies the maximum number of elements that can
be stored on disk. If you specify zero (0), there is no limit on
the number of elements that can be stored on disk.

By default, the value is set to 0.

eternal Required. Specifies whether or not elements are eternal. By
default, the value is set to true.
Note: Do not change this default value.
diskPersistent Optional. Specifies whether or not the disk store persists
between restarts of the Java™ Virtual Machine (JVM). By
default, the value is set to false.
Note: Do not change this default value.
memoryStoreEvictionPolicy Optional. Specifies the algorithm to be used for in-memory
cache when the memory store reaches the
maxElementsInMemory limit. Valid values:
v LRU (Least Recently Used)
v FIFO (First In First Out)
v LFU (Least Frequently Used)

By default, the value is set to LRU.

Note: Disk storage always uses the LFU algorithm.

20 Sterling Selling and Fulfillment Foundation: Properties Guide

Element Description
diskSpoolBufferSizeMB Optional. Specifies the size (in MB) to allocate the disk store
for a spool buffer. Writes are made to this area and then
asynchronously written to disk. By default, the size is set to 30
(MB).
Note: Each spool buffer is used only by its cache. If you get
OutOfMemory errors, consider lowering this value. To
improve disk store performance, consider increasing this
value.

Note: After you create cacheoverride.xml, you must update and rebuild the
resources.jar file. For additional information about building and deploying
extensions to XML files in the <INSTALL_DIR>/resources directory, refer to the
Sterling Selling and Fulfillment Foundation: Customization Basics.

Chapter 7. Configuring Cache for Catalog Search Index 21

22 Sterling Selling and Fulfillment Foundation: Properties Guide
Chapter 8. Property Files Reference
The following property files are described in this topic:
v yfs.properties*
v dbclassCache.properties.*
v Sandbox.cfg

Note: IBM supports changes to the properties included in this chapter only.
Changes to any other properties are not supported.

Making Changes to Properties

Do not directly edit or change the property files covered in this appendix, except
sandbox.cfg. To make changes to the properties in these files, you must use the
customer_overrides.properties file or sandbox.cfg. IBM does not recommend that
you modify or change any properties in files ending with .in because newer
versions or fix packs of the product will overwrite your changes. IBM also does
not recommend that you change a property file that has a corresponding .in file
because the setupfiles script will re-create the properties file again, thus causing
you to lose your changes.

Setting the Database Connection Properties

Database connection properties are configured during installation. They are placed
in the <INSTALL_DIR>/properties/sandbox.cfg file and are used to set values in the
jdbc.properties file when the setupfiles utility is run.

The DB_SCHEMA_OWNER is set by the installer to the default schema of the user
for whom the installation is being run. If you want to put objects in a schema
other than the default schema for Oracle or for DB2®, you must edit the
sandbox.cfg file and change the DB_SCHEMA_OWNER variable to the desired
value. The system will use the variable to decide what schema to work against.

Datasource Connection Pooling Property

In customer_overrides.properties, you can define an external datasource on your
application server to manage connection pooling for your database as follows:
<property_file_descriptor>.<database>Pool.datasource=<datasource_name>

For example:
jdbcService.db2Pool.datasource=db2_transaction_pool

In this example:
v jdbcService is the property file descriptor.
v db2 is the name of the database you are using with your application.
v db2_transaction_pool is the name of the datasource that you want to use to
manage database connection pooling. You defined this in the application server.

Note: To use an application server datasource, you must also set the -Dvendor
parameter to oracle, jboss, or db2 in the application server script file. Refer to the

© Copyright IBM Corp. 1999, 2014 23

 Sterling Selling and Fulfillment Foundation: Installation Guide for more information
about configuring datasource connection pooling.

yfs.properties*
The yfs.properties* files contain business-level properties. The properties are
grouped in the following categories:
v Agent
v Business Intelligence
v Catalog Management
v Database
v Exception Management
v Implementation
v Inventory Management
v JMS
v Context-Sensitive Help and Documentation Library
v Order Management
v Parcel Carrier Server
v Prints
v Security
v Service Definition Framework (SDF)
v Rich Client Platform (RCP)
v IBM Sterling Sensitive Data Capture Server (SSDCS)
v System Management
v User Interface
v Warehouse Management

Agent yfs.properties
The following table contains the Agent yfs.properties and descriptions.

Property Values Description

Agent
yfs.agent.override.providerurl Default is not AgentServer Override for provider url: set the
set. property to the provider URL which will be used by
ALL Agent servers. This property does not impact
integration servers configured in the service builder.
This property overrides the url configured for time
triggered transactions in config.

Example for WebLogic:

yfs.agent.override.providerurl=t3://<host>:<port>

Example for WebSphere®:

yfs.agent.override.providerurl=corbaloc::<host>:
<boostrapport>

Example for JBoss:

yfs.agent.override.providerurl=jnp://
<ipaddress>:<port>

24 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.agent.override.icf Default is not AgentServer Override for InitialContextFactory Name:
set. set the property to the InitialContextFactory Name
which will be used by ALL Agent servers. This
property does not impact integration servers
configured in the service builder. This property
overrides the InitialContextFactory configured for
time triggered transactions in config.

Example for WebSphere:

yfs.agent.override.icf=com.ibm.websphere.naming.
WsnInitialContextFactory

Example for WebLogic:

yfs.agent.override.icf=weblogic.jndi.WLInitialContext
Factory

Example for JBoss:

yfs.agent.override.icf=org.jnp.interfaces.NamingContext
Factory
yfs.agent.override.qcf Default is not AgentServer Override for QueueConnectionFactory
set. Name: set the property to the
QueueConnectionFactory Name which will be used
by ALL Agent servers. This property does not impact
integration servers configured in the service builder.
This property overrides the QueueConnectionFactory
configured for time triggered transactions in config.

Example:

yfs.agent.override.qcf=<QueueConnectionFactory
Name>
yfs.agent.override.retryCount Default is not AgentServer Override for RetryCount: set the
set. property to the JMS RetryCount to be used by ALL
Agent Servers. This property does not impact
integration servers configured in the service builder.

Example:

yfs.agent.override.retryCount=<Number of Retries>
yfs.agent.override.retryInterval Default is not AgentServer Override for RetryInterval: set the
set. property to the JMS RetryInterval to be used by ALL
Agent Servers. This property does not impact
integration servers configured in the service builder.
This interval is specified in milliseconds.

Example:

yfs.agent.override.retryInterval=<RetryInterval in
Milliseconds>

Chapter 8. Property Files Reference 25

Property Values Description
yfs.agent.backup.providerurl Default is not AgentServer Backup for JMS. Set these three
set. properties to the JMSprovider URL
InitialContextFactory Name and
yfs.agent.backup.icf Default is not
QueueConnectionFactory Name which will be used
set.
by ALL Agent servers as a Backup if the primary
yfs.agent.backup.qcf Default is not JMSServer becomes unavailable, the QueueName
set. used by the Agent Server on the backup JMSServer
will be the same as the one configured on the
primary JMSServer.

These properties will be used only after a successful

start of the Agent Server using the primary JMSServer
configuration. If the AgentServer Override properties
are specified, they are used as the primary JMSServer
properties. The backup JMSServer will be used by the
Agent Server only if all three properties are specified.

These properties do not impact integration servers

configured in the service builder.

Examples for WebSphere:

yfs.agent.backup.providerurl=corbaloc::<host>:
<boostrapport>

yfs.agent.backup.icf=com.ibm.websphere.naming.Wsn
InitialContextFactory

Examples for WebLogic:

yfs.agent.backup.providerurl=t3://<host>:<port>

yfs.agent.backup.icf=weblogic.jndi.WLInitialContext
Factory

Examples for JBoss:

yfs.agent.backup.providerurl=jnp://
<ipaddress>:<port>

yfs.agent.backup.icf=org.jnp.interfaces.NamingContext
Factory
yfs.agent.backup.retryCount Default = 0 Number of times to retry a failed JMS connection

Example: yfs.agent.backup.retryCount=3
yfs.agent.backup.retryInterval Default = 0 Number of milliseconds to wait between retries

Example: yfs.agent.backup.retryInterval=3
yfs.agent.override.auth.enabled Valid values = Y The agent override for the JMS Security parameter
or N values specified in the Agent criteria. If set to Y, you
must also include values for the following two
properties (userid and password).

Example:

yfs.agent.override.auth.enabled=Y
yfs.agent.override.auth.userid Default is not If yfs.agent.override.auth.enabled is set to Y, these
set. properties (userid and password) must be present,
yfs.agent.override.auth.password otherwise an error is thrown.

26 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.agentserver.queryTimeout Set this property to specify the Query Time out for
Agents. This is the global property applicable for all
agents.

It is possible for individual agents to override this

property by specifying their own query timeouts. For
example, the User Activity Audit Purge Agent can
specify a property such as
USERACTAUDITPRG.queryTimeout. This will
override this global property. Set to zero means
unlimited.

Example:

yfs.agentserver.queryTimeout=
yfs.agent.bulk.sender.enabled The default value of this property is set to false. If a
user set this property to true, the JMS messages are
added in batches in the internal JMS queue. All the
messages received from the 'getJobs' method are
divided into batches and each batch is sent to the JMS
Queue, using a single JMS connection or session. This
improves the performance of the agent server.
Note: If a user enables the session pooling, the
sessions will be reused among different batches.
Otherwise, a new session will be created for each
batch of the messages.
yfs.agent.bulk.sender.batch.size The default value of this property is set to 1. This
property determines the batch size and the number of
messages to be sent to the JMS queue using the same
QueueSender object. The optimum value of the
property may vary for different JMS vendors.
yfs.ChangeDataPublisherExportDirectory Export directory where the changes are published and
must be the same folder as the one specified in the
Change Data Export Agent criteria. This property
must be set in customer_overrides.properties file
before the Change Data Export agent is run.
yfs.ChangeDataPublisherWorkingDirectory Working directory for the Change Data Export Agent,
which may or may not be the same as the export
directory. This property must be set in
customer_overrides.properties file before the Change
Data Export agent is run.
yfs.ChangeDataPublisherFilePrefix Specify any prefix either in the ChangeDataPublisher
service or in customer_overrides.properties.file before
the Change Data Export agent is run.
yfs.cacheManagerforcesyncloading Default = True Set the cacheManager.forcesyncloading property as
false to unsynronize. To override the
cacheManager.forcesyncloading property through
customer overrides, in the customer_overrides the
shell.cacheManager.forcesyncloading must be set as
false.

Business Intelligence yfs.properties

The following table contains the Business Intelligence yfs.properties and
descriptions.

Chapter 8. Property Files Reference 27

Property Values Description
Business Intelligence
analytics.portal.url Powerplay Launch URL.Replace the <machine> with
the Cognos® installation machine name/ip address. Do
not change anything else in the URL, else Business
Intelligence access will fail.

Example:

http://<machine>/cognos/cgi-bin/
login.cgi?signon=#USERID#&password=#PASSWORD#
&return_url=upfcgi.exe
analytics.reportnet.url Reportnet Analytics Launch URL. Replace the
<host>:<port> with the Cognos Connection machine
name/ip address and port number. Change “cognos8”
if you have deployed cognos with a different context
path. Do not change anything else in the URL, else
Cognos access may fail.

Example:

http://<host>:<port>/cognos8/cgi-bin/cognos.cgi
analytics.namespace Business Intelligence namespace. Indicates the
namespace that has been configured in COGNOS
Business Intelligence authentication, against which the
users would be authenticated.

Example:

<smcfs>
yfs.analytics.checkCachedReports Set this to Y to view the cached reports from Yantra
Analytics Console.

Example:

yfs.analytics.checkCachedReports=N

Catalog Management yfs.properties

The following table contains the Catalog Management yfs.properties and
descriptions.

Property Values Description

Catalog Management
yfs.searchIndex.RootDirectory <root path of catalog This property must be set if you use catalog search. It
search index file> contains the root path to the directory where the catalog
search index file will be written.

Example:

yfs.searchIndex.RootDirectory=<root path of catalog

search index file>
yfs.searchIndex.maxNumberOfErrors Default = 3 This property determines the number of errors that the
Catalog Index Build agent should encounter before it
stops trying to process a search index trigger. By default,
if the search index trigger encounters 3 errors, the
trigger will be marked as a failure, and it will not be
picked up again by the agent.

28 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.searchIndex.maxRetryCount Default = 3 This property determines the number of times the agent
will sleep waiting for the process to finish in the event
that the last message is processed before all other
messages have completed processing.

The yfs.searchIndex.sleepCount property determines

the amount of time the agent sleeps between retry
attempts.
yfs.searchIndex.sleepCount Default = 300,000 This property determines the number of milliseconds
the index building agent waits before trying to merge
individual message files into the final index file.
yfs.manageItem.EnableUpdateOf Valid values = Y or This property is used to enable the manageItem API to
AdditionalAttribute N run in backward compatibility mode.

If this property is set to Y, the manageItem API is called

to support backward compatibility for updating the
AdditionalAttribute record for the item. This property
must not be used where AdditionalAttribute records
represent a value for the ItemAttribute record. If this
property is not set or set to N, the system will retain the
current behavior.

By default, this property is not set.

sci.ehcache.disk.store.dir <root path of This property contains the root path to the directory
cached data> where cached objects will be written.

For example:

sci.ehcache.disk.store.dir=<root path of cached data>

Note: If this property is set in the yfs.properties file, the
value of this property will override the value of the disk
store path set in the cache configuration XML file.
yfs.manageItem.Inherit Valid values = Y or This property is used during manageItem for the
ClassificationExtnAttributesOnly N inheritance of extension columns values from model
item to child item.

If this property is set to Y, the extension columns that

are used for classification are only inherited from model
item to child item.

If this property is not set or set to N, all extension

columns are inherited from model item to child item.

By default this property is set to N.

Database yfs.properties
The following table contains the database yfs.properties and descriptions.

Property Values Description

Database
yfs.db.compression.class Valid values = <class Enter the custom class which provides the
name> implementation logic for the data compression for
columns that support compression.

Chapter 8. Property Files Reference 29

Property Values Description
yfs.dblogin.yantraschema.name Valid values = <schema The database schema for the Application installation
name> (if different from the userid being used)

Default is not set. Example:

yfs.dblogin.yantraschema.name=<SchemaName>
yfs.cursor.sharing.mode.dcm Default = FORCE Note: This property is required only when the
database is Oracle and you are integrating with
Yantra DCS.

Set this to the current value of cursor_sharing

parameter in your database. You can find it in
v$parameter table of Oracle.

Example:

yfs.cursor.sharing.mode.dcm=FORCE
yfs.db.textsearch Valid values = Y or N Setting this property will decide whether Text Search
is to be enabled.
Default = N
Example:

yfs.db.textsearch=N
yfs.db.textsearch.oracle.contexttype Valid values = CTXCAT Set this property to determine the type of text index
or CONTEXT (ctxcat or context) in Oracle.

Default = CTXCAT Example:

yfs.db.textsearch.oracle.contexttype=ctxcat
SUFFIX_KEY_WITH_INSTANCE Valid values = Y or N Set this property to insert instance number into
_NO primary keys generated.
Default = N
Example:

SUFFIX_KEY_WITH_INSTANCE_NO=N

Exception Management yfs.properties

The following table contains Exception Management yfs.properties and
descriptions.

Property Values Description

Exception Management
yfs.exception.disable.unique Valid values = Y or N When this property is turned off (set to N), the
ExceptionId system generates a unique exception ID based on the
Default = N IP address and random numbers when an error is
thrown. The ID appears in the output XML of the
error. If you do not want to generate unique
exception IDs, set this property to Y.

Example:

yfs.exception.disable.uniqueExceptionId=N

30 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.onerror.raisealert Valid values = Y or N When this property is turned on (set to Y), errors
encountered are directed to the alert console. Errors
Default = Y are grouped by certain criteria. Not every error is a
separate entry in the alert console.

Example:

yfs.onerror.raisealert=Y
yfs.onerror.raisealert.logging Valid values = day or hour This property is to set the logging interval.
.interval
Default = day If it is set to day, errors are grouped on daily basis.
Otherwise, they are grouped on an hourly basis. If an
error is repeated within a logging interval, it is not
directed multiple times to alert console. Instead, the
alert entry shows an increased occurrence count.

Example:

yfs.onerror.raisealert.logging.interval=day
yfs.onerror.raisealert.expira Number of days This property controls how many days of inactivity
tion.days are required before the alert is eligible to be
Default = 7 automatically closed by the Inbox Purge Agent.

A value of 0 means the Example:

alert will never be closed
by this agent. yfs.onerror.raisealert.expiration.days=7
yfs.onerror.raisealert.queuekey <QUEUE_KEY> Set this to the QUEUE_KEY of the Queue the alert
should be assigned to.
Default = DEFAULT
Example:

yfs.onerror.raisealert.queuekey=
yfs.exception.display.unique This property tells the application where to add the
ExceptionID=Description unique exception id, either on error description
(default behavior) or in the error XML as a separate
element.
yfs.exception.disable.unique If this property is set to Y, the system does not
Exception=N append a unique numeric ID to the error description
of an error. The default value is N, which means that
a unique numeric ID gets appended to the error
description.

Implementation yfs.properties
The following table contains implementation yfs.properties and descriptions.

Property Values Description

Implementation
yfs.context.namespace Default is not set Prefix to add the JNDI name when performing an
EJB lookup in the client API library. If not set, then
no prefix is used.

Chapter 8. Property Files Reference 31

Property Values Description
yfs.api.history.disable Valid values = true or false This property controls access to history tables. If the
value of this flag is set to “true”, access to the
Default = false entire deployment's history tables is suppressed
and the select, list, and count operations on history
tables will return no data.
v A select operation returns null.
v A list operation returns an empty list.
v A count operation returns a zero count.

Also, if update, delete, and insert operations are

attempted on history tables, the system will throw
an exception.

This property enables applications to suppress

history so that the system can be started after
upgrading transaction data, even before history
upgrades are complete.

Example: yfs.api.history.disable = true

yfs.api.history.disable.colony. Valid values = <colony_id>, This property controls access to history tables for
<colony_id> true or false specific colonies, instead of disabling history access
for the entire deployment. If this property is not set
Default = false and the yfs.api.history.disable property is set to
"true," access to all history tables is disabled for all
database operations, such as insert, update, delete,
executeBatch, selectwithwhere, and so forth.

Example:

If history access is to be disabled for a colony with

the colony ID NewColony, the property should be
set in the following way:

yfs.api.history.disable.colony.NewColony = true
yfs.comsupport Valid values = Y or N Indicates whether or not your system supports
COM. If COM is enabled, you can configure actions
Default = Y to call COM objects.

Example:

yfs.comsupport=Y
yfs.purge.path Default is &APP_DIR;/logs This property must be set for the purge programs
to run. It contains the absolute path to the directory
where purge logs will be written.

Example:

yfs.purge.path=&APP_DIR;/logs
log4j.configuration <Property Name> Property to handle logging. This property points to
the location of the log4j configuration xml file.
Default =
/resources/log4jconfig.xml Example:

log4j.configuration=/resources/log4jconfig.xml

32 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
CaseInsensitiveSearch.Mode Valid Values = DISABLED, This property specifies the following configuration
ENABLED, or MIXED modes to enable or disable case insensitive search
across entities.
Default = ENABLED
v Disabled: Search is case-insensitive. SEarch is
done on the original column only.
v Enabled: Search is case insensitive. Search is done
on the shadow column, which is generated once
this attribute is set.
v Mixed: Search is done on both the original and
shadow columns. This mode is useful only
during data migration (while populating the
shadow column).
Note: Mixed mode might have a negative impact
on performance, hence it is recommended to not
use mixed mode.

Though this mode is globally applicable across

entities, it can be overridden at a particular entity
or column level.

To enable case insensitivity at an entity level, use

the format:
<ENTITY_NAME>.CaseInsensitiveSearch.Mode
=ENABLED

Example:
YFS_INBOX.CaseInsensitiveSearch.Mode=ENABLED

To enable case insensitivity at a column level, use

the format:
<ENTITY_NAME>.<COLUMN_NAME>.CaseInsensitive
Search.Mode=ENABLED

Example:
YFS_INBOX.ALERT_TYPE.CaseInsensitiveSearch.
Mode=ENABLED
yfs.install.localecode <locale code> Installation locale code. This localecode has to
match the underlying OS default timezone where
Set to en_US_EST when the database is installed to avoid timezone
Sterling Selling and calculation errors.
Fulfillment Foundation is
delivered; If changes are Example:
necessary, this must be
changed by the customer. yfs.install.localecode=en_US_EST
yfs.install.displaydoublequantity Valid values = Y or N This property should be set to "Y" if you want to
support fractional quantities for attributes which
Default = Y belong to QUANTITY datatype.

Example:

yfs.install.displaydoublequantity=Y

Chapter 8. Property Files Reference 33

Property Values Description
yfs.file.encoding <Property name> This property controls the encoding of the files, like
API template, theme XMLs, exception template
Default = UTF-8 (except e-mail templates which is controlled by
yfs.email.template.encoding).

Example:

yfs.file.encoding=UTF-8
yantra.app.maxrecords <number of records> This property sets the default number of records
returned by Application list APIs. Increase the
Default = 5000 application server JVM heap settings if these
parameters are increased. Change will affect search
limits for all users.

Example:

yantra.app.maxrecords=5000
yfs.app.identifyconnection Valid values = Y or N Set this property to "Y" to enable the application to
set contextual information (Agent, API name) on
Default = N the connection. The information stamped on the
connection can be viewed on the database
connection by the tools provided by the database
vendors. This allows mapping of the connection in
the database to its origin on the application side.
This is available only for Oracle and DB2.

Example:

yfs.yfs.app.identifyconnection=Y
enable.resource.addition Valid values = true or false Set this property to "true" if you want to add new
resources from the Applications
Default = false ManagerConfigurator and the IBM Sterling Web
application.

Example:

enable.resource.addition=false
yfs.uidev.refreshResources Valid values = Y or N This property can be set to "Y" when developing
and customizing the Application Console UI.
Default = N
When set to "Y", refresh actions will be available
within the Resource Hierarchy tree. These actions
can be used to refresh the resources used in the
Console UI Framework without having to restart
the application server.

If this property is not set to "Y", then the actions

will be disabled, and it will be necessary to restart
the application server whenever any resource is
changed within the Applications Manager.

IMPORTANT: This property should NOT be set to

"Y" for live production systems because the refresh
only works for a single user development
environment.

Example:

yfs.uidev.refreshResources=N

34 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yantra.document.isnamespace Valid values = Y or N This property should be set to Y to handle
aware namespaces in XML.
Default = N
Example:

yantra.document.isnamespaceaware=N
yantra.document.suppress.huge. Valid values = true or false Set this property to enable or disable printing a
doc.alert document that contains more than one million
Default = false nodes.

If the value of this property is set to “true”, the

document will not be printed, and instead, a
"Please disable/set
yantra.document.suppress.huge.doc.alerts to False
to print the offending document with more than
one million nodes" warning message will be
displayed.

If set to “false”, the application will retain the

default behavior.
com.yantra.ycp.em.server.task <number of seconds> Set this property (in seconds) to indicate the
pollingtime interval at which tasks need to be polled for mobile
Default = 60 operators.

Example:

com.yantra.ycp.em.server.taskpollingtime=60
OverrideTransitTime Valid values = Y or N If both Request Delivery date and Request Ship
date are passed, setting this property will compute
Default = N the transit time as difference between these two
dates, and no further transit time computation will
be required.

Example:

OverrideTransitTime=N
yfs.install.applyshipdateoptimiz Valid values = Y or N Set this property to "N" if allocation should not
ation optimize releases based on ReqShipDate.

Example:

yfs.install.applyshipdateoptimization=Y
yfs.audit.user.session.activity Valid values = Y or N Set this property to enable auditing and disable
auditing.
Default = Y (audit enabled)
Example:

yfs.audit.user.session.activity=Y
yfs.bundleProperties.multiple Default: locale is en_US When this property is set to N, the system will not
Load=Y create multiple entries for bundle literals for
different locales. When trying to load literals for a
given locale, if the properties file is not found for
the locale, the system will use the default locale for
string translations.

Chapter 8. Property Files Reference 35

Property Values Description
yfs.logall Valid values = Y or N Setting this property enables and disables verbose
logging.
Default =N
Example:
yfs.logall=N
yfs.cacheManager.forcesyncloading
Default = True Set the cacheManager.forcesyncloading property as
false to unsynchronize. To override the
cacheManager.forcesyncloading property through
customer overrides, in the customer_overrides the
shell.cacheManager.forcesyncloading must be set as
false.

Inventory Management yfs.properties

The following table contains Implementation Management yfs.properties and
descriptions.

Property Values Description

Inventory Management
yfs.inventory.sortandlock Valid values = Y or N Setting this property to Y will prevent dead locking
on YFS_Inventory_Item table during order creation
and when synchronizing changes from a shipment
back to the order. This parameter is only used if the
order contains a logical kit, or when a shipment
contains shipment lines from different orders. Setting
this property to Y will result into holding lock on
YFS_Inventory_Item table for longer period. So, this
may degrade overall system performance. Because of
this reason, you should set this property to Y only if
you are getting excessive dead locks on
YFS_Inventory_Item table.

Example:

yfs.inventory.sortandlock=
yfs.hotsku.useHotSKUFeature Valid values = Y or N Set this property to "Y" to use the Hot SKU feature.
For more information about the Hot SKU feature,
Default = N please see Sterling Selling and Fulfillment Foundation:
Product Concepts Guide and the Sterling Selling and
Fulfillment Foundation: Performance Management Guide.

Example:

yfs.hotsku.useHotSKUFeature=N
yfs.hotsku.useTimeOutLocking Valid values = Y or N Set this property to "Y" to use locking timeout while
trying to obtain a lock for an inventory item when
Default = N the Hot SKU feature is enabled. The timeout period
will be based on the
yfs.hotsku.secondsToClassifyAsAbnormalTime
property (round up to integer).

Example:

yfs.hotsku.useTimeOutLocking=N

36 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.Hotsku.useAvailabilityAcrossNodes
Valid values = Y or N While determining whether hot item still needs to be
locked, system will take into consideration
Default = Y availability across all nodes requested instead of
individual nodes. And compare the consolidated
availability across all nodes with the High
Availability threshold.

If consolidated inventory is 0, system will avoid

locking. If consolidated inventory is low, system will
lock the sku even though it may be considered hot. If
consolidated inventory is high, we will avoid locking.

All agents and APIs that update demand/supply and

check availability will be impacted by this property
(ex: reservations, order creation/modifications,
scheduling, release). This property does not change
actual availability calculation, instead it just impacts
decision whether to lock an item. There is a slight
chance that multiple threads can schedule or allocate
against a node with low availability. This could result
into backorder from the node (no pick) from DC or
Store. In such case, order would get rescheduled to
another location based on availability and sourcing
decisions.

The property must be set in

customer_overrides.properties as;
yfs.yfs.Hotsku.useAvailabilityAcrossNodes=<value>

JMS yfs.properties
The following table contains JMS yfs.properties and descriptions.

Property Values Description

JMS
yfs.jms.session.disable.pooling Valid values = Y, N To disable JMS Session pooling, set this property to
Y. IBM recommends setting to N for performance
Default = N reasons.

Example: yfs.jms.session.disable.pooling=N
yantra.jms.receive.timeout Valid values = <number of Specifies the JMS receive timeout value (in
milliseconds> milliseconds). The JMS Receiver receives the next
message that arrives within the specified timeout
Default = 1800000 interval. The receive call blocks until a message
milliseconds (30 minutes) arrives, the timeout expires, or this message
consumer is closed. A timeout of zero never
expires, and the call blocks indefinitely.

Example: yantra.jms.receive.timeout=180000
Note: If the default JMS server of Websphere is
used, then the receive timeout interval must be set
to 60000 milliseconds (1 minute).

Example: yantra.jms.receive.timeout=60000

Chapter 8. Property Files Reference 37

Property Values Description
yfs.flow.override.auth.enabled Valid values = Y or N The flow overrides to override the JMS Security
parameter values specified in the service definition
yfs.flow.override.auth.userid framework. If this value is set to Y then the other
two properties at left (userid and password) must
yfs.flow.override.auth.password be present, otherwise an error is thrown.

Examples:
yfs.flow.override.auth.enabled=Y
yfs.flow.override.auth.userid=Y
yfs.flow.override.auth.password=Y
yfs.jms.session.disable.pooling Valid values = Y or N To disable JMS Session pooling, set this property to
Y. By default this property is set to N. Yantra
Default = N recommends N value to this property for better
performance reasons.

Example:
yfs.jms.session.disable.pooling=N
yfs.restrict.flowmessageid.length Valid values = Y or N To restrict the length of correlating attributes, such
to24 as MESSAGEID and JMS-CORRELATION-ID, to 24
Default = N characters, set this property to Y.

Example:

yfs.restrict.flowmessageid.lengthto24=N
sci.queuebasedsecurity.userid Valid values = <USER_ID> Set this property for queue-based security.

Example:

sci.queuebasedsecurity.userid=<user_id configured
in the APPLICATION_SERVER and assigned to the
queue>
sci.queuebasedsecurity.password Valid values = Set this property for queue-based security.
<PASSWORD>
Example:

sci.queuebasedsecurity.password=<password for
the user_id as configured in the
APPLICATION_SERVER>
enable.db.check.before.jms.commitValid values = true or false When the value of the
'enable.db.check.before.jms.commit' property is set
Default =false to false or no value is set for this property, the
order of commit for the components is as follows:
1. JMS receiver
2. Database
3. JMS producer

When the enable.db.check.before.jms.commit

property is set to true and 'testOnReserveQuery' is
defined in the 'jdbc.properties', then the order of
commit is as follows:
1. JMS receiver
2. JMS producer
3. Database

38 Sterling Selling and Fulfillment Foundation: Properties Guide

 Context-Sensitive Help and Documentation Library
yfs.properties
The following table contains Context-Sensitive help and Documentation Library
yfs.properties and descriptions.

Property Values Description

Context-Sensitive Help and Online Documentation Library
yfs.urlforhelp.path </link to Context-Sensitive Help/> This controls where the link to the
Context-Sensitive Help will go. The value must
Default = /wwhelp/wwhimpl/ begin and end in a forward slash (/) to ensure
common/html/wwhelp.htm proper behavior.

Example:
yfs.urlforhelp.path=/wwhelp/wwhimpl/commo
n/html/wwhelp.htm

Note: Context-Sensitive Help is not the same as

the Product Documentation Libraries, also
described in this guide.
yfs.heightforhelp.path <height in pixels> This controls height for the Context-Sensitive
Help.
Default = 590
Example:
yfs.heightforhelp.path=390
yfs.widthforhelp.path <width in pixels> This controls width for the Context-Sensitive Help.

Default = 715 Example:

yfs.widthforhelp.path=515
yfs.onlinehelp.path </Context-Sensitive Help path/> This controls where the link to the
Context-Sensitive Help will go. The value must
Default = /docs/yfscommon/ begin and end in a forward slash (/) to ensure
online_help/ proper behavior. It must be a simple path; a full
URL will not work.

Example:
yfs.onlinehelp.path=/docs/yfscommon/online_help/
yfs.onlinehelp.path.override Valid values=</Context- This property enables you to specify the path for a
forlocale.<lang_country Sensitive Help path/ locale-specific Context-Sensitive Help. This
code> lang_country code> property overrides the yfs.onlinehelp.path
property. The default locale used for
Default=/<appname>docs/ Context-Sensitive Help is US English (en_US).
yfscommon/online_help/
en_US/ If this property is not defined, the path specified
in the yfs.onlinehelp.path property is considered,
and is suffixed with the default language and
country code, which is, en_US.

Example:
yfs.onlinehelp.path.overrideforlocale.jp_JP=/y
antradocs/yfscommon/online_help/jp_JP/

Chapter 8. Property Files Reference 39

Property Values Description
yfs.sync.jms.request.timetolive. JMS messages. Use this property to set the
timetolive value for Synchronous JMS Messages.
Note that, this property is a global level override
and is applicable for all the services using
Synchronous JMS. WARNING: If this property
value is set beyond the responseTimeOut value, it
may result in unprocessed request messages in the
reply/response queue. By default, in order to
clean up the un-processed messages from the
reply/response queue, the timeToLive for request
messages is set to the responseTimeOut value of
the receiver.

Example:
yfs.sync.jms.request.timetolive=<responseTi
meOut valueof the receiver>
plt.active.doc.url Valid values: LOCAL or Flag to identify Active Help URL.
ONLINE

Default: ONLINE
plt.online.doc.url Absolute URL for the IBM-hosted web page that
contains the Sterling Selling and Fulfillment
Foundation Online Documentation Library help
content.
plt.local.doc.url Relative URL for the local instance of the Sterling
Selling and Fulfillment Foundation Local
Documentation Library help content.

Order Management yfs.properties

The following table contains Order Management yfs.properties and descriptions.

Property Values Description

Order Management
yfs.transferPreparation.min <number of hours> Set this property with the minimum time
TimeReq (Hours) required for transfer preparation. This
Supported maximum value = 24 property is used by all Promising and
HRs Scheduling APIs.
Default = 0 Example:
yfs.transferPreparation.minTimeReq=0
yfs.NonAddressFields Valid values: AlternateEmailID, This property enables you to change the value
Beeper, DayFaxNo, DayPhone, of any non-address field in the ShipTo address
Department, EMailID, of a sales order without requiring the creation of
EveningFaxNo, EveningPhone, a new work order.
FirstName, HttpUrl, JobTitle,
LastName, MiddleName, Example:
MobilePhone, OtherPhone, Suffix, yfs.NonAddressFields=FirstName,LastName,
or Title DayPhone,EMailID

40 Sterling Selling and Fulfillment Foundation: Properties Guide

 Parcel Carrier Server yfs.properties
The following table contains Parcel Carrier Server yfs.properties and descriptions.

Property Values Description

Parcel Carrier Server
ycs.airborne.server.url Valid values = <server url> Airborne logon parameter.

Default = https:// Example:

eCommerce.airborne.com/ ycs.airborne.server.url=https://eCommerce.air
ApiLandingTest.asp borne.com/ApiLandingTest.asp
ycs.airborne.server.UserID Valid values = <userid> Airborne logon parameter.

Example:

ycs.airborne.server.UserID=<your airborne server

userid>
ycs.airborne.server.Passwd Valid values = <password> Airborne logon parameter.

Example:

ycs.airborne.server.Passwd=<your airborneserver
password>
ycs.airborne.LabelPrint.X- Valid values = <X-coordinate> Airborne print parameter.
coordinate
Default = 0.1 Example:

ycs.airborne.LabelPrint.X-coordinate=0.1
ycs.airborne.LabelPrint.Y- Valid values = <Y-coordinate) Airborne print parameter.
coordinate
Default = 0.1 Example:

ycs.airborne.LabelPrint.Y-coordinate=0.1
ycs.airborne.LabelPrint.Width Valid values = Airborne print parameter.
<LabelPrint.Width>
Example:
Default = 8.5
ycs.airborne.LabelPrint.Width=8.5
ycs.airborne.LabelPrint.Height Valid values = Airborne print parameter.
<LabelPrint.Height>
Example:
Default = 6.5
ycs.airborne.LabelPrint.Height=6.5
ycs.airborne.LabelPrint.Dump Valid values = yes or no Airborne print parameter.
_Switch
Default = yes Example:

ycs.airborne.LabelPrint.Dump_Switch=yes
yfs.log.logger <absolute path to message log dir> This property must be set if you use the default
message handling implementation. It contains the
absolute path to the directory where message logs
will be written.

Example:

yfs.log.logger=

Chapter 8. Property Files Reference 41

Property Values Description
ycs.log.directory <full path to log dir> This property must be set if you use the default
message handling implementation. It contains the
ycs.xmlDump.directory absolute path to the directory where message logs
will be written.

Examples:

ycs.log.directory=<full path of log directory>

ycs.xmlDump.directory=<full path of log

directory>
ycs.pierbridge.db.url <IP address> Change the IP address and port number
according to the IP and Port of your Pierbridge
<port> server database.

Example:

ycs.pierbridge.db.url=jdbc:sqlserver://
10.11.20.133:1215;databaseName=Pierbridge
Shipment Server
ycs.pierbridge.db.username <userid> This is the user identification required to log in to
the Pierbridge server database.

Example:

ycs.pierbridge.db.username=yantra
ycs.pierbridge.db.password <password> This is the password required to log in to the
Pierbridge server database.

Example:

ycs.pierbridge.db.password=yantra1
ycs.pierbridge.server.url <IP address> Change the IP address according to your
Pierbridge integration IP.

Example:

ycs.pierbridge.server.url=http://10.11.20.133//
pierbridge_shipping/services/xmlservice.aspx
ycs.pierbridge.default.rate. <userid> This is the user identification required to log in to
request.user the Pierbridge shipment server. This user
identification is required when the
getFreightCharge API is invoked in the IBM
Sterling Warehouse Management System.

Example:

ycs.pierbridge.default.rate.request.user=pierbridge
ycs.timer.switch Valid values = yes or no This property is to set to enable and disable the
Timer from logging.

Example:

ycs.timer.switch=yes

42 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
ycs.log.size.maxallowed <max log file size in bytes> This property is only used if you use the default
message handling implementation. It specifies the
Default = 1000000 maximum allowed log file size in bytes. A new
active log file is created whenever the currently
active log file reaches this size.

Example:

ycs.log.size.maxallowed=1000000
ycs.log.logger <class name> Default class to handle messages output by
PureEcommerce. The default implementation will
write these messages to log files. Refer to the
Programming Guide for how to write your own
implementation for this class.

Example:

ycs.log.logger=com.yantra.ycs.util.YCSFileLogger
ycs.purge.path <full path of log directory> This property must be set for the purge programs
to run.

Example:

ycs.purge.path=<full path of log directory>

ycs.purge.days <number of days> This property must be set for the purge programs
to run.

Example:

ycs.purge.days=15
ycs.weight_tolerance_percent <percent> If a label is printed before it is actually
manifested, weight printed on the label may not
Default = 5 exactly match the actual weight. Parameter below
specifies the tolerance percent beyond which the
label has to be reprinted.

Example:

ycs.weight_tolerance_percent=5
proxySet=false Valid values = true or false Proxy settings for https connections.

Default = false Example:

If set to true, the following proxySet=false

details are required:

https.proxyHost

https.proxyUser

https.proxyPassword

https.proxyPort
yfs.closeManifest.doInventory Valid values = Y or N Upon setting this property as 'Y', the
UpdatesOfflineOnConfirm closeManifest API calls the confirmShipment API
Shipment Default = N with DoInventoryUpdatesOffline=Y.
ycs.manifest. Default = Y This property must be set as “N”, so that the
reopenmanifest addToContainerToManifest API will never reopen
the closed manifest.

Chapter 8. Property Files Reference 43

 Prints yfs.properties
The following table contains the Prints yfs.properties and descriptions.

Property Values Description

Prints
yfs.loftware.tcpip.sockets Valid values = Y or N Set this property to Y to enable printing via TCP/IP
Socket Interface. Set it to N to enable printing via the
Default = N File Interface (file "drop" to a shared network drive).
Note: Although the default value is set to N for the
sake of backward compatibility, our recommendation
is to set this flag to Y.

Example:

yfs.loftware.tcpip.sockets=N
yfs.loftware.tcpip.sockets.mode Valid values = WAIT or Set this property to WAIT to change the Loftware
NOWAIT print server's mode to WAIT mode

Default = NOWAIT Example:

yfs.loftware.tcpip.sockets.mode=NOWAIT
ycs.pierbridge.pickupsummary <time in seconds> Set this property to specify the time period (per loop)
.wait_interval the system will wait before checking the End Of Day
Default=0 status on the Pierbridge server before proceeding
with Pickup Summary Label Print.

Example:

ycs.pierbridge.pickupsummary.wait_interval=60
ycs.pierbridge.pickupsummary <number of times of loop Set this property to specify the number of times the
.max_no_of_retries execution> system will loop to check the End of Day status on
the Pierbridge server before proceeding with Pickup
Default=0 Summary Label Print.

Example:

ycs.pierbridge.pickupsummary.max_no_of_retries=25
yfs.encoding.standard.for <ISO printing standard> Set this property to test print for different language
.prints characters, such as German, Chinese, Korean, and so
Default=0 forth.

Example:

yfs.yfs.encoding.standard.for.prints=ISO-8859-1

Security yfs.properties
The following table contains the Security yfs.properties and descriptions.

Property Values Description

Security
api.security.enabled Valid values = Y or N Set this property to secure access to APIs. If
enabled, an authorization check is performed on a
Default = Y user's access to an API when the user calls that
API.

44 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
api.security.mode Valid values = STRICT, STRICT: If any validation fails, throw an exception.
LAX, or DEBUG This is appropriate for production systems, if all
permissions are configured properly.
Default = STRICT
LAX: Filter out and log invalid input, but continue
processing. The filtering allows the system to
mostly work despite incorrect input or output,
while the logging helps to identify placed that need
change. LAX can be useful during initial
development and testing.

DEBUG: Log invalid input and output, but do not

filter anything or throw exceptions. This is
appropriate only during initial development, to
identify the permissions required by various
processes.

Note: If you do not specify a security mode, then

the system defaults to STRICT.

Example:

api.security.override.createorder.mode=DEBUG

This example sets access for the CreateOrder API to

DEBUG.
api.security.token.enabled Valid values = Y or N If api.security.token.enabled = Y, the login API
returns a special UserToken security token attribute
Default = Y upon successful authentication.

The api.security.token.timeout property controls

how long this token is active.
api.security.console.enabled Valid values = Y or N If api.security.console.enabled = Y, API security, in
addition to the built-in security, is used for the JSP
Default = N console.

Note: Enabling this property may require that you

relax other security settings or take additional steps
that are described in the following article:
v Go to the link https://
customer.sterlingcommerce.com/group/sterling/
support_center
v Log in, and in the Search Knowledgebase, enter
“HTG2798”.
v The article will be displayed as a selectable item.

Chapter 8. Property Files Reference 45

Property Values Description
api.security.smc.enabled Valid values = Y or N If api.security.smc.enabled = Y, API security, in
addition to the built-in security, is used for the
Default = N Applications Manager and the system monitor
console.

Note: Enabling this property may require that you

relax other security settings or take additional steps
that are described in the following article:
v Go to the link https://
customer.sterlingcommerce.com/group/sterling/
support_center
v Log in, and in the Search Knowledgebase, enter
“HTG2798”.
v The article will be displayed as a selectable item.
api.outputDBPasswords Valid values = Y or N If api.outputDBPasswords = true, passwords are
returned in the output of the getDBPoolLIst and
Default = N getDBConnParams APIs.
dsg.api.disable Valid values = <api_name> Set this property to disable the new data access
policy functionality for specific APIs.

Example:

dsg.api.disable=<api_name, api_name, api_name>

httpOnlyCookie Valid values = True or False Set this property to "False" to disable the setting of
"httpOnly" flag on cookies.
Default = True
interopservlet.security.enabled Valid values = Y or N Enables application server to authenticate a user,
using token-based or container-based
Default = Y authentication.
interopservlet.auth.container. Valid values = Y or N Set this property to “true” if you want the
enabled application server to authenticate a user by
Default = N checking whether the user ID matches the
requested user ID. If this property is set to “false”,
container-based authentication is disabled.

Example:

interopservlet.auth.container.enabled = false
interopservlet.auth.token.enabled Valid values = Y or N Setting this property to “true” validates the user
token supplied as a parameter on the request.
Default = Y When enabled, this also allows access to the login
API, which is what supplies the user token. If this
property is set to “false”, token-based
authentication is disabled.

Example:

interopservlet.auth.token.enabled = true
interopservlet.auth.userPassword. Valid values = Y or N Set this property to “true” if you want the user ID
enabled and password to be passed as parameters to the
Default = Y servlet, instead of using the typical login
API/token approach.

Example:

interopservlet.auth.userPassword.enabled = true

46 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
userauthfilter.enabled Valid values = yes or no Sets a servlet filter that ensures authenticated user
access to everything under web root, except for
Default = Y login pages.
yfs.login.singlesignon.class <class name> The class that handles Single Signon. Refer to the
javadocs for the
com.yantra.ycp.japi.util.YCPSSOManager interface
for information about how to write your own
implementation for this class.
yfs.security.singlesignon.enabled Valid values = Y or N If this property is set to Y, the single sign on class
is called.
Default = Y
yfs.login.singlesignon.checkuser Valid values = Y or N If this property is set to Y, each request is validated
against the singleSignOn Server for the user
Default = N authentication. If the property is set to N, user
authentication against the singleSignOn Server is
done only when the session times out.
yfs.security.authenticator <class name> The class that will be invoked for user
authentication. Uncomment and change this only if
Default is not set. you do not want to use application authentication.

Refer to the javadocs for the YFSAuthenticator

interface for information about how to write your
own implementation for this class. If you want to
use the default implementation for LDAP
authentication, uncomment the property and set it
to com.yantra.yfs.util.YFSLdapAuthenticator.

Example:

yfs.security.authenticator=
yfs.security.ldap.factory <class name> The LDAP context factory classname as specified in
your LDAP Server configuration.

Example:

yfs.security.ldap.factory=com.sun.jndi.ldap.Ldap
CtxFactory
yfs.security.ldap.url <url> The URL for accessing your LDAP Server as
specified in your LDAP Server configuration.

Example:

yfs.security.ldap.url=ldap://
<ldapservername>:<portnum>
yfs.security.ldap.ou Default is not set. The value specified for the organizational unit in
your LDAP Server configuration.

Example:

yfs.security.ldap.ou=
yfs.security.ldap.o Default is not set. The value specified for the organization in your
LDAP Server configuration.

Example:

yfs.security.ldap.o=

Chapter 8. Property Files Reference 47

Property Values Description
yfs.encrypter.class <class name> The class that handles encryption and decryption
of credit card numbers. Refer to the javadocs for
the YCPEncrypter interface for information about
how to write your own encrypter class. If this
property is not specified, then no encryption will
be performed.

IBM provides an application, the IBM Sterling

Sensitive Data Capture Server, that captures and
tokenizes credit card numbers and store value card
numbers. IBM recommends that you review the
Sterling Selling and Fulfillment Foundation: Secure
Deployment Guide for IBM's approach to meeting
PCI DSS and PA-DSS requirements.
yfs.propertyencrypter.class Valid values = <class name> This class will be used for encrypting and
decrypting properties specified in yfs.properties,
Default is not set. yiclient.properties and management.properties files.
All properties which end with ".encrypted" are
automatically decrypted using this class at runtime.
Use this property to encrypt critical data like
user/password.

The yfs.propertyencrypter.class is deprecated and

no longer used for property encryption. You can
now use security.property.encrypter.class for
property encryption. For more information about
encryption through property files, refer to the
Sterling Selling and Fulfillment Foundation: Extending
Transactions.

Example:

yfs.agent.override.auth.password=<password>

could be specified as:

yfs.agent.override.auth.password.encrypted=
<encrypted password>
security.propertyencrypter.class Valid values = This class will be used for encrypting and
<your_property_encrypter_ decrypting properties specified in the
class> yfs.properties, yifclient.properties, and
management.properties files. Use this property to
Default is not set encrypt sensitive data, such as user IDs and
passwords. Properties starting with “encrypted:”
are automatically decrypted at run-time.

For more information about encryption through

property files, refer to the Sterling Selling and
Fulfillment Foundation: Extending Transactions.

Example:

yfs.dblogin.datasource.name=encrypted:<encrypted
value>

Service Definition Framework (SDF) yfs.properties

The following table contains the Service Definition Framework yfs.properties and
descriptions.

48 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
Service Definition Framework (SDF)
yfs.smtp.session.reaptime Default = 10*60 seconds This is the frequency at which the JMS/SMTP
connection reaper thread will examine the connection
yfs.jms.session.reaptime pool for connections that are eligible to be closed. The
connection will be eligible to be closed if the connection
is idle for the number of seconds specified for the
reaptime. This property is specified in seconds.
yfs.smtp.connectionpool.enable Valid values = true or To disable SMTP connection pooling, set this property to
false false. IBM recommends setting this property to true for
performance reasons.
Default = true
Example:
yfs.smtp.connectionpool.enable=true
yfs.emailer.class The class that handles automated e-mail communication
to and from this application.

Example:

yfs.emailer.class=com.yantra.util.YFCEmailerImpl
yfs.email.template.encoding <encoding type> Handles encoding for e-mail communication to and
from this application.
Default = UTF-8
Example:

yfs.email.template.encoding=UTF-8
yfs.xsl.uriresolver <class name> This class can be used to provide a custom URIResolver
during XSL processing. Refer to the Java documentation
for more information on this interface.

If this property is not present, then the default

implementation provided by the XSL processor is used.
If set to
com.yantra.interop.util.YantraDefaultURIResolver an
attempt is made to resolve the URI within the classpath.
If set to another class name, this class is used in place of
the YantraDefaultURIResolver. The class given here
must implement the javax.xml.transform.URIResolver
interface.

Example:
yfs.xsl.uriresolver=com.yantra.interop.util.Yan
traDefaultURIResolver

Chapter 8. Property Files Reference 49

Property Values Description
yfs.sync.jms.request.timetolive <number of seconds> Request queue timetolive in seconds for Synchronous
JMS messages. Use this property to set the timetolive
Default = value for Synchronous JMS Messages. Note that, this
responseTimeOut value property is a global level override and is applicable for
of the receiver all the services using Synchronous JMS.

WARNING: If this property value is set beyond the

responseTimeOut value, it may result in unprocessed
request messages in the reply/response queue. By
default, in order to clean up the un-processed messages
from the reply/response queue, the timeToLive for
request messages is set to the responseTimeOut value of
the receiver.

Example:
yfs.sync.jms.request.timetolive=
yfs.sync.jms.request.timetolive. <number of seconds> Request queue timetolive in seconds for Synchronous
<SERVICE_NAME> JMS messages. Use this property to set the timetolive
Default = value for Synchronous JMS Messages. Note that, this
responseTimeOut value property is applicable only for the specified service.
of the receiver
WARNING: If this property value is set beyond the
responseTimeOut value, it may result in un-processed
request messages in the reply/response queue. By
default, in order to clean up the un-processed messages
from the reply/response queue, the timeToLive for
request messages is set to the responseTimeOut value of
the receiver.

Example:

yfs.sync.jms.request.timetolive.<SERVICE_NAME>=
yfs.reprocess.MaxErrorMessage Valid value = integer Setting this property will decide the length to which the
Length error message to be stored in YFS_REPROCESS_ERROR
Default = 4000 table should be truncated.

Example:

yfs.reprocess.MaxErrorMessageLength=
yfs.eof.wait.time Valid values =<number Set this property to indicate the time interval (in
of seconds> seconds) an EOF message must wait to lapse after
receiving an EOF message before executing the service.
Default = 300
Example: yfs.eof.wait.time=600

Rich Client Platform (RCP) yfs.properties

The following table contains the Rich Client Platform yfs.properties and
descriptions.

Property Values Description

Rich Client Platform (RCP)

50 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.rcp.devmode Valid values = Y or N Set the property to 'Y' if you want to run the
Rich Client Platform application in RCP dev
Default = N mode. When a Rich Client Platform application
is run in the RCP dev mode, the server-side
RCP validations such as commands validation
for security purposes are not done.

Example:
yfs.rcp.devmode=Y
logindialogontop Valid values = true or false By default, the Rich Client Platform log-in
window is displayed at the top and cannot be
Default = true minimized. To change the log-in window
behavior, set the value of the logindialogontop
property to false in the application ini file. If
you want the log-in window to be displayed at
the top, set the value of this property to true
(default behavior).

IBM Sterling Sensitive Data Capture Server (SSDCS)

yfs.properties
The following table contains the IBM Sterling Sensitive Data Capture Server
yfs.properties and descriptions.

Property Values Description

IBM Sterling Sensitive Data Capture Server (SSDCS)
yfs.document.domain A subdomain of the domain If a subdomain is specified, this setting exempts the
that the user is running on. subdomain from the Same Origin Policy. For
example, http://smcfs.stercomm.com and
http://ssdcs.stercomm.com would meet the Same
Origin Policy if they both set yfs.document.domain
to stercomm.com.

Example:

yfs.document.domain=stercomm.com

This property must also be set in the SSDCS

Properties file as
ssdcs.document.domain=stercomm.com.

For more information, see the Sterling Selling and

Fulfillment Foundation: Sterling Sensitive Data Capture
Server, Release 1.1: Configuration Guide.
yfs.ssdcs.url Valid value = Contains the URL to access the SSDCS application.
https://<host>:<port>/ssdcs This URL is not provided out of the box. You must
enter the SSDCS URL in this file to enable Sterling
Default = Selling and Fulfillment Foundation to contact
https://<host>:<port>/ssdcs SSDCS. The variables <host> and <port> are
placeholders that you must replace with the name of
the machine (not the IP address) and with the port.
Do not change anything else in the URL.

Example:
yfs.ssdcs.url=https://sterlingcommerce.com:8
080/ssdcs

Chapter 8. Property Files Reference 51

Property Values Description
yfs.ssdcs.servlet Valid value = /tokenize Contains the default servlet path that can be used in
UI coding. It is recommended that you do not
change this value.
yfs.ssdcs.jsp Valid value = Contains the default jsp path that can be used in UI
/jsp/ssdcs_tokenize_pan.jsp coding. It is recommended that you do not change
this value.
yfs.ssdcs.tokenize.cc Valid values = Y or N A Y/N property to determine if credit cards have to
be tokenized. Set the property to N if you do not
Default = Y want to make tokenization calls for credit cards.

Example:

yfs.ssdcs.tokenize.cc=Y
yfs.ssdcs.tokenize.svc Valid values = Y or N A Y/N property to determine if stored value cards
have to be tokenized. Set the property to N if you
Default = Y do not want to make tokenization calls for stored
value cards.

Example:

yfs.ssdcs.tokenize.svc=Y
sc.access.token.expire.in. Valid value = <number of This property indicates the default expire time (in
seconds seconds> seconds) for an access token.

Default = 600 seconds Example:

sc.access.token.expire.in.seconds=600
sc.access.token.max.allowed. Valid value = <number of This property indicates the maximum allowed expire
expire.in.seconds seconds> time (in seconds) for an access token. It can be used
to set the upper limit on allowed expire time for an
Default = 1800 seconds access token.

Example:

sc.access.token.max.allowed.expire.in.seconds=1800

System Management yfs.properties

The following table contains the System Management yfs.properties and
descriptions.

Property Values Description

System Management

52 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
rmi.portrange <minport> - <maxport> In a deployment with servers in two different
network zones, the firewall between them must
Default = 0 be configured to allow Remote Method
Invocation (RMI) communication between them.
When you specify a port range, a single, unused
port in that range will be selected for use. You
can specify multiple ranges separated by a
comma. If an open port cannot be found, an
exception will occur. If you specify 0, any
available port in the RMI range can be selected
for use. Do not specify the 0-1023 range or the
1024-49151 range.

Example:

rmi.portrange=49152-49162, 49170, 49180-49190

The next four properties are for the Health Monitor. The health monitor will raise the configured alerts when the
api/appServer response time or the agent Pending Job count crosses the threshold.
yantra.hm.api.threshold <number of milliseconds> api threshold in milliseconds, this is the system
default value used for average response time for
Default = 20000 milliseconds appservers. If this value is not specified 20000
milliseconds will be assumed.
yantra.hm.agent.threshold <job size> System default value used for the pending jobs
size for agents. If this value is not specified,
Default = 10000 10000 will be assumed.
yantra.hm.appserver.threshold <number of milliseconds> Appserver threshold in milliseconds, this is the
system default value used for average response
Default = 8000 milliseconds time for api's/services. If this value is not
specified 8000 milliseconds will be assumed.
yantra.hm.purge.interval <number of days> Health Monitor purge interval, this is the system
default value used for purging heartbeat and
Default = 30 days snapshot records. if this value is not specified 30
days purge interval is assumed.
yantra.statistics.collect Valid values = n, N, y, or Y Property to turn on Statistics logging.

Default = N Example:

yantra.statistics.collect=Y

Chapter 8. Property Files Reference 53

Property Values Description
yantra.statistics.persist.interval Valid values for minutes (M/m) Property to determine statistics logging time
= 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, or interval. Format of the property is Xm or Xh
30 where X is an integer between 1 and 60 and
M/m for minutes or H/h for hours.
Valid values for hours (H/h) = 1,
2, 3, 4, 6, 8, or 12 If any unrecognized value or unit is specified, it
will default to 10m (minutes).

If a value of 61m or greater is specified, it will

be reduced to 60m. If a value of 25h or greater is
specified, it will be reduced to 24h.

If the units are minutes (M/m), then the value is

rounded up or down to the nearest equal divisor
of 60 minutes.

If the units are hours (H/h), then the value is

rounded up or down to the nearest equal divisor
of 24 hours.

Example:

yantra.statistics.persist.interval=10m
yantra.shutdown.wait.timeout <number of milliseconds> Set this property to specify the maximum time
that the shutdown process should wait for
Default = 0 consumer transactions to finish before
proceeding with the shutdown. If a consumer
transaction does not finish before the specified
time, the shutdown will proceed, issuing a
rollback on the session/message.

The default value for this property is zero (0),

which maps to an indefinite wait.

Example:

yantra.shutdown.wait.timeout=30
systemlogger.rotatelogs Flag indicating whether to rotate the system log
after it has reached its maximum size. If this flag
is set to false the below two attributes will be
ignored and logger will continue to write in just
one log file. Set this flag to true to let the below
properties take effect.

Example: true
systemlogger.maxlogsize Maximum number of write operations after
which the log messages will be logged in a new
log file.

Example: 100000
systemlogger.maxnumlogs Maximum number of log files after which the
oldest log file should be deleted. If the value of
this flag is set 10, the 11th log file is created and
the first log file will be removed.

Example: 10

54 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.heartbeat.refresh.interval Valid values for minutes (M/m) Property to determine heartbeat refresh time
= 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, or interval. Format of the property is Xm or Xh
30 where X is an integer between 1 and 60 and
M/m for minutes or H/h for hours. If any
Valid values for minutes (H/h) = unrecognized value or unit is specified, it will
1, 2, 3, 4, 6, 8, or 12 default to 10m (minutes). If a value of 61m or
greater is specified, it will be reduced to 60m. If
Default = 10 m a value of 25h or greater is specified, it will be
reduced to 24h. If the units are minutes (M/m),
then the value is rounded up or down to the
nearest equal divisor of 60 minutes. If the units
are hours (H/h), then the value is rounded up
or down to the nearest equal divisor of 24 hours.

Example:
yfs.heartbeat.refresh.interval=10m

Note: IBM recommends that the value of this

property should be set greater than the value of
the yantra.statistics.persist.interval property.

User Interface yfs.properties

The following table contains User Interface yfs.properties and descriptions.

Property Values Description

User Interface
yfs.cache.size.regionmap Default =1000 Set this property to set the cache size, which
maintains a LRU cache of RegionMaps. If a
RegionMap needs to be inserted into the cache
beyond this size, the least recently accessed
RegionMap is removed from the map to provide
space for the new RegionMap.

Chapter 8. Property Files Reference 55

Property Values Description
yfs.config.lookuplimit Valid values =<integer> Set this property to determine number of records
needed before a drop down list is displayed as a
Default = 75 lookup text field.

Example:
yfs.config.lookuplimit=75

Note: The behavior of this property is described

below:

When the value of the yfs.config.lookuplimit is

not set:
v If the number of records is 75, only the lookup
text field is displayed.
v If the number of records is less than 75 but
greater than 20, the drop down list and
lookup text field are displayed.
v If the number of records is less than or equal
to 20, only the drop down list is displayed.

When the yfs.config.lookuplimit is set to a value

that is less than 20:
v If the number of records is greater than the set
value, only the lookup text field is displayed.
v If the number of records is less than or equal
to the set value, only the drop down list is
displayed.

When the yfs.config.lookuplimit is set to a value

that is greater than 20 but less than 75:
v If the number of records is less than the set
value but greater than 20, the drop down list
and lookup text field are displayed.
v If the number of records is greater than the set
value, only the lookup text field is displayed.
v Number of records is less than 20, only the
drop down list is displayed.
yfs.disable.webpages.caching Valid values = Y, y, N, or n Setting this property to 'Y' will disable caching of
Application pages.
Default = N
Example:
yfs.disable.webpages.caching=N
yfs.rcp.pca.updates.dir Set the property to specify the root folder under
which the updates for the PCAs are located. It
can be a shared folder on a network.

Example:
yfs.rcp.pca.updates.dir=<updates_directory>

56 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.rcp.pca.updates.cache.dir Set following property to a local cache directory,
where the updates need to be cached.

IMPORTANT: The updates cache directory

MUST NOT point to same location as the
yfs.rcp.pca.updates.dir. The cache directory is a
working directory and involves file I/O e.g. file
creations and deletions, etc.

Example:

yfs.rcp.pca.updates.cache.dir=<updates_directory>
yfc.ui.ListPageSize <number of records> Set this to determine number of records shown
on paginated list page.

Example:

yfc.ui.ListPageSize=30
yfs.login.redirect.url If the system needs to redirect to some custom
url upon error in the login page, this property
needs to be set to this url. If not specified, it will
redirect to the default login page. This property
can be specified in yfs.properties_ext file.

Example:

yfs.login.redirect.url=<REDIRECT_URL>
yfs.ui.MaxRecords <number of records> This property sets the number of records
displayed on a list screen. Increase the
Default = 200 application server JVM heap settings if these
parameters are increased. Change will affect
search limits for all users. The value of this
property should not exceed 999.

Example:

yfs.ui.MaxRecords=200
yfs.ui.queryTimeout <number of seconds> This property sets the number of seconds the
Application Console will wait for an SQL
Default = 60 Statement to execute. If the limit is exceeded, an
SQLException is thrown. Set to zero means
unlimited.

Example:

yfs.ui.queryTimeout=60
yfs.ui.defaultEncoding Default = UTF-8 This property controls the encoding of the
HTML sent to the client.

Example:

yfs.ui.defaultEncoding=UTF-8

Chapter 8. Property Files Reference 57

Property Values Description
yfs.config.java.plugin.codebase Valid values =<location of If you wish to install the Java plugin (used for
the plugin> the Applications Manager and HSDE's) in
intranet environments, configure this parameter
Default to point to the location of the plugin. If not
=http://java.sun.com/ passed, it defaults to http://java.sun.com/
update/1.4.2/jinstall- update/1.4.2/jinstall-1_4_2_03-windows-i586.cab.
1_4_2_03-windows-i586.cab
For more details, refer to

http://java.sun.com/products/archive/j2se/
1.4.2/jre/installwindows.html.

Example:

yfs.config.java.plugin.codebase=http://
java.sun.com/update/1.4.2/jinstall-1_4_2_03-
windows-i586.cab
yfs.config.password.noprompt Valid values = Y or N This enables the ability in the Applications
Manager to health monitor to popup a message
Default = N asking the user to log back via the console.

Example:

yfs.config.password.noprompt=N
yfs.rcp.ui.pagesize Default = 30 This property sets the maximum number of
records to display on a single page in the Table
on the Search List screen. This property is used
by PCA Applications.

Example:

yfs.rcp.ui.pagesize=30
yfs.gridLayout.maximumRecords Default is not set This property is used to limit the number of
records shown in grid screens in Mobile
Application.

For vt220 clients, because of memory

implications, this property shouldn't be set to
more than 7. If this property is not set or is not a
positive integer, the default value would be
taken as 7.

Example:

yfs.gridLayout.maximumRecords=
yfs.closemanifest.online Valid values = Y or N Manifesting options. Set this property to N to
close manifest asynchronously using the
CLOSE_MANIFEST Agent.

Example:

yfs.closemanifest.online=Y

58 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.showOrganizationName.enabled Valid values = Y or N This property can be used to enable the display
of Organization names instead of Organization
Default = N codes in screen titles of Applications Manager. To
display organization names, overwrite the
default by adding a line to
customer_overrides.properties:

Example:

yfs.yfs.showOrganizationName.enabled=Y

Warehouse Management yfs.properties

The following table contains Warehouse Management yfs.properties and
descriptions.

Property Values Description

Warehouse Management
yfs.allow.reuse.previouswave.slots Valid values = Y or N When dynamic slotting in configured, for the
second and subsequent wave releases, the
Default = Y previously slotted locations are considered in order
to minimize the number of locations. If this
property is set to N, the previously slotted locations
are not considered for the subsequent wave
releases.

Example:

yfs.allow.reuse.previouswave.slots=Y
yfs.solver.iterations.wavecreate The number of solver iterations for Create Wave.
Use this property to set the number of solver
iterations through which the create wave Agent
will undergo to optimize wave creation.

Example:

yfs.solver.iterations.wavecreate=1
yfs.cancelwave.offline.taskcount. Cancellation of wave happens in background
greaterthan depending upon the value of the property
yfs.cancelwave.offline.taskcount.greaterthan. If the
value of the property is for ex: 500 then
cancellation of a wave, which has open tasks more
than 500 included in it then the wave gets cancelled
in offline mode. Waves that have open tasks equal
to or less than 500 gets cancelled online.

Example:

yfs.cancelwave.offline.taskcount.greaterthan=-1

Chapter 8. Property Files Reference 59

Property Values Description
yfs.cancelwave.offline.shipmentcount. Cancellation of wave happens in background
greaterthan depending upon the value of the property
yfs.cancelwave.offline.shipmentcount.greaterthan. If
the value of the property is for ex: 500 then
cancellation of a wave, which has shipments more
than 500 included in it then the wave gets cancelled
in offline mode. Waves that have shipments equal
to or less than 500 gets cancelled online.

Example:

yfs.cancelwave.offline.shipmentcount.greaterthan=-1
yfs.cancelmove.offline.taskcount. Cancellation of move request happens in
greaterthan background depending upon the value of the
property
yfs.cancelmoverequest.offline.taskcount.greaterthan.
If the value of the property is for ex: 500 then
cancellation of a move request, which has open
tasks more than 500 included in it then the move
request gets cancelled in offline mode. Move
requests that have open tasks equal to or less than
500 gets cancelled online.

Example:

yfs.cancelmove.offline.taskcount.greaterthan=-1
yfs.suggesttask.onshortpick.tasktype If this property is enabled, the specified task or
list tasks will be suggested even if onhand inventory is
not available at the pick location. You can specify
multiple task type values for this property;
however, values must be separated by commas.

Example:

yfs.suggesttask.onshortpick.tasktypelist=<tasktype1>,
<tasktype2>,<tasktype3>
yfs.canceltask.onshortpick.tasktypelist Cancellation of specified tasktypes happens for the
remaining quantity on a short pick depending upon
the value of the
yfs.canceltask.onshortpick.tasktypelist. You can
specify multiple tasktype values for this property;
however, values must be separated by commas.

Example:

yfs.canceltask.onshortpick.tasktypelist=<tasktype1>,
<tasktype2>,<tasktype3>

Only tasktypes specified in

yfs.canceltask.onshortpick.tasktypelist= are
canceled, and if tasktype is not specified in this
property, the task is moved to hold status.

60 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.containerization.maxshipmentsin The containerizeWave API will use this property to
oneround select number of shipments to be considered for
creating the outbound containers in one round. API
will consider default value as 75 if value is not
specified for this property.

Example:

yfs.containerization.maxshipmentsinoneround=75
yfs.prevent.palletlabel.for.parcel During containerization, the system creates Pallet
shipment.tasktypelist labels if the item has an alternate UOM with LPN
type = Pallet and the containerization quantity
matches the alternate UOM quantity. But for Parcel
shipments, creation of Pallet labels can be
prevented by specifying the task type to this
property. You can specify multiple task type values
for this property; however, values must be
separated by commas. If this property is not set or
if the task is not among the task types mentioned
in the property value list, the system will retain the
default behavior.

Example:
yfs.prevent.palletlabel.for.parcel
shipment.tasktypelist=<tasktype1>,
<tasktype2>,<tasktype3>
yfs.install.createWave.delayhours The CREATE WAVE FOR SHIPMENT GROUP
agent uses this property to increase the Available
date (in hours) of YFS_Task_Q records with
transaction key "CREATE_WAVE_TASK_Q.4001"
against which no waves could be created.

Agent considers default value as 1 if value is not

specified for this property. If set to -1, the
YFS_Task_Q records with transaction key
"CREATE_WAVE_TASK_Q.4001" for which no
waves are generated, will be deleted.

Example:

yfs.install.createWave.delayhours=1
yfs.createwave.dbRead.numShipment Default = 20000 The CREATE WAVE agent uses this property to
Lines read maximum number of shipment lines from
database in a single query.

Example:

yfs.createwave.dbRead.numShipmentLines=20000
yfs.createwave.process.numShipment Default = 50000 The CREATE WAVE agent uses this property in
Lines order to determine the maximum number of
shipment lines for optimal memory utilization
during wave creation.

Example:

yfs.createwave.process.numShipmentLines=50000

Chapter 8. Property Files Reference 61

Property Values Description
yfs.releasetask.ignore.wavesequence Valid values = Y or N If this property is set to “Y”, the RELEASE TASK
agent ignores the wave sequence when releasing
tasks. For example, if there are two waves having
the same priority, but different sequence numbers,
and if the tasks for the wave having a lower
sequence number cannot be released, the tasks for
the wave having a higher sequence number will be
released.

Example:

yfs.releasetask.ignore.wavesequence=Y
yfs.wms.resourceplanning.QueueName Set these JMS properties to enable resource
planning move.
yfs.wms.resourceplanning.Provider
URL Examples:

yfs.wms.resourceplanning.QCF yfs.wms.resourceplanning.QueueName=Default
LookUp AgentQueue

yfs.wms.resourceplanning.ProviderURL=t3://
localhost:7001

yfs.wms.resourceplanning.QCFLookUp=AGENT_
QCF
yfs.wms.zonetransattr.refreshrate Default = 600 seconds getZoneDetails API uses the below mentioned
property to refresh the zone attributes: available
volume, available weight, pending volume and
pending weight in the table
YFS_TRAN_ZONE_ATTRS. These zone attributes
are aggregates of the location attributes. Zone
attributes # are refreshed after specified time
intervals which is defined by this property.

Example:

yfs.wms.zonetransattr.refreshrate=600
yfs.releaseWave.SortShipmentsByDate Valid values = Y or N During Release wave, if shipments need to be
AndKey allocated quantity based on requested shipment
Default = N dates, set this property to "Y".

Example:

yfs.releaseWave.SortShipmentsByDateAndKey=N
yfs.default.inventorystatus.for.new In case of counting through mobile application if
inventory user counts new inventory, system currently
displays first inventory status of the node as
defaulted. If this behavior needs to be overridden,
then the below property needs to be set with valid
inventory status which will be used as default
inventory status for new inventory. If this property
is not set, system will retain the current behavior.

Example:

yfs.default.inventorystatus.for.newinventory=

62 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.closemanifest.online Valid values = Y or N Manifesting options. Set this property to N to close
manifest asynchronously using the
CLOSE_MANIFEST Agent.

Example:

yfs.closemanifest.online=Y
yfs.confirmbatch.online Valid values = Y or N Batch completion options. Set this property to N to
complete batch asynchronously using the
REQ_BATCH_COMPLETION Agent.

Example:

yfs.confirmbatch.online=Y
yfs.reopentask.time Default = 1 hour The re-open task agent will change the status of a
suggested task back to open status, if the task is
not modified for the time specified by this property.
This property is specified in hours.

Example:

yfs.reopentask.time=1
yfs.serial.receiving Valid values = Y or N Set this property to 'Y' to process one serial at a
time during receiving i.e on scanning one serial
user is taken to Disposition Code entry screen.

Example:

yfs.serial.receiving=N
yfs.releasetaskagent.mode Valid values = releaseTaskAgent uses this property to select the
mode of execution for releasing tasks.
01: Location Driven.
All the pending tasks Example:
from the location are
evaluated. yfs.releasetaskagent.mode=01

02: Reference (eg.

ShipmentNo) Driven.
All the pending tasks
for the reference are
evaluated.

Default = 01

Chapter 8. Property Files Reference 63

Property Values Description
yfs.retain.pack.tasks.for.minute Default = 60 minutes In case of item driven packing, shipment level
transaction locks are created in order to reserve the
shipment against the packer. Once the shipment
packing is complete, these transaction locks are
deleted from DB.

If for some reason packing for this shipment cannot

be completed by the packer, these transaction locks
block other users from packing this shipment.

This property can used to define maximum time, in

minutes, for which the shipment level transaction
locks are retained. If it is set to 120, and a user
scans a Pallet in Pack HSDE, transaction locks
created 120 minutes before will be deleted so that
the unpacked blocked shipment becomes available
to other users.

Example:

yfs.retain.pack.tasks.for.minutes=60
yfs.override.user.constraints.for. Valid values = Y or N Based on this property, the maximum user
manually.assigned.task constraints defined for a task type will be
Default = N evaluated. If task is manually assigned to a user
and this property is set to Y, the maximum user
constraint defined for task type will not be
honoured. To retain the existing behavior, set this
property to N.

Example:

yfs.override.user.constraints.for.manually.assigned.
task=N
yfs.displayTaskInfoDetails Valid values = Y or N Set this property to 'Y' to show the task details
(Pick Location, Item ID and Quantity) in RF mobile
Default = N terminal when tasktype is defined to say pick onto
equipment. This provides user an ability to
determine whether he needs to carry a pallet/case
to pick inventory even before he goes to the pick
location.

Example:

yfs.displayTaskInfoDetails=N
yfs.override.pendingallocations.for. Valid values = Y or N If Delayed Inventory Allocation Support is
adhocmoves configured in a Node, the default behavior is that
Default = N system will wait to complete the pending allocation
before creating new tasks. Setting this property to Y
allows ad-hoc move operations on Mobile
Application to be processed by the system without
waiting for the Allocate Task agent to complete the
pending allocation.

Example:

yfs.override.pendingallocations.for.adhocmoves=Y

64 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Values Description
yfs.allow.container.quantity.adjustment Valid values = Y or N In case of picking through mobile application if
user picks a full LPN, system currently doesn't
provide an option to adjust the discrepancies. To
allow user to adjust the discrepancies in the license
plates, the property needs to be set to Y. If this
property is not set or set to N, system will retain
the current behavior.

Example:

yfs.allow.container.quantity.adjustment=
yfs.determine.shipmentgroup.for. Valid values = Y or N Set this property to “N” to prevent the shipment
shipment group determination during shipment creation. The
Default = Y shipment group for these shipments is determined
later by the CREATE WAVE FOR SHIPMENT
GROUP agent.
yfs.split.reference.across.totes Valid values = Y or N If this property is set to “Y”, the system throws a
warning when a user picks the same reference,
such as shipment, move request, or batch into
multiple to totes or target LPNs when performing
cart picking through the Sterling Supply Chain
Mobile Application.
yfs.createwave.lookfor Valid values = Y Set this property to “N” to avoid item ID IN clause
similarshipments during the Wave Creation process. It potentially
results in an increased performance when a high
number of similar shipments are being waved.

dbclassCache.properties.*
The dbclassCache.properties file contains a list of the Sterling Selling and
Fulfillment Foundation tables and the associated DBCache class. Every table listed
will be registered with the cache manager with the default cache sizes. The
dbclassCache.properties file also contains the global settings for the DBCache
classes, and additional properties that can be uncommented and set as needed. Do
not make changes directly to the dbclassCache.properties file; instead, use the
customer_overrides.properties file.

Property Values Description

sci.globalcache.select.size Any positive integer, Default maximum size of the “select” database cache
defaults to 10000 for a given table. This is the number of select
statements that return a single record that will be
cached.
sci.globalcache.list.size Any positive integer, Default maximum size of the “list” database cache
defaults to 10000 for a given table. This is the number of select
statements that return a multiple records that will be
cached.
sci.globalcache.count.size Any positive integer, Default maximum size of the “count” database cache
defaults to 10000 for a given table. This is the number of select
statements that count records that will be cached.

Chapter 8. Property Files Reference 65

Property Values Description
sci.globalcache.object.size Any positive integer, Default maximum size of the “object” database cache
defaults to 10000 for a given table. This is the total number of
resulting database objects across the “select” and
“list” caches that will be cached. If this limit is
reached, all database caches for the table are
dropped

The dbclassCache.properties file also lists the cacheable tables, in the form of
<TableName>.class=<cache implementation>. This would only be changed/added
by applications.

Each table also supports overriding the defaults provided in the globalcache
settings. For example, using YFS_COMMON_CODE as the table name:

Property Values Description

YFS_COMMON_CODE.enabled true or false. Default value is Whether the database cache is enabled. Set
true. to false to disable caching.
YFS_COMMON_CODE.select.size Any positive integer, defaults to Override the “select” cache size for the
value of given table.
sci.globalcache.select.size
YFS_COMMON_CODE.list.size Any positive integer, defaults to Override the “list” cache size for the given
value of sci.globalcache.list.size table.
YFS_COMMON_CODE.count.size Any positive integer, defaults to Override the “count” cache size for the
value of given table.
sci.globalcache.count.size
YFS_COMMON_CODE.object.size Any positive integer, defaults to Override the “object” cache size for the
value of given table.
sci.globalcache.object.size

Sandbox.cfg
Sandbox.cfg contains properties related to system and database information.

Note: Sandbox.cfg contains ports used by multiple IBM applications in addition to

Sterling Selling and Fulfillment Foundation. For Sterling Selling and Fulfillment
Foundation, only the ports defined in the following table are in use by the
application. Other ports defined in sandbox.cfg are not in use and do not conflict
with ports that may be required by other applications running on the same host.
Specifically, Sterling Selling and Fulfillment Foundation uses only a subset of the
database ports: DB_PORT, DB2_PORT, MSSQL_PORT, ORA_PORT, based on your
database vendor. Your application server vendor requires additional ports, not
described here. Refer to the vendor's documentation to determine the ports that
may be required by the application server. The following table provides
descriptions of the ports used by Sterling Selling and Fulfillment Foundation. The
table does not provide information about ports used by other IBM applications.

Note: The sandbox.cfg file is not used at runtime by the product. If you change a
parameter in the sandbox.cfg file at any time, you must run the setupfiles script
so that the runtime property files are re-created with the updated values.

Sandbox.cfg Installation Properties

The following are sandbox.cfg Installation properties and descriptions.

66 Sterling Selling and Fulfillment Foundation: Properties Guide

 Property
Description
Installation
ADDITIONAL_ANT_JAVA_TASK_ARGS
During the installation, you can pass JVM-specific arguments to avoid
out-of-memory errors.
Example: -Xms1024m -Xmx1408m -XX:MaxPermSize=512m
ADDITIONAL_ANT_COMPILER_TASK_ARGS
During installation, you can pass initial and maximum JVM-specific
arguments to avoid out-of-memory errors.
Example:
ADDITIONAL_ANT_COMPILER_TASK_ARGS=-J-Xms1024m -J-Xmx1536m
JVM_LOC
Source of downloaded JDK files, external to Sterling Selling and
Fulfillment Foundation application files.
Example: <jdk_dir>
JAVA_HOME
Points to the location of the Java SDK that is used for the installation. This
location can be the directory with the downloaded JDK files (JVM_LOC) or
it can be the Sterling Selling and Fulfillment Foundation directory to which
they have been copied during installation.
Example: <jdk_dir> or <INSTALL_DIR>/jdk
DB_CLEAN
Deletes all objects from the database for the user. The GUI installer sets
this property to false.
Valid values = true or false
Default: true
ENTITY_GEN_LOGLEVEL
Specify VERBOSE to enable logging of verbose messages during entity
class generation.
Valid values = VERBOSE or INFO
Default: INFO
OVERRIDE_LOAD_DEFAULTS_PK_GEN
Specify "true" to generate unique primary keys for entities across
deployments before installation.
Valid values = true or false
Default: false

Sandbox.cfg Agent Property

The following is a sandbox.cfg Agent property and description.
Property
Description
Agent

Chapter 8. Property Files Reference 67

 AGENT_JAVA_HOME
Overrides the java that the agents use. For instance, if, with WebSphere,
you wanted to use the IBM jdk, you could set this parameter to a new
value.

Sandbox.cfg Internal Properties

The following table contains sandbox.cfg Internal properties and descriptions.

Property Description
Internal
COPY_FCXML_TO_REPOSITORY Only used at install time.

Required. Installs the files related to the database factory defaults in

the <INSTALL_DIR>/repository/factorysetup directory. This enables
you to delete the <INSTALL_DIR>/installed_data/<package_name>/
factorysetup directory after installation, as it contains other files that
take up space.

The GUI installer sets this property to true.

Valid values = true or false

Default: true
Note: This property should be set to true.
DB_DATA Only used at install time. Database name to connect to.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
DB_DRIVERS Only used at install time. Full path to JDBC driver file.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
DB_HOST Only used at install time. Database host to connect to.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
DB_JAR_DIR Only used at install time.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
DB_PASS Database password to connect with.
DB_POOL Note: To change this database property after installation, use the
database specific properties (see the properties in the Database
section of this table).
DB_PORT Only used at install time. Database listener port.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).

68 Sterling Selling and Fulfillment Foundation: Properties Guide

Property Description
DB_USER Database login ID to connect with.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
DB_VENDOR Required. The DB vendor to use. Valid values are Oracle, DB2, or
MSSQL.

Note: To change this database property after installation, use the

database specific properties (see the properties in the Database
section of this table).
INSTALL_DIR Required. Directory in which to install.
JDBC_DRIVER Path to database driver file.
PLATFORM_AFC_BUILD_NUMBER It is recommended that you do not change this value.

Example: 5000
PLATFORM_AFC_LIC_PROD_VERSION It is recommended that you do not change this value.

Example: 5_0
PLATFORM_AFC_PRODUCT_LABEL It is recommended that you do not change this value.

Example: platform_afc
SI_LICENSE_AVAILABLE Indicator of if a license is being passed in and is required for
installation. Valid values are Yes or No (default).
NOAPP_HOME These properties should only be changed as a group.

CLASS_DIR

HOME_DIR

VENDORS_DIR

DEPLOYED_APP_DIR

BIN_DIR

APPBEANS_DIR

SVC_DIR

DIST_DIR

Sandbox.cfg SQL Proxy Tool Properties

The following describes sandbox.cfg SQL Proxy Tool properties and descriptions.
Property
Description
SQLProxy Tool
To set up the SQL Proxy tool, add the following properties to
customer_overrides.properties prior to starting the application server or
noapp server. These will override settings for these properties that are in
jdbc.properties. For more information, see Sterling Selling and Fulfillment
Foundation: Extending the Database.
jdbcService.proxyLoggingEnabled
Valid values are Y or N. Specifies whether SQLProxy logging is enabled.

Chapter 8. Property Files Reference 69

 Example: jdbcService.proxyLoggingEnabled=Y
jdbcService.proxySourceLogging
Valid values are Y or N. Used when enabling SQLProxy.
Example: jdbcService.proxySourceLogging=Y
jdbcService.proxyLogDir
Valid values are Y or N. Specifies the directory where the trace files will be
generated.
Example: jdbcService.proxyLogDir=<INSTALL_DIR>/logs/sqlproxylogs
jdbcService.mssqlPool_local.driver
Set the jdbcService.mssqlPool_local.driver property to
com.yantra.jdbc.driver.SCIProxyDriver.
Example:
jdbcService.mssqlPool_local.driver=com.yantra.jdbc.driver.SCIProxyDriver
jdbcService.mssqlPool_NoTrans.driver
Set the jdbcService.mssqlPool_NoTrans.driver property to
com.yantra.jdbc.driver.SCIProxyDriver.
Example:
jdbcService.mssqlPool_NoTrans.driver=com.yantra.jdbc.driver.SCIProxyDriver

Sandbox.cfg Database Properties

The following are sandbox.cfg Database properties and descriptions.
Property
Description
Database
These are database-related properties that can be changed after installation.
Use the vendor-specific properties in this section to make changes to your
installed database's properties.

Note: You cannot change the database provider for a specific smcfs
instance after installation.
DB_SCHEMA_OWNER
Default schema/schema-owner for the provided login ID.
JDBC_VENDOR
JDBC driver vendor. Used when multiple vendor are available. Default is
Microsoft.
DB2_DATA
If using DB2, the database name to connect with.
DB2_HOST
If using DB2, the database host to connect to.
DB2_PASS
If using DB2, the database password to connect with.
DB2_PORT
If using DB2, the database listener port.
DB2_USER
If using DB2, the database login ID to connect with.

70 Sterling Selling and Fulfillment Foundation: Properties Guide

 MSSQL_DATA
If using MSSQL, the database name to connect with. Valid for both
MSSQL2000 and MSSQL2005.
MSSQL_HOST
If using MSSQL, the database host to connect to. Valid for both
MSSQL2000 and MSSQL2005.
MSSQL_PASS
If using MSSQL, the database password to connect with. Valid for both
MSSQL2000 and MSSQL2005.
MSSQL_PORT
If using MSSQL, the database listener port. Valid for both MSSQL2000 and
MSSQL2005.
MSSQL_USER
If using MSSQL, the database login ID to connect with. Valid for both
MSSQL2000 and MSSQL2005.
ORA_HOST
If using Oracle, the database host to connect to.
ORACLE_NLS_LENGTH_SEMANTICS
Indicates the type of length semantic to be used for Oracle database, when
using the dbverfiy tool.
Valid values = CHAR or BYTE
Default: BYTE
Example: BYTE

Note: If the database or the specific session in which database was created
has length semantic as CHAR, this property should be set to CHAR before
running the dbverify tool.
ORA_PASS
If using Oracle, the database password to connect with.
ORA_PORT
If using Oracle, the database listener port.
ORA_TS
Indicates the kind of text search index to be used for Oracle database,
when using the dbverify tool.
Valid values = CTXCAT or CONTEXT
Default: CTXCAT
Example: CTXCAT
ORA_USER
If using Oracle, the database login ID to connect with.

Sandbox.cfg DB Pooling Properties

The following are sandbox.cfg DB Pooling properties and descriptions.
Property
Description
DB Pooling

Chapter 8. Property Files Reference 71

 MIN_TRANS_POOL
mssqlPool.initsize
MAX_TRANS_POOL
mssqlPool.maxsize

Sandbox.cfg Product Documentation Library Properties

The following are the sandbox.cfg Product Documentation properties and
descriptions.
Property
Description
Product Documentation Libraries
ACTIVE_DOC_URL
This value determines whether the Help > View Product Documentation
menu item invokes the Online Documentation Library
(ONLINE_DOC_URL) or the Local Documentation Library
(LOCAL_DOC_URL).
The Online Documentation Library consists of a IBM web-hosted Sterling
Selling and Fulfillment Foundation documentation set in HTML and PDF
format.
The Local Documentation Library consists of a locally hosted Sterling
Selling and Fulfillment Foundation documentation set in HTML format.
This value is chosen during the GUI and text-based installations, which
write the value out to the ONLINE_DOC_URL and LOCAL_DOC_URL
properties. In the silent installation, you must define these values, as
explained in the Sterling Selling and Fulfillment Foundation: Installation Guide.
If the correct URL is not entered, users will receive a “404 Not Found”
error when they click the View Product Documentation option on the Help
menu.
After installation, you can switch between the Online and Local
Documentation Libraries by overriding the ACTIVE_DOC_URL property.

Note: These properties are different from the properties described in this
guide for Context-Sensitive Help. Also, the Sterling Selling and Fulfillment
Foundation: Installation Guide describes connection settings for
Context-Sensitive Help.
Examples:
ACTIVE_DOC_URL = ONLINE (default)
ACTIVE_DOC_URL = LOCAL
For more information, see the Sterling Selling and Fulfillment Foundation:
Installation Guide.
ONLINE_DOC_URL
The value of this property is the URL for the IBM-hosted web page that
contains the Sterling Selling and Fulfillment Foundation Online
Documentation Library HTML and PDF format.
Example:
ONLINE_DOC_URL=http://help.sterlingcommerce.com/SFSF91/index.jsp

72 Sterling Selling and Fulfillment Foundation: Properties Guide

 This URL cannot be changed. The first time a user visits this IBM-hosted
web page, registration is required. Subsequent visits require only login.
LOCAL_DOC_URL
The value of this property is the URL for the local instance of the Sterling
Selling and Fulfillment Foundation Local Documentation Library in HTML
format.
Example:
LOCAL_DOC_URL=/smcfsdocs/yfscommon/online_help/
en_US/wwhelp/wwhimpl/js/html/wwhelp.htm

Sandbox.cfg Implementation Properties

The following are the sandbox.cfg Implementation properties and descriptions.
Property
Description
Implementation
These are properties that can be changed after installation.
LOAD_FACTORY_SETUP
Indicates whether or not you want to load factory setup defaults during
installation or manually after installation.
AUDIT_LOAD_DEFAULTS
Valid values are true or false. When set to true the audits are generated
when the loadDefaults script is run.
LOG_DIR
Use to override the logging directory. For example, if you want to deploy
the ear on another server you could set the parameter to a new value, run
setupfiles, then build the ear. The application would then log to the
directory you mentioned.
MAX_MEMORY
The maximum amount of memory.
Example: 512
NO_DBVERIFY
Valid values are true or false. When set to true during installation and
install service, dbverify will not be run. This means that Sterling Selling
and Fulfillment Foundation will not generate DDL to make the database
like the XML entity repository.
REINIT_DB
Whether Sterling Selling and Fulfillment Foundation should initialize the
database or not. Valid values are Yes (default) or No.
OVERRIDE_LOAD_DEFAULTS_PK_GEN
Valid values are "true" or "false". Set the property to "true" to generate
unique primary keys for entities across deployments. Default value is
"false".

Sandbox.cfg Localization Property

The following is the sandbox.cfg Localization property and description.
Property
Description

Chapter 8. Property Files Reference 73

 Localization
SUPPORT_MULTIBYTE
Valid values are Y or N. If you are installing on a DB2 or Microsoft SQL
Server® and need to localize your database using a multi-byte character set,
set this flag to Y. This ensures that the database column sizes are large
enough to handle the multibyte characters correctly.

Sandbox.cfg Multischema Properties

The following are sandbox.cfg Multischema properties and descriptions.
Property
Description
Multischema
multischema.enabled
Valid values are true or false. During installation, this property in the silent
installation file indicates whether this is a multischema installation. If true,
the installation looks for a customer-created multischema.xml file, which
specifies database information for the Configuration, Metadata,
Transaction, and Statistics schemas. Specify this property in lowercase only.
Example: multischema.enabled = true
For more information, see the Sterling Selling and Fulfillment Foundation:
Installation Guide.
multischema.version
(Required) During installation, this property in the silent installation file
indicates which Sterling Selling and Fulfillment Foundation version is
being installed. Specify this property in lowercase only.
Example: multischema.version = 8.5 (recommended with Version 8.5
installation)
multischema.file
During installation, this property in the silent installation file indicates the
name of the user-defined XML file that contains multischema database
information. Specify this property in lowercase only.
Example: multischema.file = multischema.xml
For more information, see the Sterling Selling and Fulfillment Foundation:
Installation Guide.
STERLING_FOUNDATION_PRODUCT_LABEL
(Required) Specifies the product label.
Example: STERLING_FOUNDATION_PRODUCT_LABEL = Sterling Selling
and Fulfillment Foundation
STERLING_FOUNDATION_PRODUCT_VERSION
(Required) Specifies the product version you are installing.
Example: STERLING_FOUNDATION_PRODUCT_VERSION = 9.0

Sandbox.cfg Sterling Application Platform Properties

The following are sandbox.cfg IBM Sterling Application Platform properties.
Property
Description

74 Sterling Selling and Fulfillment Foundation: Properties Guide

Application Platform
ANT_DIR
Contains the ant binaries used in the java deployer and other deployment
and build scripts.
Example: install_dir/ant
ANT_VER
The version of the ant released with an application. It is recommended that
you do not change this value.
Example: 1_6_5
DOC_DIR
The root directory for the XAPI documentation. This is exported in the
tmp.sh command.
Example: install_dir
JAR_DIR
Directory used by install and install3rdParty to store 3rd party software jar
files (referenced by the dynamic class loader and tmp.sh for the java
classpath).
Example: install_dir/jar
JAVADOC_COPYRIGHT_INFO_LABEL
It is recommended that you do not change this value.
Example: Copyright IBM Corp. 1999-2010 All Rights Reserved.
JAVADOC_PRODUCT_LABEL
It is recommended that you do not change this value.
Example: Platform_Javadocs.
JDK64BIT
Specifies whether you're using a 32-bit JDK or a 64-bit JDK. This setting is
important for interactive password libraries and other operating system
tie-ins. These are non-Java libraries.
Default: true (indicates 64-bit JDK)
Example: false (indicates 32-bit JDK)
LIC_PROD_VERSION
Product version (not build version). It is recommended that you do not
change this value.
Example: 2.0
ORA_TS_CONTEXT
Indicates the kind of text search index to be used for Oracle database,
when using the dbverify tool.
Valid values = CTXCAT or CONTEXT
Default: CTXCAT
Example: CTXCAT
PROP_DIR
Path to the properties subdirectory for the an application installation.
Example: install_dir/properties

Chapter 8. Property Files Reference 75

 SYSTEMP_DIR
Derived from the INSTALL_DIR property, which is the user-specified root
of the directory structure for an application on the file system. This is the
location where temporary files are used.
Example: install_dir/tmp
XALAN_VER
Used to specify which version of the Xalan jars is being used. When there
are multiple JDKs, different versions of these jars are required. It is
recommended that you do not change this value.
Example: 2_5_2
XERCES_VER
Used to specify which version of the Xerces jars is being used. When there
are multiple JDKs, different versions of these jars are required. It is
recommended that you do not change this value.
Example: 2_6_0

76 Sterling Selling and Fulfillment Foundation: Properties Guide

Notices
This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785

U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,

contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law

IBM Japan Ltd.

19-21, Nihonbashi-Hakozakicho, Chuo-ku

Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be

© Copyright IBM Corp. 1999, 2014 77

 incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Corporation

J46A/G4

555 Bailey Avenue

San Jose, CA 95141-1003

U.S.A.

Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

Any performance data contained herein was determined in a controlled

environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.

78 Sterling Selling and Fulfillment Foundation: Properties Guide

This information is for planning purposes only. The information herein is subject to
change before the products described become available.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which

illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:

© IBM 2014. Portions of this code are derived from IBM Corp. Sample Programs. ©
Copyright IBM Corp. 2014.

If you are viewing this information softcopy, the photographs and color
illustrations may not appear.

Trademarks

IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “Copyright and
trademark information” at http://www.ibm.com/legal/copytrade.shtml.

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States,
and/or other countries.

IT Infrastructure Library is a registered trademark of the Central Computer and

Telecommunications Agency which is now part of the Office of Government
Commerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,
Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or
registered trademarks of Intel Corporation or its subsidiaries in the United States
and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

Notices 79
 Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

ITIL is a registered trademark, and a registered community trademark of the Office

of Government Commerce, and is registered in the U.S. Patent and Trademark
Office.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the

United States, other countries, or both and is used under license therefrom.

Linear Tape-Open, LTO, the LTO Logo, Ultrium and the Ultrium Logo are
trademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.

Connect Control Center®, Connect:Direct®, Connect:Enterprise®, Gentran®,

Gentran®:Basic®, Gentran:Control®, Gentran:Director®, Gentran:Plus®,
Gentran:Realtime®, Gentran:Server®, Gentran:Viewpoint®, Sterling Commerce™,
Sterling Information Broker®, and Sterling Integrator® are trademarks or registered
trademarks of Sterling Commerce®, Inc., an IBM Company.

Other company, product, and service names may be trademarks or service marks
of others.

80 Sterling Selling and Fulfillment Foundation: Properties Guide

Index
A
Applications Manager 10

C
cache for catalog search index
configuring 19

L
LDAP user authentication 9
assumption 9
for application consoles 9
modifying weblogic startup file 10
modifying yfs.properties
customer_overrides.properties 10
password expiration 9
change password link 9
expire in days 9
properties 9
log files
setting up 11
log4j configuration file 11
logging
masking sensitive information using
log4j utility 12
properties 11

M
masking sensitive information during
logging 12
memory usage for catalog search index
limiting 19

O
Oracle database
production environment
setting connection properties 23

P
password expiration 9

S
Setting Oracle Database Connection
Properties 23
setting up Selling and Fulfillment
Foundation 1

© Copyright IBM Corp. 1999, 2014 81

82 Sterling Selling and Fulfillment Foundation: Properties Guide



Printed in USA