Previous     Contents     Index     Next     
iPlanet Market Maker 4.5 Customization Guide



Appendix A       Configurable Property Names


This appendix contains the following sections:



Overview

The following tables list the configurable properties for the modules. Before you configure a property, make sure that you understand what the property does and how it affects the module. Failure to do so can cause the module to fail. Also, note that you must restart the web server for property changes to take effect.

This chapter describes the following types of properties.

  • IPlanet Market Maker

  • Auction Module

  • Catalog Module

  • Community Module

  • Display

  • Order Management Module

  • Pricing Module

  • RFx Module

The property files that contain the properties are in the following directories.

<ias_dir>/ias/APPS/imm40/imm40/WEB-INF/classes

<imm_dir>/iMM/resources

When you make changes to the Vortex.Configuration.properties file, make sure that your edits are in both of these directory locations.



Configure Properties for iPlanet Market Maker


The following properties are in the Vortex.Configuration.properties file.

Table A-1    Market Maker Configuration Properties 

Property Name and Value

Description

CFG_DATABASE_DRIVER  

Specifies the Oracle JDBC driver class.  

CFG_DATABASE_URL  

Specifies the Oracle database connectivity URL. This field is typically encrypted.  

CFG_DATABASE_USER  

Specifies the database user. This property should be encrypted.  

CFG_DATABASE_PASSWORD  

Specifies the database password. This property should be encrypted  

CFG_DEBUG_LEVEL  

Specifies the debug level for the iPlanet Market Maker system. All debug output is written to a file specified by the CFG_DEBUG_DESTINATION property. Acceptable values are off=3, terse=7, verbose=15, vverbose=31.  

CFG_DEBUG_DESTINATION  

Specifies the directory path for the debug log file.  

CFG_DEBUG_STDOUT  

Specifies whether to write debug output to the standard output stream.  

CFG_LDAP_HOST  

Specifies the LDAP server host. Note that this property is typically encrypted and must also be set in the userxconfig.properties file  

CFG_LDAP_PORT  

Specifies the LDAP server port. Note that this property is typically encrypted and must also be set in the userxconfig.properties file.  

CFG_LDAP_READ_USER  

Specifies the name of an LDAP user with read privilege. This property should be encrypted.  

CFG_LDAP_READ_PASSWORD  

Specifies the LDAP password corresponding to CFG_LDAP_READ_USER. This property should be encrypted.  

CFG_LDAP_WRITE_USER  

Specifies the name of an LDAP user with write privilege (e.g. admin or cn="Directory Manager"). This property should be encrypted.  

CFG_LDAP_WRITE_PASSWORD  

Specifies the LDAP password corresponding to CFG_LDAP_WRITE_USER. This property should be encrypted.  

CFG_DEFAULT_LANGUAGE_CODE  

Specifies the default Language Code for the market maker.  

CFG_DEFAULT_COUNTRY_CODE  

Specifies the default Country Code for the market maker.  

CFG_DEFAULT_DATE_FORMAT  

Specifies the default date format used by the toString() method of the iPlanet Market Maker Date class.  

CFG_NOTIFIER_REMOTABLE_FACTORY  

Specifies the factory used to create the notification Remotable interface. By subclassing, you can augment processing as notifications are posted.  

CFG_NOTIFIER_SMTP_HOST  

Specifies the SMTP host for the Notifier.  

CFG_LOG_REMOTABLE_FACTORY  

Specifies the factory used to create the log Remotable interface. By subclassing, you can augment processing as messages are logged.  

CFG_DEFAULT_TIME_ZONE  

Specifies the default TimeZone value for the market maker.  

CFG_DEFAULT_CURRENCY  

Specifies the default Currency value for the market maker.  

CFG_LOG_THREAD_SLEEP_TIME  

Specifies the polling interval of the background configuration thread in milliseconds.  

CFG_ATTACHMENT_DEFAULT_MAX_SIZE  

Specifies the maximum size of the file attachment.This defaults to 2M bytes.  

CFG_ATTACHMENT_DEFAULT_SAVE_DIRECTORY  

