exportWebCatalog

@Since 5.5.0.1

Extracts WebCatalog objects from an OTBI server to the the file system.  This operations is only supported for partial deployment projects.

This operation is especially useful to automate the syncing of catalog items to a source control management system. 


Endpoint Tip

This operation uses HTTP operations 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

OTBI Server HostFDOTBI_SERVER_HOSTYesThe server host name for Oracle Transactional Business Intelligence.

OTBI Server Port

FDOTBI_SERVER_PORTYesThe HTTP port number for Oracle Transactional Business Intelligence.  Default is 443.
OTBI Server UserFDOTBI_USERYesThe user to log into Oracle Transactional Business Intelligence. User must have BI Service Administrator role to unarchive catalog.
OTBI Server PasswordFDOTBI_PASSWORDYesThe password for the user to login to Oracle Transactional Business Intelligence.
OTBI Server SSL ConnectionFDOTBI_SERVER_USE_SSLYesIndicates whether to connect to OTBI server using SSL.  Default is true.

Project Properties

Property Name

Property Code

Required

Description

OTBI WebCat Object PathFDOTBI_OBJECT_PATHYes

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

Default value is "/shared/Custom".

Inputs

Input Name

Input Code

Required

Description

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

Copy Object Permissions

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

FDOTBI_INP_PRESERVE_TIMESTAMPS

No

Export object with timestamp details.

Outputs

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.