Using Publication For Capella Web Client
1. Glossary
- Model
-
A model is a set of objects with properties and links between each other. These properties and links define a semantic that can be understood by knowledgeable users or software. In general, these properties and links conform to a set of rules defined by a meta-model.
- Account
-
A user account that makes it possible for a given person or software to connect to the Publication Server.
- Team
-
A team groups a number of users to give them specific access rights to specific projects.
- Project
-
A project groups any number of models stored by the Publication Server. It is the unit of exposure of data to the OSLC API of the Publication Server. Access Control can only be defined on a per-project basis.
- OSLC
-
Open Services for Lifecycle Collaboration. OSLC is a standard for interoperability between repositories. For more details, refer to the official OSLC page at https://open-services.net/ .
2. Login
Any access to a page will cause the login page to be displayed if the user is not already logged in.
3. Logout
Users can log out of the server by clicking on the icon on the top right of any page header and clicking on logout.
4. Web Client Welcome Page
The server will by default display the 'Home' page, which displays the Project List and the Organization list.
5. Project List
Click on the project name to navigate to the project’s page described in section Project Page.
Click on the '+' button to create a new project. See Project Creation for more details. Any user can create new projects.
Click on the three dots to the right side of a project to display a pop-up menu with the following actions:
-
Rename - see Project Renaming
-
Delete - see Project Deletion
5.1. Project Creation
To create a new project, click on the '+' button in the Web Client Welcome Page. This displays the following form:
The name of a project must contain less than 1024 characters. If the name is not valid, a warning message is displayed and the 'Create Project' button is disabled.
5.2. Project Renaming
To rename a project, open the project contextual menu in the Web Client Welcome Page and select 'Rename'.
Change the name and click on 'Rename' to rename the projects, or click on the background (or press 'Escape') to cancel the renaming.
5.3. Project Deletion
To delete a project, open the project contextual menu in the Web Client Welcome Page and select 'Delete'.
Click on 'Delete' to confirm the deletion, or click on the background (or press 'Escape') to cancel the deletion.
6. Project Page
The Project Page is accessible from the Project List once a user is logged in, by clicking on the name of a project in the list.
The Project Page is the entry point to browse the models it contains.
It is made of:
-
A header that contains:
-
The Obeo icon, which can be clicked on to navigate to the Web Client Welcome Page;
-
The project name;
-
A hamburger menu for this project, with the following entries:
-
Rename;
-
Share: an action to copy a shareable link to the project into the clipboard;
-
Settings - see Project Settings Page;
-
Delete.
-
-
(Optional) A customizable hoverable label (see [custom-info-ext])
-
The logged-in user name and menu.
-
-
A main panel, split in three columns:
-
The left column contains the explorer, that displays the models exposed by this project, and their structure;
-
The middle panel displays information on the selected element;
-
The right panel displays the details (properties) of the selected element.
-
6.1. Model Explorer
The model explorer, in the left panel, can be used to navigate inside the structure of the model(s) available in the current project.
The top-level elements in the explorer correspond to the models themselves (1).
Inside of it the user can find the actual model elements (2), which correspond to the content of the .capella model, and all the exported diagrams (3) organized by category (4).
Clicking on any element in the explorer will select it and display its corresponding information in the main panel, and details in the right panel. The information displayed in the main panel depends on the type of element selected. See Main Panel - Model Navigation for more details.
When navigating in the model elements, the explorer selections stays the same. To select the currently viewed element in the explorer, click on the target icon on top of the explorer.
| When an element is selected, the browser’s URL can be bookmarked to reopen this specific object. This URL can also be provided to other users so that they can access the details of this particular page, provided they have the appropriate permissions. |
6.2. Search
Model Objects within a project can be searched in two ways:
-
From the Quick Search, available in the project header;
-
From the Filtered Search View, available in a dedicated panel of the project workbench.
6.2.1. Quick Search
The quick Search feature makes it possible to search for a given String in Model Object names, in a case insensitive way, within the current project. It also looks for OSLC links whose target title or URL matches.
This pattern is searched 'as is', there is no support yet for wildcard characters such as '*' or '_'.
Any value containing the exact search terms will match.
|
The search is launched each time a character is typed in its field and only displays the first 10 results.
Clicking on a result will set the current selection to the object.
The object page can be opened in a new tab using Ctrl+Click.
Results can also be browsed using the keyboard up/down arrows and selected with Enter.
Ctrl+Enter will open the object page in a new tab.
6.2.2. Filtered Search View
If more results are needed or there is a need to use more criteria for the search than the name only, the filtered search view provides a more complete search feature. It can be accessed directly from the search bar by clicking on this icon:
Or it can be opened/closed the same way the explorer is by clicking on this icon:
The filtered search view can be used through the following form:
The form accepts the following search parameters:
-
A text field which accepts a pattern to find in model objects names or attributes. This pattern is also looked for in the title, URL, or identifier of OSLC link artifacts. It makes it easy to find model elements linked to a particular artifact when the artifact’s title or ID is known.
This pattern is searched 'as is', there is no support yet for wildcard characters such as '*' or '_'.
Any value containing the exact search terms will match.
|
-
A model filter, which limits the search to the specified models. If left blank, all models in the projects are considered by the search.
-
A type filter, which limits the search to the specified types. If left blank, any type will be considered by the search.
-
A 'search in attributes' switch, which activates the search in all model objects attribute values, instead of only in their names. If activated, the search will also look in OSLC identifiers. This option can have a significant impact on the duration of the search.
Unlike the Quick Search, a filtered search is launched when the 'Search' button is clicked or when 'Enter' is pressed. This button will be enabled only if either a pattern or a type is set.
Each model object in the result list can be clicked, which will open the model object page as a new tab within the current page.
To ease the reading of the result of a search, it is possible to group the results by model and/or by type. It will turn the list of results into a tree grouping the results by their respective model and/or type (depending on the selected grouping options). A badge above the group name shows how many results are under the group.
To help with the selection of the right element among the search results, it is possible to hover any result to display its Preview.
The results shown in the view are paginated, which means only the first 30 results of each group are shown. To see more results, a 'More results' link appears at the bottom of a list of results (if there are more to show).
The 'Clear all' button will reset the form to its initial state. All search parameters will be left blank and options reset to their default (no result grouping, no search in attributes).
6.3. Main Panel - Model Navigation
The main panel displays useful information about a particular object, which can be a 'Model' or a 'Model Object', including a special kind of of model object that is a 'Diagram'.
6.3.1. Models
For Models, the main panel displays:
-
The model Name;
-
Description;
-
An optional section to fix invalid OSLC links (for more details, see Fixing Invalid Links).
6.3.2. Model Objects
The model object pages display:
-
The object’s icon and label;
-
The object type name (its meta-class name);
-
The namespace of the object’s meta-class (useful to configure OSLC Linkings);
-
The 'Bread Crumbs', which displays the list of parents of the object in the model hierarchy;
-
The parent objects in the 'Bread Crumbs' can be navigated by clicking on them.
-
-
The object’s rich text description;
-
The description may contain links to other model elements or diagrams, which can be used to navigate within the model. It is possible to hover any link that refers to a model element or diagram to display its Preview.
-
Since version
2026.5.0, the rich text description can also display embedded images, which can increase the value of the description.
-
-
The semantic browser. See next section for more information about the semantic browser.
| The layout of the original rich text description created in Capella will not always be totally similar. The reason is that the injected HTML is sanitized to prevent any risk of malicious HTML injection. This sanitization step can result in a (hopefully minor) loss of formatting. As a rule of thumb, it is a good idea to avoid fancy layouts in the rich text descriptions and to focus on their contents and illustrations. |
6.3.3. Semantic Browser
The semantic browser is organized as follows:
-
3 optional panels display the Capella semantic browser, as it is in Capella.
-
These panels are only present if the model is a Capella model, and has been published with the 'semantic browser' option.
-
-
One panel 'OSLC links' that displays the links to third-party repositories, if any.
-
This panel makes it possible to view and edit links between the current object and artifacts exposed by Friend OSLC repositories.
-
The types of the links that can be created depends on the OSLC Linking Settings.
-
The semantic browser has a 'title bar' made of buttons, one button per available panel. This title bar acts a a filter to display or hide panels at will. Each Panel can be hidden or displayed by clicking on its name in this title bar.
The selected panels will be remembered between pages for each user, using the navigator local storage.
| If access to the browser’s local storage is forbidden, then the selected panels will be reset each time the user navigates. |
6.3.4. External Links
External Links are displayed in a specific panel within the semantic browser. When a model object page is loaded, the semantic browser is automatically displayed. The External Links Panel can appear with limited information.
Then, the External Links Panel will be refreshed automatically when they receive up-to-date information from the friend server(s). That information includes:
-
The icon of the remote artifact
-
The label of the links
The External links can be clicked to navigate to this object on the remote repository.
The External Links Panel displays:
-
A button to refresh the panel;
-
A button to create a new link in this panel;
-
A tree of existing links, grouped by type. For each link, the panel displays:
-
An icon;
-
A label (as a navigable URL, that opens in a different page);
-
A delete button, to delete that link.
-
| Once they are created, links are displayed in the External Links Panel to every user who can read the contents of the project that contains the model. There is no check that the current user has any kind of access or authorization to the third-party server. This can lead to revealing the existence of artifacts to users who are not authorized to see these artifacts on their remote repositories. |
6.3.5. Add an OSLC Link
-
Pre-Requisites
-
The user must have the right to edit the project.
-
The user must have an account on the targeted remote repository, and whatever rights are needed on that repository to create links.
-
An OSLC Association (see OSLC Associations) must have been configured on the project that contains the current model.
-
-
Modus Operandi
-
Click on the 'add link' button
in the OSLC Links Panel header.
That will open the OSLC Link Creation Dialog. -
Select the link type in the left drop-down menu:
-
-
Then select the OSLC Action Dialog to use for the selection or creation of the remote artifact. The contents of this drop-down is dynamically loaded from the Friend server:
-
The relevant delegated UI will then be displayed within the OSLC Link Creation Dialog. Here is an example using Polarion:
-
Use the delegated UI to select or create the target of the link on the remote Friend server:
-
The OSLC Link Creation Dialog remains open in case the user wants to create several links in a row. To close it, click outside of it anywhere in the page.
-
The OSLC Links Panel is automatically updated with the new link or links.
| During this process, it is possible that the Friend server demands a confirmation to the Publication For Capella user that they agree on Publication For Capella accessing their data on their behalf on the friend server. Refer to the OAuth section of this documentation for more details. |
| Any creation of link done in Publication For Capella server will be effective in the corresponding Capella model after the "Update from server" action described in the [update-from-server] chapter. |
6.3.6. Delete an OSLC Link
-
Pre-Requisites
-
The user must have the right to edit the project.
-
The user must have an account on the targeted remote repository, and whatever rights are needed on that repository to create links.
-
An OSLC Association (see OSLC Associations) must have been configured on the project that contains the current model.
-
-
Modus Operandi
-
Click on the 'delete' button
of the OSLC link to delete.
That will trigger the deletion of the link.
A progress indicator appears on the panel until the deletion is done.
-
-
On success, the OSLC Links Panel is automatically updated and the deleted link disappears.
-
It may happen that the delete is partial, which means that the deletion of the corresponding backlink on the remote server failed. In such a case, the link will appear in the 'Invalid link' widget of the containing model which offers solutions to resolve the problem, as described in the Fixing Invalid Links section.
| During this process, it is possible that the Friend server demands a confirmation to the Publication For Capella user that they agree on Publication For Capella accessing their data on their behalf on the friend server. Refer to the OAuth section of this documentation for more details. |
| Any deletion of link done in Publication For Capella server will be effective in the corresponding Capella model after the "Update from server" action described in the [update-from-server] chapter. |
6.3.7. Diagrams
The information displayed for diagrams is mostly identical as for any other model element.
The only difference is that the diagram’s image is displayed between the 'Bread Crumbs' and the description.
This image can be used to navigate in the model by clicking on the objects displayed in the diagram, except the object links.
It is possible to hover any object to display its Preview.
In some cases, a shape in a diagram represents several model elements. In such a case, a small pop-up menu is displayed and the user can choose to which element he or she wants to navigate.
The button in the top right of the diagram image is used to open the diagram in full size, using all the space available in the browser’s window.
| Known limitation: Object links in the diagrams cannot be navigated by clicking on them. |
Diagrams are actually standard model objects, with a type of DDiagram, mainly to match the diagram concept of Sirius, which are stored in *.aird files.
However, diagrams in Publication For Capella just own an image of the corresponding Capella diagram, they do not contain all the information of the DDiagrams contained in the *.aird files.
|
6.4. Details Panel
The details display the selected object’s attributes, as defined by its meta-class.
The value of the properties cannot be edited. If the user attempts to edit them, an error message will be displayed.
| This view is somehow similar to the properties view in Capella. However, it is much more simplistic and not configurable (yet). Consequently, the details are displayed in a similar manner for all objects. |
6.5. History Panel
There is exactly one history per project, which contains:
-
a list of commits numbered by version, which refer to the changes made on any model of the project (usually a single model).
-
a list of baselines, each baseline referring to a commit of the history.
The history panel displays a list of the changes related to the current selection. Changes are displayed in a compact way but leaving the mouse over them displays a pop-up with detailed information.
6.5.1. Model History Panel
When the selected object is a Model, then the history panels displays the complete history of this model, including any change to any element it contains.
Hovering any commit in the model history view will display a tooltip that provides some details about the commit in question:
Several actions are available in the history panel when a model is selected, via the contextual menu:
-
Create a baseline (if the logged-in user is at least a contributor to the project).
-
Delete a baseline (if the logged-in user is administrator of the project).
-
Browse the model on any baseline or even commit.
-
To browse the model on an existing baseline, just click on the baseline tag in the history view.
-
To browse the model on any commit, just select the action 'Browse Commit' on the desired commit.
-
To delete an existing baseline, click on the cross icon on the baseline chip.
A confirmation dialog is displayed:
Click on 'Confirm' to delete the baseline.
| Creating a baseline requires being logged in as a contributor to the parent project. Deleting a baseline requires being logged in as an administrator of the parent project. |
| For the moment, baselines cannot be renamed. |
6.5.2. Model Object History Panel
When a model object is selected, only the changes impacting this object are listed in the history panel.
Hovering any commit in the model object history displays a preview of the selected object, as it was in this commit. If the selected object is a diagram, the preview displays the diagram, as it was in the hovered commit.
Several actions are available in the history panel when a model object is selected, via the contextual menu:
-
Delete an existing Baseline (if the logged-in user is administrator of the project).
-
Browse the model on any visible Baseline or commit. Activating the browsing will land on the currently selected object’s page, in the context of the desired Baseline or commit.
| Creating a baseline can only be done from the Model History Panel. |
6.6. Preview
Previews of model objects and remote artifacts linked through OSLC are available when hovering several elements:
-
Breadcrumbs items;
-
Search results;
-
Model elements in the semantic browser;
-
Invalid links table elements;
-
Model elements, artifacts, and some edge labels in the diagrams;
-
Links that refer to model elements or diagrams in the rich text descriptions;
-
History commits.
| Previews are currently unavailable in the model explorer. |
7. Project Settings Page
The settings page of a project makes it possible to edit the settings of this project. It displays the following tabs:
-
Visibility - See Project Visibility
-
Associations - See OSLC Associations
-
OSLC Linking - See OSLC Linking Configuration
-
Global Conf. - See Activating Global Configuration on a Project
7.1. Project Visibility
The project settings visibility tab makes it possible to edit a project’s visibility (either private or public).
Projects marked as public can be accessed for reading by any logged-in user with a READ permission license token (See [licenses-mngt]), no matter the organizations. This simplifies access management to non-sensitive projects.
|
8. Organizations Management
Administrators can create and edit Organizations and assign access rights to users.
An organization is the top-level structure that consists of:
-
Projects: Containing Capella models;
-
Administrators: Assigned users who manage the organization;
-
Members: A list of users who have been granted access to the organization.
Create multiple organizations to logically group your projects and precisely manage security and user permissions.
The Organization management page can be accessed by clicking on the account icon, then in the menu, by clicking on "Organizations":
This action will lead to the Organizations page:
| The organization list is also directly available on the homepage. |
8.1. Organization Creation
You can create a new organization using the 'Create Organization' button.
| For the moment, organizations cannot be renamed. |
8.2. Organization Projects and Teams
Clicking on an organization in the organizations list leads to the organization page.
In this organization page you can manage the projects inside the organization, people who have access to it and teams to bind people acces to projects.
8.3. Organization People
You have to allow users to access your organization. To add a user to a organization, click on the 'People' tab of an organization page.
Then click on the 'Invite' button.
Enter his or her user name in the field and click on the 'Invite' button.
To remove a member from a organization, use the delete action next to the user in the organization page.
Members can be assigned a role within the organization:
-
member: Default role, user has access to this Organization content and has access to projects via the teams assignments. Any user could be granted as member of an organization no matter its license token.
-
admin: On top of member rights, admin manages this organization and are allowed to:
-
invite and assign role to users;
-
manage the projects and the teams of this organization;
-
delete this organisation.
-
| An "Organization Admin" must possess an Administrator Token (See [licenses-mngt]). |
To change the role of a member within the organization, click on its role and change the value in the drop down menu:
8.4. Default Organization
When migrating from a previous Publication For Capella version, the Default Organization will automatically be created (Refer to the installation guide, section 'Migrating to 2026.5.0' for more details) using the name specified by the perseus.default.org.name property. On any empty database, a default organization will be created the first time the server is launched with an available administrator account.
The default organization name must be specified in the application.properties through the perseus.default.org.name property.
|
8.5. Organization Deletion
Only organization administrators can delete an organization. To delete an organization, click on the delete action next to the organization.
| Deleting an organization will also delete the organization projects and teams. |
9. Teams Management
Any "Organization Admin" can manage Teams: create, edit or delete. A team permits to bind roles on projects and users.
The teams management page can be accessed by clicking on the account icon, then in the menu, by clicking on "Teams":
This action will lead to the Teams page:
9.1. Team Creation
You can create a new team using the 'Create New Team' button.
You can then rename the team using the pen icon or delete it using the trash icon.
To add members and access rules to the team, click on the team name to access the team page.
9.2. Team Members
To add a member to a team, use the 'Add member' button. Enter his or her user name in the field 'Member' and click on the 'Save' button.
To remove a member from a team, use the cross next to the user in the team page.
9.3. Access Rules
The team system allows to parameterize three access levels:
-
READaccess level: Members of this team can view the models exposed by this project. -
WRITEaccess level: Members of this team can view, publish models in the project (or publish updates of models already attached to this project) and create/delete OSLC links. -
ADMINaccess level: Members of this team can edit this project, configure OSLC associations on it, rename the project and delete the project.
Any access level will be restricted to the license role of the user, e.g. a user with ADMIN access level on a project but with a CONTRIBUTOR license role will only gain a WRITE access on the project.
|
To create a project access rule in a team, use the 'New Project Access Rule' button.
-
Select the access level you want to grant the members of the team.
-
Select the project you want to grant access to.
Click on the 'Grant access' button.
Once granted, an access rule can be deleted using the trash icon or updated by creating a new access rule on the same project.
10. User Settings Page
The settings page of a user makes it possible to edit the settings. It displays the following tabs:
-
Explorer Filters - See Explorer Filters
-
Security - See Security
10.1. Explorer Filters
The model explorer view is filter according to the criteria defined in these settings. Each user can have its own settings, and they all inherit the server default settings if they don’t explicitly change these settings.
The server administrator can edit the server default settings and reload these default settings so that they become active for every user that has not explicitly configured their own settings.
The settings are based on two simple concepts:
- Meta-Model Pattern
-
A String that will be used to match meta-models. Each meta-model whose
NsURIcontains the pattern will match. - Meta-Class Name
-
A String that identifies a meta-class by its name.
To be displayed in the Model Explorer, an object must have a type (i.e. a meta-class) that complies with the following constraints:
-
The meta-class name must be among those present in the settings.
-
The meta-class' meta-model must match the associated pattern.
For example, the default settings define two patterns:
-
capella: This pattern matches all the Capella meta-models, since their meta-modelNsURIall contain the Stringcapella. For example, The Logical Architecture meta-model in Capella 6 has the followingNsURI:http://www.polarsys.org/capella/core/la/6.0.0. -
perseus: This pattern matches all the Publication For Capella meta-models.
The list of meta-classes to display in the explorer can be edited for each pattern. The editor offers completion features to facilitate the selection of the relevant type.
It is also possible to add or delete a pattern. The bottom text Field labeled 'New Pattern' can be used to enter the name of a new pattern to add. Then, the user must click on the 'Add' button.
The addition of a pattern is only possible if the new pattern does not overlap with an existing pattern.
For example, trying to add a pattern cap when there already is a pattern capella is forbidden because any meta-model that matches capella would also match cap.
|
A pattern and the associated list of meta-class names can be deleted from the settings by clicking on the delete icon of the corresponding panel.
Three buttons are available at the bottom of the page:
-
Use Defaults: This button is only active if the current user’s settings is not the server defaults. Clicking on this button will erase the user’s settings and reset them to the server’s defaults. -
Reset: This button is only active if some modification has been made to the settings. Clicking on this button will reset the form to its saved state, discarding any change that was made by the user in the settings. The settings will not be changed. -
Save: This button is only active if some modification has been made to the settings. Clicking on this button will persist the user’s settings, so that they will be taken into account afterwards.
10.1.1. Explorer Filters Default Settings
The default settings of the Explorer Filters can be edited by the administrator in an external file.
This file must be referred to by URL in the perseus.metaclass.filter.default property that must be set in the server’s application.properties settings file.
perseus.metaclass.filter.default:file:///d:/metaclass-filter.json
After this file has been modified, it must be reloaded for these changes to be taken into account on the server.
Only the Server Administrator can reload this settings file.
It can be achieved from the User Settings page of the administrator account, by clicking on the 'Reload Defaults' button. This button is only visible by Server Administrators.
10.2. Security
The Security tab provides users with means to understand and act on their security authorizations.
It lists all active authorizations, either:
-
Outgoing Authorizations: the active authorizations granting Publication For Capella access to third party applications.
-
Incoming Authorization: the active authorizations granting third party applications access to Publication For Capella.
Each of those authorizations can be revoked at any time using the delete action.
11. Jobs Page
As some processes can take a long time to complete, they are launched as jobs on the server. This is the case with model publications for instance. The jobs page displays the list of current and past jobs (all the jobs that are not finished, plus the jobs that finished in the last 7 days).
It can be accessed by clicking on the account icon, then in the menu, by clicking on "Jobs":
For each job, the following information is available:
-
The jobs status, as an icon (scheduled, running, complete, warning, failed, canceled);
-
The job label, which is a clickable link if the job produced usable results. For instance, a publication job link will have its label linked to the published model;
-
The username of the account used to create the job;
-
One or two dates:
-
The job scheduling date, if the job has not started yet, or the start date, if the job has begun;
-
The end date, if the job has finished.
-
A server administrator can view all the jobs, created by any user. A non-administrator user can only view the jobs he or she created.
12. OAuth Consumers Management
The Publication For Capella server supports OAuth 1.0 and OAuth 1.0a for authentication from third-party servers (like Polarion or IBM Jazz applications). To be able to interact with Publication For Capella, administrators of third-party servers must first issue a request to be associated with the Publication For Capella server (friend request). Administrators of the Publication For Capella server must then accept the friend request.
| It is not necessary, and actually impossible, to declare consumers for Jama Connect or Codebeamer friend servers. |
12.1. Managing Consumers and Friend Requests
Administrators (and administrators only) can manage the registered or provisional consumers (friend servers) on a dedicated page.
That page can be accessed via the administrator user menu, by clicking on the menu item Consumers:
When a third-party server has issued a friend request and it has not yet been validated by a server administrator, the request is 'provisional', which is materialized by the yellow question mark icon.
Clicking on a consumer leads to its dedicated consumer page:
Administrators can edit consumers as follows:
-
On provisional consumers (marked with a question mark icon):
-
Approve the consumer — in which case the consumer is marked as approved and can then be used for OSLC scenarios.
-
Deny the consumer — in which case the consumer is deleted, and OSLC communication from the requesting server remains not allowed.
-
-
On all consumers:
-
Rename the consumer — so that it can be easily recognized. The new name must then be save with the Apply button.
-
Delete the consumer — This does not warn the consumer’s remote server in any way. It does not either delete links associated to this consumer. However, the association between this consumer and this Publication For Capella instance will be broken, and behavior is unspecified on both ends. So, removing a registered consumer should be done with caution, and is generally discouraged in production. However, it can be useful when the associated server is no longer in use, for example.
-
13. Connecting to Remote Repositories with OSLC
Publication For Capella is an OSLC Provider that exposes model elements using the OSLC AM (Architecture Management) vocabulary.
Publication For Capella is also an OSLC Consumer that can connect to third-party repositories using OSLC. It has been tested with Polarion(tm) and IBM DOORS Next(tm).
This section describes how the connection to such third-party repositories is established and used.
13.1. Friend Servers
The first operation that needs to be performed to connect to a third-party repository is to emit a so-called 'Friend Request' to this repository.
13.1.1. View the Publication For Capella server’s Friends
This page is only accessible to a Server Administrator.
The page of the server’s Friends display the list of known Friend servers with the following details:
-
Name: The user-friendly name of the friend (editable).
-
Root Services URI: The URL of the friend, used as the main entry point for all communications with that friend. If the friend is a standard OSLC server, this is its root services URL. Otherwise, please refer to the specific integrations documentation below.
-
Key: The key used for authenticating with this friend.
-
Type: The type of the friend server, one of:
-
Standard OSLC (Polarion, IBM Jazz): The default value; -
Jama Connect; -
Codebeamer.
-
-
The last column contains actions to rename or delete friend servers.
13.1.2. Create a new Standard Friend
This is the procedure to follow to connect to Polarion, any IBM Jazz application (IBM DOORS Next, IBM EWM, IBM QM, …), Jira, Confluence, or any server that conforms to OSLC.
-
Pre-Requisites
-
Being logged in as a Server Administrator;
-
Navigate to the 'Friends' page;
-
Know the Friend server’s OSLC root services URL. That URL depends on the third-party repository you want to connect to, please refer to the relevant documentation of that repository.
-
-
Modus Operandi
-
Click on the button 'New': The OSLC Friend creation dialog is displayed.
-
-
Fill in the form:
-
Name: This is a human-readable name that should make it easy for users to recognize the Friend server.
-
Friend type: Leave it to the default value 'Standard OSLC (Polarion, IBM Jazz)'.
-
Root Services URI: This is the URL of the friend server’s root services entry point. That information can only be obtained from the third-party repository’s documentation.
-
|
-
Secret: This should be a complex password, we recommend using at least 12 characters and mixing lowercase & uppercase letters, digits and special characters.
-
Confirm secret: This should be the same as the Secret above.
-
Trusted: This is reserved for future use and has no effect.
-
Click on 'Create'
-
-
If successful, the dialog is closed and the friend appears in the list of server friends. In the background, a friend request is issued and sent to the remote server using its root services URL.
|
This request must be accepted by the third-party repository administrator (or whoever is relevant according to the third-party repository’s policy).
|
-
If the root services URL is incorrect, then an error message is displayed on the bottom right of the page.
13.1.3. Create a new Jama Connect Friend
This is the procedure to follow to connect to a Jama Connect server.
-
Pre-Requisites
-
Being logged in as a Server Administrator;
-
Navigate to the 'Friends' page;
-
Know the Jama Connect server’s Rest API URL.
-
-
Modus Operandi
-
Click on the button 'New': The OSLC Friend creation dialog is displayed.
-
Select the Friend type 'Jama Connect'.
-
Fill in the form:
-
Name: This is a human-readable name that should make it easy for users to recognize the Jama Connect server.
-
Friend type: Set it to 'Jama Connect'.
-
Jama server API URI: This is the URL of the Jama Connect server’s Rest API entry point (Currently, the integration has only been tested with version 1 of the Jama Connect Rest API). For example,
https://<mycompany.jamacloud.com>/rest/v1.
-
Configure a Jama Connect Friend Server
Jama Connect Friend server declarations have a specificity: They can be configured.
To access the configuration of a Jama Connect friend server, click on the friend’s name in the page View the Publication For Capella server’s Friends. The Jama Connect Settings page will open.
This page makes it possible to configure the mapping of the Jama Connect server’s item types to OSLC types.
Only the items whose type is mapped to an OSLC type will be recognized by Publication For Capella.
OSLC types are identified by a URI. Standard OSLC types include (non-exhaustive list):
-
Requirements Management Domain:
-
http://open-service.net/ns/rm#Requirement. -
http://open-service.net/ns/rm#RequirementCollection.
-
-
Quality Management Domain:
-
http://open-service.net/ns/qm#TestCase. -
http://open-service.net/ns/qm#TestPlan. -
http://open-service.net/ns/qm#TestScript. -
http://open-service.net/ns/qm#TestResult. -
http://open-service.net/ns/qm#TestxecutionRecord.
-
-
Change Management Domain:
-
http://open-service.net/ns/cm#ChangeNotice. -
http://open-service.net/ns/cm#ChangeRequest. -
http://open-service.net/ns/cm#Defect. -
http://open-service.net/ns/cm#Enhancement. -
http://open-service.net/ns/cm#Task.
-
-
Architecture Management Domain:
-
http://open-services.net/ns/am#Resource.
-
However, it is possible to create additional types and use them with Publication For Capella if necessary.
The OSLC types mapped to Jama Connect item types must be defined in the other Publication For Capella settings:
-
In the OSLC Linking Configuration.
-
In the traceability settings of the Capella models.
To add a mapping:
-
Select an item type in the left-hand input.
-
Select or type an OSLC type uri in the right-hand input.
-
Click on add.
To delete a mapping, click on the trash icon in the mapping line. A confirmation dialog will be displayed.
13.1.4. Create a new Codebeamer Friend
This is the procedure to follow to connect to a PTC Codebeamer server.
-
Pre-Requisites
-
Being logged in as a Server Administrator;
-
Navigate to the 'Friends' page;
-
Know the Codebeamer server’s URL.
-
-
Modus Operandi
-
Click on the button 'New': The OSLC Friend creation dialog is displayed.
-
Select the Friend type 'Codebeamer'.
-
Fill in the form:
-
Name: This is a human-readable name that should make it easy for users to recognize the Codebeamer server.
-
Friend type: Set it to 'Codebeamer'.
-
Root catalog URI: This is the URL of the Codebeamer server’s OSLC catalog entry point. For example, on a CodeBeamer server deployed at
https://<codebeamer.mycompany.com>/cb, theRoot catalog URIto use should be:https://<codebeamer.mycompany.com>/cb/api/oslc/catalog.
-
13.1.5. Rename a Friend
-
Pre-Requisites
-
Being logged in as a Server Administrator;
-
Navigate to the 'Friends' page;
-
-
Modus Operandi
-
Click on the icon '…' on the line of the Friend to rename, select the 'Rename' action: A renaming dialog is opened.
-
13.1.6. Delete a Friend
-
Pre-Requisites
-
Being logged in as a Server Administrator;
-
Navigate to the 'Friends' page;
-
-
Modus Operandi
-
Click on the icon '…' on the line of the Friend to rename, select the 'Delete' action: A confirmation Dialog is opened. The dialog indicates the OSLC Associations that will be deleted, if any.
-
13.2. OSLC Associations
Once the OSLC 'friendship' is established between the Publication For Capella server and a third-party repository, each Project Administrator can define 'OSLC Associations' between their Publication For Capella project and OSLC Service Providers of a friend server.
The association configuration page can be found in project settings, under the "Associations" tab:
Once a friend is selected, a service provider can be selected among available ones:
Clicking on "Create OSLC Association" will add the association to the list. This button is grayed if the association already exists:
An association can be deleted from the list, this will display a warning dialog.
An association can be parameterized by clicking on the pen icon next to it. A dialog makes it possible to change the following options:
-
"Allow selection dialogs": Unckecking this option will remove the selection dialogs from the list of available dialogs when creating a link.
-
"Allow creation dialogs": Unckecking this option will remove the creation dialogs from the list of available dialogs when creating a link.
-
"Keep dialogs open after links creation": Unckecking this option will make the link creation dialog close after automatically after use. This option is unchecked by default except when associating with a Polarion server. It is recommended to leave this option unchecked when associating with a third-party that supports multi-selection, such as IBM DOORS Next or Atlassian Jira, for instance.
13.3. OSLC Links
Once at least one OSLC association has been configured on a Publication For Capella project, users that are allowed to edit the project can create links to artifacts hosted on the friend repositories.
See sections External Links, Add an OSLC Link, Delete an OSLC Link, or for more details.
13.4. OSLC Linking Configuration
The OSLC Linking Configuration makes it possible to configure, to some extent and depending on the third-party repositories capabilities, the kinds of links that can be created to third-party repository objects.
For example, it is possible to allow the creation of links 'satisfies' from Capella LogicalFunctions to third party Requirements, and of links 'refines' from Capella Logical Components to third-party Requirements.
13.4.1. Default and Project-Specific Configurations
The Server Administrator can configure the default Linking configuration, which will be used by default by all the projects of the server.
Global OSLC Linking configuration
The Default Linking Configuration can be seen by a Server Administrator using the administrator user menu and selecting 'OSLC Linking'.
To modify it, the Server Administrator should manually edit the file containing those configuration then save it.
The path and name of this file is defined in application.properties file and inside its perseus.oslc.linking.default field.
Once this file has been modified, the Server Administrator must use the 'Reload' button on the default configuration page to reload the contents of the default configuration file so that it is used by the server.
Project-Specific OSLC Linking configuration
Each member of a Project’s Administrator Team can configure the Project-specific Linking configuration that will be used for this project.
The Project Linking Configuration can be accessed by a Project Administrator in the project’s settings page.
-
Click on the checkbox to enable or disable the project-specific configuration
-
If enabled, the configuration can then be edited and saved using the text area in this page, and the 'Update' button.
13.4.2. Configuration Syntax
The configuration of OSLC Linking is specified in JSON format. The example below shows the different concepts that can be used for this configuration.
{
"namespaces" : {
"dcterms" : "http://purl.org/dc/terms/",
"oslc" : "http://open-services.net/ns#",
"oslc_rm" : "http://open-services.net/ns/rm#",
"oslc_am" : "http://open-services.net/ns/am#",
"oslc_cm" : "http://open-services.net/ns/cm#",
"cap_ctx" : "http://www.polarsys.org/capella/core/ctx/5.0.0#",
"cap_la" : "http://www.polarsys.org/capella/core/la/5.0.0#",
"cap_fa" : "http://www.polarsys.org/capella/core/fa/5.0.0#"
},
"types" : {
"oslc_am:Resource": {
"label" : "Architecture Resource"
},
"oslc_rm:Requirement": {
"label" : "Requirement"
},
"oslc_rm:RequirementCollection": {
"label" : "Requirement Collection"
}
},
"links" : {
"oslc_rm:elaborates": {
"label" : "elaborates",
"inverse" : "oslc_rm:elaboratedBy"
},
"oslc_rm:elaboratedBy": {
"label" : "is elaborated by",
"inverse" : "oslc_rm:elaborates"
},
"oslc_rm:satisfies": {
"label" : "satisfies",
"inverse" : "oslc_rm:satisfiedBy"
},
"oslc_rm:satisfiedBy": {
"label" : "is satisfied by",
"inverse" : "oslc_rm:satisfies"
},
"oslc_rm:refines": {
"label" : "refines",
"inverse" : "oslc_rm:refinedBy"
},
"oslc_rm:refinedBy": {
"label" : "is refined by",
"inverse" : "oslc_rm:refines"
}
},
"linking" : {
"cap_la:LogicalComponent" : {
"oslc_rm:elaborates": ["oslc_rm:Requirement"],
"oslc_rm:refines": ["oslc_rm:Requirement", "oslc_am:Resource"]
},
"cap_la:LogicalFunction" : {
"oslc_rm:satisfies": ["oslc_rm:Requirement", "oslc_rm:RequirementCollection"],
"oslc_rm:refines": ["oslc_rm:Requirement", "oslc_am:Resource"]
}
}
}
-
namespaces: This is a JSON Object that defines prefixes for URI used in the rest of the document.
-
The
namespaceof the meta-class of a model element hosted in Publication For Capella can be found on this model elements page. Add a#character at the end to use it in the OSLC linking configuration.
-
-
types: This is a JSON Object that defines the object types that can be used , and the labels corresponding to these types.
-
links: This is a JSON Object that defines the links types that can be used. Each type of link has a 'label' and an 'inverse' that refers to a link type. The 'reverse' link type is used to create a backlink on the Friend server for each link created from the Publication For Capella server, along the lines of the Linked Data philosophy.
-
linking: This is a JSON object that defines the types of links that can be created from specific types of model objects stored on the Publication For Capella server to specific types of remote objects on third-party friend repositories.
|
General Consideration on Configuration Consistency between Repositories
It is important to make sure that the configuration of links in the Publication For Capella server matches the one in the connected repositories. Especially, it is necessary that the link types and associated reverse link types match. They need to be declared symmetrically in Publication For Capella and in the connected repositories. For example, Let’s assume a link type |
13.4.3. IBM DOORS Next Specific Configuration
When configuring links to create towards DOORS Next requirements, it is necessary to respect the following constraints:
-
In the
namespacessection, define a namespace prefix for the Jazz-Specificlinktypesnamespace:-
jts_dm : "http://jazz.net/ns/dm/linktypes#"
-
-
In the
linkssection, define any of the following link types without any reverse (these are the link types supported by DOORS Next):-
jts_dm:trace(For links labeled as “Traced By Architecture Element” in DOORS Next) -
jts_dm:refine(For links labeled as “Refined By Architecture Element” in DOORS Next) -
jts_dm:satisfy(For links labeled as “Satisfied By Architecture Element” in DOORS Next) -
jts_dm:derives(For links labeled as “Derives Architecture Element” in DOORS Next, the ‘s’ at the end of ‘derives’ is on purpose)
-
-
In the
linkingssection, assign these link types to relevant object types.
A minimal example of a valid configuration to create links of type satisfies to DOORS Next requirements would be:
{
"namespaces" : {
"oslc_rm" : "http://open-services.net/ns/rm#",
"oslc_am" : "http://open-services.net/ns/am#",
"cap_la" : "http://www.polarsys.org/capella/core/la/5.0.0#",
"jts_dm" : "http://jazz.net/ns/dm/linktypes#"
},
"types" : {
"oslc_am:Resource": {
"label" : "Architecture Resource"
},
"oslc_rm:Requirement": {
"label" : "Requirement"
},
"oslc_rm:RequirementCollection": {
"label" : "Requirement Collection"
}
},
"links" : {
"jts_dm:satisfy": {
"label" : "satisfies DOORS Next Requirement"
}
},
"linking" : {
"cap_la:LogicalComponent" : {
"jts_dm:satisfy": ["oslc_rm:Requirement"]
},
"cap_la:LogicalFunction" : {
"jts_dm:satisfy": ["oslc_rm:Requirement"]
}
}
}
13.4.4. IBM EWM Specific Configuration
Links that can be created to Change Requests exposed by IBM EWM are constrained. However, Publication For Capella does not currently support dynamically configuring the types of links that can be created based on remote server’s configuration.
So, currently, when configuring links to create towards IBM EWM change requests, it is necessary to respect the following steps:
-
In the
namespacessection, define a namespace prefix for the Jazz-Specificlinktypesnamespace:-
"jts_dm" : "http://jazz.net/ns/dm/linktypes#"
-
-
In the
linkssection, define the following link type:-
jts_dm:elaborates-
with the label you wish to use in Publication For Capella,
-
with inverse value
oslc_cm:relatedArchitectureElement(For links labeled as “Elaborated By Architecture Element” in IBM EWM).
-
-
-
In the
linkingssection, assign these link types to relevant object types.
Such a configuration makes it possible to create links jts_dm:elaborates from Capella elements to EWM change requests, with a reverse link of type oslc_cm:relatedArchitectureElement visible in EWM.
A minimal example of a valid configuration to create links to DOORS Next requirements would be:
{
"namespaces" : {
"oslc_cm" : "http://open-services.net/ns/cm#",
"oslc_am" : "http://open-services.net/ns/am#",
"cap_la" : "http://www.polarsys.org/capella/core/la/5.0.0#",
"jts_dm" : "http://jazz.net/ns/dm/linktypes#"
},
"types" : {
"oslc_am:Resource": {
"label" : "Architecture Resource"
},
"oslc_rm:Requirement": {
"label" : "Requirement"
},
"oslc_cm:ChangeRequest": {
"label" : "Change Request"
}
},
"links" : {
"oslc_cm:relatedArchitectureElement": {
"label" : "Elaborated by Architecture Element",
"inverse" : "jts_dm:elaborates"
},
"jts_dm:elaborates": {
"label" : "elaborates Change Request",
"inverse" : "oslc_cm:relatedArchitectureElement"
}
},
"linking" : {
"cap_la:LogicalComponent" : {
"jts_dm:elaborates": ["oslc_cm:ChangeRequest"]
},
"cap_la:LogicalFunction" : {
"jts_dm:elaborates": ["oslc_cm:ChangeRequest"]
}
}
}
13.4.5. IBM ETM Specific Configuration
Links that can be created to Test Cases exposed by IBM ETM are constrained. However, Publication For Capella does not currently support dynamically configuring the types of links that can be created based on remote server’s configuration.
So, currently, when configuring links to create towards IBM ETM Test Cases, it is necessary to respect the following steps:
-
In the
namespacessection, define prefixes for the following namespaces:-
"oslc_qm": "http://open-services.net/ns/qm#", -
"oslc_am": "http://open-services.net/ns/am#", -
"jts_rqm": "http://jazz.net/ns/qm/rqm#"
-
-
In the
typessection, define the following artifact type:-
"oslc_qm:TestCase": { "label": "Test Case" }
-
-
In the
linkssection, define the following link types:-
"oslc_am:validatedBy": { "label": "Validated By", "inverse": "jts_rqm:validatesArchitectureElement" }, -
"jts_rqm:validatesArchitectureElement": { "label": "Validates Architecture Element", "inverse": "oslc_am:validatedBy" } -
You can customize the
labelof these types
-
-
In the
linkingssection, assign these link types to relevant object types.
Such a configuration makes it possible to create links oslc_am:validatedBy from Capella elements to ETM Test Cases, with a reverse link of type jts_rqm:validatesArchitectureElement visible in ETM.
A minimal example of a valid configuration to create links to ETM requirements (from Logical Components and Logical Functions) would be:
{
"namespaces" : {
"oslc_qm": "http://open-services.net/ns/qm#",
"oslc_am": "http://open-services.net/ns/am#",
"jts_rqm": "http://jazz.net/ns/qm/rqm#"
},
"types" : {
"oslc_am:Resource": {
"label" : "Architecture Resource"
},
"oslc_qm:TestCase": {
"label": "Test Case"
}
},
"links" : {
"oslc_am:validatedBy": {
"label": "Validated By",
"inverse": "jts_rqm:validatesArchitectureElement"
},
"jts_rqm:validatesArchitectureElement": {
"label": "Validates Architecture Element",
"inverse": "oslc_am:validatedBy"
}
},
"linking" : {
"cap_la:LogicalComponent" : {
"oslc_am:validatedBy": ["oslc_qm:TestCase"]
},
"cap_la:LogicalFunction" : {
"oslc_am:validatedBy": ["oslc_qm:TestCase"]
}
}
}
13.4.6. Jira Specific Configuration
| The following indications are only valid for use with the Jira add-on OSLC Connect for Jira by Sodius. |
Jira exposes its artifacts as Change Requests form the standard OSLC Change Management vocabulary (oslc_cm:ChangeRequest).
The only link type supported between Publication For Capella and Jira is jts_dm:elaborates, with an inverse type of oslc_cm:relatedArchitectureElement.
A minimal example of a valid configuration to create links to Jira Change Requests (from e.g. Logical Components and Logical Functions) would be:
{
"namespaces" : {
"dcterms" : "http://purl.org/dc/terms/",
"oslc" : "http://open-services.net/ns#",
"oslc_am" : "http://open-services.net/ns/am#", (1)
"oslc_cm" : "http://open-services.net/ns/cm#", (2)
"cap_ctx" : "http://www.polarsys.org/capella/core/ctx/7.0.0#", (3)
"cap_la" : "http://www.polarsys.org/capella/core/la/7.0.0#", (3)
"cap_fa" : "http://www.polarsys.org/capella/core/fa/7.0.0#", (3)
"jts_dm" : "http://jazz.net/ns/dm/linktypes#" (4)
},
"types" : {
"oslc_am:Resource": { (5)
"label" : "Architecture Resource"
},
"oslc_cm:ChangeRequest": { (6)
"label" : "Change Request"
}
},
"links" : {
"jts_dm:elaborates": { (7)
"label" : "elaborates",
"inverse" : "oslc_cm:relatedArchitectureElement" (8)
},
"oslc_cm:relatedArchitectureElement": { (9)
"label" : "is elaborated by",
"inverse" : "jts_dm:elaborates"
}
},
"linking" : {
"cap_la:LogicalComponent" : {
"jts_dm:elaborates": ["oslc_cm:ChangeRequest"] (10)
},
"cap_la:LogicalFunction" : {
"jts_dm:elaborates": ["oslc_cm:ChangeRequest"] (10)
}
}
}
| 1 | Prefix for the Architecture Management Domain (for Publication For Capella model objects) |
| 2 | Prefix for the Change Management Domain (for Jira items) |
| 3 | Prefixes for some Capella 7 meta-models (there could be more if necessary) |
| 4 | Prefix for Jazz Team Server Domain, which is used by Jira as well |
| 5 | Artifact type for Architecture resources exposed by Publication For Capella |
| 6 | Artifact type for items exposed by Jira |
| 7 | Link type required by Jira for links from Publication For Capella model objects to Jira items |
| 8 | And the associated back-link type, required to create the back-links on Jira items |
| 9 | Declaration of the back-link type |
| 10 | Allow links with type jts_dm:elaborates from Publication For Capella elements to Jira items |
13.5. Authentication with OAuth 1
Publication For Capella supports OAuth 1.0 to authenticate users with Friend servers (except CodeBeamer, which does not support OAuth 1.0 and with which authentication is made using HTTP Basic).
OAuth 1.0 is an authorization framework that makes it possible to have Publication For Capella communicate with third-party servers, on behalf of a user, without having to know the user’s login and password on the friend server.
This authentication can be triggered on different occasions, whenever a user action in the Publication For Capella web site requires authenticated communication with a friend server.
A pop-up frame will be displayed to the user. This frame embed a page from the Friend server that will ensure that the user is properly authenticated on the remote server and allows Publication For Capella to access the friend server on their behalf.
On the user has confirmed that he or she agrees on Publication For Capella accessing the friend server on their behalf, an access token is securely generated and will be used for further communication between the Publication For Capella server and the friend server. Depending on the friend server’s implementation, this access token might have a limited duration. As long a this token is valid, the user will be able to access the friend server from the Publication For Capella server. As soon as this token in invalidated, for whatever reason, the OAuth authentication process described above will be triggered again.
The following figures show how this authentication looks like when accessing a Polarion server from Publication For Capella.
| In some cases, the OAuth user interface might be blocked by the web browser. If that happens, the user must click on the dedicated link to open the OAuth user interface directly within the Friend server’s website instead of within an iframe in the Publication For Capella website. The user will then be able to confirm approval, and Publication For Capella will then be able to securely communicate with the Friend server on behalf of the user. |
14. Global Configuration Support
Publication For Capella supports the connection to Jazz Team Server projects that use the Global Configuration mechanism.
|
The support of Global Configuration in Publication For Capella is, for the time being, limited. Specifically, we support Scenario Two of the 5 scenarios described by IBM for integrating with Global Configuration. We plan to enrich this support in the next versions. |
14.1. Server Set-Up
To use Global Configuration, Publication For Capella must be associated with a friend server that provides Global Configurations. A project will then require an association to a Global Configuration service provider of this friend server.
On the friend side, Global Configuration must be activated and at least one configuration must exist.
14.2. Activating Global Configuration on a Project
In Publication For Capella, the use of Global Configuration is decided on a per-project basis. Deciding to use Global Configuration on a Publication For Capella Project is a final decision, it cannot be reverted afterwards.
|
Impacts of Global Configuration
Activating Global Configuration on a Project will change the behavior of Publication For Capella for this specific project:
|
To activate the use of Global Configuration on a project:
-
Go to project settings;
-
In the Overview section, click on the Activate Global Configuration;
-
Confirm.
| Global configuration cannot be activated for a project if active OSLC links are already in use in any of the project models. |
Once activated, the button is no longer available and a message indicates that Global Configuration has been activated for this project. A subtitle appears under the project name:
| This action cannot be reverted. |
14.3. Assigning a Global Configuration to a Model
For the time being, each model should correspond to a single stream of work for this model.
Once the Global Configuration mode has been activated for a project, the models it contains can be assigned a Global Configuration as follows:
-
Click on the model in the Explorer;
-
In the model page, click on Assign Global Configuration.
-
A dialog makes it possible to chose the Global Configuration Provider among the configured OSLC associations. If there is only one possible choice the OSLC remote dialog will automatically be loaded.
-
Select a Global Configuration then click OK;
-
Confirm.
| This action cannot be reverted. |
Once assigned, any OSLC link created on any of this model’s objects will use the configuration to retrieve the remote element data:
-
Label & icon of the link will match the remote version related to the assigned configuration.
-
Clicking on a link will lead to the remote page within the assigned configuration.
-
Once an Update from server action has been performed, a Publication For Capella client synchronized with the model will see the data available within the assigned configuration:
-
Refreshing artifacts will fetch the remote version within the assigned configuration.
-
Only artifacts available within the assigned configuration can be dropped within the model.
-
14.4. Filtering a Project by Global Configuration
The project can be filtered to only display information related to a specific Global Configuration as follows:
-
Click on the label under the project title, which shows No configuration selected by default.
-
This will open the configuration selection dialog.
-
Once a configuration is selected, its title appears under the project name.
-
The filter can be reset by clicking on the cross icon on the right of the configuration title.
15. Traceability Support
The version 2023.3.0 introduces the capability to manage traceability links to third-party artifacts directly from within Capella.
Such traceability links are stored in a dedicated model tied to the Capella model of interest.
The primary means of creating such links is by drag & drop. Just dragging an artifact URL from your browser into the Capella will create a link between a model element and this artifact. Such links are stored in the model. The traceability information is thus available within the model in the modeling workbench.
This traceability information is published to the Publication For Capella server whenever a publication takes place, along with the rest of the model. It is then available in the usual 'OSLC Links' section, described in External Links.
For more information about the management of such links in Capella, refer to the Publication For Capella user manual, chapter 'Using Publication For Capella Contributor Client'.
15.1. Traceability Maintenance
Some operations can cause links to become technically invalid. That is the case if the remote server does not respond properly to a link change request, whatever the reason (the server could be in maintenance, or overloaded, or anything else).
This section describes the maintenance tools that can be used to act and hopefully repair such invalid links.
15.1.1. Fixing Invalid Links
Creating a link to a third-party artifact leads to the creation of the matching reverse link on the remote friend, as deleting a link in Publication For Capella will delete that reverse link on the remote friend.
However, creation and deletion of links to an OSLC friend depends on the availability of said friend so in some cases, a link can be created/deleted locally in Publication For Capella but the related remote operation can fail.
A model with invalid links will appear with a Warning icon in the Explorer.
A Publication For Capella server administrator or a project contributor can fix such situations with the help of a dedicated panel that is available on the model page.
This invalid links panel will only appear if there are invalid links in the database.
Several kinds of issues can make a link invalid:
-
Missing artifact: the target of the link has been deleted.
-
Broken link: the source of the link has been deleted.
-
Remote creation failed: the creation of the reverse link on the remote friend was attempted but failed with an error.
-
Remote deletion failed: the deletion of the reverse link on the remote friend was attempted but failed with an error.
For each link the administrator can:
-
Retry the operation: either retry to create or delete the reverse link.
-
Delete the link so it will no longer appear in the incomplete link interface. Before deleting an invalid link, the administrator should make sure the remote backlink, if it exists, is properly deleted as well.
The "Retry" action can require an OAuth authentication which will be proposed by a dialog, the operation will be cancelled and need to be retried afterwards.
If the link is broken, "Retry" will be disabled unless it is in Remote deletion failed state.
"Retry all" and "Delete all" actions will apply the same fix for all links, any error or OAuth authentication request that happens during that process will halt it.
16. Known Limitations - Web Client
-
The server does not support pagination of responses. This may cause performance or UI issues in some circumstances.
-
Tabular representations (tables and cross-tables) are not supported. The only representations that can currently be displayed are diagrams.
-
Object links in diagrams don’t support navigation by clicking on them.
-
The support of the OSLC Query API is partial, despite improvements made in version 2023.8.0.
-
CodeBeamer Integration Limitations:
-
CodeBeamer has no delegated dialogs for creating links. Consequently, it is not possible to create links to CodeBeamer artifacts online, it has to be done in Capella.
-
CodeBeamer cannot display links stored in an associated Publication For Capella server.
-
-
Images in Rich text descriptions are ignored when publishing from Team for Capella with Capella versions 6.0 or below