Specifies the directory in which file attachments are saved.  

CFG_MODULES_TO_INITIALIZE  

Specifies the list of modules that are initialized (plugged into the iPlanet Market Maker bus). This can be used to enable or disable the Auction and RFx modules, but should not be modified.  

CFG_DEBUG_MODULES_TO_DEBUG  

Defines the list of modules for which debugging output will be displayed. If none are specified, then debugging for all modules is enabled. These are defined as follows: MODULE_BASE=0,MODULE_RFX=1, MODULE_AUCTION=2, MODULE_CATALOG=3, MODULE_PRICING=4,MODULE_COMMUNITY=5, MODULE_DISPLAY=6, MODULE_OMS=7, MODULE_CATALOG_IMPORT=8  

CFG_DEV_LOG  

Specifies the location of the log file used by the FileDebug utility.  

CFG_SMTP_PORT  

Specifies the SMTP port used by Notification facility.  

CFG_MAX_THREADS_IN_NOTIFIER_POOL  

Defines the initial number of threads created to post SMTP messages.  

CFG_VALID_COUNTRIES  

Specifies the list of valid countries (ISO standard country codes) to display (for example, when defining the user profile). Note if this property is empty, all are countries considered valid.  

CFG_VALID_LOCALE_LANGUAGES  

Specifies the list of valid languages to display (for example. when defining the user profile). Note if this property is empty, all languages are considered valid.  

CFG_ACTIVATE_DP  

Specifies an internal setting, set to true to enable the display profile code. This property should be set to true.  

CFG_JS_REMOTABLE_FACTORY  

Specifies the remotable factory for the JobScheduler. This allows the job scheduler to be subclassed.  

CFG_JS_EXE  

Specifies the JobScheduler process. This allows flags (for example, -Djava.compiler=none) to be passed to the job scheduler.  

CFG_JS_ONCEONLY_NUM_WORKERS  

Specifies the total number of worker threads in the thread pool for the OnceOnly Timer in the Job Scheduler.  

CFG_JS_REPEAT_NUM_WORKERS  

Specifies the total number of worker threads in the thread pool for the Repeat Timer in the Job Scheduler.  

CFG_JS_ONCEONLY_SLEEP_INTERVAL  

Specifies the sleep interval (in milliseconds) for the OnceOnly timer database thread maintained by the Job Scheduler.  

CFG_JS_REPEAT_SLEEP_INTERVAL  

Specifies the sleep interval (in milliseconds) for the Repeat timer database thread maintained by the Job Scheduler.  

CFG_NOTIFIER_POOL_WAIT_INTERVAL_FOR_CLEANUP  

Used for internal testing.  

CFG_DEFAULT_JSP  

Used for internal testing. Personalizes the default selected JSP at login time.  

CFG_IN_DEPLOYMENT_MODE  

Used for internal testing. When false this enables the nocache header. This property should be set to true.  

CFG_CRYPTO_SALT  

Specifies the salt as needed by the PKCS #5 standard.  

CFG_CRYPTO_COUNT  

Specifies the iteration count as needed by the PKCS #5 standard.  

CFG_CRYPTO_PROVIDER  

Specifies the Java Cryptography Extension 1.2.1 provider name.  

CFG_CRYPTO_CIPHER_TYPE  

Specifies the type of JCE cipher used for encryption.  

CFG_CRYPTO_KEY_FACTORY_TYPE  

Specifies the type of JCE key factory to used.  

CFG_MAX_NOTIFIER_THREADS_ALLOWED  

Specifies the maximum number of threads in the pool. Do not change this value.  

CFG_CPOOL_INITIAL  

Specifies the initial number of initial database connections created in the connection pool.  

CFG_CPOOL_MAXIMUM  

Specifies the maximum number of database connections created in the connection pool.  

CFG_CPOOL_IDLE_TIMEOUT  

Specifies the timeout for stale database connections in milliseconds.  

CFG_CPOOL_WAIT_TIMEOUT  

