Layton ServiceDesk - Installation - Upgrade Database

From Layton Support
(Difference between revisions)
Jump to: navigation, search
m (Added HelpBox 5.0.5 links)
m (Updated links)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk™]] [[User Guide for Layton ServiceDesk™|<u>Back to Contents</u>]]</p>
+
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p>
 
__FORCETOC__
 
__FORCETOC__
==Notes==
+
=Overview=
 
The ''Upgrade Database'' option is used to migrate existing HelpBox v5.0.5 databases to Layton ServiceDesk. It may also be used to upgrade Layton ServiceDesk databases to newer versions if required in the future. If you are starting a fresh installation of Layton ServiceDesk and do not wish to keep any existing data from your current HelpBox installation you can skip the following steps and start using Layton ServiceDesk right away, once you have it installed.  
 
The ''Upgrade Database'' option is used to migrate existing HelpBox v5.0.5 databases to Layton ServiceDesk. It may also be used to upgrade Layton ServiceDesk databases to newer versions if required in the future. If you are starting a fresh installation of Layton ServiceDesk and do not wish to keep any existing data from your current HelpBox installation you can skip the following steps and start using Layton ServiceDesk right away, once you have it installed.  
  
 
Note: You must be running HelpBox v5.0.5 or later to be able to migrate the database to Layton ServiceDesk. If you are running an earlier version, please upgrade before proceeding. Please contact your local Layton Technology office if you have any questions. Here are links to download either the upgrade or the full version:
 
Note: You must be running HelpBox v5.0.5 or later to be able to migrate the database to Layton ServiceDesk. If you are running an earlier version, please upgrade before proceeding. Please contact your local Layton Technology office if you have any questions. Here are links to download either the upgrade or the full version:
  
[http://http://www.helpbox.com.au/software/hb_sql_update.zip HelpBox 5.0.5 Upgrade]
+
*'''[http://www.laytontechnology.com/trialsoftware/HB505s.exe HelpBox 5.0.5 Upgrade]'''
 
+
*'''[http://www.laytontechnology.com/trialsoftware/HBTrial-SQL.zip HelpBox 5.0.5 Full]'''
[http://http://www.helpbox.com.au/software/hb_sql_full.zip HelpBox 5.0.5 Full]
+
  
 +
=Upgrade Limitations=
 
Layton ServiceDesk is not an upgrade for HelpBox but a completely new product, as such there is a limitation on what will be retained from HelpBox:
 
Layton ServiceDesk is not an upgrade for HelpBox but a completely new product, as such there is a limitation on what will be retained from HelpBox:
  
===Database===
+
==Database==
 
All the data in your existing HelpBox database will be retained when you migrate to Layton ServiceDesk, including all request classes. You will be upgrading your database "in place", meaning that the existing HelpBox database will be converted to a Layton ServiceDesk database. It will no longer be usable with HelpBox.
 
All the data in your existing HelpBox database will be retained when you migrate to Layton ServiceDesk, including all request classes. You will be upgrading your database "in place", meaning that the existing HelpBox database will be converted to a Layton ServiceDesk database. It will no longer be usable with HelpBox.
  
Line 19: Line 19:
 
'''In any event, you must make a backup of your HelpBox database before you migrate.'''
 
'''In any event, you must make a backup of your HelpBox database before you migrate.'''
  
===Form Designs===
+
==Form Designs==
 
When migrating from HelpBox to Layton ServiceDesk, all your current form designs such as Analyst and End User Request forms, Login Screen design layouts and the all the List Views, will be lost. These will be replaced by our default Layton ServiceDesk forms. See the Tips section below for some useful ideas for reproducing your existing HelpBox form designs.
 
When migrating from HelpBox to Layton ServiceDesk, all your current form designs such as Analyst and End User Request forms, Login Screen design layouts and the all the List Views, will be lost. These will be replaced by our default Layton ServiceDesk forms. See the Tips section below for some useful ideas for reproducing your existing HelpBox form designs.
  
===Reports===
+
==Reports==
Layton ServiceDesk includes over 100 canned reports. All your existing reports in HelpBox will be replaced with the new reports. Any custom reports you may have created will be lost.  
+
Layton ServiceDesk includes over 100 pre-configured reports. All your existing reports in HelpBox will be replaced with the new reports. Any custom reports you may have created will be lost.  
  
===ActiveDirectory, Email and AuditWizard Databridge Settings===
+
==ActiveDirectory, Email and AuditWizard Databridge Settings==
 
Layton ServiceDesk uses a different method of connecting to ActiveDirectory, Exchange and AuditWizard (if applicable). Once you have migrated to Layton ServiceDesk you will need to re-enter any Active Directory, Exchange and AuditWizard database details.
 
Layton ServiceDesk uses a different method of connecting to ActiveDirectory, Exchange and AuditWizard (if applicable). Once you have migrated to Layton ServiceDesk you will need to re-enter any Active Directory, Exchange and AuditWizard database details.
  
 
Your existing email bodies in HelpBox can be copied to Layton ServiceDesk if required. Copy the email body XML folder from the HelpBox programs folder to the Layton ServiceDesk email folder. You may need to reformat the email bodies slightly when they are added as the emails in HelpBox are in plain text whereas in Layton ServiceDesk you have the option of using the WYSIWYG editor.
 
Your existing email bodies in HelpBox can be copied to Layton ServiceDesk if required. Copy the email body XML folder from the HelpBox programs folder to the Layton ServiceDesk email folder. You may need to reformat the email bodies slightly when they are added as the emails in HelpBox are in plain text whereas in Layton ServiceDesk you have the option of using the WYSIWYG editor.
  
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk™]] [[User Guide for Layton ServiceDesk™|<u>Back to Contents</u>]]</p>
+
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p>
 +
 
 +
