KB-127464: Calling the Legato Interface

Calling the Legato Interface

A Legato data set can be generated via a command line call:

VdogLegato.exe /rd:{Path to the versiondog archive} /PathPrj:{Path to the project data} /PathDst:{Output path} [/Text0:{hexadecimal ID of the first language}] [/Text1:{hexadecimal ID of the second language}]

The following options and parameters can be passed as arguments for the call:

Argument Description

VDogLegato.exe

This application is created during the setup and resides in the same directory as the octoplant server binaries (for example, C:Program FilesvdogServer).

The following return values are possible:

Exit code Information

0

The application was executed without error, meaning either:

  • A Legato data set was created successfully
  • The S7 projects contain no PDIAG elements (therefore it was not necessary to create a Legato data set).
  • No S7 projects were specified (therefore it was not necessary to create a Legato data set).

1 There was a problem creating the Legato data set

-1 Incorrect / missing call parameters.

Additional information is generated via the console output.

Note

A Legato data set can only be generated by VDogLegato.exe if this feature has been activated in the

octoplant license.

/rd:{Path to the versiondog archive} Fully qualified path the root directory of the versiondog archive.

/PathPrj:{path to the project data}

Fully qualified path to the project.

Project data can be passed by:

  • Specifying a directoryIf a directory is provided in the command line, the application (VDogLegato.exe) will perform a recursive search for project files (*.s7p). A Legato data set will be created for all project files that are found.
  • Specifying a zip archive (.zip)If a zip archive is provided in the command line, the application (VDogLegato.exe) will search for project files (.s7p). Zip archives containing multiple projects are supported. Additional zip archives within the specified zip archive will be ignored.
  • Specifying an explicit S7 project file (*.s7p)A LEGATO data set will only be created for the project provided via the command line.

/PathDest:{Output path}

Fully qualified path for the output.

For the output, parameters can be passed by:

  • Specifying a directory without the file nameA name will be created for the output file automatically and placed in the output directory. Identical projects will have the same name. The following applies:
    • For an S7 project containing only one program, the file name will consist of the name of the project (s7p) and the file extension ({Name of project}.csv).
    • If multiple programs reside in a project, then a CSV file will be written for each program into a folder with the relevant project name ( .{Name of project}{Program ID}.csv).If the file is already present in the output directory, then it will be overwritten automatically.If a folder was provided for the project data (/PathPrj:) and its directories reside in subprojects, then the output file structure will be mirrored in the output path.
  • Specifying a directory including the file nameThe results will be generated in the specified file. If this file is already present in the output directory, it will be overwritten automatically. Specifying an explicit output file is particularly suitable if exactly one project was provided as the parameter for the project data (/PathPrj:).

/Text0:{Hexadecimal ID of the first language}

This parameter is optional and can be used to determine the language of the generated error messages.

If this option is not activated, the “Text0” column will remain empty in the exported CSV file

Examples of language codes are:

  • German: 0407
  • English (US): 0409
  • English (GB): 0809
  • Spanish: 040A
  • French: 040C
  • Czech: 0405
  • Italian: 0410
  • Portuguese: 0816
  • Hungarian: 040E4

A language identification list can be found in the MSDN under “Language Identifier Constants and Strings”.

Note

Error messages in the relevant languages can only be supported and exported if they are present in the configuration.

The messages will not be translated automatically.

/Text1:{Hexadecimal ID of the first language

This parameter is optional and can be used to determine an additional language for the generated error messages.

If this option is not activated, the “Text1” column will remain empty in the exported CSV file.


Last update: September 15, 2023

Related Articles

TABLE OF CONTENTS

IMPRINT | PRIVACY POLICY | COOKIE POLICY

Privacy Preference Center