Citrix Context properties

After adding a Citrix Context and adding the required application adapters to the context, set the Citrix Context properties which define the Citrix servers and connection properties. See the following table for definitions of the Citrix Context properties.

Parameter

Description

Debug

Debug Runtime

When set to True, a dialog that contains the command log parameters that were passed in is displayed at start up. Initialization process problems can be detected using this setting.

Run Local

If set to True, this lets you run the solution through Studio on the local machine to test functionality. Set this parameter to False when you are ready to deploy the solution.

ICA File

 

Project To Load

Deployed project name associated with this solution. The name must include the full path for the project name as it exists on the server. If this property is left blank, Studio uses the path to the deployment package for the client workstation.

Published Application Name

The name of the Citrix Published Application which runs the OpenSpan Runtime application running on the Citrix server. The entry is not case sensitive.

Temporary Folder

This setting only applies if the Studio user does not have permission to write to the default temporary folder (defined in the TEMP environmental variable). In this case, select a location on the client workstation where a temporary copy of the ICA file can be written during the Runtime session. (OpenSpanTempICACopy.ica )

To see the value of the TEMP environment variable, start a command window (Start > Run > cmd.exe), and enter set temp. The result will be the value of the TEMP variable. Typically, it is set to:

C:\Users\<logged in user name>\Local Settings\Temp 

Note:  The path may appear in 8.3 notation, such as C:\DOCUME~1\<user>\LOCALS~1\Temp.

Login

Domain

Domain used when logging into the Citrix server.

Login

Login used when logging into the Citrix server. This property is not typically set for a production project. It is mainly useful for testing where the tester has an alternate set of credentials that do not need to be re-entered every time the project is run. If this property contains a value, then pass-through authentication is disabled, and the specified credentials are passed to Citrix on the command line.

Password

Password associated with the Citrix login. This property is not typically set for a production project. It is mainly useful for testing, where the tester has an alternate set of credentials that don’t need to be re-entered every time the project is run.  The password is encrypted when serialized. If this property contains a value, then pass-through authentication is disabled, and the specified credentials are passed to Citrix on the command line.

Show Password Dialog

If set to True, a login window is created for the user to login to the Citrix Server. If set to False, the user is automatically logged in to the server when the solution is run on the client. The login dialog should only be enabled if users log into Citrix using credentials other than their NT login credentials. If this property contains a value, then pass-through authentication is disabled, and the specified credentials are passed to Citrix on the command line.

Misc

Dialog Dismissal List

Enter a comma-separated list that contains the specifications of the dialogs that you want to search for. Include the coordinates on those windows that identify the buttons that must be clicked to dismiss the dialogs.

Dismiss Dialogs

If you set this property to True, the adapter searches for and dismisses dialogs that match the specifications you defined in the Dialog Dismissal List property. If you enter False, dialogs are not dismissed.

Folder Name

The design name of the context.

Path

The full path for the Citrix Context file location.

Startup

Client Location

Set this property to the folder where the Citrix client is installed on the desktop computers. The default installation location is:

C:\Program Files\Citrix\ICA Client

If you leave this property blank, then the default location for the product ICA Client as specified in the Windows registry will be used. Typically, you will leave this property blank.

Refer to the key ‘HKLM\Software\Citrix’ in the Registry for the installed Citrix client products. The folder must contain wfcrun32.exe file.

Timeouts

Ping Interval

A keep-alive indication in milliseconds. Every 30,000 milliseconds (30 seconds), a message is sent to the client to determine if it is active.  If no response is received, the Runtime application on the server will shutdown. The default is 30,000 milliseconds.

Startup Timeout

Number of milliseconds to wait for the Studio virtual channel to be loaded after the Citrix client is started.

XenApp 6x and older

Connection Server Address

Use this property when the Citrix client workstations connect directly to a single Citrix server. In this case, enter the IP address of the Citrix server in this property. This address overrides any other address settings, and disables browsing. Typically, this will be left blank for production projects.

Note: When an IP address is entered in this field, the ICA browsing capability is disabled. The Address key in the .ICA file [<named application server>] section is set to this value instead of the published application name.

Http Browser Address Mode

This property applies when a list of HttpBrowserAddresses has been specified. Use this property to specify the method by which HTTP browse addresses should be updated in the .ICA file. See the description of the HttpBrowserAddress property for more information.

Note:  If HttpBrowserAddresses is blank, or if no template ICA file is specified, the mode is ignored.

Http Browser Addresses

Use this property when the Citrix client workstations should search for the ICA Master Browser using HTTP. In this case, enter a comma-delimited list of host names or IP addresses that should be consulted first when looking for the ICA Master Browser. Browsing takes place on port 80 over HTTP when using these addresses.

This property corresponds to the HttpBrowserAddress[n] keys in the .ICA file.