Specifies the maximum time in milliseconds to wait for a connection to be released when all database connections are in use.  

CFG_CRYPTO_KEYFILE  

Specifies the file that holds the password to the JCE crypto key.  

CFG_JS_WATCHDOG_EXE  

Specifies the JobScheduler WatchDog process that ensures the Job Scheduler process is running.  

CFG_LNC_REMOTABLE_FACTORY  

Specifies the class name of the Remotable used to write Logging and Notification configuration information to the RDBMS.  

CFG_TRANSACTIONAL_MAIL_SCHEDULER_INTERVAL  

Specifies the polling interval for the scheduled job that posts unsent messages in the Notification subsystem.  

CFG_DEFAULT_NOTIFICATION_INITIATOR  

Specifies a default email address when the sender of the notification has not specified an email address. This is possible because a user's email address is not a required field.  

CFG_DATA_INTEGRITY_OBJECT  

Specifies the license key.  

CFG_DB_DATE_SYNC_INTERVAL  

Specifies in milliseconds how often to poll the database machine to synchronize the date. The intent is to synchronize the database clock with the server's clock if they are on different machines. The synchronization keeps the clocks within a few seconds. The default is 30 minutes  

CFG_JS_HOST  

Specifies he host name in which the JobScheduler is running.  

CFG_JS_PORT  

Specifies the port number in which the JobScheduler listens. Use an unused TCP port on your machine. The JS_HOST and PORT are used to ensure only a single instance of the Job Scheduler is running.  

CFG_CURRENCY_EXCHANGE_REFRESH_INTERVAL  

Specifies the amount of time between refreshes for currency exchange rates. The unit is in minutes.  



Configurable Properties for the Auction Module


The following properties are in the Auction.Configuration.properties file.

Table A-2    Auction Configuration Properties 

Property Name and Value

Description

CFG_DEFAULT_NUM_ROWS_PER_PAGE Property # = 3; Current Setting : (3=10)  

Sets the number of rows displayed per page.  

CFG_SHOW_N_COL Property # = 4; Current Setting : (4=3)  

Sets the number of columns displayed per page.  

CFG_SHOW_N_SUBCATEGORIES
Property # = 5; Current Setting : (5=2)  

Sets the number of auction subcategories displayed below the second level of categories when browsing by category.  

#CFG_ARCHIVE_CHECKING_RATE , the unit # is millisecond.
# - the frequency at which we check
# for auctions eligible for
# archiving, the unit is in
# milliseconds.

# - Currently set to 1 week, which is 7 * 24 * 60 * 60 * 1000 = 604800000 millisecond. 6=604800000  

Represents the frequency (in milliseconds) at which auctions are checked to be eligible for archiving. If you want to change the frequency for auction archive checking, change the current setting (1 week) from 6=604800000 to 6=(the number of milliseconds; result of calculation <number of weeks> * 24 * 60 * 60 * 1000).  

CFG_ENABLE_ARCHIVE_SCHEDULER
Property # =7; Current Setting: 7=false  

Enables or disables the archive scheduler.  

CFG_ATTACHMENT_TMP_DIR
Property # =8; Current Setting:

8=@IMM_DOCROOT_FULL@/imm40/iMM/auction/images/uploaded_images/tmp  

Specifies the temporary directory for auction images.  

CFG_ATTACHMENT_DIR
Property # =9; Current Setting:

9=@IMM_DOCROOT_FULL@/imm40/iMM/auction/images/uploaded_images  

Specifies the permanent directory for auction images.  

CFG_IMAGE_ATTACHMENT_TMP_URI
Property # = 10; Current Setting:

10=/imm40/iMM/auction/images/uploaded_images/tmp  

Specifies the temporary relative uniform resource identifier (URI) to store the image files.  

CFG_IMAGE_ATTACHMENT_URI

Property # = 11; Current Setting:

11=/imm40/iMM/auction/images/uploaded_images  

Specifies the permanent relative URI to store the image files.  

CFG_CATALOG_IMAGE_DIR
Property # = 12; Current Setting:

