...
Download the Kyvos CICD Utility.
...
Export Utility
| Anchor |
|---|
...
|
Prerequisites
To use the Export utility, you must have the following.
...
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 Kyvos CICD Utility#Appendix Appendix. |
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.
#Appendix
Export single entity present from a single folder
"CUBEDETAILS": { "Folder1" : [ “Cube1”] }
"DRDDETAILS": { "Folder1" : [ “DRD1”] }
"RFDETAILS": { "Folder1" : [ “RF1”] }
"WBDETAILS": { "Folder1" : [ “WB1”] }
Export multiple entities from a single folder
"CUBEDETAILS": { "Folder1" : [ “Cube1”, “Cube2”] }
"DRDDETAILS ": { "Folder1" : [ “DRD1”, “DRD2”] }
"RFDETAILS": { "Folder1" : [ “RF1”, “RF2”] }
"WBDETAILS": { "Folder1" : [ “WB1”, “WB2”] }
Export multiple entities from multiple folders
"CUBEDETAILS": { "Folder1" : [ “Cube1”,”Cube2”], “Folder2” : [“Cube3” ] }
"DRDDETAILS ": { "Folder1" : [ “DRD1”,” DRD2”], “Folder2” : [“DRD3” ] }
"RFDETAILS": { "Folder1" : [ “RF1”,” RF2”], “Folder2” : [“RF3” ] }
"WBDETAILS": { "Folder1" : [ “WB1”,” WB2”], “Folder2” : [“WB3” ] }
Export All entities from one or more folders
"CUBEDETAILS": { "Folder1" : [], “Folder2” : [] }
"DRDDETAILS ": { "Folder1" : [], “Folder2” : [] }
“RFDETAILS": { "Folder1" : [], “Folder2” : [] }
“WBDETAILS": { "Folder1" : [], “Folder2” : [] }
Export single/multiple entities from ROOT (when entities are not a part of any folder)
"CUBEDETAILS": { "ROOT" : [ “Cube4”, “Cube5”] }
"DRDDETAILS ": { "ROOT" : [ “DRD4”, “DRD5”] }
"RFDETAILS": { "ROOT" : [ “RF4”, “RF5”] }
"WBDETAILS": { "ROOT" : [ “WB4”, “WB5”] }
Export ALL entities, which includes all entities at ROOT and all folders with all entities
“CUBEDETAILS": { }
“DRDDETAILS ": { }
“RFDETAILS": { }
“WBDETAILS": { }
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Important You must have Python 3.x (with the required packages as mentioned in the Python script) installed on the target system to execute the script. |
...
The Personal Access Token is required for authentication of Export Utility with Git. You are required to provide this in the Export Utility config file, as explained in the Export Utility section.
To create a Personal Access Token in Git, perform the following steps.
...
In your Git Account, select the repository you want to integrate with Jenkins and go to Settings.
Select the Webhooks option from the left pane.
In the URL, enter the URL and append “/project/project name” to this URL, as shown in the figure below, and enter the secret token. To generate the secret token, check the section Creating secret token in Jenkins). For example, http://localhost:8080/project/Git
Select Push events in the trigger and then click Add webhook.