Builds a deployment object that contains any combination of WebCatalog objects or the OBI Repository file(RPD).
In full deployment mode, the artifacts are downloaded from a source OBI server. In Partial mode, they can be sourced from either an OBI server or SCM instance.
All WebCatalog objects and the RPD are supported for both full and partial deployments.
If partial deployment is used, each of the WebCatalog files will be placed into one of the following buckets:
- Analysis
- Dashboards
- DashboardPrompts
- DataModels
- Filters
- Folders
- KPIs
- MetaData
- Reports
- StyleTemplates
- RPD
- Other Files
In the case of the RPD and DataModels, property replacement on variables and connection pool information is supported via a configuration file that should reside in an SCM repository. For more information on Property Replacement for OBIEE, see RPD Configuration File Setup and Datamodel Configuration File Setup. Note that if you want to provide a config file for both the RPD and DataModels and deploy both at the same time using partial deploy, the two configurations should reside in one common file which is specified on the obiDeploy input Config File.
Source Controlling
Source Controlling of OBI Objects and the RPD is supported as of 4.0.3. When sourcing the objects through a Source Control Management system, some additional setup and consistencies are required.
Environment/Instance Properties
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 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. |
| OBIEE Admin Server Port | FDOBIEE_ADMIN_PORT | 11G | Required for OBI 11G. Not used in 12C. The admin server port number for OBIEE.(e.g. 9500 or 7001) |
| OBIEE RPD Name | FDOBIEE_RPD_NAME | Yes | The RPD name on the OBIEE server. (e.g. liverpd) |
| OBIEE RPD Password | FDOBIEE_RPD_PASSWORD | Yes | The RPD password on the OBIEE server. |
| Oracle BI Service Instance Name | FDOBIEE_SERVICE_INSTANCE_NAME | 12C only | Required for OBI 12C build and deploy of the RPD. Not used in 11G. The Oracle BI Service instance name.(e.g. ssi) |
| Oracle BI Home | FD_ORACLE_BI_HOME | 11G | Required for OBI 11G. Not used in 12C. The oracle BI home. (e.g. /oracle/Middleware/Oracle_Home/Oracle_BI1) |
| Oracle BI Domain Path | FD_ORACLE_BI_DOMAIN | 11G | Required for OBI 11G. Not used in 12C. The oracle BI domain home. (e.g. /oracle/Middleware/Oracle_Home/user_projects/domains/bifoundation_domain) |
| Oracle BI Instance Path | FD_ORACLE_BI_INSTANCE | 11G | Required for OBI 11G. Not used in 12C. The oracle BI instance home.(e.g. /oracle/Middleware/Oracle_Home/instances/FDBI01) |
| 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) |
| Oracle Weblogic Home (WL_HOME) | FDWLS_WEBLOGIC_HOME | Yes | Weblogic Home Directory. (e.g. /u01/oracle/products/fmw/wlserver) |
| 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 |
|---|---|---|---|
| OBIEE WebCat Object Path | FDOBIEE_OBJECT_PATH | Yes | The WebCatalog path to be recursively exported. If using full deployments, leave blank if you wish to build the RPD. Separate folders with a forward slash (/). The value must be the same during the build and deploy, so after changing the value, please do not deploy any old builds. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Copy Object Permissions | FDOBIEE_INP_COPY_PERMISSIONS | Yes | Copy object with current permissions. If false, parent folder permissions in deploy environment will be used. |
| Recursive WebCat Object Build | FDOBIEE_INP_RECURSIVE_CAT_BUILD | Yes | Boolean to indicate if a recursive build should be performed for web catalog objects. If false, no objects under the catalog path will be exported. This will only be set to false in rare circumstances. Even if you only wish to export a single WebCatalog object, chances are that object has other data underneath it, that are required for the object to run, that would justify a recursive export. |
| Recursive WebCat Folder Build | FDOBIEE_INP_RECURSIVE_FOLDER_BUILD | Yes | Boolean to indicate if a recursive build should be performed for web catalog folders. If false, no objects under the catalog path will be exported. |
Outputs
Output Name | Required | Description |
|---|---|---|
Artifacts
This operation produces an archive file of the object specified in the OBIEE WebCat Object Path or the RPD artifact if the project is configured for full deployments. If the project is configured for partial deployments, then the artifact will be a zipped directory containing the archive files for each built object(whether WebCatalog or RPD). The zip/archive files are suitable for the deploy 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 environment instance. Selecting a specific resource will result in selection of endpoints associated to the environment instance 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.