HowTo: Update the Silver Essence Framework

If you want to update your local version of the Silver Essence Framework, you can do this through your web browser. No remote access to the local server is required. Providing that is, of course, that you have all the necessary information. Here's how you can do the update.

What you will need

You will need to have the following information ready:

  • InstanceID
    The unique ID of your local Instance of the Essence Framework
  • InstanceKey
    The unique Key that is currently associated with your local Instance
  • AccessCode
    Your unique AccessCode as set during the installation

The InstanceID and InstanceKey can be found in the Partner Portal. That's where you can also reset the InstanceKey if necessary. The AccessCode is not known to us and can only be found (and maintained) in the SilverApplication.xml in the XML directory of your local installation.

Start the local Instance Updater

Go to ToolBox and select the Instance Manager from the main menu on the left.

Select the Instance you want to update and click the update button.

Update your local Instance

In the Framework Updater, provide the necessary data. Your InstanceID, InstanceKey and AccessCode.

Leave the TestMode checkbox on to run the Update process, without the actual update itself. After the Update, you will get a message and you can open the Log File. Scroll down a bit an you will find something like this:

2017-01-04 02.25.08 Downloaded files will be extracted to C:\Silver\Delivery\
2017-01-04 02.25.08 Test Mode: No files were extracted
2017-01-04 02.25.08 The downloaded files were deleted

If you run the Update again after clearing the TestMode checkbox, the files will be extracted. In the Log File you will see:

2017-01-04 02.25.57 Downloaded files will be extracted to C:\Silver\Delivery\
2017-01-04 02.26.10 Files were extracted to C:\Silver\Delivery\
2017-01-04 02.26.10 The downloaded files were deleted

After the update, you can start the Portal.

Download Location

By default we will use the SystemProfile folder from the Application Pool account. So make sure that this user has access right for this folder, and enough rights to create the subfolders, download the necessary files and delete them afterwards.

If you don't want to give the Application Pool account these access rights to this folder, you can alternatively set a local Temp Directory for your Instance. Go to ToolBox, select the Instance Manager and the correct Instance. Instead of Update, click View/Edit Settings. Here too, you will need to sign in with the InstanceID, InstanceKey and AccessCode.

In the Settings tab you will find the option for the Local Temp Directory.

While running the update

Depending on your internet connection, the update will take about a minute to complete. Users that are at that moment using the Portal will be disconnected and will have to sign in again. Any changes they were making at that time, will not be saved. Also, the first start of the Portal will take about a minute, so be sure to schedule the update and announce a maintenance window