T_ALY_SPRecordData_Cmd

Syntax

Definition:

FUNCTION_BLOCK T_ALY_SPRecordData_Cmd EXTENDS T_ALY_JsonPayload
VAR_INPUT
    sRecordDataKey : GUID;
    sStorage : GUID;
    sSubBroker : GUID;
    sPipeline : GUID;
    sAlias : T_MaxString;
    sRecordName : T_MaxString;
    eRecording : E_RecordMode;
    sRecorder : GUID;
    sRecorderAlias : T_MaxString;
    sTopic : T_MaxString;
    eDataFormat : E_RawDataFormat;
    eDurationTimeMode : E_TimeMode := E_TimeMode.Minutes;
    nDuration : DINT;
    eRingBufferMode : E_RingBufferMode;
    nRingBufferParameter : DINT;
    eMode : E_SymbolMode;
    sSymbolLayout : GUID;
    arrSymbols : ARRAY [0..255] OF T_ALY_Symbol;
END_VAR

Inheritence hierarchy

T_ALY_JsonPayload

T_ALY_SPRecordData_Cmd

Inputs

Name	Type	Description
sRecordDataKey	GUID	Individual GUID to identify the recording
sStorage	GUID	Individual GUID of the Storage to be used
sSubBroker	GUID	Individual GUID of the message broker to be used
sPipeline	GUID	Optional – GUID of the RuleEngine pipeline
sAlias	T_MaxString	Alias name for the recording.
sRecordName	T_MaxString	Name for this record.
eRecording	E_RecordMode	Start or Stop the recording.
sRecorder	GUID	Individual GUID of the recorder.
sRecorderAlias	T_MaxString	Alias name for the recorder.
sTopic	T_MaxString	Topic name of the live stream.
eDataFormat	E_RawDataFormat	Saving the data format (currently only binary format is supported).
eDurationTimeMode	E_TimeMode	Resolution of the nDuration parameter
nDuration	DINT	Duration of the recording in minutes. (-1 unlimited)
eRingBufferMode	E_RingBufferMode	Ring buffer mode
nRingBufferParameter	DINT	TimeBased => parameter in minutes. DataBased => parameter in megabytes.
eMode	E_SymbolMode	Record all symbols or only a subset.
sSymbolLayout	GUID
arrSymbols	ARRAY [0..255] OF T_ALY_Symbol	If SymbolMode is Subset, only the list of this symbols will be recorded.

Methods

Name	Definition location	Description
Reset		Reset all values in the payload FB.
Init_JsonValue	Inherited from T_ALY_JsonPayload	Initialization of the FB with JSON object.

Development Environment	Target platform	PLC libraries to include
TwinCAT v3.1.4022.25	PC or CX (x64, x86, Arm®)	Tc3_AnalyticsStorageProvider