Note: How the .ICA file is updated by this property depends on the HttpBrowserAddressMode property as follows.

Mode – Replace:  The first address in the list will be assigned to the “HttpBrowserAddress” and the second address will be assigned to “HttpBrowserAddress2”, and so on.

Mode – InsertBeforeExisting or AppendAfterExisting: The existing addresses will remain and the new addresses will be inserted/appended as indicated.

TCP Browser Address Mode

This property applies when a list of TCP Browser Addresses has been specified. Use this field to specify the method by which TCP browser addresses should be updated in the .ICA file. See the description of the TCP Browser Addresses property for more information.

Note:  If TCP Browser Addresses is blank, or if no template ICA file is specified, the mode is ignored.

TCP Browser Addresses

Use this property when the Citrix client workstations should search for the ICA Master Browser using TCP/UDP. In this case, enter a comma-delimited list of host names or IP addresses that should be consulted first when looking for the ICA master browser. Browsing takes place over port 1694 via UDP when using these addresses.

This property corresponds to the TCP Browser Address[n] keys in the .ICA file.

Note: How the .ICA file is updated by this property depends on the TCP Browser Address Mode property as follows.

Mode – Replace:  The first address in the list will be assigned to the “TCP Browser Address” and the second address will be assigned to “TCPBrowserAddress2”, and so on.

Mode – InsertBeforeExisting or AppendAfterExisting: The existing addresses will remain and the new addresses will be inserted/appended as indicated.

Template File Name

 

This property applies to client workstations using template ICA files. In this case, enter the fully qualified name of the template file. The template ICA file is used to create a temporary ICA file. The temporary ICA file is the file actually used when launching the Citrix session. If this property is left blank, then the temporary ICA file will be constructed using only the properties specified on the Citrix context. All sections and key/value pairs are copied as-is from the template ICA file except for the following:

TcpBrowserAddress/HttpBrowserAddress (in section WFClient):  These are replaced/appended to as described above.

InitialProgram (in the named application server section):  This is replaced with the value of the property “PublishedApplicationName” (see above).

Address (in the named application server section):  This is replaced with the value of the property “DirectConnectAddress”, if this property contains a value, or the value of the property “PublishedApplicationName”, if DirectConnectAddress is blank.

LongCommandLine (in the named application server section):  This is replaced/created with a command line constructed from various properties.

UseLocalUserAndPassword (in the named application server section):  This is set to one (1) if the Login properties are disabled, or zero (0) if not.

XenApp 7x

Storefront Web Url

If you set the Use Storefront Web property to True, the context uses the specified Citrix storefront website to get an ICA file that can be used to launch the specified, published application. The following is an example of the URL format:

 https://storefrontServer/Citrix/StoreWeb

Use Passthrough Authentication

Determines how the Citrix Context authenticates with the Citrix storefront website.  If you set this property to True, the logged-in user’s Windows identity is passed through to the site.  If you set this property to False, the user must provide explicit credentials either using the  Citrix Context properties or by using the  Citrix Context login dialog.

Use Storefront Web

Enter True if you want the Citrix Context to get an ICA file from the specified Citrix storefront website. If you set this property to True, you must enter a URL in the Storefront Web Url property. The default is False.

XenApp WebInterface/NetScaler

Custom JavaScript Content

Use this property to enter a custom JavaScript that the system will execute on the Web Interface landing page.

External Properties File Path

Enter the path to the file that contains properties that can be used instead of retrieving values from the Citrix Context. Use the WebInterfacePropertyManager utility to create this file. For more information, see WebInterface Property Manager utility.

Note: The file that the WebInterfacePropertyManager utility creates is encrypted.

Run Custom JavaScript

Enter True to run the custom JavaScript to login to a WebInterface. The default is False.

Show Navigation UI

If you entered True for the Use Web Interface property, this setting indicates whether the navigation utility’s user interface should appear when running. The default is False. You would only set this to True for diagnostic purposes, not in production.

URL Is NetScaler

If you entered True for the Use Web Interface property, this setting indicates whether the initial URL that is navigated is a NetScaler web front end. The default is False.

Use External Property File

Enter True if you want the client to get its properties from an external file. Enter False if you want the client to get its properties from  the Citrix Context. The default is False.

Use Web Interface

Set this property to True to tell the Citrix Context to get an ICA file from the specified Citrix Web Interface website. If you set this property to True, you must also enter a value in the Web Interface URL property.

Web Interface URL

If you entered True for the Use Web Interface property, the Citric Context uses the Citrix Web Interface website that you specified to get an ICA file. It then uses this ICA file  to launch the published application that you specified. The following is an example of the URL format:

https://citrixWIServer/Citrix/Xenapp/

If you set the URL Is NetScaler property to True, this URL must point to a NetScaler web front end.

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 04 October 2021

© 2016 - 2021 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label