T_ALY_SPCleanup_Desc

Syntax

Definition:

FUNCTION_BLOCK T_ALY_SPCleanup_Desc EXTENDS T_ALY_JsonPayload
VAR_OUTPUT
    sCleanupKey : GUID;
    eMode : E_CleanupMode;
    nModeParameter : LINT;
    nCheckInterval : DINT;
    arrRetainRecords : ARRAY [0..cMaxCleanupRetainRecords] OF LINT;
    bAutoStart: BOOL;
    eScope : E_CleanupScope;
    nTargetID : LINT;
    eReferenceTime : E_CleanupReferenceTime;
    nLifetime : LINT;
    eStatus : E_CleanupInstanceStatus;
    sStatusMessage : T_MaxString;
    bHasTarget : BOOL;
    sAlias : T_MaxString;
END_VAR

Inheritance hierarchy

T_ALY_JsonPayload

T_ALY_SPCleanup_Desc

Outputs

Name	Type	Description
sCleanupKey	GUID	GUID “Key” for identifying the Cleanup Service
eMode	E_CleanupMode	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 is restarted automatically.
eScope	E_CleanupScope	Record or Recording
nTargetID	LINT	RecordID or RecordingID
eReferenceTime	E_CleanupReferenceTime	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.
eStatus	E_CleanupInstanceStatus	Cleanup service status
sStatusMessage	T_MaxString	Cleanup service status message
bHasTarget	BOOL	Indicates whether a target is linked.
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