12=@IMM_DOCROOT_FULL@  

Directory in which to store catalog images.  

CFG_ARCHIVE_CLOSING_DELAY
Property # = 13;
Current Setting : (13=14400)
( 14400 minutes = 10days * 24 * 60)  

Represents the maximum delay (duration in minutes) allowed between the closing date (time in minutes) and the check point at which the time is checked (time in minutes). If you want to change the delay, change the current settings from 13=14400 to 13=(the number of minutes).  

CFG_NOTIFY_ALL_INITIATORS

Property #=27;
Current Setting : 27 = false  

This parameter indicates whether to send notification to everyone in the company with initiating privilege or just to the initiator who created the auction.  

CFG_NOTIFY_ALL_BIDDERS

Property #=28;
Current Setting : 28 = false  

This parameter indicates whether to send notification to everyone in the company with bidding privilege or just to the bidder who bid on the auction.  

The following properties are in the Auction.Messages.properties file.

Table A-3    Auction Message Properties 

Message Name and Value

Description

Error codes 20000 to 20028  

Auction error messages. If you change an error message, change the text against the error code.  

Error code 22024 to 22068  

Auction general messages for Auction status, bid, invitation, win, and so on.  



Configurable Properties for the Catalog Module


The following properties are in the Catalog.Configuration.properties file.


Table A-4    Catalog Configuration Properties

Property Name and Value

Description

#CFG_FORMAT_SEARCH_STRING

7=true  

True means that the search strings you type in the browser will be preprocessed for the Oracle interMedia search engine. For example, special characters are removed or translated and "AND" is inserted between consecutive words. True is the recommended value.

False means the string you type in string is immediately passed to the search engine without being preprocessed.  

#CFG_NO_ADJUSTED_PRICES

8=false  

Default number of items to show on one page on the catalog search and browse pages. You can change this value on the browse page as well. Possible values are 10, 25, 50, 100.  

#CFG_NESTED_CATEGORIES_SIZE

10=16  

The catalog browse page can show nested categories when browsing. If the number of categories being displayed during browsing is less than this configuration parameter, then up to three subcategories are also displayed below the parent.

Set this to zero if no subcategories are to be displayed, or set to a very high number if subcategories should always be shown. No nested categories are shown when displaying search results. The recommended default value is 16.  

#CFG_DOUBLE_COLUMN_SIZE

11=32  

Categories can be displayed in one or two columns. If categories names are long, then a one column display is better. If category names are generally short, then two column of categories are a better use of screen space. Also, if nested categories are being displayed, it is less likely that double columns will be the best presentation, so this value should be set to a lower number.

The recommended default is 32 characters.  

The following properties are in the Catalog.Messages.properties file.

Table A-5    Catalog Message Properties 

Message Name and Value

Description

Error codes 30000 to 30011  

Catalog error messages. If you change an error message, change the text against the error code.  

Error code 80000 to 80010  

Catalog error messages. If you change an error message, change the text against the error code.  



Configurable Properties for the Community Module


The following properties are in the Community.Configuration.properties file.

Table A-6    Community Configuration Properties 

Property Name and Value

Description

CFG_SYSTEM_USER_ID  

System user ID.The default is system.  

CFG_SYSTEM_PASSWORD  

System user password. The default is system.  

CFG_SITE_ID  

Site ID for the LDAP directory structure. The default is imm.  

CFG_HOST_COMPANY_ID  

Host ID under which the market administrator operates. The default is immhost.  

CFG_ROOT_USER_ID  

User ID which the Market Maker Administrator uses to log in. The default is root.  

CFG_MMADMIN_ROLE - ID  

Market maker administrator role ID. The default is mmadmin.  

CFG_COMPANY_ADMIN_ROLE  

Company administrator roleID. The default is companyadmin.  

CFG_EXTENDED_INFO_MANAGER  

Path for the ExtendedInfoManager class you can use to extend the Community module. The default is

com.iplanet.ecommerce.vortex.
community.ExtendedInfoManager.  

CFG_ANONYMOUS_USER_ID  

