A P P E N D I X A - Deployment Configuration Files

This appendix describes the format of the deployment configuration file used to deploy the Content Delivery Server components. This file format is designed to operate with the ANT replace command. See Section 3.1.3, Set up the Deployment Configuration File for information on using the configuration file.

A.1 Configuration Properties

The following table describes the general properties in the configuration file that are used with both Sun Java System Application Server and WebLogic Server. These properties must always be set. Properties used only by WebLogic Server are described in TABLE A-2.

TABLE A-1 General Properties
Property	Description
`server.type`	Specifies the type of application server that you are using. For Sun Java System Application Server, use `sun`; for WebLogic Server, use `weblogic`, for example: server.type=sun Note: Do not change the value of this property.
`java.mem`	A string that is used when starting the Java virtual machine for the application server, and determines the memory settings for the Java Virtual Machine, for example: java.mem=-ms512m -mx1024m -XX:MaxPermSize=256m
`app.server.domain`	The domain name of the application server, for example: app.server.domain=cdsdomain
`app.server.name`	The name to use for the application server, for example: app.server.name=cdsserver
`app.server.portnumber`	The port on which the application server listens for HTTP requests, for example: app.serverportnumber=80
`app.server.ssl.port`	The port number on which the application server listens for SSL HTTP requests, for example: app.server.ssl.port=81
`jndi.factory`	The name of the Java Naming and Directory Interface (JNDI) API factory class to use. Specify the fully qualified class name,. For Sun Java System Application Server, specify `com.sun.jndi.fscontext.RefFSContextFactory` For WebLogic, specify `weblogic.jndi.WLInitialContextFactory`
`jndi.url`	The URL for the JNDI API. For Sun Java System Application Server, specify `file://[[deployment]]/sun` For WebLogic, specify `t3://localhost:80`
`cs.internal.uri`^[1]	The URI for the Catalog Manager used within the Content Delivery Server, for example: cs.internal.uri=http://localhost:80/admin/
`dp.internal.uri`a	The URI for the Developer Portal used within the Content Delivery Server, for example: dp.internal.uri=http://localhost:80/developer/
`fs.internal.uri`a	The URI for the Fulfillment Manager used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/fs/
`vs.internal.uri`a	The URI for the Vending Manager used within the Content Delivery Server, for example: vs.internal.uri=http://localhost:80/vsadmin/
`sp.internal.uri`a	The URI for the Subscriber Portal used within the Content Delivery Server, for example: sp.internal.uri=http://localhost:80/subscriber/
`es.internal.uri`a	The URI for the Event Service used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/es/
`ms.internal.uri`a	The URI for the Messaging Service used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/ms/
`ns.internal.uri`a	The URI for the Notify Service used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/ns/
`pps.internal.uri`a	The URI for the Postpaid Service used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/pps/
`mos.internal.uri`a	The URI for the Monitoring Service used within the Content Delivery Server, for example: fs.internal.uri=http://localhost:80/mos/
`cs.external.uri`a	The URI used by external entities to access the Catalog Manager, for example: cs.external.uri=http://webhost.domain.com:80/admin/
`dp.external.uri`a	The URI used by external entities to access the Developer Portal, for example: dp.external.uri=http://webhost.domain.com:80/developer/
`fs.external.uri`a	The URI used by external entities to access the Fulfillment Manager, for example: fs.external.uri=http://webhost.domain.com:80/fs/
`vs.external.uri`a	The URI used by external entities to access the Vending Manager, for example: vs.external.uri=http://webhost.domain.com:80/vsadmin/
`sp.external.uri`a	The URI used by external entities to access the Subscriber Portal, for example: sp.external.uri=http://webhost.domain.com:80/subscriber/
`vs.account.name`	Name of the Vending Manager for the current deployment, for example, `suncds.vending.server.1`. This name must match the name attribute specified for the corresponding `Vending` element in the database configuration file. Use this name as the Account ID when you create the Vending Manager account in the Catalog Manager. Note: This property is required only when a Vending Manager is deployed.
`vs.account.password`	Password used to access the Vending Manager for the current deployment. This password must match the password specified for the corresponding `Vending` element in the database configuration file. Use this password as the Account Password when you create the Vending Manager account in the Catalog Manager. Note: This property is required only when a Vending Manager is deployed.
`ms.mail.smtp.host`	The name of a mail server that is capable of accepting unauthenticated email messages. Note: This property is required only when a Messaging Service is deployed.
`ms.mail.smtp.sender`	The reply-to address for email messages. Note: This property is required only when a Messaging Service is deployed.

The following table describes the properties that are used only with WebLogic Server. If you are not using WebLogic Server, you do not need to set these properties.

