Email Marketer Upgrade Guide
Please read every step of the relevant instructions before undertaking the first step. It is always a good idea to backup your data before performing any sort of update. Before you begin the upgrade process, you must ensure that you have a full backup of your database. After you have backed up your database, ensure that you download the complete contents of your current installation to a safe location on your local machine.
YOU MUST BACKUP YOUR DATABASE AND INSTALLATION BEFORE YOU BEGIN!
The easiest way to check that your server meets our software's requirements is to upload our
check_iem.php script to your server's base website directory, and load it in your browser. If you see "NOT OK" in red on that page, please troubleshoot the issue with your webhost until everything says "OK" or "Unknown".
Essentially what you're about to do is replace your current Email Marketer files with the latest files and then restore any private labeling assets that you have in your current installation, as well as restoring the following directories and files:
The renaming process outlined below serves to reduce the likelihood that someone visits your site while key Email Marketer files are mid-update. It also serves to provide a working backup of your existing installation, should something go wrong during the upgrade.
If you haven't already, be sure to download the complete contents of your existing installation to a safe location on your PC:
- Download the new version from the Interspire client area, https://www.interspire.com/clientarea/index.php
- Unpack the Email Marketer archive. Windows comes with a built in tool to handle zip files, but you can also download a program like WinZip or unRar for free if needed
Using an FTP program (such as Filezilla which is free) login to your web server and create a new directory along side your existing Email Marketer directory using the same name as your current installation only with '-new' at the end. For example, if your copy of Email Marketer is located in a directory named /marketing/, create a new directory named /marketing-new/. After you have created your new folder, simply upload the contents of the Email Marketer archive to your new directory. Please note, when you unpack your download, it will create a folder named /emailmarketer.
Please DO NOT upload this folder. Rather, upload the CONTENTS of this folder in the new directory you just created.
Once the upload is complete, restore the following files/folders on your server:
- /somename/admin/includes/config.php ---> /somename-new/admin/includes/ (be sure to overwrite the old config.php)
- /somename/admin/temp/ ---> /somename-new/admin/temp/
Restore any private labeling that you have from your original installation to your new installation.
After you have restored all the items above, rename the folder on your server:
- /somename/ ----------> /somename-old/
- /somename-new/ ---------> /somename/
Clear your browser's cache and visit your installation's URL.
You will now see an Upgrade Wizard show. Click the button on this page to upgrade to the latest version.
Interspire Email Marketer requires the following files/directories to have 'write' permissions set. If you're running on a Linux or Unix web host, you can use your FTP program and use the 'CHMOD' ('Change Mode') function to grant write permissions. If your host is running Windows, you will need to contact them about setting up write permissions on these files/folders. If a folder listed here doesn't exist please create it.
Files, CHMOD this file to 646:
- Note: Although it says 646, some webhosts may require 664 or 666 instead.
Folders, CHMOD these to 757:
- Note: Although it says 757, some webhosts may require 775 or 777 instead.
Restoring Your Files.
If you have modified your Interspire Email Marketer files with custom functions or changed the look and feel of the application, you should now upload these files. You should check the changelog.txt file found in the root folder of the zip file you downloaded to see what files have been modified so that you can make sure your customizations all still work.
Congratulations, you are now ready to login to the Interspire Email Marketer control panel and start adding content! Your control panel will be accessible by browsing to http://www.example.com/youremailmarketerinstallation/admin.
Error after upgrading: Your license key is invalid - possibly an old license key
Your license key may need to be updated if you're recieveing the message, "Your license key is invalid - possibly an old license key" after your upgrade. To fix this follow these steps:
- Log into your client area
- Copy the license key for your domain
- Open admin/includes/config.php
- Paste the license key in the respective spot and make sure your changes are saved
You can also paste the license key directly into the application on the 'Application Settings' page. You may need to log out of the application and/or clear your cache for the changes to take effect if you use this method though.
I just uploaded from Interspire Email Marketer version X to version Y and did not see the upgrade process. What happened?
Upgrades from one minor version to another are only file updates. For example, if you are updating from version NX 1.0.1 to NX 1.0.2 then this is a minor update. You will not see any upgrade process as this is simply changing some files that have been modified to remove known bugs. There are no database changes in minor version changes.
If however, you are upgrading from different major versions such as from 2004.18 to NX 1.0.3 or from NX 1.0.3 to NX 2 (just an example) then this is a major update and will require you to run an upgrade script to update database fields.
I have lost or corrupted my config file. How do I fix this so that I can continue to use Interspire Email Marketer?
If you have accidentally deleted or corrupted your config file you will need to either fill in your empty/corrupted config file or create a new one.
The config file should contain the following information and be saved as 'admin/includes/config.php':
<?php define('SENDSTUDIO_DATABASE_TYPE', ''); define('SENDSTUDIO_DATABASE_USER', ''); define('SENDSTUDIO_DATABASE_PASS', ''); define('SENDSTUDIO_DATABASE_HOST', ''); define('SENDSTUDIO_DATABASE_NAME', ''); define('SENDSTUDIO_TABLEPREFIX', ''); define('SENDSTUDIO_LICENSEKEY', ''); define('SENDSTUDIO_APPLICATION_URL', ''); define('SENDSTUDIO_SMTP_SERVER', ''); define('SENDSTUDIO_SMTP_USERNAME', ''); define('SENDSTUDIO_SMTP_PASSWORD', ''); define('SENDSTUDIO_SMTP_PORT', ''); define('SENDSTUDIO_SERVERTIMEZONE', ''); define('SENDSTUDIO_FORCE_UNSUBLINK', ''); define('SENDSTUDIO_HTMLFOOTER', ''); define('SENDSTUDIO_TEXTFOOTER', ''); define('SENDSTUDIO_MAXHOURLYRATE', '0'); define('SENDSTUDIO_MAXOVERSIZE', '0'); define('SENDSTUDIO_CRON_ENABLED', '0'); define('SENDSTUDIO_CRON_ENABLED', '0'); define('SENDSTUDIO_DEFAULTCHARSET', 'ISO-8859-1'); define('SENDSTUDIO_EMAIL_ADDRESS', ''); define('SENDSTUDIO_IPTRACKING', ''); define('SENDSTUDIO_IS_SETUP', 1); ?>
You will need to fill out the following details:
SENDSTUDIO_DATABASE_TYPE: This will either be 'mysql' or 'pgsql'
SENDSTUDIO_DATABASE_USER: This is the user name that you use to connect to your Interspire Email Marketer database
SENDSTUDIO_DATABASE_PASS: This is the password for that database
SENDSTUDIO_DATABASE_HOST: This is usually local host but if this does not work contact your host
SENDSTUDIO_DATABASE_NAME: This is the table that has your Interspire Email Marketer install information in
SENDSTUDIO_TABLEPREFIX: This will be the first few characters of your tables. Default is ss_
SENDSTUDIO_LICENSEKEY: Your license key for Interspire Email Marketer
SENDSTUDIO_APPLICATION_URL: The full path to your Interspire Email Marketer install. Do not add a slash to the end. I.e. 'http://www.domain.com/iem'
SENDSTUDIO_SERVERTIMEZONE: This is the timezone that your server is located in such as 'GMT+10:00'
The rest of these details can be filled out by using the settings page in Interspire Email Marketer .
You will need to make sure that your config file has write permissions so that Interspire Email Marketer can save the details when you edit them in the Settings page.
How do I know if I am running the most current version of Interspire Email Marketer?
You can check what version of Interspire Email Marketer you are running by looking at the version number at the bottom of the Settings page within Interspire Email Marketer.
If you are not running the most up to date version then you should upgrade by following the instructions below.
- Download the most current version of Interspire Email Marketer.
- Back up all of your existing files.
- Upload the new files from the zip file.
- Restore the 'admin/includes/config.php' file that you backed up in the second step.
- Restore any files you have modified for rebranding purposes.
And your done.
I get this or similar error: Langvar 'ApplicationURL' doesn't exist. How can I fix it?
If you get an error such as Langvar 'ApplicationURL' doesn't exist or any error regarding "Langvar ... doesn't exist" then most commonly this is because you're missing a language file. This commonly occurs when upgrading from one version of Interspire Email Marketer to another and not uploading all the required files. Try re-uploading all the files inside the admin/language folder.
When I try to upgrade I am told to set permissions to CHMOD 757 but am running on a Windows server. What are the equivalent permissions?
You will be asked to set the permissions of a file and folder to CHMOD 757 in the upgrade process. This will not work for Windows servers.
You will need to set the permissions to read/write/modify for the 'admin/temp' folder and read/write for the 'admin/includes/config.php' file.
I installed Interspire Email Marketer to the wrong folder. Can I change where it is installed?
Yes this is possible. Simply move all the files and folders to the desired directory and set the
SENDSTUDIO_APPLICATION_URL in the 'admin/includes/config.php' to where your installation is.
This line should look something like this:
The following file(s) are missing from the admin/language/upgrades/nx/ folder: Once you have uploaded the file(s) mentioned, try again.
If you have checked the 'admin/language/upgrades/nx/' folder and your files are there then you should look to see if there are any files that do not end in '.php' .
If there are other files in there, delete them and try the upgrade again.