Rebranding (Customizing) the Web Transfer Client

Before you make any changes to the Web Transfer Client (WTC) files, make a backup copy of any files and images that you plan to edit. Deleting or incorrectly editing the WTC files can render the client unusable. When you upgrade to a new version of EFT, copy the *changes* to the new files; do not overwrite the new files with your custom files as numerous updates will have been made. Copy and then edit the files only in the /custom folder as described in the procedure below.

EFT provides for custom branding of the per-Site and per-Server login page, WTC interface, Plain-Text Client (PTC), Account Management interface, and AS2 Management interface. Save the edited files in the \custom\ directory for the Site and\or Server. Each file is searched for independently, so you could have some files branded on the Server (under \custom\EFTClient\), others branded on the Site (under \custom\MySite\EFTClient\), and the rest left as they were originally installed (under \public\EFTClient\).

EFT first looks in the Site's custom (branded) directory \web\custom\MySite\EFTClient and loads any branded files. For files that are not present in the Site's \custom\ directory, EFT checks the Server's \custom\ directory, \web\custom\EFTClient\, and then loads the files that it finds there. Finally, for any other files, it will load the default files from \web\public\EFTClient\. Branded files that are Site-specific override any Server-wide branded and default files, while branded files that are Server-wide override the default (Globalscape-branded) files provided by the installer.

Upon initial installation, this \custom\ directory is empty. You must create the directory structure for any Server (\custom\EFTClient\) or Site (\custom\MySite\EFTClient\) branded files. If you have multiple Sites, each Site can have different branding (e.g., one can be in English and one in French).

Below is an illustration of the folder hierarchy:

To customize files on the Server

  1. Create an \EFTClient\ folder in the \custom\ folder.

  2. Copy only the default files that you want to edit (rebrand) for the Server into the \custom\EFTClient\ folder that you created. (It is not necessary to copy all of the default files.)

  3. Edit the copy of the file and save it in the \custom\EFTClient\ folder.

The WTC and PTC files can be modified independently.

For example, suppose you wanted to rebrand the PTC from English to French:

  1. Copy the EFTWebClientPlainText.htm file from \web\public\EFTClient\ptc to \web\custom\EFTClient\ptc. (If you wanted to make only one of your Sites French, you would copy the file to \web\custom\SiteName\EFTClient\ptc INSTEAD of \web\custom\EFTClient\ptc.)

  2. Edit the copy of the file to rename the buttons from English to French.  For example, change the word "Upload" in:

<button class="fg-button ui-state-default fg-button-icon-left ui-corner-left fg-button-toggleable" type="button" id="uploadButton" title="Upload" ><span class="ui-icon ui-icon-circle-arrow-n"></span>Upload</button>

to "Envoyer":

<button class="fg-button ui-state-default fg-button-icon-left ui-corner-left fg-button-toggleable" type="button" id="uploadButton" title="Upload" ><span class="ui-icon ui-icon-circle-arrow-n"></span>Envoyer</button>

  1. Save the file, then reload the PTC browser page. Your buttons are now in French!

To customize files on the Site

  1. Create a directory structure in the form [SiteName]\EFTClient\ in the \custom\ folder.

  2. Copy only the default files that you want to edit (rebrand) into the \custom\SiteName\EFTClient folder that you created. (It is not necessary to copy all of the default files.)

  3. Edit the copy of the file and save it in the \custom\SiteName\EFTClient\ folder.

When upgrading, the \custom\ and \public\ folders are backed up and renamed with the date and time (e.g., \customBackup_9-28-2010_16-18\ and \publicBackup_9-28-2010_16-18\).

Related Topics