Using O3 Builder

Owned by Nicolás Palombo (Unlicensed)
Last updated: 24 Sept, 2008Version comment
5 min read
Unknown macro: {scrollbar}

Use the O3 Builder command to perform an incremental or complete build from command line, or by scheduling the cube building through the operating system's task scheduler.

Builder.exe is located in the bin directory of your O3 install location. There is also a .bat or .sh script file available in the bat or sh folders respectively depending on the platform.

The Builder's execution syntax is:

Builder [opciones] <modelo | cubo | servercfg>

Options include:

Option

Description

-log

Enables logging to the console.

-logfile=<filename>

Enables logging to the specified log file.

-logtype

Configures the type of logfile to generate.
Options are:

  • clear: Deletes the file before every build
  • append: Appends new information to the log if it already exists

-help

Display the possible parameters and options for the command.

-version

Display version information for O3 components.

-cube=<filename>

Specify the location and name of the cube you are generating. This is valid only for a full build. If you do not specify a filename, the default location and name are the same as for the model.

-is=<InputSet>

Specify the input set to use in the build. If you are performing a complete build, specify a full input set for this option and an .mdl file as the parameter. If you do not specify an input set, the default is the Full input set.If you are performing an incremental build, specify an incremental input set for this option and a .cube file as the parameter. If you do not specify an input set, the default is the Incremental input set.

-cfg=<filename>

Specify the location and name of the file containing the substitute build parameters. By default, the build parameters are taken from the ParamDefs page of the cube's property pane.

-server

Indicate that the O3 Builder is executing as a Server. This allows a user to connect from Adm Server to the Builder during the build process, to shut it down using ShutDown, or to view the log. This is useful in cases where the build process is lengthy.If you execute a ShutDown while the cube is being built or updated, the shutdown is defered until the build is complete. If the process is waiting on a retry, the shutdown is immediate.

-port=<number>

When you execute O3 Builder as a server, you must specify a port for the connection between the AdmServer and the O3 Builder. The format is <hostname>:<portnumber>. The default is port 1098.


Specify one of the following parameters:

Type

Description

model

A .mdl file, indicates that a full build corresponding to the indicated model is requested. If you do not specify an input set, the default is the Full input set.

cube

A .cube file, indicates that an incremental build of the indicated cube is requested. If you do not specify an input set, the default is the Incremental input set.

servercfg

A .srv file containing the configuration of a cube running in an O3 Server, indicates that a full or incremental build of this cube is requested. The building type is specified using the -is option. With this type of build, O3 Builder connects to the O3 Server, disables the cube (closing the session of connected users), builds or rebuilds the cube, enables the cube.The generated cube is located in the URL defined for the cube in the O3 Server.


The .srv file should have the format of the following example:

serverHost = localhost
serverName = O3Server
cubeName   = Demo
model      = C:\IdeaSoft\O3\Demo.mdl
user       = admin
password   = admin

where:

serverHost

is the IP name or number of the machine where O3 Server is executing.

serverName

is the name of the server O3 Builder is connecting to. Typically this is O3Server

cubeName

is the name of the cube being executed in the O3 Server.

model

is the path and name of the cube building model. It is used for full builds.

user

is the user through which O3 Builder connects to the O3 Server. The user must have administrative permissions for the cube being updated.

password

is the password for the specified user.

publishType

Specifies how the cube will be made available to the server
Options are:

  • none: This is the default value and ensures backward compatibility.
  • upload: O3 Builder creates the cube in a temporary repository and then send it to the server. This repository could be the file system, ftp or istore
  • contents: O3 Builder sends the content of the cube as it is being built to the server.

targetURL

Specifies where the cube will be created.
This option is ignored when publishType is set to "none"

forceAvailable

Specifies if the datamart would be made available once updated
This option is ignored when publishType is set to "none"

uploadURL

Specifies the temporary repository where the cube will be created.
This URL could be file system, fto or istore.
This URL has to be visible to both the O3 Builder and the O3 Server.
This option is only relevant when the publishType was set to "upload".
The default URL is the temporary folder for the user running the O3 Builder

deleteDownloadFile

Specifies if the datamart has to be deleted from the temporary repository once updated in the server
The default value is false

deletePreviousCube

Specifies if the previous version of the datamart has to be deleted when the new version is published.
This is only accomplished if the property "o3.publish.mode" is set to "newfile" in the GServer.properties or GServer_custom.properties file

(warning) Note
This .srv file can be created automatically using the O3 Server Administrator, mechanism that also encrypts the password to the server. More details about this feature can be accessed in the Managing Cubes page from the O3 Server Administratormanual.

Examples

The following examples are based on the Bike demonstration data. This includes data for the years 1997 and 1998.

Generating A Complete Build

C:\O3\bat\builder -cube=C:\O3\IncrementalBuild\Complete.cube C:\O3\files\IncrementalBuild\IncrementalBuild.mdl

This command line generates a Complete.cube containing information for 1997 and 1998 as follows:

  • the -cube parameter was used to change the name of the destination cube
  • because no input set is included, the default is a full set
  • specifying the .mdl file indicates a full build

Generating A Cube with 97 Only Data

C:\O3\bat\builder -is=Only97 C:\O3\files\IncrementalBuild\IncrementalBuild.mdl

This command line generates a cube containing data for 1997 only as follows:

  • the -is parameter specifies an input set named Only97 de tipo full which uses Only97.txt as the data source
  • the destination cube name is IncrementalBuild.cube because it defaults to the same name as the model file if a cube name is not specified as a full construction.

Adding 98 Data to the 97 Only Cube

C:\O3\bat\builder -is=Inc98 C:\O3\files\IncrementalBuild\IncrementalBuild.cube
  • the -is parameter specifies an input set named Inc98 which uses Inc98.txt as the data source
  • specifying the .cube file indicates that this is an incremental build on the indicated cube
Unknown macro: {scrollbar}