=Procedure=
 +
==Preparation==
 +
===If you are migrating from HelpBox to Layton ServiceDesk for the first time===
 +
#Do a '''[[Layton ServiceDesk™ - Installation - New Installation|new installation]]'''. When the Database Tool opens, follow the below procedure.
 +
#Copy the contents of ''C:\LaytonHelpBoxSQL\RequestAttach\'' to ''C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\RequestAttach\''.
 +
#Copy any email bodies that you modified and want to keep (stored as XML files) from ''C:\LaytonHelpBoxSQL\EmailBodies\'' to ''C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\EmailBodies\''.
 +
 
 +
===If you are upgrading from an earlier version of Layton ServiceDesk===
 +
#Back up your database.
 +
#Log into '''[https://client.laytontechnology.com/ the Customer Portal]''' and download the latest update. Install. When the Database Tool opens, follow the below procedure.
 +
 
 +
==Upgrade==
 +
1. Launch the Database Tool and click the ''Upgrade Database'' button:
 +
 
 +
 
 +
[[File:Lsd_upgrade_db_01.png|link=]]
 +
 
 +
 
 +
2. Click the ''Select'' button next to the Server field. In the Select SQL Server dialog, select a SQL Server from the list, then click the ''Select'' button. This will populate the Server field in the main window.
 +
 
 +
 
 +
[[File:Lsd_upgrade_db_02.png|link=]]
 +
 
 +
 
 +
3. Check the ''Use Trusted Connection'' checkbox. This will authenticate as the logged-in user. This user will need to have administrative permissions on the SQL Server to continue. Select your HelpBox database in the ''Database Name'' menu. Most likely this will be called ''HelpBox'', which is the default database name:
 +
 
 +
 
 +
[[File:Lsd_upgrade_db_03.png|link=]]
 +
 
 +
 
 +
4. Click the ''Test'' button to test the connection to the SQL Server with the provided details. If successful, a dialog will confirm:
  
==Procedure==
 
===Preparation===
 
<ol>
 
  <li>Install Layton ServiceDesk as per [[Layton ServiceDesk™ - Installation - New Installation|New Installation]].</li>
 
  <li>Copy the contents of ''C:\LaytonHelpBoxSQL\RequestAttach\'' to ''C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\RequestAttach\''.</li>
 
  <li>Copy any email bodies that you modified and want to keep (stored as XML files) from ''C:\LaytonHelpBoxSQL\EmailBodies\'' to ''C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\EmailBodies\''.</li>
 
</ol>
 
  
===Upgrade===
+
[[File:Lsd_upgrade_db_04.png|link=]]
Launch the Database Tool and click the ''Upgrade Database'' button:<br/><br/>
+
  
[[File:Lsd_upgrade_db_01.png]]<br/><br/>
 
  
Click the ''Select'' button next to the Server field. In the Select SQL Server dialog, select a SQL Server from the list, then click the ''Select'' button. This will populate the Server field in the main window.<br/><br/>
+
5. Click the ''Upgrade Database'' button:
  
[[File:Lsd_upgrade_db_02.png]]<br/><br/>
 
  
Check the ''Use Trusted Connection'' checkbox. This will authenticate as the logged-in user. This user will need to have administrative permissions on the SQL Server to continue. Select your HelpBox database in the ''Database Name'' menu. Most likely this will be called ''HelpBox'', which is the default database name:<br/><br/>
+
[[File:Lsd_upgrade_db_05.png|link=]]
  
[[File:Lsd_upgrade_db_03.png]]<br/><br/>
 
  
Click the ''Test'' button to test the connection to the SQL Server with the provided details. If successful, a dialog will confirm:<br/><br/>
+
6. You will be warned that you should have a back-up of your database before proceeding. Confirm that you want to continue at this time:
  
