Bausteine exportieren

Bausteine exportieren - TIAPortal

TIA Portal Openness: API für die Automatisierung von Engineering-Workflows

ft:publication_title

TIA Portal Openness: API für die Automatisierung von Engineering-Workflows

Product

TIAPortal

Version

V20

Publication date

01/2025

Language

de-DE

Bausteine exportieren

Voraussetzung

Die TIA Portal Openness-Anwendung ist mit dem TIA Portal verbunden.

Siehe Verbindung zum TIA Portal aufbauen
Ein Projekt ist geöffnet.

Siehe Projekt öffnen
Die PLC ist nicht online.

Einleitung

Die API-Schnittstelle unterstützt das Exportieren konsistenter Bausteine und Anwenderdatentypen in eine XML-Datei.

Die XML-Datei erhält den Namen des Bausteins. Die folgenden Bausteintypen werden unterstützt:

Funktionsbausteine (FB)
Funktionen (FC)
Organisationsbausteine (OB)
Globale Datenbausteine (DB)

Die folgenden Programmiersprachen werden unterstützt:

AWL
FUP
KOP
GRAPH
SCL

Für alle Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions in alle Bausteine exportiert (siehe Export von Projektierungsdaten). In Fettdruck dargestellten Attribute werden immer exportiert.

Weitere Informationen finden Sie im Informationssystem des TIA Portals unter „Übersicht über die Bausteinattribute“.

Attribut	Typ	Standardwert	Schreibgeschützt
AutoNumber	Bool	true	false
CodeModifiedDate	DateTime	-	true
CompileDate	DateTime	-	true
CreationDate	DateTime	-	true
HeaderAuthor	String	""	false
HeaderFamily	String	""	false
HeaderName	String	""	false
HeaderVersion	String	„0,1“	false
Interface	String	leere Schnittstelle	false
InterfaceModifiedDate	DateTime	-	true
IsConsistent	Bool	-	true
IsKnowHowProtected¹	Bool	false	true
IsWriteProtected	Bool	false	true
MemoryLayout	enum MemoryLayout	-	false
ModifiedDate	DateTime	-	true
Name	String	-	false
Number	Int32	nächste verfügbare Nummer	false
ParameterModified	DateTime	-	true
PLCSimAdvancedSupport	Bool	false	true
ProgrammingLanguage	enum ProgrammingLanguage	-	false
StructureModified	DateTime	-	true
¹Das Attribut IsKnowHowProtectedgilt auch für UDT.

Hinweis

Es gibt bestimmte Bedingungen, unter denen das Attribut MemoryLayout schreibgeschützt ist.

Dynamisch zugängliche allgemeine Attribute

Die folgenden Attribute sind nur unter bestimmten Bedingungen schreibgeschützt:

Attribut	Zustand ReadOnly
AutoNumber	All KnowHowProtected blocks, All Classic OBs; Plus OBs: DiagnosticErrorInterrupt, IOAccessError, ProgrammingError, PullOrPlugOfModules, RackOrStationFailure, Status, TimeErrorInterrupt, Update
HeaderVersion	System- and KnowHowProtected DBs; ArrayDBs that originated from system library
HeaderName
HeaderFamily
HeaderAuthor
MemoryLayout	Classic blocks, System Know how protected blocks, ArrayDBs, IDBofFBs, Graph blocks

Für ArrayDB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für ArrayDB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
ArrayDataType	String	-	true
ArrayLimitUpperBound	Int32	-	true

Für DB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für DB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
IsOnlyStoredInLoadMemory	Bool	false	false
IsPLCDB	Bool	false	false
IsWriteProtectedInAS	Bool	false	false

Für FB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
AssignedProDiagFB	String	-	-
ISMultiInstanceCapable	Bool	-	true
Supervisions	String	no supervisions	true bei IDB of FB und false bei FB

Für DB- und FB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für DB- und FB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
IsIECCheckEnabled	Bool	false	false
IsRetainMemResEnabled¹	Bool	false	false
MemoryReserve	Unsigned	0	false
RetainMemoryReserve²	Unsigned	0	false
² Wenn der Wert des Attributs "IsRetainMemResEnabled" "false" ist und das Attribut "RetainMemoryReserve" ungleich "0" ist, wird eine Ausnahme ausgelöst.

Für FB-, DB- und IDB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB-, DB- und IDB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
DownloadWithoutReinit	Bool	false	true

Für FB- und FC-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB- und FC-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
LibraryType	String	-	true
LibraryTypeVersionGuid	String	-	true
¹LibraryTypeGuid	String	-	true

Hinweis

¹ In TIA Portal Openness V20 wurde LibraryTypeGuid als neues schreibgeschütztes Attribut in die Attributliste eines PLC-Bausteins / PLC-Datentyps in SimaticML aufgenommen

Sie können die oben genannten Attribute für CodeBlocks oder PlcTypes nicht exportieren, wenn diese Objekte keine Instanzen eines Bibliotheksbenutzertyps sind.

Sie können diese Attribute beim Import ignorieren. Der Importvorgang erzeugt einen nicht-typverknüpften CodeBlock oder PlcType, auch wenn diese Attribute in SimaticML vorhanden sind.

Für FB- und FC-Bausteine (AWL) geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB- und FC-Bausteine (AWL) exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
ParameterPassing	Bool	false	false

