= ExcelFlowExpand =

ExcelFlowExpand is a TOL package that provides an Excel add-in to change the dating for time series of flow type.

This add-in uses TOL (in background) via the [wiki:Software#TOLandVBA vbtol library] (vbtol.dll) and therefore it requires a TOL installation.

== Add-in Installation ==

For using this add-in, there are two software requirements:

 * Provide an Excel installation. Version 2007 (v12.0) onwards.
 * Install TOL (if you have not already done so). See [wiki:Download] and [wiki:Installation].

Then, the add-in installation needs of the following steps:

 * Install the package ExcelFlowExpand.
 * Copy the add-in (XLAM file) to an Excel add-in folder.
 * Activate the add-in in Excel.
 * Create an environment variable indicating where TOL is installed.

These steps can be done in two ways: manually or running a TOL code.

=== The steps via TOL ===

{{{
#!cpp
// Install the package ExcelFlowExpand. It requires a internet connection.
#Require ExcelFlowExpand;

// Copy the add-in (XLAM file) to the user default add-in folder.
Real ExcelFlowExpand::Install(?);

// Activate the add-in.
Real ExcelFlowExpand::Activate(?);

// Write the environment variable VBTOL_PATH with the local value of Text TOLSH_PATH.
Real ExcelFlowExpand::SetCurrentAsVBTOL(?);
}}}

=== The steps manually ===

==== Install the package ExcelFlowExpand. ====

The package can be install as usual anyway:
{{{
#Require ExcelFlowExpand;
}}}

Otherwise, download the zip file of the package: [https://www.tol-project.org/packages/OfficialTolArchiveNetwork/repository.php?action=download&format=attachment&tol_package_version=4&package=ExcelFlowExpand ExcelFlowExpand] and unzip it in the TOL Package default folder:

 * TOL Package folder: [[BR]] 
   {{{%APPDATA%\tol\TolPackage.4\Client}}} [[BR]]
   (version numbers may be different)

After unzipping, check the resulting add-in path: [[BR]]
{{{%APPDATA%\tol\TolPackage.4\Client\ExcelFlowExpand.1.2\XLA}}} [[BR]]
(version numbers may be different)

==== Copy the add-in to an Excel add-in folder ====

Copy the add-in (XLAM file) to an Excel add-in folder.

The add-in can be found at the package folder:

 * Add-in source folder: [[BR]]
   {{{%APPDATA%\tol\TolPackage.4\Client\ExcelFlowExpand.1.2\XLA}}} [[BR]]
   (version numbers may be different).

The destination folder can be the user default add-in folder:

 * Add-in target folder: {{{%APPDATA%\Microsoft\AddIns}}} [[BR]]
   or {{{%APPDATA%\Microsoft\Complementos}}} in a spanish Windows. [[BR]]
   For more details, you can read: [https://support.microsoft.com/en-us/kb/810789 Locations for Excel Add-in Programs]

==== Activate the add-in ====

The add-in activation can be done as usual.

These steps are:

 * Start Excel, and then on the Tools menu, click Add-Ins.

 * Then, in the Manage box, click Excel Add-ins, and then click Go. The Add-Ins dialog box appears.

 * In the Add-Ins available box, select the check box next to the add-in that you want to activate, and then click OK.

For more details, you can read: [https://support.office.com/en-us/article/Add-or-remove-add-ins-0af570c4-5cf3-4fa9-9b88-403625a0b460 Add-or-remove-add-ins]

==== Create the environment variable VBTOL_PATH ====

For helping the add-in to find the TOL installation, an environment variable named {{{VBTOL_PATH}}} should be created.

This environment variable should contain the 'bin' folder of the TOL installation.

 * TOL bin folder: {{{%PROGRAMFILES%\Tol-Project\tol-gnu-v3.3\bin}}} [[BR]]
   (version numbers may be different). [[BR]]
   In Windows 64-bits, probably {{{%PROGRAMFILES(x86)%}}} should be used instead {{{%PROGRAMFILES%}}}.

The TOL bin folder can also be readed from TOL variable: {{{Text TOLSH_PATH;}}}.

The environment variable creation can be done as usual. We recommend to create an user environment variable.

__Using the environment variables editing window__

The location of the environment variables editing window vary from a Windows version to another.

To open it, you should follow these steps or similar: {{{Control Panel -> System -> Advanced ->  Environment Variables}}}. [[BR]]
Otherwise you can execute (WIN + R): {{{rundll32.exe sysdm.cpl,EditEnvironmentVariables}}}.

In this window you can add an user environment variable indicating the name ({{{VBTOL_PATH}}}) and the value (your own path). 

__Using the command setx__

You can also do it executing a sentence into the Windows command line (change the path with your own):
{{{
setx VBTOL_PATH %PROGRAMFILES%\Tol-Project\tol-gnu-v3.3\bin
}}}