Introduction

The Citrix Access Gateway Enterprise Endpoint Analysis Software Development Kit (Endpoint Analysis SDK) is an add-in for Microsoft Visual Studio .NET 2003 that provides instructions for developing and testing C++ and VBScript endpoint analysis scan packages.

Download Citrix Endpoint Analysis SDK Version 4.5.1

What is included in this SDK?

The Endpoint Analysis SDK for Microsoft Visual Studio .NET is comprised of the following components:

• Endpoint Analysis SDK, an add-in for Microsoft Visual Studio .NET 2003 that you use to write and modify .NET and script endpoint analysis scan packages.
• Endpoint Analysis SDK Online Help, which contains online instructions for using the Endpoint Analysis SDK.
• API Quick Reference, which contains information about objects and interfaces associated with this SDK.
• A set of sample scan packages that illustrate how the SDK might be used to create packages that check for certain client features. These can be found in the Samples folder of your install directory.

Who should use this SDK?

The Endpoint Analysis SDK is for developers who want to create scan packages that perform a flexible range of security, identity, and device integrity checks on client devices before granting them access to an Access Gateway Enterprise server. The documentation included in this release assumes developers are familiar with using the previous version of the Endpoint Analysis SDK and with Microsoft Visual Studio .NET. Developers who are new to creating scan packages are encouraged to use the sample packages included with Access Gateway Enterprise without modification or evaluate other content delivery mechanisms.

Getting support

Citrix provides technical support primarily through Citrix Solutions Advisors. Contact your supplier for first-line support or use Citrix Online Technical Support to find the nearest Citrix Solutions Advisor.
Citrix offers online technical support services on the Citrix Support Web site . The Support page includes links to the Citrix Knowledge Center, Citrix Consulting Services, and other useful support pages.

Requirements

To run the Citrix Endpoint Analysis SDK for Microsoft Visual Studio .NET, you must have Microsoft Visual Studio .NET 2003 installed. This version of the Endpoint Analysis SDK may not function correctly with previous versions of Microsoft Visual Studio.

Installing the Endpoint Analysis SDK

To install the Endpoint Analysis SDK, run the EndpointAnalysisSDK.msi file available from this page or located in the \Setup\EPASDK folder on the Access Gateway Enterprise CD-ROM.

Important: Citrix strongly recommends that you maintain a separate development environment to create, edit, debug, and test any endpoint analysis packages. Move the package solution to the production environment only when you are sure they are ready for deployment.

To uninstall the Endpoint Analysis SDK, use Add/Remove Programs in Control Panel. To ensure all components have been removed, restart the computer.

Known issues and limitations in this release

This section describes the issues and limitations affecting Endpoint Analysis development.

Replacing VBScript files does not update package manifest
Visual Studio does not notify the Endpoint Analysis SDK of the event when an existing VBScript file is added to the project. This means the package manifest does not get updated with the new information.
The correct way to add an existing script file is:

1. Create a new script file in the Scripts folder using the Add New Item dialog.
2. Replace this file in the file system with your existing script file.
3. Update the entry points for this code using the Package Properties dialog.

[#116967]

Listing MAC Address Groups
Currently, administrators must manually enter the target group name for the Citrix Scans for MAC Address endpoint analysis package. This can entail memorizing a large number of groups.
You can avoid this problem by developing programs that display group names as a list.
If the group list is too long for a drop-down menu, Citrix recommends that you create an application that provides a display of possible groups and conveys the user's selection to the CtxEpaParamUpdate tool to display the group list.
If the group list is small enough for a drop-down menu, Citrix recommends that you customize the endpoint analysis package by adding the group names.
To enter the group names as parameter values for a menu:

1. Extract the contents of the CitrixMACEnumeration.cab file.
2. Locate file package.xml and make a backup copy.
3. Open file package.xml in a text or XML editor. Replace the <values/> entry by inserting an explicit set of values as shown.

Original Code:

<parameter>
<externalname>GroupNameList</externalname>
<description>GNListDescription</description>
<internalname>GroupNameList</internalname>
<type>string</type>
<values/>
</parameter>

Replacement Code:

<parameter>
<externalname>GroupNameList</externalname>
<description>GNListDescription</description>
<internalname>GroupNameList</internalname>
<type>string</type>
<values>
<value>Group name first</value>
.
.
.
<value>Group name last</value>
</values>
</parameter>

1. Save file package.xml.
2. Rebuild the CitrixMACEnumeration.cab file, including the revised package.xml file.
3. Uninstall the Citrix Scans for MAC Address endpoint analysis package. Note :If you also change the package URI or version from those supplied (http://www.citrix.com/EndpointAnalysisPackages/CitrixMACEnumeration.cab and 1.0 respectively) you can install the new package alongside the original, enabling the new package to use the client code from the original. If you do this you must not uninstall the original package.
4. Reinstall the Citrix Scans for MAC Address endpoint analysis package using the revised CitrixMACEnumeration.cab file.

[#118639]