Document toolboxDocument toolbox

Managing semantic model job instances

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


Kyvos supports multiple job types for better management of data and resources that you use for analytics. You can run a test data process, a full data process, an incremental data process, a data profiling job, or a drop partition process, and so on.

The incremental data process provides capabilities for adding new data and replacing old data without manual intervention or custom coding. It allows the selective update of semantic model data and the addition of new aggregations without processing older data. It refreshes automatically, identifies newly ingested data, updates existing data, and purges expired data.

If you have defined partitions in your semantic model, you can run a drop partition process to drop a whole partition from the process.

There may be cases where you may want to get back the purged or dropped data for analysis. For such cases, Kyvos offers the Manage Job Instances feature. Using this feature, you can maintain backup copies of multiple semantic model process instances and revert the semantic model process state to a previous incremental process, a full process, or a drop partition process.

Note that, once you create a new full process, the earlier incremental backups are no longer available, and you cannot revert the semantic model to that state. Similarly, you cannot go back to a previous full process too.

Configuring the Manage Job Instances feature

To configure the Manage process Instances feature, use the kyvos.build.backup.versioncount property from the Semantic Model Advanced Properties. This property specifies the number of backups of previous versions of a semantic model to be kept in the Kyvos file system. By default, the property value is set as 1, and you can change it at any time.

You can use this property at the semantic model level to increase the number of saved process versions on the file system. This requires increasing the Kyvos file system space quota to accommodate these processes.

Note

If the property value is set as say, 2, and you increase it to 5, the previously purged instances will not be available. However, going forward, Kyvos will start maintaining backups for the preceding 5 processes.

Further, if the value for the kyvos.build.backup.versioncount property is set as 5, and the semantic model has nine versions, namely - v1, v2, v3, v4, v5, v6, v7, v8, and v9; the Manage Job Instances dialog box will show only six process versions (1 active and 5 backups).

To configure this property, perform the following steps.

  1. From the Toolbox, click Semantic Models, and navigate to the semantic model for which you want to enable the feature.

  2. Click the Refine tab, and then click Advanced Properties.

  3. Search for build.backup.versioncount from the list and set the value according to your business requirement. In this example, we have set the value to 5.

  4. Click Save. The value comes into effect.

Managing job Instances

To switch between the various semantic model process instances, use the Manage Job Instances feature from the Kyvos web portal.

For this, perform the following steps.

  1. From the Toolbox, choose Semantic Models.

  2. Select the semantic model in which you want to view the instances, and click the Process tab.

  3. On the Process tab, click the Actions menu (...) and choose Manage Job Instances.

  4. To revert to an earlier build, right-click a build instance and select Revert to.

  5. Here select any of the following options:

    1. This Instance Design: Reverts to the semantic model design of the selected build instance.

    2. This Instance Data: Reverts to the selected build instance.

    3. This Instance Data and Design: Reverts to the selected semantic model design with build instance.
      NOTE: One or more options may be disabled if, either the build instance and/or semantic model design are already active, or they are not available for switching. Typically, for the active build only a semantic model design option is available.

  6. Click OK.

The selected job instance is shown as Active after switching is complete.

Tips

  • Only one version can be marked as ‘Active’ at a time.

  • To view a build summary, right-click the build instance and click View Summary.

  • If there are no successful builds available, you will see an option to schedule a build now.

  • You can also view build notes to help you determine which build you want to use. Right-click a build instance and choose Show Notes.

Viewing switching history

You can view the switching history from the Kyvos Activity Monitor.

For this, perform the following steps.

  1. From the Toolbox, choose Monitor.

  2. Click the Audit Logs tab.

  3. If needed, click the Filter button to the right.

  4. From the filters on the right, set the value for Actions as semantic model Instance Switch. You can quickly search for the same in the filter search box too.

The switching history is displayed, as shown in the following figure.

 

Copyright Kyvos, Inc. All rights reserved.