obiDeploy

Deploys any combination of WebCatalog objects to the target OBIEE environment. Objects will be deployed at the same path they were built from, e.g. if a report was built from /shared/Sample Lite/Reports, it will also be deployed to the same location on the target server.

In case of DataModel, property replacement on data sources will occur if the Config File Input is specified. For more information on Property Replacement for OBIEE, see OBI WebCatalog - DataModel Configuration File.

When deploying to 12C, it may not be necessary to specify the replacement values as OBI 12c takes care of the replacement for you in the target environment. If deploying to a new environment, it would be helpful. If your changes don't seem to be working in 12C, verify that the override files contain the correct data. They will override the values that FlexDeploy uses.

Deploy operation now supports deleting WebCatalog items. To delete an item, in the Package Files tab, click the Action menu or Right click and toggle Delete option.

Note: Delete is not supported for Folder type items.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OBIEE Server Port

FDOBIEE_SERVER_PORT

Yes

The managed server port number for OBIEE.(e.g. 9502 or 9704)

OBIEE Server Host

FDOBIEE_SERVER_HOST

Yes

The managed server host name for OBIEE.

OBIEE Server Use SSL

FDOBIEE_SERVER_USE_SSL

Yes

Check if the connection to the managed server should be made using t3s. Otherwise, it will be made using t3. Defaults to false.

OBIEE Server User

FDOBIEE_USER

Yes

The user to log into OBIEE. Should have sufficient privileges to move and upload data.

OBIEE Server Password

FDOBIEE_PASSWORD

Yes

The password for the user to login to OBIEE.

Oracle Middleware Home (MW_HOME)

FD_ORACLE_MW_HOME

Yes

The Oracle Middleware Home (which has subfolders such as oracle_common, wlserver, coherence*, etc.) (e.g. /u01/oracle/products/fmw)

Weblogic Domain Directory

FDWLS_DOMAIN_DIRECTORY

Yes

Weblogic Domain Directory.(e.g. /u01/oracle/config/domains/soa_domain)

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OBIEE WebCat Object Path

FDOBIEE_OBJECT_PATH

No

The WebCatalog path to be exported. Separate folders with a forward slash (/).

The value must be the same during the build and deploy, so if it is desired to change the value, please perform a new build.

OBIEE Analytics WSDL Path

FDOBIEE_ANALYTICS_WSDL_PATH

No

The path to the analytics WSDL. We don’t recommend changing this option unless the OBIEE instance you are using has a different path to the analytics WSDL. Use at your own risk.

Default value - /analytics-ws/saw.dll/wsdl/v7

Discover Sub-Items

FDOBIEE_DISCOVER_SUB_ITEMS

No

Only applicable to OBI V2 projects. Select the objects to make their sub-items to be discoverable in the file catalog. If none are selected, entire dashboards and scorecards are populated as a single item. If checked, each sub-item will be populated as separate deployable files.

See input FDOBIEE_INP_UPDATE_LAST_MODIFIED for information about how this property works in conjunction with it.

Backup files prior to deploy

FD_BACKUP_FILES_PRIOR_TO_DEPLOY

No

Indicates whether a backup of the files should be performed prior to deploying the files.

For more information on the backups repository see: FlexDeploy Backups Repository

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Copy Object Permissions

FDOBIEE_INP_COPY_PERMISSIONS

Yes

Upload object with exported permissions. If false, parent folder permissions in deploy environment will be used.

Overwrite Object

FDOBIEE_INP_OVERWRITE_OBJECT

Yes

If object already exists in deployment environment, should it be overwritten with this one.

Config File

FDOBIEE_INP_CONFIG_FILE

No

Config file name for DataModel property replacement. Config file can be absolute path or relative to artifacts folder. If you are using config file from temp folder, then use FD_TEMP_DIR variable to indicate absolute path (using groovy expression for input).

You can either

  1. Save config file during build operation as artifact, or

  2. Extract it from SCM during deploy workflow or

  3. Use absolute path to location on server. (Not recommended as it requires manual setup on server)

See OBI WebCatalog - DataModel Configuration File for details.

Update Last Modified

FDOBIEE_INP_UPDATE_LAST_MODIFIED

No

If checked, last modified will be updated to current time on web catalog item. If Keep Timestamps is checked on build then it may make sense to not check this. (Boolean)

A few details:

V1 projects do not allow selecting portions of scorecards or dashboards for deployment, so if checked, the entire scorecard or dashboard will be marked as updated. This is done with a recursive request to OBI to update the timestamp.

V2 projects allow with project property FDOBIEE_INP_UPDATE_LAST_MODIFIED checked will set individual timestamps on the exact objects that are deployed. This call is not recursive, so if the dashboard is deployed as a unit, its contents will retain their existing last modified dates.

Artifacts

This operation consumes the artifacts produced from the obiBuild operation.

Endpoint Selection

This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the Target. Selecting a specific resource will result in selection of endpoints associated to the Target which have that resource defined.

Endpoint Execution

This operation delegates endpoint execution to the workflow developer. The workflow editor will default to "Any", which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to "All" to will result in execution on all selected endpoints.

 

The following macros are not currently supported in the footer:
  • style