T_ALY_SPCleanupCtrl_Cmd
Syntax
Definition:
FUNCTION_BLOCK T_ALY_SPCleanupCtrl_Cmd EXTENDS T_ALY_JsonPayload
VAR_OUTPUT
eAction : E_CleanupControlAction := E_CleanupControlAction.Start;
sStorage : GUID;
sRecordDataGuid : GUID;
sCleanupKey : GUID;
eMode : E_CleanupMode := E_CleanupMode.TimeBased;
nModeParameter : LINT;
nCheckInterval : DINT;
arrRetainRecords : ARRAY [0..cMaxCleanupRetainRecords] OF LINT;
bAutoStart: BOOL;
eScope : E_CleanupScope := E_CleanupScope.Record;
nTargetID : LINT;
eReferenceTime : E_CleanupReferenceTime := E_CleanupReferenceTime.DataTime;
nLifetime : LINT;
sAlias : T_MaxString;
END_VARInheritance hierarchy
T_ALY_JsonPayload
T_ALY_SPCleanup_Desc
Outputs
Name | Type | Description |
|---|---|---|
eAction | Action to be performed | |
sStorage | GUID | Individual GUID of the Storage to be used |
sRecordDataGuid | GUID | Unique GUID of the Live Recording to be used |
sCleanupKey | GUID | GUID “Key” used to identify the service. |
eMode | Cleanup mode | |
nModeParameter | LINT | Mode-specific parameter |
nCheckInterval | DINT | Interval execution time of the cleanup service |
arrRetainRecords | ARRAY [0..cMaxCleanupRetainRecords] OF LINT | List of records that should not be deleted. |
bAutoStart | BOOL | Specifies whether the Cleanup Service should start automatically. |
eScope | “Service” refers to a single recording or an entire recording configuration | |
nTargetID | LINT | RecordID or RecordingID |
eReferenceTime | Reference time. System time or data timestamp | |
nLifetime | LINT | Execution time in minutes. If the value is greater than 0, the cleanup is automatically stopped after this time. |
sAlias | T_MaxString | Alias name for the Cleanup Service |
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 |