Für FB, FC und Instanz-DB von FB-Bausteinen geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB, FC und Instanz-DB von FB-Bausteinen exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
UDABlockProperties	String	""	false
UDAEnableTagReadback	Bool	false	false

Für Instanz-DBs von FBs und UDTs geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für Instanz-DBs von FB- und UDT-Bausteinen exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
InstanceOfName	String	""	false
InstanceOfNumber	Unsigned Short	-	true
InstanceOfType	enum BlockType	-	true
OfSystemLibElement	String	""	false
OfSystemLibVersion	String	""	false

Für OB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für OB-Bausteine für bestimmte Plus-PLCs exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
ApplicationCycle	Single	-	true
AutomaticMinimum	Bool	-	true
ConstantName	String	-	true
CycleTimeDistributedIO	Single	-	true
CyclicApplicationCycleTime	Single	-	true
CyclicTime	Int32	100000	true
DataExchangeMode	OBDataExchangeMode	Cyclic	true
DelayTime	Double	-	true
DistributedIOName	String	-	true
DistributedIONumber	Int32	-	true
EnableTimeError	Bool	-	true
EventClass	String	-	true
EventsToBeQueued	Int32	-	true
EventThresholdForTimeError	Int32	-	true
Execution	OBExecution	Never	true
Factor	Single	-	true
PhaseOffset	Int32	0	true
PriorityNumber	Int32	-	true
ProcessImagePartNumber	UInt32	-	true
ReportEvents	Bool	-	true
SecondaryType³	String	-	false
StartDate	DateTime	1/1/2012	true
SynchronousApplicationCycleTime	Single	-	true
TimeMode	OBTimeMode	System	true
TimeOfDay	DateTime	12:00 AM	true
TransformationDBNumber	UInt16	0xffff	true
³ Beim Exportieren eines OB wird anhand der OB-Nummer zusätzlich der "SecondaryType" festgelegt. Die Zuordnung wird während des Importvorgangs geprüft. Ist die Zuordnung falsch, wird eine Ausnahme vom Typ „Recoverable“ ausgelöst.

Für FB-, FC- und OB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB-, FC- und OB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
HandleErrorsWithinBlock	Bool	false	true

Für FB-, FC- und UDT-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für FB-, FC- und UDT-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
LibraryConformanceStatus	String	-	false

Für GRAPH-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für GRAPH-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
AcknowledgeErrorsRequired	Bool	true	false
CreateMinimizedDB	Bool	false	false
ExtensionBlockName	String	-	-
GraphVersion	String	-	false
InitialValuesAcquisition	String	-	-
LanguageInNetworks	String	-	false
LockOperatingMode	Bool	false	false
PermanentILProcessingInMANMode	Bool	false	false
SkipSteps	Bool	false	false

Für GRAPH FB-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für GRAPH FB-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
WithAlarmHandling	Bool	true	false

Für SCL-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für SCL-Bausteine exportiert. Diese Attribute werden basierend auf dem Typ der PLCs exportiert.

Attribut	Typ	Standardwert	Schreibgeschützt
CheckArrayLimits	Bool	false	false
ExtendedStatus	Bool	false	false
DBAccessibleFromOPCUA	Bool	true	false

Für GRAPH-, SCL- und KOP/FUP-Bausteine geltende Attribute

Die folgenden Attribute werden mit den ausgewählten ExportOptions. für GRAPH-, SCL- und KOP/FUP-Bausteine exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
SetENOAutomatically	Bool	-	false

Für Programmbausteine (außer OB), DB und UDT-Bausteine geltende Attribute

Die folgenden Attribute werden für Programmbausteine (außer OB), DB und UDT-Bausteine unter einer Unit mit den ausgewählten ExportOptions exportiert:

Attribut	Typ	Standardwert	Schreibgeschützt
Access	UnitAccessType	Unpublished	false

Importverhalten für das Attribut 'Access'

	Import unter Unit	Import nicht unter Unit (ohne SWImportOptions.IgnoreUnitAttributes)	Import nicht unter Unit (mit SWImportOptions.IgnoreUnitAttributes)
XML-Export unter Unit	'Access' verwendet und festgelegt	RecoverableException ausgelöst	'Access' ignoriert
XML-Export nicht unter Unit	'Access' erhält Standardwert	'Access' ist nicht vorhanden	'Access' ist nicht vorhanden

Programmcode

Um einen Baustein ohne Knowhow-Schutz in eine XML-Datei zu exportieren, ändern Sie folgenden Programmcode:


//Exports a regular block private static void ExportRegularBlock(PlcSoftware plcSoftware) { PlcBlock plcBlock = plcSoftware.BlockGroup.Blocks.Find("MyBlock"); plcBlock.Export(new FileInfo(string.Format(@”D:\Samples\{ 0 }.xml”, plcBlock.Name)), ExportOptions.WithDefaults); }

//Exports a regular block

private static void ExportRegularBlock(PlcSoftware plcSoftware)

{

PlcBlock plcBlock = plcSoftware.BlockGroup.Blocks.Find("MyBlock");

plcBlock.Export(new FileInfo(string.Format(@”D:\Samples\{ 0 }.xml”, plcBlock.Name)), ExportOptions.WithDefaults);

}