Source Control for OAC Webcatalog Objects
The FlexDeploy OAC solution enables developers to source WebCatalog objects either from a development OAC instance or directly from a source control system. When sourcing WebCatalog objects from source control, two key practices must be followed. For fully automated process see Automate check-in of development OAC catalog items to SCM.
First, the directory structure of the WebCatalog objects in the source control system must mirror that of the OAC WebCatalog. While the root directory in the source control repository can vary, the internal directory structure must precisely match that of the WebCatalog. For example, consider the following WebCatalog path for the report:
The path above must match the path in the source control system as we see below.
For the above example, FlexDeploy project source configuration will be configured with "OAC"
as the sparse checkout folders when using Git. This would ensure that all objects under that folder will be discovered as WebCatalog objects and the file path starts with /shared/Financials which matches the WebCatalog path in OAC.
Secondly, the files stored in source control should be named with the following extensions corresponding to the object type. The extensions are important to both ensure the deployment operation is handled correctly, and to make it easier to identify and search for these objects in FlexDeploy.
OAC Type Name | OAC Signature / Composite Signature* | Source Control Extension |
---|---|---|
Action | action | Action |
Agent | coibot1 | Agent |
Analysis | queryitem1 | Analysis |
Column | cosavedcolumn1 | Column |
Condition | condition1 | Condition |
Dashboard | dashboardfolder1 | Dashboard |
Data Model | .xdm * | Data Model |
Dashboard Prompt | globalfilteritem1 | Dashboard Prompt |
Filter | filteritem1 | Filter |
Hyperion Financial Reporting Report | application/hyperion-reports-report | Financial Reporting Report |
Group | customgroup1 | Group |
KPI | kpi1 | KPI |
KPI Watchlist | scorecardkpiwatchlist1 | KPI Watchlist |
Mobile App | .xma | Mobile App |
Report | .xdo * | Report |
Scorecard | scorecard1 | Scorecard |
Shortcut | N/A | Shortcut |
Style Template | .xss * | Style Template |
Visual Analyzer Projects | projectfolder1 | Visual Analyzer Projects |
The OAC signature can be viewed by hovering over the icon on the OAC WebCatalog Manager's properties for a catalog object (see image above).
The manual process of ensuring folder structure and file extensions can be cumbersome when managed manually. See Automate check-in of development OAC catalog items to SCM for details on more effectively managing this.
Related content
- style