LogoLogo
  • Solution Overview
    • PLC Management and Code Versioning platform
    • Basic terminology
    • Supported automation vendors
  • Project versioning
    • How to upload and manage projects
    • How to use the Windows local client
    • How to view projects incl. changes
  • AI Generated Code Documentation
    • Overview
    • How to generate a documentation
  • Connectivity Service
    • Overview
    • Requirements
    • How to set up a Gateway
    • Configuring Proxy
    • Configuring networks
    • FAQ
  • Browser Based Engineering
    • Working with Browser Based Engineering
    • Up- and download of TIA licenses for Browser Based Engineering
    • Troubleshooting
  • Automated backup
    • Configuring automated PLC backups
  • Automated deployment
    • Directly deploying your projects
    • Deployment Requests (preview)
      • Actions with 2 Factor Authentication (preview)
  • Console administration
    • Creating an account
    • SSO via Azure Active Directory
    • Deleting an account
    • Inviting console users
    • Receiving a console invite
    • Understanding permissions
    • Managing permissions
    • Choosing a subscription plan
    • Viewing bills, downloading invoices, and managing payment methods
  • Examples
    • Quick Start Guide
    • Preparing a Raspberry Pi to be used as a Gateway
  • FAQ
    • Deployment
    • IDEaaS
Powered by GitBook
On this page
  • Download and installation of the local client
  • Syncing a project to the local workstation
  • "Checking out" a project to work on it
  • "Checking in" a new project version
  • Getting an updated project version
  • Manually unblocking projects (admin users only)
  1. Project versioning

How to use the Windows local client

PreviousHow to upload and manage projectsNextHow to view projects incl. changes

Last updated 1 year ago

SDA offers a local client for Windows to enable customers to seamlessly version PLC projects in the SDA platform while working with the automation development environments (IDE, e.g., Siemens TIA Portal) on their local workstations.

Download and installation of the local client

Navigate to the user menu in top right corner of the SDA Console and click on "Get the Client". The installation package will be automatically downloaded. Execute the package on your workstation and follow the instructions.

After successful installation, the local client will ask you to provide your SDA Console login credentials.

Syncing a project to the local workstation

To sync a PLC project to a local folder, find the corresponding project entry in the project view and click on "Link to local folder". You will then be asked to select a folder in the local file system. After confirmation, the local client will automatically create a new subfolder inside the selected folder in which the project is available in an unarchived format.

Codesys projects only: In this case the project will not be automatically unarchived and saved in the .projectarchive format inside the selected folder.

After the project has been synced the local folder can be opened in the Windows file explorer by clicking on the folder icon in the bottom right corner of the project entry in the project list.

"Checking out" a project to work on it

Before starting to work on a project, you can check it out to ensure that no other team member is working on it in parallel. In order to check a project out, locate the corresponding linked project in the project view and click on "Check Out".

Note that when the project is checked out, other users of the local client will not be able to check the project out in parallel. In addition, users of the IDEaaS feature will not be able to open the project in IDEaaS in the web console.

"Checking in" a new project version

After you have edited the project locally (e.g., in Siemens TIA Portal), you can click on check-in to automatically archive and upload a new project version. The client will ask you to provide a comment on what was changed. After successful upload, the project will be unblocked again for other users.

Getting an updated project version

In case that another use has uploaded a newer version of the project for a locally linked project, a red notification icon will appear in the local client next to the corresponding project. By clicking on the icon, you can choose to download the latest version and overwrite the existing local version.

Note that any changes you may have made that are not checked-in will be overwritten!

Manually unblocking projects (admin users only)

In case that the project was blocked by a local client user ("checked out") and the user never unlocked ("checked in") the project again or can't do so for some reason (e.g., local workstation is malfunctioning), admin users can unblock projects via the context menu of the corresponding project in the SDA web console.

User menu with selected "Get the client" entry
Sign-in screen of local client
Project list in local client
Unarchived PLC project in local folder
Project list a locally linked project and option to check the project out
Project that is blocked in the web console due to a check out in the local client
Project entry with option to check-in changes
Project with icon indicating that a newer version is available
Confirmation to get the latest version and overwrite the local version
Context menu of a project with "unblock project" option