downloadWebCatalog

@Since 5.6.0.6

Extracts WebCatalog objects from an OTBI server to the file system.  This operation can be used from a utility workflow, which can also be augmented to sync the files to a source control management system (such as Git or Subversion). This allows the OTBI project which is used for build and deployment to source from a source code repository rather than directly from a development instance of OTBI.

Endpoint Tip

This operation uses HTTPS to communicate remotely to the OTBI server, and therefore, can be executed on any endpoint (including LOCALHOST).

Environment/Instance Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OTBI Server Host

FDOTBI_SERVER_HOST

Yes

The server host name for Oracle Transactional Business Intelligence.

OTBI Server Port

FDOTBI_SERVER_PORT

Yes

The HTTP port number for Oracle Transactional Business Intelligence.  Default is 443.

OTBI Server User

FDOTBI_USER

Yes

The user to log into Oracle Transactional Business Intelligence. User must have BI Service Administrator role to unarchive catalog.

OTBI Server Password

FDOTBI_PASSWORD

Yes

The password for the user to login to Oracle Transactional Business Intelligence.

OTBI Server SSL Connection

FDOTBI_SERVER_USE_SSL

Yes

Indicates whether to connect to OTBI server using SSL.  Default is true.

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)

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

 

 

 

 

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

WebCatalog Object Path

FDOTBI_INP_OBJECT_PATH

Yes

The WebCatalog path to be downloaded. Separate folders with a forward slash (/). (e.g. /shared/Custom/Financials)

Download Folder

FDOTBI_INP_DOWNLOAD_FOLDER

No

Absolute or relative target folder path. Relative path will be assumed in FD_TEMP_DIR.

Copy Object Permissions

FDOTBI_INP_COPY_PERMISSIONS

Yes

Copy object with current permissions. If false, parent folder permissions in deploy environment will be used.

Keep Timestamps

FDOTBI_INP_PRESERVE_TIMESTAMPS

Yes

Download object with timestamp details.

Outputs

Output Name

Required

Description

Output Name

Required

Description

 

 

 

Artifacts

This operation does not produce any artifacts.

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.

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