Keep alive: Difference between revisions
Jump to navigation
Jump to search
(Created page with "When performing large calculations or other long running action, consider to set your project on Keep alive. This means that you can close the client, but the project stays ac...") |
No edit summary |
||
| (26 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
The Keep Alive option can be found in the [[File Menu]] of a [[project]] in the [[editor]] and is an option to keep a [[session]] running on the {{software|server}}, a so called Keep Alive session, even after the [[client]] is closed. The keep alive mode delays an automatic shut-down of your project session due to a [[time-out]]. | |||
The Keep | There are a couple of scenarios where keeping a session alive in the {{software}} is desirable. This option is commonly used in the following use cases: | ||
* For other users to be able to join. The Keep Alive option enables the project to be accessed by users with 'join only' [[Account_management|access rights]]. This can be implemented in a (multi user) stakeholder [[session]], where an organization has a session running, and is inviting external stakeholders (civilians, companies, municipalities, etc) to join the session on the {{software}}. | |||
* To complete the process of uploading data from a service. Some services contain a large amount of (3D) data. Having the session continue to process this data in the background will free up a user's time and system. Please note that in case the data is located at the user's system, this option does not work as described, as the session needs to be open on the system where the local data is located. | |||
* To finalize a long [[calculation]]. Some calculations can take a long time. It is possible to schedule such calculations with a long scheduled update. When this is selected, the session is automatically set to Keep Alive, and the user can exit while the calculation continues on the server, at the designated times. | |||
After 7 days, the Keep Alive option is ended automatically. An exception is made for [https://www.tygron.com/roadmap/ Partners]. | |||
==How to use the Keep Alive option== | |||
{{howto|title=use the Keep Alive option| | |||
| Click on the [[File Menu]] tab in the [[Editor]]. | |||
| On the Details page, select the checkbox in the ''Keep Active'' part. | |||
}} | |||
<gallery> | |||
File:FileTab1.jpg|Click on the File tab in the Editor. | |||
File:KeepAliveCheckbox1.jpg|On the Details page, select the checkbox in the ''Keep Active'' part. | |||
</gallery> | |||
==How to join a Keep Alive session== | |||
{{howto|title=join a Keep Alive session| | |||
| Select the Join option from the main menu. | |||
| Select the project to join from the list of available projects that are running. | |||
}} | |||
<gallery> | |||
File:JoinOption1.jpg|Select the Join option from the main menu. | |||
File:SelectProjectToJoin1.jpg|Select the project to join from the list of available projects that are running. | |||
</gallery> | |||
==How to end a Keep Alive session== | |||
{{howto|title=end a Keep Alive session| | |||
| Click on the File tab in the Editor. | |||
| On the Details page, deselect the checkbox in the ''Keep Active'' part. | |||
| Exit the project as usual. | |||
}} | |||
<gallery> | |||
File:FileTab1.jpg|Click on the File tab in the Editor. | |||
File:KeepAliveUnCheckbox1.jpg|On the Details page, deselect the checkbox in the ''Keep Active'' part. | |||
File:ExitProject1.jpg|Exit the project as usual. | |||
</gallery> | |||
Latest revision as of 09:47, 4 May 2023
The Keep Alive option can be found in the File Menu of a project in the editor and is an option to keep a session running on the Tygron Engine, a so called Keep Alive session, even after the client is closed. The keep alive mode delays an automatic shut-down of your project session due to a time-out.
There are a couple of scenarios where keeping a session alive in the Tygron Platform is desirable. This option is commonly used in the following use cases:
- For other users to be able to join. The Keep Alive option enables the project to be accessed by users with 'join only' access rights. This can be implemented in a (multi user) stakeholder session, where an organization has a session running, and is inviting external stakeholders (civilians, companies, municipalities, etc) to join the session on the Tygron Platform.
- To complete the process of uploading data from a service. Some services contain a large amount of (3D) data. Having the session continue to process this data in the background will free up a user's time and system. Please note that in case the data is located at the user's system, this option does not work as described, as the session needs to be open on the system where the local data is located.
- To finalize a long calculation. Some calculations can take a long time. It is possible to schedule such calculations with a long scheduled update. When this is selected, the session is automatically set to Keep Alive, and the user can exit while the calculation continues on the server, at the designated times.
After 7 days, the Keep Alive option is ended automatically. An exception is made for Partners.
How to use the Keep Alive option
How to use the Keep Alive option:
Click on the File tab in the Editor.
On the Details page, select the checkbox in the Keep Active part.
How to join a Keep Alive session
How to join a Keep Alive session:
- Select the Join option from the main menu.
- Select the project to join from the list of available projects that are running.
Select the Join option from the main menu.
Select the project to join from the list of available projects that are running.
How to end a Keep Alive session
How to end a Keep Alive session:
- Click on the File tab in the Editor.
- On the Details page, deselect the checkbox in the Keep Active part.
- Exit the project as usual.
Click on the File tab in the Editor.
On the Details page, deselect the checkbox in the Keep Active part.
Exit the project as usual.
