ACTICO Platform - Model Hub
User Guide
Version 8112
wwwacticocom
User Guide Version 8112
User Guide
Copyright copy ACTICO GmbH iii
Table of Contents
1 About this document 1
11 Audience 1
12 Content 1
13 Conventions 1
2 Introduction 2
3 System Overview Links and Authentication 3
31 System Overview Diagram 3
32 Web User Interface 3321 Demo Users 3
33 Modeler Endpoint 3
34 Git Endpoint 4
35 REST Endpoint 4
4 Model Versioning 5
41 Creating a Repository 5
42 Working with a Repository using the Modeler 6
43 Branches and Tags 6431 Branches 6432 Tags 7
44 Granting Access to Other Users 7
45 Resource Locking 8
5 Users Groups and Permissions 9
51 General Permissions 9
52 Managing Users 9
53 Managing User Groups 9
6 Health 11A List of Symbols 12
Chapter 1 About this document
Copyright copy ACTICO GmbH 1
Chapter 1 About this documentThis document describes the usage of ACTICO Model Hub
11 Audience
This document is intended for
bull Users
bull System Administrators
12 Content
This document considers the following topics
bull Usage of Model Hub
13 Conventions
The following text conventions are used in this document
Table 11 Conventions
Convention Meaning
boldface Used for elements labels and terms from the userinterface
monospace Used for filenames or URLs
Chapter 2 Introduction
Copyright copy ACTICO GmbH 2
Chapter 2 IntroductionACTICO Model Hub provides versioning capability for model projects created with ACTICO Modeler
Main features are
bull Versioning of model projects
bull Export and import functionality
bull Security and access control
bull Auditing of all events within the system
Note for users familiar with Team Server
bull Model Hub is the fully modernized successor of Team Server
bull Modeler connects to the Model Hub just like to a Team Server before
bull Users of Modeler use the known Team Server Explorer and Team Server Activities views to retrieve andpublish their model changes
bull Repositories in Model Hub are now Git repositories and it provides the APIs to allow standard Git tooling toclone checkout commit and push changes This facilitates integration into IT processes and tools
bull Locking of resources to prevent conflicting changes in Modeler is still available
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
User Guide Version 8112
User Guide
Copyright copy ACTICO GmbH iii
Table of Contents
1 About this document 1
11 Audience 1
12 Content 1
13 Conventions 1
2 Introduction 2
3 System Overview Links and Authentication 3
31 System Overview Diagram 3
32 Web User Interface 3321 Demo Users 3
33 Modeler Endpoint 3
34 Git Endpoint 4
35 REST Endpoint 4
4 Model Versioning 5
41 Creating a Repository 5
42 Working with a Repository using the Modeler 6
43 Branches and Tags 6431 Branches 6432 Tags 7
44 Granting Access to Other Users 7
45 Resource Locking 8
5 Users Groups and Permissions 9
51 General Permissions 9
52 Managing Users 9
53 Managing User Groups 9
6 Health 11A List of Symbols 12
Chapter 1 About this document
Copyright copy ACTICO GmbH 1
Chapter 1 About this documentThis document describes the usage of ACTICO Model Hub
11 Audience
This document is intended for
bull Users
bull System Administrators
12 Content
This document considers the following topics
bull Usage of Model Hub
13 Conventions
The following text conventions are used in this document
Table 11 Conventions
Convention Meaning
boldface Used for elements labels and terms from the userinterface
monospace Used for filenames or URLs
Chapter 2 Introduction
Copyright copy ACTICO GmbH 2
Chapter 2 IntroductionACTICO Model Hub provides versioning capability for model projects created with ACTICO Modeler
Main features are
bull Versioning of model projects
bull Export and import functionality
bull Security and access control
bull Auditing of all events within the system
Note for users familiar with Team Server
bull Model Hub is the fully modernized successor of Team Server
bull Modeler connects to the Model Hub just like to a Team Server before
bull Users of Modeler use the known Team Server Explorer and Team Server Activities views to retrieve andpublish their model changes
bull Repositories in Model Hub are now Git repositories and it provides the APIs to allow standard Git tooling toclone checkout commit and push changes This facilitates integration into IT processes and tools
bull Locking of resources to prevent conflicting changes in Modeler is still available
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
User Guide
Copyright copy ACTICO GmbH iii
Table of Contents
1 About this document 1
11 Audience 1
12 Content 1
13 Conventions 1
2 Introduction 2
3 System Overview Links and Authentication 3
31 System Overview Diagram 3
32 Web User Interface 3321 Demo Users 3
33 Modeler Endpoint 3
34 Git Endpoint 4
35 REST Endpoint 4
4 Model Versioning 5
41 Creating a Repository 5
42 Working with a Repository using the Modeler 6
43 Branches and Tags 6431 Branches 6432 Tags 7
44 Granting Access to Other Users 7
45 Resource Locking 8
5 Users Groups and Permissions 9
51 General Permissions 9
52 Managing Users 9
53 Managing User Groups 9
6 Health 11A List of Symbols 12
Chapter 1 About this document
Copyright copy ACTICO GmbH 1
Chapter 1 About this documentThis document describes the usage of ACTICO Model Hub
11 Audience
This document is intended for
bull Users
bull System Administrators
12 Content
This document considers the following topics
bull Usage of Model Hub
13 Conventions
The following text conventions are used in this document
Table 11 Conventions
Convention Meaning
boldface Used for elements labels and terms from the userinterface
monospace Used for filenames or URLs
Chapter 2 Introduction
Copyright copy ACTICO GmbH 2
Chapter 2 IntroductionACTICO Model Hub provides versioning capability for model projects created with ACTICO Modeler
Main features are
bull Versioning of model projects
bull Export and import functionality
bull Security and access control
bull Auditing of all events within the system
Note for users familiar with Team Server
bull Model Hub is the fully modernized successor of Team Server
bull Modeler connects to the Model Hub just like to a Team Server before
bull Users of Modeler use the known Team Server Explorer and Team Server Activities views to retrieve andpublish their model changes
bull Repositories in Model Hub are now Git repositories and it provides the APIs to allow standard Git tooling toclone checkout commit and push changes This facilitates integration into IT processes and tools
bull Locking of resources to prevent conflicting changes in Modeler is still available
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 1 About this document
Copyright copy ACTICO GmbH 1
Chapter 1 About this documentThis document describes the usage of ACTICO Model Hub
11 Audience
This document is intended for
bull Users
bull System Administrators
12 Content
This document considers the following topics
bull Usage of Model Hub
13 Conventions
The following text conventions are used in this document
Table 11 Conventions
Convention Meaning
boldface Used for elements labels and terms from the userinterface
monospace Used for filenames or URLs
Chapter 2 Introduction
Copyright copy ACTICO GmbH 2
Chapter 2 IntroductionACTICO Model Hub provides versioning capability for model projects created with ACTICO Modeler
Main features are
bull Versioning of model projects
bull Export and import functionality
bull Security and access control
bull Auditing of all events within the system
Note for users familiar with Team Server
bull Model Hub is the fully modernized successor of Team Server
bull Modeler connects to the Model Hub just like to a Team Server before
bull Users of Modeler use the known Team Server Explorer and Team Server Activities views to retrieve andpublish their model changes
bull Repositories in Model Hub are now Git repositories and it provides the APIs to allow standard Git tooling toclone checkout commit and push changes This facilitates integration into IT processes and tools
bull Locking of resources to prevent conflicting changes in Modeler is still available
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 2 Introduction
Copyright copy ACTICO GmbH 2
Chapter 2 IntroductionACTICO Model Hub provides versioning capability for model projects created with ACTICO Modeler
Main features are
bull Versioning of model projects
bull Export and import functionality
bull Security and access control
bull Auditing of all events within the system
Note for users familiar with Team Server
bull Model Hub is the fully modernized successor of Team Server
bull Modeler connects to the Model Hub just like to a Team Server before
bull Users of Modeler use the known Team Server Explorer and Team Server Activities views to retrieve andpublish their model changes
bull Repositories in Model Hub are now Git repositories and it provides the APIs to allow standard Git tooling toclone checkout commit and push changes This facilitates integration into IT processes and tools
bull Locking of resources to prevent conflicting changes in Modeler is still available
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 3
Chapter 3 System Overview Links and Authentication
31 System Overview Diagram
The following diagram shows Model Hub and related systems
32 Web User Interface
The Model Hub UI is available at its configured base URL eg httpsmodelhubexamplecom By default(eg in a local installation with the evaluation bundle) this is httplocalhost8080
The server port may be configured to another value If the server is not installed locally use thecorresponding valid server name
321 Demo Users
If Model Hub is installed with demo data the following users are available
User Name User Id Password Assigned User Groups
Administrator Admin Admin Administrators ampStandard Users
John John John Standard Users
Mary Mary Mary Standard Users
33 Modeler Endpoint
The URL to use Model Hub for model versioning is httpsltservergtteamserver By default (eg with theevaluation bundle) this is httplocalhost8080teamserver
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 3 System Overview Links and Authentication
Copyright copy ACTICO GmbH 4
Use this URL in ACTICO Modeler to specify a connection to Model Hub For authentication choose Model Huband enter user name and password for a valid user account with appropriate permissions
34 Git Endpoint
Model versioning repositories in Model Hub are Git repositories and they provide the APIs to allow standard Gittooling to clone checkout commit and push changes This facilitates integration into IT processes and tools
In order to access a repository via Git use this URL `httpltservergt8080gitteamserverltid_of_repositorygt `
Basic Authentication is used and the user needs to have the general permission Access Git repositoryAdditionally the specific permissions read and write are used to secure pull and push operations for eachindividual repository
Hints and warnings
bull It is recommended to prefer the Model Hub provided interfaces before using the Git endpoint Use the GitEndpoint for push (write) operations at own risk as Model Hub relies on some conventions
bull Modeler does show revision information for folders When creating a new folder using this endpoint a filetsfoldermeta is required next to the folder Best is to use the Modeler for this
bull Modeler accesses tags by a timestamp and branch information When creating a new tag using thisendpoint you must add a Git note with necessary information to the tag Best is to use the Modeler for this
bull Modeler can only handle certain entries in its own order for gitignore files Do not edit this file yourself
bull Some files can not be merged using a textual merge as those might get invalid Those can only be mergedusing the Modeler In order to prevent a textual merge those files are marked as binary
bull Adapt the git config settings to Model Hub conventions
bull username is the name attribute as shown in your profile
bull useremail is the username attribute as shown in your profile appended with modelhubinternal
35 REST Endpoint
REST calls require authentication using OAuth 20 with Access Token The token can be generated eg with thePostman Application
Table 31 Required values for the Postman Dialog Get new access token
Property Value
Token Name ltany_valuegt
Grant Type Password Credentials
Access Token URL httpslocalhost8080securityoauthtoken
Username ltusergt
Password ltpasswordgt
Client ID actico-model-hub
Client Secret (empty)
Scope openid profile email
Client Authentication Send Basic Auth header
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 5
Chapter 4 Model VersioningModel projects (eg rule projects) can be versioned within a repository This enables to coordinate work amongmultiple users and to track changes to models and other resources In order to work with a repository a modelproject is shared within the Modeler for accessing and modifying it
41 Creating a Repository
A new repository is created by following these steps
1 Make sure you have the permission to create new repositories See Chapter 5 Users Groups andPermissions for details
2 Select the menu item Repositories from the navigation to show the repository overview screen
3 Click the New Repository button in the upper right corner
4 Enter the name of the repository and other details
5 Click Save
The created repository is now listed in the repository overview screen and ready to be used
Figure 41 Repository overview screen
Click on the corresponding tile to see the repository details screen
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 6
Figure 42 Repository details screen with selected context menu of master branch
The first created branch is named master Within Modeler this branch is named HEAD
A repository can be deleted if not needed anymore by selecting Delete from the context menu within therepository details screen You need to type in the repository name for confirmation
42 Working with a Repository using the Modeler
Use the Modeler to share add and change model projects
See chapter Working with Team Server in the Modeling Guide of ACTICO Modeler It gives detailed steps abouthow to connect the Modeler to a repository and how to work with it See Modeler Endpoint for connectiondetails
Model Hub is the fully modernized successor of Team Server Modeler connects to the Model Hubjust like to a Team Server before Users of Modeler use the known Team Server Explorer andTeam Server Activities views to retrieve and publish their model changes
43 Branches and Tags
The repository detail screen shows Branches and Tags
431 Branches
A branch is a structural element inside a repository which can contain one or multiple model projects Everybranch contains its own copies of the model projects so that changes on different branches are isolated fromeach other This is often used to develop or maintain different versions of the same model projects And thebranch names often reflect these version numbers
The Branches tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected one (and including its history)
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 7
bull New Tag - create a new tag at the current end of the branch
bull Rename - renames an existing branch
bull Delete - delete a branch
bull a tab Projects listing all model projects
bull a tab Locks showing all locks of the selected branch See Resource Locking for details
bull a tab Revisions showing the history
432 Tags
A tag represents the current status of a model project at a specific point in time
The Tags tab contains
bull a context menu with the entries
bull New Branch - create and start a new branch based on the selected tag (and including its history)
bull Delete - delete the tag
bull a tab Projects listing all model projects
bull a tab Revisions showing the history of changes
44 Granting Access to Other Users
Access to a repository can be granted to individual users or user groups
Click the Permissions button on the repository details screen to open the Repository Permission view
Figure 43 Repository Permission screen
The screen contains a section for assigning permissions to users and another section to assign them to usergroups Each section contains a selection element to add additional users or user groups
Read or Write access can be given It is also possible to grant the Admin permission that also allows to egdelete the repository or to manage its permissions
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 4 Model Versioning
Copyright copy ACTICO GmbH 8
At least one user with administration permission is required which means that the deletion of a user whichowns the last administration permission is disabled Also the deselection of the administration permissionof the user owning the last administration permission is disabled In order to remove the administrationpermission from a user owning the last administration permission just give another user the administrationpermission Afterwards the administration permission can be removed from the already existing user whichhas owned the last administration permission
45 Resource Locking
A resource (a file or a folder) is locked by the Modeler automatically when it is about to be changed It can alsobe locked manually A resource cannot be edited by other users as long as it is locked
A resource is unlocked when publishing the changes to the repository It might still be necessary to manuallyunlock a resource eg if you want to work on it but it is locked by another user Be aware that manuallyunlocking a resource poses the danger of both users publishing their changes which might end up in a conflictThis needs to be resolved then
Locks can be listed and unlocked on several locations
bull In the Team Server Activities view in the Modeler
bull On the Locks tab of the repository details screen
bull On the general Locks screen available directly via the menu
The Team Server Activities view and the Locks tab of the repository details screen show only locks in thecurrently used repository
The general Locks screen shows all locks in any repository and provides filtering options
Figure 44 Locks screen
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 9
Chapter 5 Users Groups and Permissions
51 General Permissions
The functionality of Model Hub available to a user is controlled by permissions
Model Hub supports the following General Permissions
Permission Description
Login to Model Hub Grants access to login and use Model Hub (necessaryfor all endpoints)
Read users user groups and permissions Read and list Users User Groups and GeneralPermissions
Administrate users user groups and permissions Create delete and change Users User Groups andGeneral Permissions
Create new repository Create new Repositories
View metrics and system information View metrics and system information
Access Git repository Access Repositories as Git repositories where ModelHub acts as a Git endpoint
General Permissions are assigned to User Groups The permissions are then granted to all Users which aremembers of these User Groups
See also Operations Guide for default user groups that are always available
In addition to general permissions there are also permissions for individual Repositories Setting thesepermissions is described in the respective chapters
52 Managing Users
The Users screen lists all users on the left side that are known by the system
Selecting one user shows the details about assigned User Groups and Permissions The assigned User Groupscan be changed after clicking the Edit button in the lower right corner Permissions inherited from the UserGroup cannot be changed here
Synchronised user groups (ie groups that come from an external system like ActiveDirectory)cannot be manually assigned to users here Users must be members of these groups in theexternal system
53 Managing User Groups
The User Groups screen has the same layout as the Users screen It contains a list of available User Groupsincluding the synchronized user groups from an external authentication provider Details are displayed when auser group is selected
User Groups can be deleted by selecting the corresponding action from the context menu Also Permissionscan be assigned to User Groups after clicking on the Edit button in the lower right corner
New User Groups can be created using the add button (+)
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 5 Users Groups and Permissions
Copyright copy ACTICO GmbH 10
See also Operations Guide for default user groups that are always available
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Chapter 6 Health
Copyright copy ACTICO GmbH 11
Chapter 6 HealthThe Health screen shows technical monitoring data of Model Hub
Figure 61 Health screen
Here you can find the following info
bull uptime
bull number of loaded Java classes
bull number of CPUs of the system and their usage
bull information about memory threads and Java garbage collection
bull statistics about HTTP request
You can also create and download a thread dump via a context menu This may be useful to analyze technicalproblems
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-
Appendix A List of Symbols
Copyright copy ACTICO GmbH 12
Appendix A List of SymbolsThe following table lists symbols that are used within the user interface
Table A1 Symbols
Symbol Description
Hide or Show Navigation Bar
Hide Navigation Bar (if Navigation Bar is invisible)
Back - Navigate to parent view
Back - Navigate to parent details
Show Activities dialog
Display or Hide Context Menu
Close a dialog
Show User Profile View
Logout from Model Hub
Edit data of an item (ie rename)
Delete item or row from a table
Download a file to your local system
- User Guide
- Table of Contents
- Chapter 1 About this document
-
- 11 Audience
- 12 Content
- 13 Conventions
-
- Chapter 2 Introduction
- Chapter 3 System Overview Links and Authentication
-
- 31 System Overview Diagram
- 32 Web User Interface
-
- 321 Demo Users
-
- 33 Modeler Endpoint
- 34 Git Endpoint
- 35 REST Endpoint
-
- Chapter 4 Model Versioning
-
- 41 Creating a Repository
- 42 Working with a Repository using the Modeler
- 43 Branches and Tags
-
- 431 Branches
- 432 Tags
-
- 44 Granting Access to Other Users
- 45 Resource Locking
-
- Chapter 5 Users Groups and Permissions
-
- 51 General Permissions
- 52 Managing Users
- 53 Managing User Groups
-
- Chapter 6 Health
- Appendix A List of Symbols
-