User ID for anonymous log in. The default is anonymous.  

CFG_DEFAULT_ORG_USER_LIMIT  

Maximum number of users that can be registered into any company. The default is 500.  

CFG_VORTEX_BASE_DN  

Base ID for the LDAP directory from which distinguished names (DN's) may be formulated. The default is imm.  

CFG_SEARCH_MAX_RESULTS  

Maximum number of search results that is returned for a search. The default is 50.  

CFG_DEFAULT_NUM_ROWS_PER_PAGE  

Maximum number of results displayed on a page. The default is 10.  

CFG_OPTIONAL_MODULES  

List of optional modules you can plug in.The defaults are auction and catalog.  

The following properties are in the Community.Messages.properties file.

Table A-7    Community Message Properties 

Message Name and Value

Description

Error code 50000 to 50024

Error code 51000 to 51018  

Contains warning and error messages generated by the back-end of the Community module.  



Configurable Properties for the iPlanet Market Maker Display


The following properties are in the Display.Configuration.properties file.

Table A-8    Display Configuration Properties 

Property Name and Value

Description

#CFG_GENERIC_CONFIG

0=Generic Config  

Define a generic iPlanet Market Maker configuration.  

#LOGIN PROPERTIES

# Pages used for login

4=community/login/Login.jsp

8=community/login/AskRole.jsp  

Specifies the log-in JSPs used when you log in to iPlanet Market Maker.  

#CFG_APPNAME: name of the application

14=iMM  

Specifies the name of the application in LDAP. The default is iPlanet Market Maker.  

# IMM Doc root: name of the directory under which iMM will appear on the server url

16=/imm40/iMM/  

Specifies the iPlanet Market Maker root directory name. The default is @IMM_DOCROOT@.  

#CFG_SEND_NOCACHE_HEADER: send a nocache http header with each page served by the portal.

19=false  

Sends a nocache header with each page served by the portal.  

The following properties are in the Display.Messages.properties file.

Table A-9    Display Message Properties

Message Name and Value

Description

Error code 60000 to 60029  

Error Messages related to URL, login, display profile, and event handlers.  



Configurable Properties for the OMS Module


The following properties are in the OMS.Configuration.properties file.

Table A-10    OMS Configuration Properties 

Property Name and Value

Description

#CFG_GENERIC_CONFIG

0=GenericConfig  

Specifies a generic configuration.  

#CFG_OMS_MANAGER

1=com.iplanet.ecommerce.vortex.oms.OMSManagerFactory  

Name of the factory class for the OMS manager class.  

#CFG_OMS_REMOTABLE

2=com.iplanet.ecommerce.vortex.oms.OMSRemotableFactory  

Name of the factory class for the OMS remotable class.  

#CFG_ROWS_TO_DISPLAY

3=10  

Number of rows to display in OMS screens containing lists.  

The following properties are in the OMSStrings.properties file.

Table A-11    OMS Message Properties 

Property Name and Value

Description

#OMS_PAYMENT_METHOD_NAMES

OMS_PAYMENT_METHOD_NAMES[0]=VISA

OMS_PAYMENT_METHOD_NAMES[1]=
MasterCard

OMS_PAYMENT_METHOD_NAMES[2]=COD

OMS_PAYMENT_METHOD_NAMES[3]=PCARD

OMS_PAYMENT_METHOD_NAMES[4]=AMEX

5=AMEX  

Payment methods for orders. The default is AMEX (American Express Card).  

#OMS_SHIPPING_METHOD_NAMES

OMS_SHIPPING_METHOD_NAMES[0]=DHL

OMS_SHIPPING_METHOD_NAMES[1]=FedEx

OMS_SHIPPING_METHOD_NAMES[2]=USPS

OMS_SHIPPING_METHOD_NAMES[3]=UPS  

Specifies the shipping method for orders.  

#OMS_PAYMENT_TERM_NAMES

OMS_PAYMENT_TERM_NAMES[0]=NET15DAYS

OMS_PAYMENT_TERM_NAMES[1]=NET30DAYS

OMS_PAYMENT_TERM_NAMES[2]=NET45DAYS

OMS_PAYMENT_TERM_NAMES[3]=NET60DAYS  

Specifies the payment terms for orders.  



Configurable Properties for the Pricing Module


The following properties are in the Pricing.Configuration.properties file.

Table A-12    Pricing Configuration Properties 

Property Name and Value

Description

#CONSTANTS FOR PRICING DISPLAY MODULE

#STR_PRICING_DISPLAY_START_YEAR

100=2000  

Sets the start year to display in the listbox that shows the range of years. If you want to change pricing display start year to 2001, for example, change the current setting from100=2000 to 100=2001.

Note that must change the #STR_YEAR_STR fields accordingly in the Pricing.Strings.properties file if you change the start year with this property.  

#STR_PRICING_DISPLAY_END_YEAR

101=2003  

Sets the end year to display in the listbox that shows the range of years. If you want to change pricing display end year to 2004, for example, change the current setting from 100=2003 to 100=2004.

Note that must change the #STR_YEAR_STR fields accordingly in the Pricing.Strings.properties file if you change the end year with this property  

#STR_PRICING_DISPLAY_ROW_INCREMENT

102=4  

Sets the row increment in the pricing display, which is the number of empty rows for dates to be filled in. If you want the row increment to be 5 in pricing display, for example, change the current setting from 102=4 to 102=5  

#STR_PRICING_DISPLAY_NO_RECORDS_PER_
PAGE

103=10  

Sets the number of records per page in the pricing rules display in a page. If you want the number of records per page to be 4 in pricing display, for example, change the current setting from 103=10 to 103=11.  

#STR_PRICING_DISPLAY_NO_ITEMS_PER_
LISTBOX

105=4  

Sets the number of catalog items per listbox.If you want the number of items per listbox to be 5, for example, change the current setting from 105=4 to 105=5.  

The following properties are in the Pricing.Messages.properties file.

Table A-13    Pricing Message Properties

Message Name and Value

Description

Error code 40000 to 40022  

General and error messages related to pricing rules administration.  

Error code 40100 to 40112  

Error messages related to pricing rules display.  



Configurable Properties for the RFx Module


The following properties are in the RFx.Configuration.properties file.

Table A-14    RFx Configuration Properties 

Property Name and Value

Description

#CFG_ENABLE_ARCHIVE_SCHEDULER

# - true: turn on. false: no action

3=false  

Turns the archive scheduler on or off.  

#CFG_ARCHIVE_CHECKING_RATE

# - the frequency at which we check for archiving RFx data.

# - the unit is in millisenconds.

# - currently set to 100

4=8640000000days  

Frequency to check for archiving data.  

#CFG_ARCHIVE_CLOSING_DELAY

# - the maximum delay allowed between the closing date and the check point.

# - the unit is in msecs.

# - currently set to 100 days

5=8640000000  

The maximum delay allowed for archiving between the closing time and the check point at which the time is checked.  

#CFG_RFX_JOB_SCHEDULER_RUN_INTERVAL

# - the frequency at which we check
# for running the job scheduler.

# - the unit is in millisenconds.

# - currently set to 1 day

7=86400000  

Frequency to check for running the job scheduler.  

#CFG_PADDING_MINUTES_FOR_MAX_EXPIRATION_DATE

# this is the number of minutes to
# pad to expiration date so that

# validation of (if
# getExpirationDate() >
# maxExpirationDate) is

#   more lenient.

# Note: this does not need to be
# dynamic.

9=60  

Number of minutes to add to (pad) the expiration date to make the date deadline more lenient.  

#CFG_SPAWN_THREAD_FOR_NOTIFICATION

10=false  

Runs notification as a separate thread. Leave this set as false.  

#CFG_DISPLAY_WARNINGS_AS_MESSAGES

11=false  

Turns warning messages in the user interface on or off.  


Previous     Contents     Index     Next     
Copyright © 2002 Sun Microsystems, Inc. All rights reserved.

Last Updated March 25, 2002