Skip to main content

Command: Checkout from Server

Symbol: cas_checkout_from_server.png

Function: The command checks out a project from CODESYS Automation Server, unpacks it, and saves it in the local file system. Then the project is opened in CODESYS.

Call: CODESYS menu: Project → Automation Server

Requirement:

  • The CODESYS Automation Server Connector package is installed.

  • A CODESYS project exists on the CODESYS Automation Server.

  • No project is open in CODESYS.

Table 3. Dialog: Checkout from Server

New Project

Name

Name of the project

Cannot be changed

The name is inserted automatically when you have selected a commit of a project.

Location

File path in the local file system where the project should be saved

The input is also possible by means of the list box or Input Assistant.

Automation Server

Server URL

List box for the Automation Server

Refresh

Refreshes the project list

If you are not already connected to the CODESYS Automation Server, then the Automation Server – Sign In dialog opens before the project list is refreshed.

Projects

Search field

Input of a string to filter the list by projects which contain the string in ID or Name

List of projects that exist on the Automation Server

Shows all projects which exist on the CODESYS Automation Server. Displays the ID, Name, and Modified on information.

From this list, you select the project which should be opened in CODESYS and saved in the local file system.

When you select a project here, the list of Commits of the project is refreshed.

Commits

Search field

Input of a string to filter the list by commits which contain the string in ID, Modified on, Modified by, or Message

List of commits of the selected project

Display of all commits of the selected project with the ID, Modified on, Modified by, and Message information

When you select a commit, the Name is refreshed in the New Project area.

Categories

Opens the Select Archive Categories dialog. In the dialog, select the referenced items of the repositories for the devices and the libraries of the project.

Requirements: A commit of the project is selected in the project list.

Default Selection

All items in the Select Archive Categories dialog are selected.

<number> of <total number> items are extracted

If the Default Selection is not selected in the Select Archive Categories dialog, then the number of items that are extracted and the total number are displayed here.

OK

The project in the version of the selected commit of the CODESYS Automation Server is opened in CODESYS and saved in the local file system.

Requirement: A Commit of the selected project is selected.



Table 4. Dialog: Select Archive Categories

Archive Items

Archived Items

Display of all items of different categories contained in the repository (for example, Referenced libraries and Referenced devices)

  • standard icon: The item is extracted from the repository and added to the project.

  • _cds_icon_option_deactivated.png: The item is not extracted from the repository and not added to the project.

For more information, see: CODESYS help, chapter "Command: Extract Archive"

Repositories

Install devices into

List box with currently available repositories. You select the repository where CODESYS should install the devices contained in the repository.

Install libraries into

List box with currently available repositories. You select the repository where CODESYS should install the libraries contained in the repository.

OK

The settings are applied.