Property Detail

• java.lang.String adminHost

  The hostname used for the OBI Admin Server. Default: result of the Java getHostname() method

• java.lang.String adminPassword

  The password associated with adminUser.

• java.lang.Object adminPort

  The port used for the OBI Admin Server. Default: depends on the version of OBIEE

• java.lang.String adminUser

  The name of the OBI administration user. Default: weblogic

• java.lang.String barPassword

  Password used for encrypting a BAR file.

• java.lang.String biHost

  The hostname used for the OBI BI service in 12c. Checks with the OS for a default. Default: result of the Java getHostname() method

• java.lang.Object biPort

  The BI server port number. Default: depends on the version of OBIEE

• java.lang.String catalogArchiveFolder

  The presentation catalog folder used for all deployments. The default should almost always be used. Default: '/shared'

• java.lang.Boolean catalogDeleteFirst

  When 'true', the catalogArchiveFolder is first deleted before the archive file is unarchived. Default: true

• java.lang.String catalogDiffFolder

  The presentation catalog folder used for generating diff patches. The default should almost always be used. Default: '/shared'

• java.lang.String catalogOverwrite

  The 'overwrite' parameter expected by Catalog Manager. Default: 'clean'

• java.lang.String catalogParentFolder

  The presentation catalog parent folder used for all deployments. The default should almost always be used. Default: '/'

• java.lang.String catalogPermissions

  The 'permissions' parameter expected by Catalog Manager. Default: 'create'

• java.lang.String catalogSkipFolder

  A comma-separated list of presentation catalog folders to skip with catalog deployment tasks. Default: NULL, so no presentation catalog folders are skipped.

• java.lang.String cliPathPolicy

  Determine the path strategy used for calling CLI utilities. Value of 'bitools' means that the full path to the 'bitools' directory will be appended to all CLI calls. Default: bitools

• java.lang.String compatibility

  The version of OBI APIs and utilities that Checkmate will execute against. OBI usually accepts API calls for prior compatibility versions. Default: 12.2.1.4

• java.lang.String connPoolsName

  Default file name used when exporting and importing connection pools. Default: conn-pools.json.

• java.lang.String connPoolsPath

  Full file path that overrides connPoolsName.

• java.lang.String contentPolicy

  This parameter controls whether we are primarily importing, exporting and publishing OBIEE content using traditional tools and APIs, therefore generating distribution files. Or, whether we are using the new BAR utilities and APIs introduced in OBIEE 12c.

  1. distribution: default to utilities used for generating distribution files.
  2. distribution-metadata: same as distribution, except distribution files only contain metadata content.
  3. distribution-catalog: same as distribution, except distribution files only contain catalog content.
  4. bar: default to utilities used for generating BAR files.
  5. mixed: (DEPRECATED) imports and exports using distribution tools, but also generate a BAR file during publication.

• java.lang.String decisionFileName

  Name used for the decision analytics file. Default: obi-decision.json

• java.lang.String domainHome

  The location of the OBI domain.

• java.lang.Boolean enableBuildGroups

  Determines whether the default build groups 'feature', 'release' and 'promote' are automatically enabled. Default: true

• java.lang.Boolean exportConnPoolVars

  Determines whether variables are exported as well when issuing 'connPoolsExport'. Default: true

• java.lang.String fmwInstance

  OBI 11g Only: The name of the Fusion Middleware Instance. Defaults to 'instance1'.

• java.lang.Boolean generateMergedRpd

  Determines whether a fully-merged repository file is created and added to any distribution files when `metadataCompare` tasks are executed. Default: true

• java.lang.Boolean generateXml

  Determines whether a single XML file of the repository is created and added to any distribution files. Default: false

• java.lang.Boolean importReload

  Determines whether metadataReload is executed during import workflow tasks. Default: true

• java.lang.Boolean importVersionJson

  Determines whether the current_version repository variable is created and populated during import workflow tasks. Default: true

• java.lang.Boolean importWorkflowConns

  Determines whether connPoolsExport and connPoolsImport are executed during import workflow tasks. Default: true

• java.lang.String jarContents

  Name for the directory where the Checkmate JAR contents are extracted. Default: jar-contents

• java.lang.Object jenkinsAdminCred

  The Jenkins username/password credential environment variable used to specify 'adminUser' and 'adminPassword'. Default: ADMIN

• java.lang.String metadataFileName

  Name used for the metadata analytics file. Default: obi-metadata.json

• java.lang.String metadataPatchMode

  The patch upgrade strategy used when automatically applying patches to offline repositories. Default: upgrade

• java.lang.String metadataProject

• java.lang.String middlewareHome

• java.lang.String mudHistXmlName

• java.lang.String mudMasterPath

• java.lang.Boolean patchReload

  Determines whether metadataReload is executed during patch workflow tasks. Default: true

• java.lang.Boolean patchVersionJson

  Determines whether the current_version repository variable is created and populated during patch workflow tasks. Default: true

• java.lang.Object presentationPort

  The presentation server port number. Default: depends on the version of OBIEE

• java.lang.Object protocol

  The presentation server protocol to use. Default: http

• java.lang.String publishBase

  The base file name for artifacts. Default: the name of the project directory

• java.lang.String publishGroup

  The publication group used for artifacts Default: obiee

• java.lang.String reportDirName

  The default name of the directory where catalog reports are written. Default: 'misc/reports'

• java.lang.String repositoryMode

  Mode for storing the metadata repository in source control.

  1. dir: MDS-XML format (the default)
  2. xml: A single XML file with the entire repository
  3. bin: A binary repository.

• java.lang.String repositoryPassword

  The password used for the OBI metadata model repository.

• java.lang.Boolean resetVariables

  When 'true', variables that have changed value, but not definition, will be ignored during a metadata export. Default: true

• java.lang.String scmCommitPath

• java.lang.String scmCommitter

• java.lang.String scmEmail

• java.lang.String scmMessage

• java.lang.String serviceInstance

  OBI 12c Only: The Service Instance to deploy content to.

• java.lang.String sourceBase

  Base directory for source control. Default: src/main

• java.lang.String testFileName

  Name used for the test analytics file. Default: obi-test.json

• java.lang.String testPassword

• java.lang.String testUser

• java.lang.String trustPassword

  Password used with the SSL trust keystore.

• java.lang.String trustPath

  Path to the SSL trust keystore.

• java.lang.Boolean useBarArchive

  Determines whether importarchive.sh and exportarchive.sh are used with 12c BAR tasks. Default: true

• java.lang.Boolean useCatalogArchive

  When 'true', presentation catalog archive files are used for import/export processes instead of catalog directory copies and syncs. Default: false

• java.lang.Boolean useMergedRpd

  Determines whether fully-merged repository files are used from distribution files instead of the repository file that was built from source control. Default: false

• java.lang.Boolean useOnlineCatalog

  When 'true', access to the presentation catalog is made through the online API, instead of the offline API. Default: false

• java.lang.String useOnlineMetadata

  When 'true', the online API is used for applying metadata patches. When 'false', patching is applied offline, and then the entire RPD is uploaded. Default: false

• java.lang.Boolean useRestApi

  Determines whether an equivalent REST API call will be used whenever available. Default: false

• java.lang.Boolean validateRpd

  Determines whether repository validation will run as part of the 'metadataBuild' process. Default: true

• java.lang.String variablesName

  Default file name used when exporting and importing variables. Default: variables.json.

• java.lang.String variablesPath

  Full file path that overrides variablesName.