...
...
Smartfacts Unattended Upload Tool
1.1 Description
The Smartfacts Unattended Upload Tool allows you to publish models according to smartfacts without having to open them manually in the respective authoring tool or upload them with a user action.
The model only has to Therefor, the model must be checked into a version management system VCS. After After check-in, this model is made available in smartfacts at periodic intervals.
1.1.1 Features of the tool
Checking out the model from the VCS
Conversion of the model to Smartfacts format
Upload of the model to Smartfacts
Currently supported tools:
Rhapsody
Enterprise Architect
Innovator
Cameo/MagicDraw with TWC
Currently supported VCS:
Git
Cameo/MagicDraw TWC
The tool works with provided configuration files in the form json or y(a)ml. A configuration file represents one model that is to be published after smart facts.
...
the model is published to Smartfacts in a periodic interval.
The Process of Auto-Publishing
The following tasks are performed for each configuration.
...
Check out the model from the VCS
Check whether any changes have occurred in the model since the last export to Smartfacts.
...
If changes are found, the Smartfacts Export is called for
...
the model
...
.
After the
...
Smartfacts publishing file has been generated, the file is uploaded to Smartfacts and imported into the Smartfacts
...
database. All users who have access to the model receive a
...
...
Smartfacts notification or an email.
Supported Modeling Tools
Rhapsody
Enterprise Architect
Innovator
Cameo / CATIA Magic / MagicDraw with Teamwork Cloud
Supported VCS
GIT
Teamwork Cloud
The tool works with provided configuration files in the form JSON or y(a)ml. A configuration file represents one model that is to be published to Smartfacts.
Configuration
The following tasks are performed for each configuration.
Checking out the model from the VCS
Check whether any changes have occurred in the model since the last export to Smartfacts.
...
After the export file has been generated, the file is uploaded to Smartfacts. This file is then available after a short time. All users who have access to the model receive a notification within Smartfacts ("Notification") or a mail that a new model version is available.
...
Structure of the
...
Configuration File
Each configuration file consists of the following parameters:
Source model
GIT repository
Branch of the model
Credentials for retrieving the model from GIT
Target
Smartfacts instance
Model name under which the model is to be exported to Smartfacts
Credentials to be allowed to publish the model according to smart facts.
...
JSON Format: Exemplary structure of the configuration file in JSON format
...
| Code Block |
|---|
{ |
...
"modelingTool": "RHAPSODY", |
...
"unitName": "MyModel", |
...
"doDeltaImport": false, |
...
"smartfactsURL": "https://developer-sfit.smartfacts.com/platform", |
...
"versionName": "Version.Automatically.Imported", |
...
"smartfactsCredentials": { |
...
"name": "j.nagl@mid.de", |
...
"password": "<MyPassword>" |
...
}, |
...
"mwhId": "mwhe8588029-3b55-4b54-81e0-50ce90aa9637", |
...
"enabled": true, |
...
"gitData":{ |
...
"url":"https://git.acme.com/HomeAlarm.git", |
...
"branch":"master", |
...
"credentials": { |
...
"password": "<git password>", |
...
"name": "gitea-admin" |
...
} |
...
} |
...
} |
...
YAML Format: Exemplary structure of the configuration file in YAML format
...
Same content in YAML format, which is sometimes easier to write:
| Code Block |
|---|
--- |
...
modelingTool: RHAPSODY |
...
unitName: MyModel |
...
doDeltaImport: false |
...
smartfactsURL: https://developer-sfit.smartfacts.com/platform |
...
versionName: Version.Automatically.Imported |
...
smartfactsCredentials: |
...
name: j.nagl@mid.de |
...
password: "<MyPassword>" |
...
mwhId: mwhe8588029-3b55-4b54-81e0-50ce90aa9637 |
...
enabled: true |
...
gitData: |
...
url: https://git.acme.com/HomeAlarm.git |
...
branch: master |
...
credentials: |
...
password: "<git password>" |
...
name: gitea-admin |
...
Explanations for the individual parameters :
Parameter | Description | Values |
modelingTool
| Name of the modeling tool | [RHAPSODY, ENTERPRISE_ARCHITECT,MAGICDRAW,INNOVATOR] |
unitName | Name of the unit or model as it is named in Smartfacts | Text |
smartfactsURL | Url of the Smartfacts instance, please note that /platform is appended. | URL |
versionName | The default value for the version name | Will be created by the Headless Publisher. |
smartfactsCredentials | User under whose ID the modell is to be published after Smartfacts, the user must be one model owner | |
smartfactsCredentials.name | The user name of the Smartfacts user, normally its email address, in some installations this is the user name. | |
smartfactsCredentials.password | The password of the Smartfacts user | |
mwhId | Modelwarehouse Id ( See determination of the model warehouse Id ) | |
enabled | Default : true. The switch can be used to activate or temporarily deactivate individual configurations. | [true,false] |
gitData | GIT Connection Data | |
gitData.url | URL of Git Repositories | |
gitData.branch | Branch of the model to be used, e.g. master, release/version1 | |
gitData.credentials | Creditials for (read) access to the model | |
gitData.credentials.name | Name of the reading Git user | |
gitData.credentials.password | Password of the reading Git user (if necessary) | |
eaConnectionData | EA Connection Data Section | |
eaConnectionData.modelURL | The url to the file of the ea model. | |
cameoConnectionData | CAMEO Connection Data Section | |
cameoConnectionData.twcSecure | Use Secure connection ( TWC Setup determines this flag) true,false | |
cameoConnectionData.twcURL | URL of TWC, e.g. twc.acme.com:4555 | |
cameoConnectionData.credentials | Creditials for (read) access to the model | |
cameoConnectionData.credentials.name | Name of the reading TWC user | |
cameoConnectionData.credentials.password | Password of the reading TWC user (if necessary) | |
cameoConnectionData.twcBranch | Name of the branch on TWC, e.g trunk | |
cameoConnectionData.modelURL | Name of the model in TWC, or the name of the CAMEO file | |
doDeltaImport | Use version delta publishing (true,false) | |
doVersionOverride | Override last recent version (true,false) |
...
Special tags in the GIT version commentary to control the uploader
Since there is no special way in GIT to provide further information to control the uploader, the possibility was created to control the uploader by special tags in the GIT commit comment.
The following keywords are supported:
...
Name of the version:
...
<VersionName>This is the value for the version</ VersionName >"
Oror
VersionName: This is the value for the version name.
The specified value within the XML tag or the value of the text VersionName: is taken as the value for the version description after smartfacts.
1.2.3.2 Description of the version:
...
The tool queries the commit id of the specified model on TWC and checks, if the last model published to Smartfacts has a different it.
1.2.5 Directory structure
UUStarter.bat for Windows environment
...
And therein the individual configuration files:
1.2.6 Detecting the modelwarehouse id
...
You will now find the model warehouse id under the property “mwhid”
Copy Copy the warehouse id to your configuration file.
1 1.2.7 Installing the tool
...
If you are not using the Java jre1.8.0_241, please adapt the parameter JAVAHOME
...
1.2.7.2 Adapting the tool to the Rhapsody Installation
Due to the great variance of the Rhapsody installations, another script must also be adapted.
...
<DRIVE>:uploader/tools/rhapsody/RhapsodyUploader.bat
Adjust Adjust the path of the Rhapsody installation here:
...
Also adjust the parameter JAVAHOME to specify the location of the java installation.
...
1.2.7.3 Test existing Rhapsody projects for Plugin confirmity
We provide a tool to check whether the Rhapsody projects can be processed by the Smartfacts Rhapsody Plugin.
...
JAVAHOME: The Java Installation
...
1.3 Automatic schedule
We use for automatic scheduling the windows task schedule service
...
Create the task according to the following values:
General Page
Triggers Page:
Actions Page
Save it.