diff --git a/content/en/docs/workstation/wks-import.md b/content/en/docs/workstation/wks-import.md new file mode 100644 index 00000000000..e231c94c815 --- /dev/null +++ b/content/en/docs/workstation/wks-import.md @@ -0,0 +1,69 @@ +--- +title: "Managing and Sharing Workspace and Station Data" +linktitle: "Managing and Sharing Data" +url: /mendix-workstation/import-export/ +description: "Describes how to import and export workspace and station data across workspaces and environments." +weight: 30 +--- + +## Introduction + +You can manage and share station and workspace data across various workspaces and environments by exporting and importing the configuration of a single station, or of multiple stations at the same time. If performed by the workspace admin, the import includes applications and devices associated with the station. In this way, you can replicate or migrate of station setups, supporting efficient and consistent data handling. + +### Workspace Roles and Permissions + +Different user roles are granted various levels of access to import and export tasks. For more information, see [Workspace Team and Collaboration](/mendix-workstation/installation/#collaboration). + +## Importing and Exporting Stations in Bulk + +{{% alert color="info" %}} +This option is only available to licensed users. For more information, see [Mendix Workstation Client](/mendix-workstation/). +{{% /alert %}} + +To transfer multiple station configurations, along with their associated applications and devices, between workspaces, perform the following steps: + +1. Open the [Workspaces](https://workstation.home.mendix.com/) page. +2. Click the workspace whose stations you want to export. +3. On the **Stations** page, click the three-dot menu in the top right corner of the screen, and then click **Export Stations**. + + {{< figure src="/attachments/workstation/wks-import1.png" class="no-border" >}} + + The **Dowload Stations** dialog opens. You can either download all the stations created for the workspace, or select individual stations from the list. + +4. Click **Download**. + + The export is saved to your computer in JSON format. + +5. Go to the workspace where you want to import the stations. + + This can be the workspace from which you exported the stations, or a different one. + +6. On the **Stations** page, click the three-dot menu in the top right corner of the screen, and then click **Import Stations**. +7. Optionally, specify if the import should include the apps and devices: + + * **Include Apps** - If you select this option, the import creates any apps that are linked to the exported stations but do not yet exist in the workspace with the same URL and public key. This option is only available to [Workspace Owners and Admins](/mendix-workstation/installation/#collaboration). + * **Include Devices** - If you select this option, the import includes any exported device configurations. + +After the import finishes, your target workspace has the same applications and station configurations as the source workspace, but the stations are not yet registered to computers. + +## Importing and Exporting a Single Station + +To transfer the contents of a single station, perform the following steps: + +1. On the **Stations** page, click the three-dot menu by the station which you want to copy, and then click **Copy Station to Clipboard**. + + {{< figure src="/attachments/workstation/wks-import2.png" class="no-border" >}} + + Alternatively, you can click **Download Station File** to download the configuration to your computer in JSON format for later use or for sharing it with others. + +2. Click **Create Station**, and then select **Create station from clipboard**. + + Alternatively, if you downloaded a file in step 1, click **Create station from file**. + +3. Paste the configuration into the **Paste Station Configuration** field. + + {{< figure src="/attachments/workstation/wks-import3.png" class="no-border" >}} + +4. Click **Continue**. +5. On the **Summary** screen, review the information and optionally select a group to categorize it, such as *Assembly*. +6. Click **Create Station**. diff --git a/content/en/docs/workstation/wks-installation.md b/content/en/docs/workstation/wks-installation.md index 82ee79c2f77..03abefc73c2 100644 --- a/content/en/docs/workstation/wks-installation.md +++ b/content/en/docs/workstation/wks-installation.md @@ -194,11 +194,38 @@ Note: Collaborating with other users in a workspace requires a Workstation licen Invite and manage members of a Workspace on the Team page. Only users who have signed into Workstation Management can be invited via email. One of the following roles can be assigned: -* Owner - The owner has full rights to manage the workspace. They can read and edit configurations, manage the team, register computers, and manage workspace settings. They can also delete a workspace or transfer ownership to a new owner. By default, the user who created a workspace is assigned the owner role. Contact Mendix Support if a Workspace owner has left the company to transfer the ownership. +* Owner - The owner has full rights to manage the workspace. They can perform the following tasks: + + * Reading and editing configurations + * Managing the team + * Registering computers + * Managing workspace settings + * Deleting a workspace or transfering ownership to a new owner + + By default, the user who created a workspace is assigned the owner role. Contact Mendix Support if a Workspace owner has left the company to transfer the ownership. + + * Exporting and importing stations (single and in bulk) + * Linking imported stations to existing workspace apps + * Creating apps during station import. + * Workspace admin - The workspace admin can manage the workspace in the same way as the owner, but they cannot delete the workspace or change its ownership. -* Station admin - Station admins can view and edit station configurations. They can also register computers to stations. They cannot manage any other settings. -* Computer admin - Computer admins can view configurations without editing them. They can also register computers to stations. -* View only - This role grants access to viewing the configuration but cannot perform any actions. +* Station admin - Station admins can perform the following tasks: + + * Viewing and editing station configurations + * Registering computers to stations + * Exporting and importing stations (single and in bulk) + * Linking imported stations to existing workspace apps. + +* Computer admin - Computer admins can perform the following tasks: + + * Viewing configurations without editing them + * Registering computers to stations + * Exporting stations (single and in bulk). + +* View only - This role can perform the following tasks: + + * Viewing configurations without editing them + * Exporting stations (single and in bulk). All members except for the Workspace owner can leave a workspace. diff --git a/static/attachments/workstation/wks-import1.png b/static/attachments/workstation/wks-import1.png new file mode 100644 index 00000000000..6332f3d5ffa Binary files /dev/null and b/static/attachments/workstation/wks-import1.png differ diff --git a/static/attachments/workstation/wks-import2.png b/static/attachments/workstation/wks-import2.png new file mode 100644 index 00000000000..da8889917ea Binary files /dev/null and b/static/attachments/workstation/wks-import2.png differ diff --git a/static/attachments/workstation/wks-import3.png b/static/attachments/workstation/wks-import3.png new file mode 100644 index 00000000000..4bb214ce471 Binary files /dev/null and b/static/attachments/workstation/wks-import3.png differ