Wizard Scripting

In BBj 9.0 and higher, developers can customize the BASIS administrative (admin) wizard and run the wizard via scripting. In addition, they can specify the values for each wizard screen and run specified wizards either interactively or silently. These actions take affect when running the BASIS installation program or the Admin utility program.

The wizard.properties file shares some of the values specified in the response file used for automating a BBj install and will always overwrite all key values specified in the response file.

In order to run the wizard scripted, there must be a java.properties file. The wizard.properties file allows for the specification of key value pairs to control the behavior of the wizards. A sample wizard.properties file appears in the <bbj install>/bps/customInstall directory. During installation, the wizard.properties file takes effect when placed in the same directory as the BBj installation program named below.

In order for the wizard.properties to take affect when running the Admin utility, the wizard.properties file must exist in the <bbj install>/cfg directory.

The sample wizard.properties is self documenting; it describes all key values along with their default. If a value is blank or invalid, it assumes the default value.

Below is the sample wizard.properties file provided in the product build:

#######################################################################
#
# BASIS Wizards Scripting File
#
#
#
# Make sure all directory settings are specified with forward slashes.
#
######################################################################

######################################################################
#
# Global Settings
#
# "Language" specifies the language, this value can be:
# en, nl, fr, de, it, es, sv. The default is current locale
#
Language=en
#
# "LogFile" specifies the log file. The default is no log file.
#
LogFile=/tmp/BASISWizards.log
#
######################################################################

#######################################################################
#
# UACWizard
#
# "UACWizardRun" can be: interactive, silent, or off. The default is off.
# This wizard will only run on Windows machines in which UAC is enabled.
#
UACWizardRun=off
#
# Valid "UACWizardAction" settings are: admin or standard. Default is standard.
#
UACWizardAction=standard
#
######################################################################

#######################################################################
#
# Licence Registration Wizard
#
# "LicRegWizardRun" can be: interactive, silent, or off. The default is off.
#
LicRegWizardRun=interactive
#
# "LicRegWizardAction" can be: register or userSelection.
#
# If 'register' is specified, the wizard will go directly to the registration
# process.
#
# The Value 'userSelection' is only valid when LicRegWizardRun=interactive.
# When this value is specified, the LicInstallWizardRun and the SelectBLMWizardRun
# value need to be set to 'on' as well.
# If LicRegWizardRun=interactive, the default for this (LicRegWizardAction)
# value is userSelection.
# If LicRegWizardRun=silent, the default for this (LicRegWizardAction)
# value is register
#
LicRegWizardAction=userSelection
#
# "UserSelection" is only used when LicRegWizardAction=userSelection.
# Valid settings are: register, install, or selectBLM.
# Default is register.
#
UserSelection=
#
# Valid "DemoLic" settings are: yes or no.
# Default is no.
#
DemoLic=
#
# User Information
#
CompanyName=
FirstName=
LastName=
Email=
InfoEmail=
Fax=
Phone=
#
# License Information
# Only used if DemoLic=no
#
SerialNum=
AuthNum=
HostName=
HostID=COMPOSITE=
UserCount=
#
# Demo License
# Only used if DemoLic=yes.
#
DemoSerialNumber=
DemoAuthNumber=
#
# Valid settings for "RegMethod" are: auto, web, email, phone, other.
# Default is auto.
#
RegMethod=
#
# License Delivery Method
# Valid settings for Delivery are: web, email, fax.
# This setting is not used if RegMethod=auto
# Default is web
#
Delivery=
#
# Valid settings are: USA/Canada or Other
# Default is USA/Canada
#
country=
#
# Product Information
# Valid settings for "WantInfo" are: yes or no
# Default is no
#
WantInfo=
#
# Valid settings are yes or no
# Default is no
#
Notebook=
#
# "PhoneFile" is only used if RegMethod=phone
# Specify path and file name. An ASCII text file will be generated by wizard
# Example: /tmp/BASISPhone.txt
#
PhoneFile=
#
# "OtherFile" is only used if RegMethod=other
# Specify path and file name. An ASCII text file will be generated by wizard
# Example: /tmp/BASISother.txt
#
OtherFile=
#
######################################################################

######################################################################
#
# License Install Wizard
#
# Valid settings for "LicInstallWizardRun" are: interactive, silent, or off
# The default is off
#
LicInstallWizardRun=
#
# Enter License Info
# Valid settings for "LicInstallEnterLicInfo" are: true of false
# Default is false
#
LicInstallEnterLicInfo=
#
# License Location
# "LicInstallLicFileLoc" is only used if LicInstallEnterLicInfo=false
# Specify location of existing license file
# Example: /tmp/BASISLicense.txt
#
LicInstallLicFileLoc=
#
# License Info
# The following are only used if LicInstallEnterLicInfo=true
# NOTE: LicInstallHostID Must use a composite host id
#
LicInstallFeature=
LicInstallEncryptCode=
LicInstallLicRev=
LicInstallHostID=
LicInstallExpDate=
LicInstallCheckSum=
LicInstallNumOfUsers=
LicInstallSerialNum=
#
######################################################################

