Configuration Item Details

The following tables contain a description of each Configuration Item Detail.

At any time, select Revert to installation settings to restore the default values.

Client Transfer Group Configuration Item Details

Item

Description

TransferInterval

Indicates the time interval (in minutes) that DPA waits before sending data from the client to the server. The default is 1 minute.

TriggerUpdateInterval*

Indicates the time interval (in minutes) that DPA waits before checking with the Trigger server to determine whether a new trigger version is available.

* No longer used. Available for backward compatibility only.

ConfigUpdateInterval*

Indicates the time interval in minutes that DPA waits before checking with the Configuration server and the Trigger server to determine whether a new configuration or trigger version is available. The default is 2 minutes.

* To reduce client calls to the server, the ConfigUpdateInterval setting now provides functionality for both TriggerUpdateInterval and ConfigUpdateInterval.

AdherenceTransferInterval

Indicates the time interval (in minutes) that the DPA client waits before sending Adherence aggregated data to the DPA Application server.

TraceFileTransferInterval

Indicates the time interval (in minutes) that the DPA client waits before sending trace data from the client to the server. The default is 5 minutes.

Client Group Configuration Item Details

Item

Description

ExcludeRemoteIdle

Used to control whether a monitored RDP Session or a Citrix Session will report Idle time.

IdleInterval

Indicates the time interval (in seconds) that DPA waits to classify all subsequent use as idle. That is, if no click or keypress has been detected.

InactiveInterval

Indicates the time in seconds DPA waits before classifying all detected Idle time as Inactive time.

Snap Interval

Indicates the time interval (in seconds), that DPA waits before reviewing the current window for DPA data.

It is recommended that the value be 0.1 unless instructed otherwise.

Module Group Configuration Item Details

Item

Description

DisableMonitor

Used to control whether to turn on or off all DPA Client functionality (for example, Y = Disabled).

UseApi

Enables third party API calls.

UseLogData

Records application usage data.

UseMDI

When set to Y, all MDI applications will report the smallest child window title, rather than the parent MDI window title.

Use Processes

Detects steps and processes.

UseTriggers

Detects and fires triggers.

ClientAdherence

Controls whether Real Time Adherence is sent from the client.

Recorder Group Configuration Item Details

Item

Description

UseV11Recorder

Used to control whether or not to use V11 IS Recorder integration.

System Group Configuration Item Details

Configuration Profile Name

Description

CitrixMinWinCount

Indicates the number of windows detected that are running the Citrix Published application, before the DPA client assumes that the published application is no longer required for monitoring.

MaximumWinTextMatch

Used to control whether or not to always match the window title. This is based on the largest or smallest matching string from Trigger definitions.

TriggerCtrlPrefix

A prefix used to add to triggers when the standard control prefix is no available.

UniqueCitrixSessionNames

Used to control whether every Citrix session creates a new machine name within the DPA database.

It is not recommended to create a new machine within the DPA database.

WorkstationLockedAlert

Used to control whether to record a workstation locked event as a duration or as an alert.

UseVirtualChannelCitrix

Used to activate the remote DPA client channel in a Citrix environment.

UseVirtualChannelRDT

Used to activate the remote DPA client channel on remote desktop sessions.

ReportRemoteComputerName

Used to display remote computer names in DPA reports.

UseUserFQDN

Used to set the logged in user name as the long/FQDN or short windows user name

N = use the short windows user name (default)

Y = use the long FQDN windows user name

IMPORTANT

Modify at install time only. Changing this option during logging periods is not supported and may result in duplicate or lost data.

Tracing Group Configuration Item Details

The level of tracing can range from 1 (Summary) to 5 (Full Tracing), unless otherwise specified.

Item

Description

TracefileMaxNum

Indicates the Maximum number of trace files to store locally before transferring. The default is 25 files.

TracingTimeout

Indicates tracing activation time. Used to limit trace logs collected for specific users or machines assigned to the tracing profile. Not supported for custom profiles.

  • Default: 60 minutes.

  • Maximum: 720 minutes (12 hours)

  • For unlimited DPA client tracing, enter a value of 0 minutes. Use unlimited tracing only in coordination with Technical Support.

See Modify Trace Expiry Time

