Connector Parameters

<< Click to Display Table of Contents >>

Raynet One Data Hub > 2025.4 > Connectors > Alphabetic Connector List > Citrix Session Monitoring 

Connector Parameters

The Citrix Session Monitoring connector provides several configuration parameters to control data collection behavior and performance.

 

Data Collection Parameters

 

FETCH SESSIONS INFORMATION

Controls whether to collect VDI session data.

 

Parameter: fetchSessions

Type: Boolean

Default: true

Description: When enabled, the connector collects session information including connection details, user information, machine specifications, hypervisor details, and cloud resource information. This data is stored in the historical_sessions table.

 

FETCH APPLICATIONINSTANCES INFORMATION

Controls whether to collect XenApp application usage data.

 

Parameter: fetchApplicationInstances

Type: Boolean

Default: true

Description: When enabled, the connector collects application instance information including application names, published names, user sessions, and usage timestamps. This data is stored in the historical_application_sessions table.

 

DATA FOR SPECIFIC PERIOD

Defines the historical timeframe for data collection.

 

Parameter: fetchStartDatePeriod

Type: Integer

Default: 7 days

Range: 1-180 days

Description: Specifies the number of days (counting back from the current date) for which historical data should be retrieved. The Citrix Monitor Service retains data for up to 180 days.

 

papercliper

Performance Consideration:

Enabling both fetchSessions and fetchApplicationInstances with a large fetchStartDatePeriod value can significantly increase data extraction time. For large environments, consider:

Reducing the fetchStartDatePeriod to collect smaller time windows.

Disabling one of the data collection options if not needed.

Increasing the request_timeout value if timeout errors occur.

 

Example Configuration Scenarios

 

Scenario 1: VDI Inventory Only

Collect only VDI session information for the last 30 days:

 

fetchSessions: true

fetchApplicationInstances: false

fetchStartDatePeriod: 30

 

Scenario 2: Application Usage Only

Collect only XenApp application usage for the last 14 days:

 

fetchSessions: false

fetchApplicationInstances: true

fetchStartDatePeriod: 14

 

Scenario 3: Complete Data Collection

Collect all available data types for the last 7 days (default configuration):

 

fetchSessions: true

fetchApplicationInstances: true

fetchStartDatePeriod: 7