######################################################################
#
# Select BLM Wizard
#
# "SeelectBLMWizardRun" can be: interactive, silent, or off
# The default is off
#
SelectBLMWizardRun=
#
# "SelectBLMAction" can be: local or remote
# The default is local
#
SelectBLMAction=
#
# Set "SelectBLMServer" to the name of your license server
# Only used if SelectBLMAction=remote
#
SelectBLMServerName=
#
######################################################################

######################################################################
#
# BBj Startup Configuration Wizard
#
# "ConfigBBjStartUpWizardRun" can be: interactive, silent, or off
# The default is off
#
ConfigBBjStartUpWizardRun=
#

# ConfigBBjStartupRunType: How BBjServices should be started
#
# -- For Windows --
# Value can be: login, service, or manual
# Default is login
# -- For UNIX and Mac
# Value can be: init, or manual
# Default is init
#
ConfigBBjStartUpRunType=
#
# Configure BBj Startup User Account
# The following two values can be set only if ConfigBBjStartUpRunType=service
#
ConfigBBjStartUpUserAccount=
ConfigBBjStartUpPassword=
#
# Windows BBjServices Configuration (Windows Only)
# "ConfigBBjStartUpServiceStartUpType" can be: automatic, manual, or disabled
# Default is automatic
# Note: Value can only be set if
# ConfigBBjStartUpRunType=service
#
ConfigBBjStartUpServiceStartUpType=
#
######################################################################

######################################################################
#
# Run BBjServices Wizard
#
#
# Valid settings for "BBjServicesWizardRun" are: interactive, silent, or off
# Default is off
#
BBjServicesWizardRun=
#
# Valid settings for BBjServicesWizardAction are: start, stop, or restart
# Default is start
#
BBjServicesWizardAction=
#
# BBj Services Server Name
#
# The following values are only used if BBjServicesWizardAction=stop
# Default BBjServicesServiceName=localhost
# Default BBjServicesAdminPort=2002
# Default BBjServicesUserName=admin
# Default BBjServicesUserPassword=admin123 (Only used if BBjServicesWizardRun=silent)
# Default BBjServicesWaitForClients=false (wait for clients to disconnect)
#
BBjServicesServerName=
BBjServicesAdminPort=
BBjServicesUserName=
BBjServicesUserPassword=
BBjServicesWaitForClients=
#
######################################################################

######################################################################
#
# Configure BLM Startup Wizard

#
# "ConfigBLMStartUpWizardRun" can be: interactive, silent, or off
# Default is off
#
ConfigBLMStartUpWizardRun=
#
# "ConfigBLMStartUpRunType":Configure BLM Startup Wizard Settings
#
# -- For Windows --
#
# Value can be: service, login, or manual
# Default is service
#
# -- For UNIX and Mac --
#
# Value can be: init, or manual
# Default is init
#
ConfigBLMStartUpRunType=
#
# "ConfigBLMStartUpServiceStartUpType" can be: automatic, manual, or disabled
# Default is automatic.
# Note: Value can be set only if ConfigBBjStartUpRunType=service
#
ConfigBLMStartUpServiceStartUpType=
#
######################################################################

######################################################################
#
# BLM Startup Wizard
#
# "BLMWizardRun" can be: interactive, silent, or off.
# Default is off
#
BLMWizardRun=
#
# "BLMWizardAction" can be: start, stop, or restart
# Default is start
#
BLMWizardAction=
#
######################################################################

#######################################################################
#
# Enterprise Manager Wizard
#
# "EMWizardRun" can be: interactive, silent, or off
# Default is off
#
EMWizardRun=
#
# Enterprise Manager Wizard Settings
# Default EMWizardCurAdminPassword=admin123
# EMWizardNewAdminPassword= <Enter New Password Here>
# Default EMWizardAdminHost=localhost
# Default EMWizardAdminPort=2002
#
EMWizardCurAdminPassword=admin123
EMWizardNewAdminPassword=
EMWizardAdminHost=
EMWizardAdminPort=2002
#
######################################################################

######################################################################
#
# Finish Wizard
#
# "FinishWizardRun" can be: interactive or off
# Default is off
#
FinishWizardRun=
#
######################################################################

######################################################################
# Reboot Wizard
#
# "RebootWizardRun" can be: interactive or off
# Default is off
#
RebootWizardRun=
######################################################################