Skip to content

Publishing an Analysis Model to a Workspace

This page provides information regarding the end-to-end Publishing process of an Analysis Model.

Overview

Publishing is making the latest version of an IFS Core Analysis Model available in the desired target workspace via IFS Cloud Web. To facilitate this process, IFS Core models should be available in the Golden Workspace.

Golden Workspace

Golden workspace facilitates the Publishing and Downloading processes. This specific workspace includes all the IFS Core Models per version and release.

To populate the Golden Workspace: Navigate to Analysis Models Power BI Content repo and download the IFS Core Models, which should be added to the Golden Workspace in your own Power BI tenant.

Golden Workspace models follow a standard naming convention (i.e. IFS_GL_24R1_V2)

-- {Name: 'GeneralLeger', ReleaseVersion: '24R1', Version: 'V2', SourceWorkspaceId: 'sameasGoldenWorkspaceId', ReportId: 'OriginalIdFromGoldenWorksace'}

The display name will be referenced to the SourceReportDetails.

The status of completing the publishing will be checked by referencing the target workspace ID/dataset ID.

Publishing and Refreshing an Analysis Model:

  • Step 01: Select the desired Core Analysis Model (should be available in the Golden Workspace)
  • Step 02: Complete Publish Model assistant (change Name/Area as desired, enable/disable RLS)
  • Step 03: Set Refresh Intervals

Navigating to the Analysis Models page can be done by searching via the Navigator.

Initiate the Publish Process

The publish process initiates when the Publish Model assistant is completed. The Publish option is available on the Analysis Models page. Publish Model is a two-step assistant that allows you to rename the model if required and select the functional area (target workspace). IFS Cloud Web will update the status of the Publishing progress while the transition progresses.

Analysis Model Page:

Available functions :
Property Description
Details Navigate to the Analysis Model Details page
Set Refresh Intervals Set up model refresh time
Upload Model Upload a new/ customized model
Download Model Download an IFS-Core model version from Golden Workspace
Publish Model Push the golden workspace model directly to the Target Workspace
View logs Navigate to the Analysis Models page to view detailed logs of the sequence

By default, an entry is always selected on the Analysis Models page.

Publish Model Assistant

Click Publish Model to open up the Publish Model assistant.

Note

During the transition status (Publishing, Uploading, Loading, Refreshing), the Publish Model option will not be displayed.

Data Properties
Property Description
Name Selected Analysis Model entry's name will be the default value.
The Name is a mandatory field and it can be changed if required. This property needs to have a value set before initiating the Publishing process.
Area Selected Analysis Model entry's Area value will be the default value. The dropdown shows the available functional Areas available for Publishing an Analysis Model.
The Area is a mandatory selection.
RLS (Row Level Security) Embedded By default, the RLS enabling option is toggled OFF. It can be toggled ON based on the model's RLS status.

Alt text

1.Change the default Name if required.

2.Change Area if required.

3.Check/Un-check RLS Embedded toggle.

Note

Note that for this release, Shared is not an area which is provisioned to be used during the Analysis Models Publish/Upload.

About Row Level Security

When a client asks for an embed token the Power BI Embedded service reads the user identity of the Open ID Connect token and includes this in the request to create an embed token. The way an identity needs to be created is dependent on the data source (Power BI Import mode, AAS mode or SSAS mode all with or without RLS).

The below table shows how an effective identity is created in the Import scenario.

For Power BI Import with RLS (ImportWithRls):
  • Username - The claim of the open id connect token as configured in the environment variable “usernameClaim”
  • Dataset of the report
  • Roles-“EmbedUser” or specific value of Role
  • customData-NULL
For Power BI Import without RLS (6, ImportNoRls ):

Do not pass in an effective identity.

Read more about Row Level Security.

Important:

  • RLS Embedded toggle represents the model's RLS status. By default, this is turned OFF while Publishing an IFS Core Model. Therefore, during the Publish process, this toggle needs to be changed accordingly based on the Analysis Model's RLS status. If not, Publish Errors are expected.

Read more about RLS Enabled Models.

4.Click Publish. (the Publish button is enabled by default, as the values for the Name and Area fields are populated based on the selection)

Publishing progress status updates are initiated on another page, which is the Analysis Model Deployment page. A toast message of the successful initiation of the model publishing is displayed on this page. Since the process is asynchronous, the user is redirected to the Analysis Models page within 10 seconds, and Publishing progress is updated in the Analysis Models page's status column.

If the Publishing process encounters any error, it displays error details on the Analysis Model Deployment page.

After Publishing

Related Analysis Model entry is updated with the transitioned status value in the Analysis Models page.

Publishing Completed -IFS Cloud web

Once the Publish process is completed successfully; the status is updated as Published in IFS Cloud web, and the target workspace is updated with the dataset and report.

Publishing Completed -Target Workspace

Alt text

To enable and update report data, Refresh Intervals need to be defined to the relevant Analysis Model, to finalize the Publish process.

Refresh Intervals

Refresh intervals can be defined based on the requirement to refresh a model. This allows the addition of a time plan and a frequency, which will be set as the refresh interval of the data set. Time is based on UTC, therefore the converted time value is required.

Navigating to the Refreshing interval setting can be done via the Analysis Models page, by clicking Set Refresh Intervals.

1.The time plan (UTC) and Refresh Frequency can be set by selecting the '+' icon. This will add a new entry that will enable selecting Hours /Minutes from the drop-down.

2.Refresh frequency can be changed by selecting a value from the drop-down. Provided frequencies are Daily and Weekly.

If the Refresh Frequency is selected as 'Weekly', the day/days can be selected accordingly.

refresh_int_assistant_weekly

3.Once the time is selected, click Done to add the new entry and select Save.

4.If there are further changes required in a defined Refresh Interval, an editing option is available. This will enable you to edit all the available fields.

5.When defining a new Refresh Interval, by default the schedule will indicate that it is Active. This can be toggled off when required. It will make the refresh schedule inactive.

Once saved, the Analysis Model entry is updated with the time plan in the 'Next Refresh' column. The model will be refreshed based on the created time plan.

Multiple refresh interval time plans can be added for a single model.

Model refreshing

After a successful Publishing process, the model will be refreshed based on the defined refresh intervals. During the Publish process, Loading always happens to transform the DIM and FACTs into Parquet files before starting the dataset refresh. The scheduler pod is triggered every minute to check if data needs to be refreshed based on the refresh information.

Read more about how the Refresh Schedule works.

Analysis Model status = Loading

Analysis Model status = Refreshed

The Analysis Model Details page includes the related Refresh Details of the model. Logs can be viewed for further details.

Read more about Analysis Models Power BI Logs.

Analysis Model Status Transition During Publishing

Analysis Models Starting Status Transitioned Status Context
Not Published Publishing Publish Model assistant is completed
Publishing Published Model cloned from Golden Workspace to the target workspace
Publishing Publish Error Error while cloning Model from Golden Workspace to target workspace
Published Loading Cron expression of the Analysis Model is expired
Loading Loading Error Error while loading Parquet Data Source
Loading Refreshing Refreshing the Analysis Model data set
Refreshing Refreshed Model refreshing completed successfully
Refreshing Refresh Error Model refreshing was not successful

The latest version of each IFS Core model is connected to each of the listed items on the Analysis Models page. If another version is required to be edited, the Download Models function enables downloading any model/any version.

Once the publishing is completed, the Publish Model function will be disabled for the respective Analysis Model. Any customizations for the same Analysis Model need to be done via the Upload Model function.