TABLE A-2 General Properties Used with WebLogic Server
Property	Description
`app.server.threadcount`	The number of threads the application server will use for handling HTTP requests, for example, `app.server.threadcount=10`
`app.server.ssl.enable`	State of SSL support. Set this property to `false` to disable SSL for the application server, for example: app.server.ssl.enabled=false The default is `true`.
`app.server.hostip`	Host name or IP address of the host where the server is deployed, for example: app.server.hostip=localhost
`app.server.admin.port`	The port number for the WebLogic Server administration console, for example: app.server.admin.port=7800

In addition to the general properties, the configuration file has properties in the following format that identify which components are included in the deployment:

TABLE A-3 Component Prefixes
Prefix	Component
`cs`	Catalog Manager
`dp`	Developer Portal
`vs`	Vending Manager
`sp`	Subscriber Portal
`fs`	Fulfillment Manager
`es`	Event Service
`ms`	Messaging Service
`ns`	Notify Service
`pps`	Postpaid Service
`mos`	Monitoring Service

A component is included in the deployment, if there is no pound sign (#) preceding the property. For example, if the following statements are included in your deployment configuration file, the Catalog Manager and Developer Portal are included in the deployment and the Vending Manager and Subscriber Portal are not.

cs.include

dp.include

#vs.include

#sp.include

A.2 Sample File for Use with Sun Java System Application Server

The following code example is a sample deployment configuration file used with Sun Java System Application Server. This file shows the configuration settings described in this appendix. This file is in the $CDS_HOME/cfg directory and is called sn_sample.cfg.

Edit the properties before you use the file, or create a new file with your settings. Sample settings are generally incorrect for your environment.

Note that lines beginning with a pound sign (#) are ignored by Content Delivery Server.

CODE EXAMPLE A-1 Sample Deployment Configuration File for Use With Sun Java System Application Server
###################################################################### # # Configuration File # # # This Java properties file defines all of the required properties # that are used to deploy and configure a server. Your deployment # can consist of any combination of the following components: # # CATALOG MANAGER (cs) # DEVELOPER PORTAL (dp) # VENDING MANAGER (vs) # SUBSCRIBER PORTAL (sp) # FULFILLMENT MANAGER (fs) # EVENT SERVICE (es) # MESSAGING SERVICE (ms) # NOTIFY SERVICE (ns) # POSTPAID SERVICE (pps) # MONITORING SERVICE (mos) # # NOTE: Be careful not to leave trailing spaces..... # ###################################################################### #===================================================================== # General Properties #===================================================================== # Specifies your application server to be Sun Java System (DO NOT CHANGE) server.type=sun # ------------ Java Settings ------------- # java.mem=-ms512m -mx1024m -XX:MaxPermSize=256m # --------- App Server Settings ---------- # app.server.domain=cdsdomain app.server.name=cdsserver app.server.portnumber=80 app.server.ssl.port=81 # --------- JNDI Server Settings --------- # jndi.factory=com.sun.jndi.fscontext.RefFSContextFactory jndi.url=file://[[deployment]]/sun # ------------- URI Settings ------------- # cs.internal.uri=http://localhost:80/admin/ dp.internal.uri=http://localhost:80/developer/ fs.internal.uri=http://localhost:80/fs/ vs.internal.uri=http://localhost:80/vsadmin/ sp.internal.uri=http://localhost:80/subscriber/ es.internal.uri=http://localhost:80/es/ ms.internal.uri=http://localhost:80/ms/ ns.internal.uri=http://localhost:80/ns/ pps.internal.uri=http://localhost:80/pps/ mos.internal.uri=http://localhost:80/mos/ cs.external.uri=http://webhost.domain.com:80/admin/ dp.external.uri=http://webhost.domain.com:80/developer/ fs.external.uri=http://webhost.domain.com:80/fs/ vs.external.uri=http://webhost.domain.com:80/vsadmin/ sp.external.uri=http://webhost.domain.com:80/subscriber/ # ----------- Vending Settings ----------- # vs.account.name=suncds.vending.server.1 vs.account.password=vending # ------------ Mail Settings ------------- # ms.mail.smtp.host=mailhost.domain.com ms.mail.smtp.sender=info@domain.com #===================================================================== # Included Managers, Portals, & Services #===================================================================== # Make any of the following lines a comment if the manager, portal, or service # should not be deployed cs.include dp.include vs.include sp.include fs.include es.include ms.include ns.include pps.include mos.include

CODE EXAMPLE A-1 Sample Deployment Configuration File for Use With Sun Java System Application Server

######################################################################

# Configuration File

# This Java properties file defines all of the required properties

# that are used to deploy and configure a server. Your deployment

# can consist of any combination of the following components:

# CATALOG MANAGER         (cs)

# DEVELOPER PORTAL        (dp)

# VENDING MANAGER         (vs)

# SUBSCRIBER PORTAL       (sp)

# FULFILLMENT MANAGER     (fs)

# EVENT SERVICE           (es)

# MESSAGING SERVICE       (ms)

# NOTIFY SERVICE          (ns)

# POSTPAID SERVICE        (pps)

# MONITORING SERVICE      (mos)

# NOTE: Be careful not to leave trailing spaces.....

######################################################################

#=====================================================================

# General Properties

#=====================================================================

# Specifies your application server to be Sun Java System (DO NOT CHANGE)

server.type=sun

# ------------ Java Settings ------------- #

java.mem=-ms512m -mx1024m -XX:MaxPermSize=256m

# --------- App Server Settings ---------- #

app.server.domain=cdsdomain

app.server.name=cdsserver

app.server.portnumber=80

app.server.ssl.port=81

# --------- JNDI Server Settings --------- #

jndi.factory=com.sun.jndi.fscontext.RefFSContextFactory

jndi.url=file://[[deployment]]/sun

# ------------- URI Settings ------------- #

cs.internal.uri=http://localhost:80/admin/

dp.internal.uri=http://localhost:80/developer/

fs.internal.uri=http://localhost:80/fs/

vs.internal.uri=http://localhost:80/vsadmin/

sp.internal.uri=http://localhost:80/subscriber/

es.internal.uri=http://localhost:80/es/

ms.internal.uri=http://localhost:80/ms/

ns.internal.uri=http://localhost:80/ns/

pps.internal.uri=http://localhost:80/pps/

mos.internal.uri=http://localhost:80/mos/

cs.external.uri=http://webhost.domain.com:80/admin/

dp.external.uri=http://webhost.domain.com:80/developer/

fs.external.uri=http://webhost.domain.com:80/fs/

vs.external.uri=http://webhost.domain.com:80/vsadmin/

sp.external.uri=http://webhost.domain.com:80/subscriber/

# ----------- Vending Settings ----------- #

vs.account.name=suncds.vending.server.1

vs.account.password=vending

# ------------ Mail Settings ------------- #

ms.mail.smtp.host=mailhost.domain.com

ms.mail.smtp.sender=info@domain.com

#=====================================================================

# Included Managers, Portals, & Services

#=====================================================================

# Make any of the following lines a comment if the manager, portal, or service

# should not be deployed

cs.include

dp.include

vs.include

sp.include

fs.include

es.include

ms.include

ns.include

pps.include

mos.include

A.3 Sample File for Use with WebLogic Server

The following code example is a sample configuration file used with WebLogic Server. This file shows the configuration settings described in this appendix. This file is in the $CDS_HOME/cfg directory and is called wl_sample.cfg.

Edit the properties before you use the file, or create a new file with your settings. Sample settings are generally incorrect for your environment.

Note that lines beginning with a pound sign (#) are ignored by Content Delivery Server.

CODE EXAMPLE A-2 Sample Deployment Configuration File for Use With WebLogic
###################################################################### # # Configuration File # # This Java properties file defines all of the required properties # that are used to deploy and configure a server. Your deployment # can consist of any combination of the following components: # # CATALOG MANAGER (cs) # DEVELOPER PORTAL (dp) # VENDING MANAGER (vs) # SUBSCRIBER PORTAL (sp) # FULFILLMENT MANAGER (fs) # EVENT SERVICE (es) # MESSAGING SERVICE (ms) # NOTIFY SERVICE (ns) # POSTPAID SERVICE (pps) # MONITORING SERVICE (mos) # # NOTE: Be careful not to leave trailing spaces..... # ###################################################################### #===================================================================== # General Properties #===================================================================== # Specifies your application server to be BEA WebLogic (DO NOT CHANGE) server.type=weblogic # ------------ Java Settings ------------- # java.mem=-ms512m -mx1024m -XX:MaxPermSize=256m # --------- App Server Settings ---------- # app.server.domain=cdsdomain app.server.name=cdsserver app.server.portnumber=80 # Number of listening threads app.server.threadcount=10 # true for SSL support app.server.ssl.enabled=true # SSL listen port app.server.ssl.port=81 # Host Name or IP address of the system where server is deployed # You should change it if you are running with multiple IP addresses app.server.hostip=localhost # WL administration console port, ONLY IF SSL IS ENABLED app.server.admin.port=7800 # --------- JNDI Server Settings --------- # jndi.factory=weblogic.jndi.WLInitialContextFactory jndi.url=t3://localhost:80 # ------------- URI Settings ------------- # cs.internal.uri=http://localhost:80/admin/ dp.internal.uri=http://localhost:80/developer/ fs.internal.uri=http://localhost:80/fs/ vs.internal.uri=http://localhost:80/vsadmin/ sp.internal.uri=http://localhost:80/subscriber/ es.internal.uri=http://localhost:80/es/ ms.internal.uri=http://localhost:80/ms/ ns.internal.uri=http://localhost:80/ns/ pps.internal.uri=http://localhost:80/pps/ mos.internal.uri=http://localhost:80/mos/ cs.external.uri=http://webhost.domain.com:80/admin/ dp.external.uri=http://webhost.domain.com:80/developer/ fs.external.uri=http://webhost.domain.com:80/fs/ vs.external.uri=http://webhost.domain.com:80/vsadmin/ sp.external.uri=http://webhost.domain.com:80/subscriber/ # ----------- Vending Settings ----------- # vs.account.name=suncds.vending.server.1 vs.account.password=vending # ------------ Mail Settings ------------- # ms.mail.smtp.host=mailhost.domain.com ms.mail.smtp.sender=info@domain.com #===================================================================== # Included Managers, Portals, & Services #===================================================================== # Make any of the following lines a comment if the manager, portal, or service # should not be deployed cs.include dp.include vs.include sp.include fs.include es.include ms.include ns.include pps.include mos.include

CODE EXAMPLE A-2 Sample Deployment Configuration File for Use With WebLogic

######################################################################

# Configuration File

# This Java properties file defines all of the required properties

# that are used to deploy and configure a server. Your deployment

# can consist of any combination of the following components:

# CATALOG MANAGER         (cs)

# DEVELOPER PORTAL        (dp)

# VENDING MANAGER         (vs)

# SUBSCRIBER PORTAL       (sp)

# FULFILLMENT MANAGER     (fs)

# EVENT SERVICE           (es)

# MESSAGING SERVICE       (ms)

# NOTIFY SERVICE          (ns)

# POSTPAID SERVICE        (pps)

# MONITORING SERVICE      (mos)

# NOTE: Be careful not to leave trailing spaces.....

######################################################################

#=====================================================================

# General Properties

#=====================================================================

# Specifies your application server to be BEA WebLogic (DO NOT CHANGE)

server.type=weblogic

# ------------ Java Settings ------------- #

java.mem=-ms512m -mx1024m -XX:MaxPermSize=256m

# --------- App Server Settings ---------- #

app.server.domain=cdsdomain

app.server.name=cdsserver

app.server.portnumber=80

      # Number of listening threads

app.server.threadcount=10

      # true for SSL support

app.server.ssl.enabled=true

      # SSL listen port

app.server.ssl.port=81

      # Host Name or IP address of the system where server is deployed

      # You should change it if you are running with multiple IP addresses

app.server.hostip=localhost

      # WL administration console port, ONLY IF SSL IS ENABLED

app.server.admin.port=7800

# --------- JNDI Server Settings --------- #

jndi.factory=weblogic.jndi.WLInitialContextFactory

jndi.url=t3://localhost:80

# ------------- URI Settings ------------- #

cs.internal.uri=http://localhost:80/admin/

dp.internal.uri=http://localhost:80/developer/

fs.internal.uri=http://localhost:80/fs/

vs.internal.uri=http://localhost:80/vsadmin/

sp.internal.uri=http://localhost:80/subscriber/

es.internal.uri=http://localhost:80/es/

ms.internal.uri=http://localhost:80/ms/

ns.internal.uri=http://localhost:80/ns/

pps.internal.uri=http://localhost:80/pps/

mos.internal.uri=http://localhost:80/mos/

cs.external.uri=http://webhost.domain.com:80/admin/

dp.external.uri=http://webhost.domain.com:80/developer/

fs.external.uri=http://webhost.domain.com:80/fs/

vs.external.uri=http://webhost.domain.com:80/vsadmin/

sp.external.uri=http://webhost.domain.com:80/subscriber/

# ----------- Vending Settings ----------- #

vs.account.name=suncds.vending.server.1

vs.account.password=vending

# ------------ Mail Settings ------------- #

ms.mail.smtp.host=mailhost.domain.com

ms.mail.smtp.sender=info@domain.com

#=====================================================================

# Included Managers, Portals, & Services

#=====================================================================

# Make any of the following lines a comment if the manager, portal, or service

# should not be deployed

cs.include

dp.include

vs.include

sp.include

fs.include

es.include

ms.include

ns.include

pps.include

mos.include

^{1 (TableFootnote) The value specified must be either a host name and port number or an IP address and port number. Whichever format is used must be used for every reference to that component. For example, if you specify a host name and port number you cannot reference the component using an IP address.}