How to start IFS Configuration Builder with arguments

You can run Configuration Builder with predefined parameters stored in a text file, in document called setup.ini. This makes it possible to run the Configuration Builder to build the whole IFS Application, connect to a database, create the install.tem, and to compile all sources, from a command prompt or a command script.

Prerequisites

To be able to build, the components needs to have been fetched in advance. You can do this either by using the Configuration Builder or by copying the components to a folder, e.g. named Components. When building, all default values will be used. If there is a dependency to a component not included in the build, the Configuration Builder assumes that this component already exist in the destination. When creating the install.tem, component versions in database will be checked and that tablespaces defined in deploy.ini exists, but all other default values will be used as defined in the components deploy.ini.

Process

To execute the Configuration Builder in batch mode, you start the tool with the setup.ini file as the parameter. This parameter points out the setup.ini (path + file name) that contains the settings to use for the build. You can in command window start the Configuration Builder with parameter /? to get help about the construction of the setup.ini file and the different codes return from the tool after execution. These return codes can be examined as errorlevel codes in command script, to ensure that build was successfully executed.

A second parameter, log file, can also be set when starting the tool. The messages that the tool sends to console will instead be spooled to defined log file. Check the log file for e.g. incorrect tablespace definition if connection to database has been performed.

Actions to perform

  1. Start the tool in command window.
    1. IfsConfigBuilder /? to get a hint of how to startup IFS Configuration Builder in command window.
    2. IfsConfigBuilder .\setup.ini to execute the command defined in setup.ini file (IfsConfigBuilder [PATH]\setup.ini).
    3. IfsConfigBuilder .\setup.ini .\log.txt to execute the command defined in setup.ini file and spool console output to log file (IfsConfigBuilder [PATH]\setup.ini [PATH]\log.txt).
    4. IfsConfigBuilder /checkversion to get the version of actual executable, as well as latest version of the tool on \\corpnet\files\F1Tools\IFSConfigBuilder.
      The output will be in format x.x.x.x;y.y.y.y where x.x.x.x is actual version and y.y.y.y version on the share. If \\corpnet\files\F1Tools\IFSConfigBuilder can't be reached, y.y.y.y will be returned as 0.0.0.0
    5. IfsConfigBuilder /checkversion .\log.txt to spool the console to log file (IfsConfigBuilder /checkversion [PATH]\log.txt).

     

Configuration File

The setup.ini file has a pre specified structure with named sections. The file can contain information about the component folder, build destination, build options, database information when creating install.tem file.

Below an example of a configuration file.

[Startup]
ComponentsFolder=Y:\Workspace\Components
BuildDestination=Y:\Workspace\Build_Home
AlternativeTemplates=

[BuildOptions]
IncludeBuildOptions=All
CompileJava=
CompileDotNet=
Language=
CreateInstallationTemplate=
SilentMode=
ManualDeployPath=
InstallTemAdvance=

[Database]
User=<user>
Password=<password>
Server=<server>
Port=1521
Sid=<service name>
Setting Description
[Startup] Mandatory. Section declaration.
ComponentsFolder Mandatory. Full path to the components folder, manually created or previously fetched by Configuration Builder.
BuildDestination Mandatory. Full path to the build destination, the Build_Home, mandatory
AlternativeTemplates Optional. If not defined no alternative templates will be used. To override, partly or all, templates installed with Configuration Builder (see How to install IFS Configuration Builder), define the full path to the alternative templates.
[BuildOptions] Mandatory. Section declaration.
IncludeBuildOptions Mandatory. If set to All, all options will be included in the build. Options can be individually selected by listing them separated by semicolons, eg model;database;client;server;
CompileJava Optional. If not defined the value is set to No. If set to Yes, Java files for Server and Web will be compiled in the <BuildDestination>.
CompileDotNet Optional. If not defined the value is set to No. If set to Yes, C# for Enterprise Explorer will be compiled in the <BuildDestination>.
Language Optional. If not defined the value is set to NoLang. Define the language you want in the build, eg All, NoLang or semicolon seperated list of language codes (eg fi;sv;)
CreateInstallationTemplate Optional. If not defined the value is set to No. If set to Yes, install.tem file, and depending on contents, other subtemplates.tem files will be created. If [Database] section is defined, connection to database will be performed to get appropriate values
SilentMode Optional. If not defined the value is set to normal. Only valid value is ISD. This is used when running IFS Solution Developer (ISD) that calls Configuration Builder. If conditionalbuild exist for component in actual build, the conditional build wizard will be shown to the user for input.
ManualDeployPath Optional. If not defined no copy of files that should be manually handled will be performed. Define the full path to a folder where files that should be manually handled will be copied. Depending of the source for the build, all files in database folder that are not automatically deployed by a tem file (e.g. install.tem) and files in manualdeploy database folder will be listed in a file named FilesToHandleManually.txt and copied to ManualDeploySupport subfolder.  A file named TemFiles.txt will be created with information about tem file(s) that should be handled manually. The tem file(s) and the files called by the tem file(s) are copied to subfolder TemFilesSupport.
InstallTemAdvance Optional. If not defined the value is set to Yes. If set to No, the install.tem will be sorted on file type before component, instead of component before file type which would be the normal scenario. In addition all threading information will be removed from created tem files, meaning that the files will be deployed in one single sequence when using the IFS Application Installer (i.e no parallell/threaded deployment will occur).
[Database] Optional. Section declaration. If not defined no connection to database will be executed to fetch component, tablespace information, when creating the install.tem. If defined following parameters are mandatory.
User Application user in database.
Password Password for user.
Server The database server.
Port Port, e.g. 1521.
Sid Service name.