Method AutomaticTagGenerationAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

AutomaticTagGenerationAsync(string, string, CancellationToken)

Initiates the Automatic Tag Generation service for a specified channel and device.

public Task<KepServerJobPromise> AutomaticTagGenerationAsync(string channelName, string deviceName, CancellationToken cancellationToken = default)

Parameters

channelName string

The name of the channel.

deviceName string

The name of the device.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<KepServerJobPromise>

A task that represents the asynchronous operation. The task result contains a KepServerJobPromise.

Remarks

Jobs are automatically cleaned up after their wait time has expired. This wait time is configurable.

Note: Not all drivers support Automatic Tag Generation. Tip for TKE: If using file sources for Automatic Tag Generation files must be located in the <installation_directory>/user_data directory. All files in the user_data directory must be world readable or owned by the TKE user and group that were created during installation, by default this is tkedge.

AutomaticTagGenerationAsync(string, string, TimeSpan, CancellationToken)

Initiates the Automatic Tag Generation service for a specified channel and device.

public Task<KepServerJobPromise> AutomaticTagGenerationAsync(string channelName, string deviceName, TimeSpan timeToLive, CancellationToken cancellationToken = default)

Parameters

channelName string

The name of the channel.

deviceName string

The name of the device.

timeToLive TimeSpan

The job's desired Time to Live (timeout).

cancellationToken CancellationToken

The cancellation token.

Returns

Task<KepServerJobPromise>

A task that represents the asynchronous operation. The task result contains a KepServerJobPromise.

Remarks

Jobs are automatically cleaned up after their wait time has expired. This wait time is configurable.

Note: Not all drivers support Automatic Tag Generation. Tip for TKE: If using file sources for Automatic Tag Generation files must be located in the <installation_directory>/user_data directory. All files in the user_data directory must be world readable or owned by the TKE user and group that were created during installation, by default this is tkedge.