exportWebCatalog
- Karl Henselin
- Chandresh Patel
- Muthu Sankaralingam
Extracts WebCatalog objects from an OTBI server to the file system. This operation is only supported for package-based 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).
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
OTBI Account |
| Yes | The OTBI account includes essential properties such as the URL, Username, Password, and OAuth details for the Oracle environment. Cloud account credentials are required for downloading or uploading catalog items. You can manage the Oracle Transactional BI account via the Integrations > Cloud page. In FlexDeploy versions 9.0.0.3 or earlier, separate properties (FDOTBI_SERVER_HOST, FDOTBI_SERVER_PORT, FDOTBI_USER, FDOTBI_PASSWORD, FDOTBI_SERVER_USE_SSL) were used instead of the cloud account. If you are upgrading from FlexDeploy 9.0.0.3 or earlier, the OTBI cloud account will be automatically created from the target properties (Host, Port, Username, Password, SSL Connection). A separate cloud account will be created for each target. See Configuring Cloud Account for Oracle Transactional BI for additional details. |
Discover Thread Count |
| No | Number of threads to use when discovering files for the File Catalog from the OTBI server. Defaults to 3. |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
OTBI WebCat Object Path |
| Yes | The WebCatalog path to be recursively exported. Separate folders with a forward slash (/) (e.g. /shared/Custom/Financials). Default value is "/shared/Custom". |
Analytics WSDL Path |
| No | The path to the analytics WSDL. We don’t recommend changing this option unless the OTBI instance you are using has a different path to the analytics WSDL. Use at your own risk. Default value - /analytics-ws/saw.dll/wsdl/v12 |
Discover Sub-Files |
| No | Select the objects to make their sub-files to be discoverable in the file catalog. |
Project File Includes |
| No | Controls files included from Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /Custom/*##*.xdo##*Risk Management*##(.*)Workflow Notifications(.*) @since 9.0.0.1 |
Project File Excludes |
| No | Controls files excluded in Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /Custom/*##*.xdo##*Risk Management*##(.*)Workflow Notifications(.*) @since 9.0.0.1 |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Export Folder |
| No | Absolute or relative target folder path. Relative path will be assumed in FD_TEMP_DIR. |
Copy Object Permissions |
| Yes | Copy object with current permissions. If false, parent folder permissions in deploy environment will be used. |
Keep Timestamps |
| No | Export object with timestamp details. |
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 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.
Related content
- style