Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update documentation about T4C token and flow #1275

Merged
merged 1 commit into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/user/sessions/flows/screenshots/step_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 14 additions & 7 deletions docs/docs/user/sessions/flows/t4c.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,37 @@

<!-- prettier-ignore -->
!!! Info
Please [request a persistent session](../request.md) before you continue
with the instructions here.
Connecting to a T4C model in that way will open a connection and automatically
write changes back to the T4C model. If you do not want to write changes back you can follow
[the import T4C model](../../tools/capella/teamforcapella/import/import-from-t4c.md)
tutorial

To access a TeamForCapella based model you first need read/write access from a
model lead (usually this role is allocated to lead architects / area owners).

<!-- prettier-ignore -->
!!! Info
Please [request a persistent session](../request.md) before you continue
with the instructions here.

<!-- prettier-ignore-start -->

1. During the session creation, you perhaps already noticed the TeamForCapella
session passwords. If you've already closed the dialog, please reopen it by
session token. If you've already closed the dialog, please reopen it by
clicking `Connect` for your desired session under `Active Sessions`.
Whenever you create a session, we select all TeamForCapella models with the
same Capella version that you have access to. For those repositories, we
create a session password and register it with `TeamForCapella`. The access
is revoked after session termination. Please copy the session password (you
create a session token and register it with `TeamForCapella`. The access
is revoked after session termination. Please copy the session token (you
can just click on the text to copy it):

![Session password](screenshots/session-password.png)
![Session password](screenshots/session-token.png)

1. When Capella is finally loaded you navigate to `File` > `New` > `Other`.

![Open Connection dialog](screenshots/step_1.png)

1. Expand `Team for Capella` and select `Connect to remote model`:
1. Expand `Team for Capella` and select `Capella Connected Project`:

![Connect to remote model](screenshots/step_2.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
To import a Capella model into your persistent workspace, you need
at least the `Read/Write`-permission in the project.

<!-- prettier-ignore -->
!!! info
This imports a model into your workspace and changes are not automatically saved
back to the T4C repository. If you want to save changes directly back to the server
use [this](../../../../sessions/flows/t4c.md) documentation.

1. Open a persistent session with the corresponding Capella version.
1. Wait until Capella has started.
1. Click on `File` > `Import...`. <br />
Expand Down
Loading