[[File:Lsd_upgrade_db_04.png]]<br/><br/>
 
  
Click the ''Upgrade Database'' button:<br/><br/>
+
[[File:Lsd_upgrade_db_06.png|link=]]
  
[[File:Lsd_upgrade_db_05.png]]<br/><br/>
 
  
You will be warned that you should have a back-up of your database before proceeding. Confirm that you want to continue at this time:<br/><br/>
+
7. Click the ''OK'' button to dismiss the dialog and return to the installer. Click the ''Close'' button to exit.
  
[[File:Lsd_upgrade_db_06.png]]<br/><br/>
 
  
Click the ''OK'' button to dismiss the dialog and return to the installer. Click the ''Close'' button to exit.<br/><br/>
+
[[File:Lsd_upgrade_db_07.png|link=]]
  
[[File:Lsd_upgrade_db_07.png]]<br/><br/>
 
  
The database will be upgraded and the configuration file will be updated so that Layton ServiceDesk will use the HelpBox database name instead of the default name.
+
8. The database will be upgraded and the configuration file will be updated so that Layton ServiceDesk will use the HelpBox database name instead of the default name.
  
==Tips on Migration==
+
=Tips on Migration=
 
If you wish to use the default form designs that are installed with Layton ServiceDesk and do not require any existing designs to be replicated from your existing HelpBox installation you can skip the following steps.
 
If you wish to use the default form designs that are installed with Layton ServiceDesk and do not require any existing designs to be replicated from your existing HelpBox installation you can skip the following steps.
  
 
If you have customized your HelpBox forms, login screens etc. and would like to keep them the same in Layton ServiceDesk, we recommend you follow these steps:
 
If you have customized your HelpBox forms, login screens etc. and would like to keep them the same in Layton ServiceDesk, we recommend you follow these steps:
  
#Install a clean installation of Layton ServiceDesk
+
#Install a clean installation of Layton ServiceDesk.
 
#Configure/customize your new installation of Layton ServiceDesk to match your existing forms, login screens as they appear in your current live HelpBox installation. Once you are happy with how your new installation of Layton ServiceDesk looks, you are now ready to migrate your existing HelpBox database.
 
#Configure/customize your new installation of Layton ServiceDesk to match your existing forms, login screens as they appear in your current live HelpBox installation. Once you are happy with how your new installation of Layton ServiceDesk looks, you are now ready to migrate your existing HelpBox database.
 
#Back up your HelpBoxBox application folder and database.
 
#Back up your HelpBoxBox application folder and database.
Line 82: Line 99:
 
#Use the ''Copy Form Design'' option in the Database Tool to copy your newly created design layouts from the first installation of Layton ServiceDesk you installed (where you customized the forms etc) to your newly upgraded HelpBox installation.
 
#Use the ''Copy Form Design'' option in the Database Tool to copy your newly created design layouts from the first installation of Layton ServiceDesk you installed (where you customized the forms etc) to your newly upgraded HelpBox installation.
  
By using the the Copy Form Design steps, you can spend as much time as you require to get your new installation of Layton ServiceDesk just right before you need to upgrade. You will also have virtually no downtime whatsoever when you are ready to go live.
+
By using the the ''Copy Form Design'' steps, you can spend as much time as you require to get your new installation of Layton ServiceDesk just right before you need to upgrade. You will also have virtually no downtime whatsoever when you are ready to go live.
  
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk™]] [[User Guide for Layton ServiceDesk™|<u>Back to Contents</u>]]</p>
+
<p align="right">[[File:btn_back_up.png|link=User Guide for Layton ServiceDesk]] [[User Guide for Layton ServiceDesk|<u>Back to Contents</u>]]</p>

Latest revision as of 02:03, 12 July 2016

Btn back up.png Back to Contents

Contents

[edit] Overview

The Upgrade Database option is used to migrate existing HelpBox v5.0.5 databases to Layton ServiceDesk. It may also be used to upgrade Layton ServiceDesk databases to newer versions if required in the future. If you are starting a fresh installation of Layton ServiceDesk and do not wish to keep any existing data from your current HelpBox installation you can skip the following steps and start using Layton ServiceDesk right away, once you have it installed.

Note: You must be running HelpBox v5.0.5 or later to be able to migrate the database to Layton ServiceDesk. If you are running an earlier version, please upgrade before proceeding. Please contact your local Layton Technology office if you have any questions. Here are links to download either the upgrade or the full version:

[edit] Upgrade Limitations

Layton ServiceDesk is not an upgrade for HelpBox but a completely new product, as such there is a limitation on what will be retained from HelpBox:

[edit] Database

All the data in your existing HelpBox database will be retained when you migrate to Layton ServiceDesk, including all request classes. You will be upgrading your database "in place", meaning that the existing HelpBox database will be converted to a Layton ServiceDesk database. It will no longer be usable with HelpBox.

