...
The Smartfacts Unattended Upload Tool allows you to publish models without having to open them manually in the authoring tool or upload them with a user actionmanually.
Therefor, the model must be checked into a version management system like VCS. After check-in, the model is published to Smartfacts in a periodic interval.
...
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
...
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.
...
Description of the version:
<VersionDescription>This is the value for the version description
...
VersionDescription:This is the value for the version description to the end of the line.
The specified value within the XML tag or the value of the text after Version Description: is taken as the value for the version description after smart facts.
...
Import priority
Each configuration is treated equally. Therefore it is usually not possible to influence which model configuration is processed first and which last.
However, if the text priority:1 is specified in a commit statement, this configuration is treated preferentially.
...
If several configurations with the same priority exist, no order can be determined within these configurations and it is "random" which model in a generation run is uploaded to smart facts sooner or later.
...
Mechanism for detecting whether a new upload is necessary
...
GIT based models
The tool recognizes by the GIT Commit Id whether the model has been changed since the last upload. When uploading to Smartfacts, the current GIT Commit Id is stored with the model version in Smartfacts.
Before the model is converted to smart facts again or uploaded, the GIT Commit Id stored in smart facts and the Commit Id stored in the current branch are compared. If these do not differ, no upload is performed and the generation of the model is skipped.1.2.4.2
CAMEO TWC Models
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
...
Batch file that is called by the tool to start Rhapsody with the desired model and to invoke the Smartfacts Export.
Directory lib
The Java libraries required by the tool
Directory workdir: The working directory with configuration files and the "Working Directory" where the models are checked out
...
And therein the individual configuration files:1.2.6
Detecting the modelwarehouse id
Log in to smartfacts and select the desired modelwarehouse
...
Copy the warehouse id to your configuration file. 1.2.7
Installing the tool
Copy the structure to e.g. C:\uploader.
...
Adapting batch file parameters
It is assumed that the installation was performed on drive C: and that Java version 8/241 is used. If this is not the case, the batch files must be adapted.
...
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.
...
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.
For this purpose, all projects must be provided in a common directory. Each project must have the Smartfacts profile activated and be saved with it.
A test run can then be performed with the tool <DRIVE>:/uploader/TestRhapsody.bat. For this purpose, each model is fed to the plugin, which calls the Smartfacts converter, which creates an upload.zip for each Rhapsody model.
If an error occurs, this is logged in a log file.
The source model is not changed.
The storage point for the result and log files is located at the location
...
%TEMP%/smartfactsuploader/workspaces.
Please adapt the file the corresponding parameters
...
JAVAHOME: The Java Installation 1.3
Automatic schedule
We use for automatic scheduling the windows task schedule service
To do so, please follow the following instructions:
Call the Task scheduler in the windows menu entering “task scheduler”
In actions, create a new task by “Create Task….”
Create the task according to the following values:
General Page
Triggers Page:
Actions Page
Save it.