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

Action: plcservice


Parameters

Description

TYPE

Type of task that the action is to perform:
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 PLC configuration programs. Possible values are:

  • PlcDcExchangerBeckhoffTC3AML: Beckhoff TwinCAT 3
  • PlcDcExchangerBoschAML: Bosch Nexeed Automation
  • PlcDcExchangerLogiCals3AML: logi.cals logi.CAD 3
  • PlcDcExchangerMitsubishiAML: Mitsubishi iQ Works
  • PlcDcExchangerPhoenixContactAML: Phoenix Contact PLCnext Engineer 2019
  • PlcDcExchangerRockwellArchitectAML: Rockwell Automation Studio 5000
  • PlcDcExchangerSiemensTIAAML: Siemens SIMATIC STEP 7 TIA-Portal 14SP1
  • PlcDcExchangerSiemensTIA15AML: Siemens SIMATIC STEP 7 TIA-Portal 15
  • PlcDcExchangerSiemensTIA151AML: Siemens SIMATIC STEP 7 TIA Portal 15.1
  • PlcDcExchangerSiemensTIA16AML: Siemens SIMATIC STEP 7 TIA Portal 16
  • PlcDcExchangerSiemensTSTAML: Siemens TIA Selection Tool
  • PlcDcAMLExchangerGeneral: PLC standard exchange format (AutomationML)
  • PlcDcXMLExchangerABB: ABB Automation Builder
  • PlcDcXMLExchangerBandR: B and R Automation Studio
  • PlcDcXMLExchangerBeckhoff: Beckhoff TwinCAT 2.10/2.11
  • PlcDcXMLExchangerLogiCals: logi.cals logi.CAD
  • PlcDcXMLExchangerMitsubishi: Mitsubishi GX-Works2
  • PlcDcXMLExchangerRexroth: Bosch Rexroth Indra Works
  • PlcDcXMLExchangerSchneider: Schneider Unity Pro XL
  • PlcDcXMLExchangerSiemens: Siemens SIMATIC STEP 7 5.6
  • PlcDcXMLExchangerUniversal: PLC standard exchange format
  • XMLRockwellExchanger: Rockwell Studio 5000 Architect 20/21.

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 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 indicates whether the file should 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

Alignment options during PLC data import. The import process tries to synchronize the imported objects with those that exist in the project. Depending on the selected option, the adaption is performed on the basis of the internal object IDs or identifying object names. If an imported object matches an existing function, the properties of the existing function are updated while new functions in the project are generated for non-adjustable objects. The options are:

  • 0: Synchronization on the basis of internal object IDs.
  • 1: Synchronization on the basis of identifying names. Note that in this case a comparison dialog can be opened in which you must individually 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

Shows 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 for configuration file for the generation of 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-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\ESS_Sample_Project.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\ESS_Sample_Project.elk" 
/LANGUAGE:de_DE 
/CONVERTERID:PlcDcXMLExchangerUniversal

Generate schematic:

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