Open topic with navigation

This functionality is only available for certain module packages. Info / Copyright

Action: plcservice


Parameters

Description

TYPE 

Type of task to perform the action.
BUSDATAEXPORT: Export PLC data.
BUSDATAIMPORT: Import PLC Data.
GENERATEPLCSCHEMATIC: Generate schematic.

PROJECTNAME

Project name with complete file path.

LANGUAGE 

Language code. This parameter has an effect only if the TYPE parameter has one of the following values: BUSDATAEXPORT, BUSDATAIMPORT.

CONVERTERID

Identifier for bus configuration programs. Possible values are:

  • PlcDcXMLExchangerBeckhoff: Beckhoff TwinCAT
  • PlcDcXMLExchangerPhoenix: Phoenix Contact PC WorX
  • PlcDcXMLExchangerSchneider: Schneider Unity Pro
  • PlcDcXMLExchangerSiemens: Siemens SIMATIC STEP 7
  • PlcDcXMLExchangerUniversal: PLC standard exchange format
  • XMLRockwellExchanger: RSLogix Architect
  • XPlcXMLExchanger: EPLAN Electric P8-Format

This parameter has an effect only if the TYPE parameter has one of the following values: BUSDATAEXPORT, BUSDATAIMPORT.

CONFIGURATIONPROJECT

Name of the PLC configuration project to be exported. This parameter has an effect only if the TYPE parameter has the following value: BUSDATAEXPORT.

DESTINATIONFILE 

Target file for the data export. This parameter has an effect only if the TYPE parameter has the following value: BUSDATAEXPORT.

SOURCEFILE

Source file for the data import. This parameter has an effect only if the TYPE parameter has the following value: BUSDATAIMPORT.

OVERWRITE

If the target file already exists, this parameter specifies whether the file is to be overwritten (0 = No, 1 = Yes).
Default value: 0

This parameter has an effect only if the TYPE parameter has the following value: BUSDATAEXPORT.

IMPORTMATCH

Synchronization options for the PLC data import. The import process attempts to synchronize the imported objects with those that exist in the project. Depending on the selected option, customization is based on internal object IDs or identifying object names. If an imported objects matches an existing function, the properties of the existing function will be updated, while new functions will be generated in the project for objects that cannot be synchronized. The options are:

  • 0 = Synchronization based on internal object IDs.
  • 1 = Synchronization based on identifying names. Note that in this case a synchronization dialog can be opened where you must select a function for the update.
  • 2 = No synchronization; new functions are generated for all imported objects.

This parameter has an effect only if the TYPE parameter has the following value: BUSDATAIMPORT.

SHOWCOMPAREDLG

Displays synchronization dialog (0 = No, 1 = Yes).
Default value: 0

This parameter has an effect only if the TYPE parameter has the following value: BUSDATAIMPORT.

CONFIGFILE

File path to the configuration file for generating the schematic. This parameter has an effect only if the TYPE parameter has the following value: GENERATEPLCSCHEMATIC.

SINGLELINEPAGES

If specified, single-line pages are generated (0 = No, 1 = Yes).
Default value: 0
This parameter has an effect only if the TYPE parameter has the following value: GENERATEPLCSCHEMATIC.

MULTILINEPAGES

If specified, multi-line pages are generated (0 = No, 1 = Yes).
Default value: 0
This parameter has an effect only if the TYPE parameter has the following value: GENERATEPLCSCHEMATIC.

OVERVIEWS

If specified, overview pages are generated (0 = No, 1 = Yes).
Default value: 0
This parameter has an effect only if the TYPE parameter has the following value: GENERATEPLCSCHEMATIC.

RACKOVERVIEWS

If specified, rack overview pages are generated (0 = No, 1 = Yes).
Default value: 0
This parameter has an effect only if the TYPE parameter has the following value: GENERATEPLCSCHEMATIC.

ClosedExample:

Export PLC data: 

plcservice 
/TYPE:BUSDATAEXPORT 
/CONFIGURATIONPROJECT:Schneider-Electric 
/DESTINATIONFILE:"C:\tempdir\plcservice_export_1.xef" 
/PROJECTNAME:"C:\Users\Public\EPLAN\Projects\eplan-demo-schneider.elk" 
/LANGUAGE:de_DE 
/CONVERTERID:PlcDcXMLExchangerSchneider 
/OVERWRITE:1

Import PLC data: 

plcservice 
/TYPE:BUSDATAIMPORT 
/SOURCEFILE:"C:\tempdir\plcservice_export_2.xml" 
/PROJECTNAME:"C:\Users\Public\EPLAN\Projects\eplan-demo-schneider.elk" 
/LANGUAGE:de_DE 
/CONVERTERID:XPlcXMLExchanger

Generate schematic:

plcservice 
/TYPE:GENERATEPLCSCHEMATIC 
/PROJECTNAME:"C:\Users\Public\EPLAN\Projects\eplan-demo-schneider.elk" 
/CONFIGFILE:"C:\tempdir\schematics_generation_config.xml" 
/SINGLELINEPAGES:1 
/MULTILINEPAGES:1