TracefileMaxSize

Indicates the Maximum size a Trace file can be when stored locally before transferring.

TraceCtrlTrg

Indicates the level of Trigger tracing.

TraceHKProc

Indicates the level of Button Click tracing.

TraceSAPHooks

Indicates the level of SAP Application tracing.

TraceIEBho

Applies to Citrix or Terminal Services 64-bit environments only. Set to Y to enable tracing specific to IEBHO.

Also, see Citrix 64-bit environment limitations.

TraceChromeBho

Set to Y to enable tracing specific to the Chrome plugin.

Set to N to disable tracing specific to the Chrome plugin.

TraceFirefoxBho

Set to Y to enable tracing specific to the Firefox plugin.

Set to N to disable tracing specific to the Firefox plugin.

TraceDCUApp

Indicates the level of general DCUApp tracing.

TraceProcMon

Indicates the level of Process/Step tracing.

TraceDataTransferService

Set to Y to trace the Data Transfer Service

TracePopData

Indicates the level of Guidance and Automation tracing.

TracePythonExec

Indicates the level of Next Best Action python script tracing

TriggerDebug

Controls whether or not to activate Real Time Trigger Debugging.

TriggerHighlight

Used to control whether or not to activate Real Time trigger highlighting for all triggers.

TraceISRecording

Indicates the level of tracing in IS Recorder calls.

Tray Group Configuration Item Details

Item

Description

UseTray

Used to control whether or not the Tray icon is visible.

UseTrayClose

Used to control whether or not the Close option is visible in the Tray icon.

UseTrayComment

Used to control whether or not the Add Comment option is visible in the Tray icon.

UseTrayStartStop

Used to control whether or not start/stop logging is visible in the Tray icon.

UseTrayViewLog

Used to control whether or not the View Log option is visible in the Tray icon.

V11 Group Configuration Item Details

Item

Description

UseDevice

Enables sending the device parameter to the recorder, and by default sends the Machine Hostname as the device to the recorder.

If this is set to N, only the Agent Username is sent to the recorder.

UseAgentWithDevice

Enables sending the Agent Username and the device name to the recorder.

This setting will only be used if UseDevice is set to Y. If UseAgentWithDevice is set to N, only the device will be sent to the recorder.

UseSessionID

Used with Terminal Services to send Session ID (segments) with the device to the recorder.

This setting will only be used if UseDevice is set to Y.

UseIPasDevice

Sends the Machine IP Address as the device to the recorder instead of the default setting.

This setting requires UseDevice to be set to Y, and UseFQDNAsDevice to be set to N.

UseFQDNAsDevice

Sends the fully qualified domain name as the device to the recorder instead of the default setting.

This setting requires UseDevice to be Set to Y.

UseHttps

Enables https TLS communication for all V11 ISRecorder communications from client to IS recorder.

ISDataSource

A data source for the API Adapter.

Note: This item is typically left empty and should only be used to override the default IS adaptor in advised cases.

QueryVideoStatus

Checks the video recording status after the call to the recorder is made.

If QueryVideoStatus is set to Y then DPA will check to verify if the DPA Recorder command succeeded. If the command did not succeed, DPA will retry the call. The number of times it will attempt the call is set by the RetryOnVideoFail option.

Note: There is no QueryAudioStatus control. Audio status is always checked. In cases where video is not being recorded at a site, the option must be set to N.

RetryOnAudioFail

Indicates the number of times Retry should be activated after the Audio recorder fails.

RetryOnVideoFail

Indicates the number of times Retry should be activated after the Video recorder fails.

ISDataSource

A data source for the API Adapter.

Note: This item is typically left empty and should only be used to override the default IS adaptor in advised cases.

SendUserDomain

Y sends the Agent.Agent parameter to the IS eQuality adaptor in the format of Domain\username.

Default = N

UseFQDNAsUser

Y sends the Agent.Agent parameter to IS eQuality adaptor in the format of user@fqdn.com.

Default = N

ResponseTypeXml

Y returns the response in xml format .

N returns the response in html format (which allows error codes to be read).

Default = Y

RestartSession

Y sends a parameter to the IS eQuality adaptor to force the current session to re-start.

Default = N