buildWebCatalog (OAC)

Builds a deployment artifact that contains WebCatalog objects.

All WebCatalog objects are supported for both full and partial deployments. If partial deployment is used, all objects are populated into a single object type called WebCatalog Objects, and file extensions are added to map to the underlying OAC object type (e.g. Folder, Data Model, Analysis, Report, etc).

Source Control

  • Full deployment mode - objects are downloaded from a source OAC instance.
  • Partial deployment mode - objects can be sourced from either a source OAC or SCM instance.

Endpoint Tip

This operation uses HTTP operations to communicate remotely to the OAC instance, and therefore, can be executed on any endpoint (including LOCALHOST).

Environment/Instance Properties

Property Name

Property Code

Required

Description

OAC Server Host
FDOAC_SERVER_HOST
YesThe server hostname for Oracle Analytics Cloud.
OAC Server User
FDOAC_USER
YesThe user to log into Oracle Analytics Cloud. User must have "BI Service Administrator" role to unarchive catalog.
OAC Server Password
FDOAC_PASSWORD
YesThe password for the user to log in to Oracle Analytics Cloud.

Project Properties

Property Name

Property Code

Required

Description

OAC WebCat Object Path
FDOAC_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".

Inputs

Input Name

Input Code

Required

Description

Copy Object Permissions

FDOAC_INP_COPY_PERMISSIONS
YesCopy object with current permissions. If false, parent folder permissions in the deploy environment will be used.
Keep Timestamps
FDOAC_INP_PRESERVE_TIMESTAMPS
No

Export object with timestamp details.

Outputs

Output Name

Required

Description




Artifacts

This operation produces an archive file of the object specified in the OAC WebCatalog Object Path 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. 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 with the environment instance. Selecting a specific resource will result in the selection of endpoints associated with 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 the previous step may have been executed. Changing this value to "All" will result in execution on all selected endpoints.