Previous Topic: Editing the avcstrings.properties FileNext Topic: Customizing the VPN Client Interface

Adapter for Cisco IPSec VPN Configuration Guide › Configuring VPN Client › Editing the CopyFiles.xml File

Editing the CopyFiles.xml File

The VPN Client installer can copy extra files that might be required by VPN Client or the Cisco VPN client application to work successfully. These files could include the profile configuration or other system files that might be required for successfully running the client application.

The CopyFiles.xml file is used to specify the location where these extra files need to be copied on the end-user’s system. To distribute these extra files with the VPN Client installer, perform the following tasks:

  1. Copy the files that need to be distributed with the installer to the \resources\add-ons directory.
  2. In the CopyFiles.xml file, specify the location on the end-user’s system where these files need to be copied.

    A sample CopyFiles.xml file is as follows:

    <?xml version="1.0" encoding="UTF-8"?>
<!--
- <B>How it works</B>
-<B> Install</B>
-Document element
-   <B>OS</B>
-    To perform OS Specific install actions
-<B>PostInstall</B>
-All the children of this tag should be executed in PostInstall phase only.
-Each of the above can contain either of these only.
- <I>COPY</I>,
-<B>1. COPY</B>
-<I>from_location</I> location from where to copy, This need to be either
-absolute location or some IA variable.
-
-<I>to_location</I>  is the location where the copying will done. This need to be either
-absolute location or some IA variable.
-
-
-<I>type</I> is  to denote if the command to be applied is on directory.
-
-
-
-->

<!DOCTYPE Install [
  <!ELEMENT Install(OS+)>
  <!ELEMENT OS (PostInstall)>
 
  <!ELEMENT PostInstall(COPY)+>
  <!ELEMENT Object(#PCDATA)>
  <!ELEMENT COPY(Object+)>

  <!ATTLIST OS name CDATA #REQUIRED>
  <!ATTLIST COPYfrom_location CDATA #REQUIRED>
  <!ATTLIST COPYto_location CDATA #REQUIRED>
  <!ATTLIST COPYtype CDATA #REQUIRED>

  <!ATTLIST Objectname CDATA #REQUIRED>
 

]>


<Install>
<OS name="windows">
<PostInstall>
<!--
USER_INSTALL_DIR : Location of Arcot VPN Client installation (ARCOT HOME directory)
VPN_CLIENT_INSTALL_LOCATION : Location of VPN client (e.g. Cisco VPNClient) installation (already installed)
EXTRACTOR_DIR : Directory containing Arcot-VPN-Client-*.*-Windows-Installer.exe
-->

<!-- Example for copying a directory -->
<!--
<COPY to_location="$VPN_CLIENT_INSTALL_LOCATION$+$/$"
from_location="$EXTRACTOR_DIR$+$/$+resources+$/$+add-ons+$/$" type="directory">
<Object name="Directory Name"/>
</COPY>
-->

<!-- Example for copying a file -->
<!--
<COPY to_location="$VPN_CLIENT_INSTALL_LOCATION$+$/$"
from_location="$EXTRACTOR_DIR$+$/$+resources+$/$+add-ons+$/$" type="file">
<Object name="File Name"/>
</COPY>
-->
</PostInstall>
</OS>
</Install>

    The following table describes the XML tags and the variable names that are used in the CopyFiles.xml file.

Element

Description

to_location

Specifies the path where the add-on files need to be copied on the end-user’s system.

$VPN_CLIENT_INSTALL_LOCATION$+$/$

Contains the location of the VPN client installed on the end-user’s system. Typically, this variable should not be changed. However, if you want to store the add-on files on a location other than the VPN client installer, then replace this variable with the required location. For example, C:\Program Files\Profiles.

$USER_INSTALL_DIR$+$/$

Contains the install location of the VPN Client on the end-user’s system.

from_location

Specifies the path from where the add-on files need to be picked up for copying. By default, this is set to the \resources\add-ons directory that is extracted from the VPN Client zip file.

$EXTRACTOR_DIR$+$/$+resources+$/$+add-ons+$/$

Contains the location of the add-ons directory that is extracted from the VPN Client zip file.

type

Specifies the type of object being copied. It can be assigned one of the following values:

  • directory: the object that needs to be copied is a directory.
  • file: the object that needs to be copied is a file.

Object name

Specifies the name of the object (directory name or file name) that needs to be copied.

Note: You can now either customize the VPN Client interface, as discussed in "Customizing the VPN Client Interface", or directly proceed to "Creating the Final Package".