Implementation yfs.properties

Use the customer_overrides.properties file to override properties in the implementation category of yfs.properties.

The following table explains the implementation yfs.properties and its description:

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.
yfs.api.history.disable Valid values = true or false

Default = false

This property controls access to history tables. If the value of this flag is set to “true”, access to the entire deployment's history tables is suppressed and the select, list, and count operations on history tables return no data.
  • A select operation returns null.
  • A list operation returns an empty list.
  • A count operation returns a zero count.

Also, if update, delete, and insert operations are attempted on history tables, the system throws an exception.

This property enables applications to suppress history so that the system can be started after you upgrade the transaction data, even before history upgrades are complete.

yfs.api.history.disable.colony.<colony_id> Valid values = <colony_id>,
true or false

Default = false

This property controls access to history tables for specific colonies, instead of disabling history access for the entire deployment. If this property is not set 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 on.

Example:

If history access is to be disabled for a colony with the colony ID NewColony, set the property as yfs.api.history.disable.colony.NewColony = true

yfs.api.output.namespace.enabled Valid values = true or false

Default = false

To set the output namespace on the API output, set the value to true.
yfs.comsupport Valid values = Y or N

Default = Y

Indicates whether your system supports COM. If COM is enabled, you can configure actions to call COM objects.
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.
log4j.configuration <Property Name>

Default = /resources/log4jconfig.xml

Property to handle logging. This property points to the location of the log4j configuration XML file.
CaseInsensitiveSearch.Mode Valid Values = DISABLED, ENABLED, or MIXED

Default = ENABLED

This property specifies the following configuration modes to enable or disable case-insensitive search across entities.
  • Disabled: Search is case-insensitive, and performed on the original column only.
  • Enabled: Search is case-insensitive and performed on the shadow column, which is generated once this attribute is set.
  • 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 following format:


<ENTITY_NAME>.CaseInsensitiveSearch.Mode=ENABLED
Example,

YFS_INBOX.CaseInsensitiveSearch.Mode=ENABLED

To enable case insensitivity at a column level, use the following format:


<ENTITY_NAME>.<COLUMN_NAME>.CaseInsensitive
Search.Mode=ENABLED

For example, YFS_INBOX.ALERT_TYPE.CaseInsensitiveSearch.Mode=ENABLED

yfs.install.localecode <locale code>

Set to en_US_EST when the application is delivered. If changes are necessary, this must be changed by users.

The installation locale code. To avoid timezone calculation errors, the locale code must match the OS default timezone where the database is installed. The locale code must also be same as the server's OS default timezone.
yfs.install.displaydoublequantity Valid values = Y or N

Default = Y

This property should be set to "Y" if you want to support fractional quantities for attributes that belong to QUANTITY data type.
yfs.file.encoding <Property name>

Default = UTF-8

This property controls the encoding of the files, like API template, theme XMLs, exception template, except for email templates, which is controlled by yfs.email.template.encoding.
yantra.app.maxrecords <number of records>

Default = 5000

This property sets the default number of records that are returned by Application list APIs. Increase the application server JVM heap settings if these parameters are increased. Change will affect search limits for all users.
yfs.app.identifyconnection Valid values = Y or N

Default = N

Set this property to Y to enable the application to set contextual information for an agent or API name on the connection. The information that is stamped on the connection can be viewed on the database connection by the tools that are 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, Db2, and PostgreSQL databases.
enable.resource.addition Valid values = true or false

Default = false

Set this property to true if you want to add new resources from the Applications Manager. The default value is false.
yfs.uidev.refreshResources Valid values = Y or N

Default = N

This property can be set to Y when developing and customizing the Application Console UI.

When set to Y, refresh actions will be available within the Resource Hierarchy tree. These actions can be used to refresh the resources that are used in the Console UI Framework without having to restart the application server.

If this property is not set to Y, then the actions are disabled , and it will be necessary to restart the application server whenever any resource is changed within the Applications Manager.

Note: Ensure that you do not set the value to Y for production systems as refresh works only for a single user development environment.
yantra.document.isnamespaceaware Valid values = Y or N

Default = N

Set the value of this property to Y to handle namespaces in XML.
Note: To run an API using HTTP API Tester, set the default namespace as <Order xmlns="http://www.sterlingcommerce.com/documentation/YFS/createOrder/input" DocumentType="0001" EnterpriseCode="DEFAULT" />
yantra.document.suppress.huge.doc.alert Valid values = true or false

Default = false

Set this property to enable or disable printing a document that contains more than one million nodes.

If you set the value of this property to true, the document is not printed and a warning message will be displayed.

If you set the value to false, the retain behavior is defaulted.

com.yantra.ycp.em.server.taskpollingtime <number of seconds>

Default = 60

Set the value of this property in seconds to indicate the interval at which the tasks needs to be polled for mobile operators. For example, com.yantra.ycp.em.server.taskpollingtime=60.
OverrideTransitTime Valid values = Y or N

Default = N

If you pass both request delivery and request ship dates, and set this property, the transit time is calculated as the difference of these two dates, and no further transit time computation is needed.
yfs.install.applyshipdateoptimization Valid values = Y or N Set this property to N, if allocation should not optimize releases based on ReqShipDate.
yfs.audit.user.session.activity Valid values = Y or N

Default = Y (audit enabled)

Set this property to enable or disable auditing.
yfs.bundleProperties.multipleLoad=Y Default: locale is en_US When this property is set to N, the system will not 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 uses the default locale for string translations.
yfs.logall Valid values = Y or N

Default=N

Setting this property enables and disables verbose logging.
regionlist.match.zipcode.length Valid values = true or false

Default = false

If the value of this property is set to true, the getRegionList API filters the best match regions, such that only those regions are returned for which the length of the input postal code is same as the length of the from and to postal codes for a region.
yantra.charttransformer.allowscriptaccess Valid values = always or sameDomain or never

Default = sameDomain

Flash player accepts object parameters, such as the AllowScriptAccess parameter. Set this property to change the default value as follows.
  • always: Always permit the ActionScript-to-JavaScript calls.
  • sameDomain: Permit the ActionScript-to-JavaScript calls only when the SWF and HTML pages belong to the same domain.
  • never: Never permit the ActionScript-to-JavaScript calls.

For example, yantra.charttransformer.allowscriptaccess=sameDomain.

yfs.custom.greex.functions <full package name of a greex class> Use this property to register the custom Greex functions. Ensure that you use a comma-separated format to specify the full package name of a class that implements the com.yantra.ycp.greex.library.LibraryFunction interface.

For example, yfs.custom.greex.functions=greex.library.newEquals,greex.library.newDouble

yfs.waitforPIcommit Integer

Default = 3000

Use this property to specify the wait time for threads when the person info with the same details is processed concurrently with two or more threads. This prevents the person info-related failures.

For example, in the customer_overrides.properties file, set the value of this property as yfs.yfs.waitforPIcommit=<Integer> as in yfs.yfs.waitforPIcommit = 4000.

yfs.maxRetryWaitforPIcommit Integer

Default = 1

Use this property to specify the maximum number of times a thread must wait for the person info record to be committed in the database. This property works along with yfs.waitforPIcommit. For example, in the customer_overrides.properties file, set the value of this property to yfs.yfs.maxRetryWaitforPIcommit =<Integer> as in yfs.yfs.maxRetryWaitforPIcommit = 2.