Another approach is to back up the database and restore it as LaytonServiceDesk, thus producing a copy. This is the default name of an empty Layton ServiceDesk database. When the conversion process is complete, your database will have the correct name and your HelpBox database will be untouched.

In any event, you must make a backup of your HelpBox database before you migrate.

[edit] Form Designs

When migrating from HelpBox to Layton ServiceDesk, all your current form designs such as Analyst and End User Request forms, Login Screen design layouts and the all the List Views, will be lost. These will be replaced by our default Layton ServiceDesk forms. See the Tips section below for some useful ideas for reproducing your existing HelpBox form designs.

[edit] Reports

Layton ServiceDesk includes over 100 pre-configured reports. All your existing reports in HelpBox will be replaced with the new reports. Any custom reports you may have created will be lost.

[edit] ActiveDirectory, Email and AuditWizard Databridge Settings

Layton ServiceDesk uses a different method of connecting to ActiveDirectory, Exchange and AuditWizard (if applicable). Once you have migrated to Layton ServiceDesk you will need to re-enter any Active Directory, Exchange and AuditWizard database details.

Your existing email bodies in HelpBox can be copied to Layton ServiceDesk if required. Copy the email body XML folder from the HelpBox programs folder to the Layton ServiceDesk email folder. You may need to reformat the email bodies slightly when they are added as the emails in HelpBox are in plain text whereas in Layton ServiceDesk you have the option of using the WYSIWYG editor.

Btn back up.png Back to Contents

[edit] Procedure

[edit] Preparation

[edit] If you are migrating from HelpBox to Layton ServiceDesk for the first time

  1. Do a new installation. When the Database Tool opens, follow the below procedure.
  2. Copy the contents of C:\LaytonHelpBoxSQL\RequestAttach\ to C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\RequestAttach\.
  3. Copy any email bodies that you modified and want to keep (stored as XML files) from C:\LaytonHelpBoxSQL\EmailBodies\ to C:\Program Files\Layton Technology\Layton ServiceDesk\HBData\EmailBodies\.

[edit] If you are upgrading from an earlier version of Layton ServiceDesk

  1. Back up your database.
  2. Log into the Customer Portal and download the latest update. Install. When the Database Tool opens, follow the below procedure.

[edit] Upgrade

1. Launch the Database Tool and click the Upgrade Database button:


Lsd upgrade db 01.png


2. Click the Select button next to the Server field. In the Select SQL Server dialog, select a SQL Server from the list, then click the Select button. This will populate the Server field in the main window.


Lsd upgrade db 02.png


3. Check the Use Trusted Connection checkbox. This will authenticate as the logged-in user. This user will need to have administrative permissions on the SQL Server to continue. Select your HelpBox database in the Database Name menu. Most likely this will be called HelpBox, which is the default database name:


Lsd upgrade db 03.png


4. Click the Test button to test the connection to the SQL Server with the provided details. If successful, a dialog will confirm:


Lsd upgrade db 04.png


5. Click the Upgrade Database button:


Lsd upgrade db 05.png


6. You will be warned that you should have a back-up of your database before proceeding. Confirm that you want to continue at this time:


Lsd upgrade db 06.png


7. Click the OK button to dismiss the dialog and return to the installer. Click the Close button to exit.


Lsd upgrade db 07.png


8. The database will be upgraded and the configuration file will be updated so that Layton ServiceDesk will use the HelpBox database name instead of the default name.

[edit] Tips on Migration

If you wish to use the default form designs that are installed with Layton ServiceDesk and do not require any existing designs to be replicated from your existing HelpBox installation you can skip the following steps.

If you have customized your HelpBox forms, login screens etc. and would like to keep them the same in Layton ServiceDesk, we recommend you follow these steps:

  1. Install a clean installation of Layton ServiceDesk.
  2. Configure/customize your new installation of Layton ServiceDesk to match your existing forms, login screens as they appear in your current live HelpBox installation. Once you are happy with how your new installation of Layton ServiceDesk looks, you are now ready to migrate your existing HelpBox database.
  3. Back up your HelpBoxBox application folder and database.
  4. Migrate your HelpBox database to Layton ServiceDesk.
  5. Use the Copy Form Design option in the Database Tool to copy your newly created design layouts from the first installation of Layton ServiceDesk you installed (where you customized the forms etc) to your newly upgraded HelpBox installation.

By using the the Copy Form Design steps, you can spend as much time as you require to get your new installation of Layton ServiceDesk just right before you need to upgrade. You will also have virtually no downtime whatsoever when you are ready to go live.

Btn back up.png Back to Contents

Personal tools
Namespaces

Variants
Actions
Main Page
Online User Guides
General Support
Release Notes
Toolbox