/
deployWebCatalog (OAC)

deployWebCatalog (OAC)

Deploys any combination of WebCatalog objects to the target OAC environment. Objects will be deployed at the same path they were built from, e.g. if a report was built from /shared/Custom/Sample Lite/Reports, it will also be deployed to the same location on the target server.

Endpoint Tip

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

Deploy operation now supports deleting WebCatalog items. To delete an item, in the Package Files tab, click the Action menu or Right click and toggle Delete option.

Note: Delete is not supported for Folder type items.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OAC Account

FDOAC_CLOUD_ACCOUNT_CODE

Yes

The OAC account includes essential properties such as the URL, Username, Password, and OAuth details for the OAC instance. Cloud account credentials are required for downloading or uploading catalog items.

You can manage the OAC account via the Integrations > Cloud page.

In FlexDeploy versions 9.0.0.2 or earlier, three separate properties (FDOAC_SERVER_HOST, FDOAC_USER, FDOAC_PASSWORD) were used instead of the OAC account. If you are upgrading from FlexDeploy 9.0.0.2 or earlier, the OAC cloud account will be automatically created from the target properties (URL, Username, Password). A separate cloud account will be created for each target.

See Configuring OAC Cloud Account for additional details.

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OAC WebCat Object Path

FDOAC_OBJECT_PATH

No

The WebCatalog path to import the objects of the build artifact into.  The property is shared with the build operation and must not be changed between build and deployment execution.

Note: In case of package deployments, the import path is considered from the package file path.

OAC Analytics WSDL Path

FDOAC_ANALYTICS_WSDL_PATH

No

The path to the analytics WSDL. We don’t recommend changing this option unless the OAC 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

Backup files prior to deploy

FD_BACKUP_FILES_PRIOR_TO_DEPLOY

No

Indicates whether a backup of the files should be performed prior to deploying the files.

For more information on the backups repository see: FlexDeploy Backups Repository

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Copy Object Permissions

FDOAC_INP_COPY_PERMISSIONS

Yes

Upload object with exported permissions. If false, parent folder permissions in deploy environment will be used.

Overwrite Object

FDOAC_INP_OVERWRITE_OBJECT

Yes

If object already exists in deployment environment, should it be overwritten with this one.

Deploy Objects In Async Mode

FDOAC_INP_ASYNC_MODE

Yes

When FDOTBI_INP_ASYNC_MODE is enabled, all objects are deployed in asynchronous mode else deploy in synchronous mode. This is useful for large object, where timeout errors can occur around the 4 MB file size threshold.

Default Value: true

Async API Timeout

FDOAC_INP_ASYNC_TIMEOUT

Yes

The maximum number of seconds to wait for unarchive process. Defaults to 1200 seconds (20 minutes). (Integer)

Note: This option is only considered when the FDOAC_INP_ASYNC_MODE is checked.

Update Last Modified

FDOAC_INP_UPDATE_LAST_MODIFIED

No

If checked, last modified will be updated to current time on web catalog item. If Keep Timestamps is checked on build then it may make sense to not check this. (Boolean)

Artifacts

This operation consumes the artifacts produced from the buildWebCatalog 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 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

buildWebCatalog (OAC)
buildWebCatalog (OAC)
More like this
obiBuild
Read with this
exportWebCatalog (OAC)
exportWebCatalog (OAC)
More like this
Source Control for WebCatalog Objects
Source Control for WebCatalog Objects
Read with this
downloadWebCatalog (OAC)
downloadWebCatalog (OAC)
More like this
FlexDeploy 9.0 Release Notes
FlexDeploy 9.0 Release Notes
Read with this
The following macros are not currently supported in the footer:
  • style