...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Applies to:
Kyvos Enterprise Kyvos Azure Marketplace
Kyvos AWS Marketplace Kyvos Free (
...
As a part of the constant endeavor to enhance the ease of working with Kyvos, the Continuous Integration and Continuous Deployment (CI/CD) Utility is created to automate the end-to-end migration of Kyvos entities (Semantic model, Relationships, Datasets, and Workbooks) from Kyvos Source environment to Kyvos Target environment using Git as a versioning tool.
...
Parameter | Description |
KYVOSURL | Kyvos URL of the environment from which you need to export. For example, http://192.192.10.10:8081/kyvos/ |
KYVOSUSERNAME | Username to log into Kyvos (provide the native username). |
KYVOSPASSWORD | Password to log into Kyvos (password of native user needs to be provided). |
CUBEDETAILS | Provide details of the semantic model which needs to be exported in the format "FolderName":["Semantic model Name"], Scenarios and examples are mentioned after this table in cases where multiple entities need to be exported. |
DRDDETAILS | Provide the details of the relationship that needs to be exported in the format "FolderName":["DRDName"], Scenarios and examples are mentioned after this table in cases where multiple entities need to be exported. |
RFDETAILS | Provide the details of the dataset that needs to be exported in the format "FolderName":["RFName"], Scenarios and examples are mentioned after this table in cases where multiple entities need to be exported. |
WBDETAILS | Provide the details of the Workbooks that need to be exported in the format "FolderName":["WorkbookName"], Scenarios and examples are mentioned after this table in cases where multiple entities need to be exported. |
EXPORTCUBE | Allows you to export semantic model objects. Set the value as Y to enable export. Else, set it as N. |
EXPORTDRD | Allows you to export DRD objects. Set the value as Y to enable export. Else, set it as N. |
EXPORTRF | Allows you to export dataset objects. Set the value as Y to enable export. Else, set it as N. |
EXPORTWB | Allows you to export Workbook objects. Set the value as Y to enable export. Else, set it as N. |
GITLOCALREPOPATH | The path of the GITRepo folder is used as the staging location. The folder is available in the Export utility folder. Provide the path of the GIT Repo folder. Note: Please use the forward-slash (/) in the repo path as mentioned in the example and config file snippet above. |
GITHUBNAME | GITHub Name to connect to GIT Repo. For example: ‘Git’ is the hub name for the open source https://Git.com/. Similarly, for the enterprise Git you can mention the enterprise-specific name as GitNAME. |
GITORGNAME | In case your GIT Repo is part of a defined ‘Organizations’ on Git, then please use the Org name as the GITORGNAME, Else you can keep it as blank. In that case, your personal GIT Repo will be used to connect and export. |
GITUSERNAME | Git username to connect with GIT Repo. |
GITFEATUREBRANCHNAME | Git feature branch name where the XML entities will get exported. For example, “working” |
GITPUSH | Allows you to push the exported data to Git. Set the value as Y to push the exported data to Git. |
GITFEATUREBRANCHCLEAN | This parameter allows you to clean the GIT Feature branch before a fresh export. |
GITREPONAME | Git Repo Name where the entities will get exported. |
GITTOKEN | The Personal Access Token for Authentication with user’s GIT account. In case you do not have the Personal Access token, you can create it using the steps explained in the Appendix 16356988. |
Below are several scenarios to export multiple semantic models, relationships, and dataset entities in single export using the config.json if the respective values are set as Y.
...
- In case the Jenkins job is not created and configured, see the section Creating new Project in Jenkins.
- In case the Jenkins job is not Integrated with Git Repository, see the section Git settings to integrate with Jenkins.
- In case the Git connection is not created in Jenkins, see the section Creating Git Connection in Jenkins.
Once the above steps are completed, you can execute the Deploy Utility using any of the following methods.
...
- Click Advanced to generate the secret token required for configuring Webhooks.
- On the Build Steps tab, select the Execute Window batch command and enter the command (explained in the Deploy Utility section) to execute the Utility.
- Click the Save button to save your changes.
...