Control File Keywords

Keywords in the Control lists all the keywords that can appear in the control file.

The Configuration Menu Item / Description column provides either:

•

a description of the possible values that the keyword can take, or

•

a link to the description of the equivalent configuration menu item, which describes the item and its possible values in more detail.

The Status column indicates whether the keyword is:

•

M—Mandatory. The keyword must appear in the control file and must have a valid value.

•

O—Optional. The keyword can be omitted from the control file, in which case the installer uses the appropriate default value.

•

R—Reserved. The keyword is automatically generated by the installer as required. TIBCO recommends that you do not change its value.

Keywords in the Control
Keyword	Configuration Menu Item / Description	Status
General
IPEI_INSTALLUSER	Name of the UNIX user account that is running the installer. Note: This value is written to the control file by the installer for information only. It is not actually used by the installer.	R
IPEI_DEFSYSLANG	Default system language	O
IPEF_INTERACTIVE	"Y" for Interactive installation	R
Policy to Install Schema and Files Menu
IPEI_INSPOLICY	Installation Policy	R
IPEI_UPGRADE_PART0	Installation Policy Which part (files or schema) has been upgraded first.	O
IPEI_UPGRADE_PART1	Installation Policy Which part (files or schema) has been upgraded next.	O
Memo Data Migration Menu
IPEI_MIGRATE	Migration Setting	O
Location, Identification and OS Accounts Menu
IPEI_SWDIR	Installation Directory	M
IPEI_NODENAME	iProcess Engine Nodename	M
IPEI_LICENSEE	iProcess Engine Licensee Name	O
IPEI_BGUSER	iProcess Engine Background User Name	O
IPEI_ADMUSER	iProcess Engine Administration User Name	O
IPEI_USRGROUP	iProcess Engine User Group Name	O
IPEF_REDIRADM	Redirect Administration Queue	O
IPEF_CREATBGUSR	`Y` to Create OS iPE BG User	O
IPEF_CREATADMUSR	`Y` to Create OS Admin User	O
IPEF_CREATGROUP	`Y` to Create iPE Group	O
IPEF_ATGBGUSR	`Y` to add OS iPE BG User to iPE Group	R
IPEF_ATGADMUSR	`Y` to add OS Admin User to iPE Group	R
Configuration Options Menu
IPEI_RPCNUM	iProcess Engine Client RPC Number	O
IPEF_CLNTPASSWD	iProcess Engine Client Password Required	O
IPEF_ENABLECDN	Enable Case Data Normalization	O
IPEF_PREDICT	Enable Prediction	O
IPEF_AUTOSTART	Enable Autostart	O
IPEF_ENABLEIAP	Enable Activity Publishing	O
IPEF_EAIMAIL_ENABLECONFIG	Configure iProcess Email Plug-in	O
IPEI_JMX_PORT	JMX Port Number	O
IPEF_SPOSERVER_ENABLED	Enable iProcess Objects Server	O
IPEF_SPODIRECTOR_ENABLED	Enable iProcess Objects Director	O
IPEF_WEBDAV_ENABLED	Enable Write Access to WebDav	R
IPEF_AUTEVENT	Enable System Event Logging	O
IAP Configuration Menu
IPEI_JMSPROVIDER	JMS Provider	O
IPEI_JMSLOCATION	Base JAR Files Location	O
IPEI_ADDJARLOC	Additional JAR Files Location	O
IPEI_CTXTFACTORY	Context Factory Name	O
IPEI_JMSURL	URL for JMS Provider	O
IPEI_CONNFACTORY	Connection Factory Name	O
iProcess Email Plug-in Configuration Menu
IPEI_EAIMAIL_SMTPHOST	SMTP Host	O
IPEI_EAIMAIL_SMTPPORT	SMTP Port Number	O
IPEI_EAIMAIL_MAILFROM	Mail from Address	O
IPEI_EAIMAIL_BAKSMTPHOST1	BACKUP SMTP Host	O
IPEI_EAIMAIL_BAKSMTPHOST2	BACKUP SMTP Host	O
IPEI_EAIMAIL_BAKSMTPHOST3	BACKUP SMTP Host	O
IPEI_EAIMAIL_BAKSMTPPORT1	BACKUP SMTP Port	O
IPEI_EAIMAIL_BAKSMTPPORT2	BACKUP SMTP Port	O
IPEI_EAIMAIL_BAKSMTPPORT3	BACKUP SMTP Port	O
IPEI_EAIMAIL_RETRYCOUNTS	Retry Counts	O
Oracle Database Installation Method Menu
IPEI_DBINSTMODEL	Installation Method	O
Database Connection and Account Details Menu
IPEI_DBIDSTR	Oracle DB TNS Identifier	M
IPEI_DBIDSTR	DB2 Database Alias Name	M
IPEF_USENONTAF	"Y" to use an Oracle DB TNS Identifier that does not have TAF enabled (see notes in If you create a control file from scratch and you are using an Oracle DB TNS Identifier that does not have Oracle TAF enabled, you must add the IPEF_USENONTAF="Y" line to your control file. This is because the install (if run interactively) checks and prompts you to enter Y to continue with the installation if Oracle TAF is not enabled (see Oracle TAF is Not Enabled for more information). , if you create a control file from scratch and you are using an Oracle DB TNS Identifier that does not have Oracle TAF enabled.)	O
IPEI_DBANAME	Oracle DB Administrator Name	M
IPEI_DBAPASSWD	Oracle DB Administrator Password	M
IPEI_DBSONAME	iProcess Engine DB Schema Owner Name	O
IPEI_DBSOPASSWD	iProcess Engine DB Schema Owner Password	O
IPEI_DBSBGNAME	Reserved for internal use.	R
IPEI_DBUSRNAME	iProcess Engine DB User Name	O
IPEI_DBUSRPASSWD	iProcess Engine DB User Password	O
IPEI_SUPPORTUNICODE	Support Unicode Encoding	O
IPEI_DBTABLESPC	Data Tablespace Name	O
IPEI_DTBLSPCSIZE	Size of the `IPEI_DBTABLESPC` tablespace. (See Data Tablespace Name for more information.)	O
IPEI_DTBLSPCLOC	Location of the `IPEI_DBTABLESPC` tablespace. (See Data Tablespace Name for more information.)	O
IPEI_DBTEMPSPC	Temporary Tablespace Name	O
IPEI_TTBLSPCSIZE	Size of the `IPEI_DBTEMPSPC` tablespace. (See Temporary Tablespace Name for more information.)	O
IPEI_TTBLSPCLOC	Location of the `IPEI_DBTEMPSPC` tablespace. (See Temporary Tablespace Name for more information.)	O
IPEI_DBSCHEMA_SIZE	Size of the tablesizes control file to be used to configure the iProcess Engine database schema. (See Schema Sizing Configuration for more information.)	O
IPEI_DBSCHEMA_CTRLFILE	Full pathname to a custom tablesizes control file. (See Schema Sizing Configuration for more information.)	O
IPEI_DB2FENCEUSR	DB2 specific Fenced Username	O
IPEF_DBSOUCREATE	`Y` to Create iProcess Engine DB Schema Owner account	R
IPEF_DBFUCREATE	`Y` to Create iProcess Engine DB User account	R
IPEF_DBDTSCREATE	`Y` to Create Database Tablespace	R
IPEF_DBTTSCREATE	`Y` to Create Temporary Tablespace	R
IPEF_GOTDBINFO	`Y` if DB Information is Complete and Validated	R
IPEF_CLUSTERINST	`Y` if sub-node is in existing cluster	R
IPEF_DELETETABLES	`Y` if existing DB schema is to be deleted	R

Did you find this helpful?

Yes No