APPX 6 Upgrade Instructions

This page provides the information needed to upgrade an existing APPX 5.x installation to APPX 6.


Overview

Release 6.0 has significant changes to the format & content of the System Administration files and Application Design files. As a result, these files must be migrated to the new format. A migration utility for the System Admin (6SA) and Application Design (6AD) is provided. This should be installed in your Release 5.0. Locked applications cannot be migrated, they must be unlocked, migrated and then re-locked in 6.0.

You can upgrade from any version in the Release 5.x series, but you may have additional steps at the end of the process if you are upgrading from an early release of 5.x. You cannot upgrade from Release 4.x or earlier.

The Structure files are incompatible between 6.x and all previous releases. After installing 6.0 and migrating your applications, you will have to create new Struct files for all end user data files. This also means you cannot share the APPXIO files between Release 5 & 6. Files that are stored in an RDBMS can be shared if you choose.

The basic approach we will use for upgrading is:

  1. Install APPX 6.0 in a new folder as if it was a new installation
  2. Install the migration applications in your existing 5.x installation
  3. Run the migration for your System Administration files
  4. Install the migrated System Admin files in your new 6.0 installation & confirm all is well
  5. Run the migration for your applications
  6. Install the migrated applications
  7. Copy the end user data to Release 6.0
This approach allows you to maintain your existing 5.x installation while migrating/installing Release 6.0. You can test Release 6.0 independently of your existing 5.0 installation. When you are ready to switch you just need to refresh the end user data.

The entire process may take a few hours, depending on the amount of data involved. Users can continue to work with your Release 5.0 applications and data while you are migrating, subject to the usual requirement of not copying files that others are actively updating.

It is assumed the reader is familiar with APPX System Administration concepts and knows how to define new applications, new databases, etc. It is also assumed the reader knows how to copy files, set/check permissions, etc.

1. Install APPX 6.0.0 in a new folder

Install a fresh copy of APPX in a new folder on your server. Refer to APPX600LinuxNewInstallation for Linux/Unix servers and APPX600WindowsNewInstallation for Windows servers.

2. Install the Migration Applications in Release 5.x

There are 2 migration applications: 6SA for the System Administration files, and 6AD for Application Design files. Download the Migration Utility and follow these steps:

  1. Add application 6SA/00 to your Applications file.
  2. Create the Design Files for 6SA/00.
  3. Add application 6AD/00 to your Application file.
  4. Create the Design Files for 6AD/00.
  5. Define Database 6SA, with a startup application of 6SA/00.
  6. Define Database 6AD, with a startup application of 6AD/00.
Now you are ready to install the applications from the downloaded file. The applications are supplied in a zip file format. Save this file in your $APPXPATH/00/ folder, and unzip from there. When prompted, replace all existing files. If you do not get this warning, you have unzipped the file in the wrong location.

Once the applications are unzipped, continue with:

  1. Create Data Files for Database 6SA, Application 6SA
  2. Create Data Files for Database 6AD, Application 6AD
You are now ready to migrate your System Administration files.

3. Run the migration for your System Administration files

Before migrating your System Admin files, you should verify the integrity of the files and correct any errors. The Verify step can be found in System Administration -> System Setup -> System Administration File Management -> Verify Files. Correct any errors before proceeding.

Continue by running Database 6SA from the APPX Main Menu. You will see this menu:

6sa_menu.png

Click the 'Convert' button to proceed. A report will be produced showing the files that were converted. If any errors are shown, fix them before continuing.

The conversion step creates a new set of System Administration files in Release 6.0 format. These are located in $APPXPATH/6SA/6SA/Data.

You are now ready to install the new System Administration files in your Release 6.0 folder. Follow these steps:

  1. Make sure no Release 6.0 APPX sessions are running. In particular, make sure to terminate the License Server.
  2. Copy $APPXPATH/6SA/6SA/Data/* from your 5.x folder to $APPXPATH/0SA/Data in your 6.0 folder. Do NOT copy the Struct folder.
  3. Check permissions of $APPXPATH/0SA/Data to make sure APPX users have read/write access
  4. Delete these specific .key files in $APPXPATH/0SA/Data:
    • EDITMSG.key
    • SCJOB.key
    • SCPROJ.key
    • SCSTE.key
    • SCTASK.key
    • SECDEPT.key
    • SECROLE.key
    • SECWG.key
Log on to APPX, go to System Administration -> System Setup -> System Administration File Management and run 'Create Files'. This will create new .key files for the ones you just deleted. This is necessary because the keys in those flies contain Unicode fields. Release 5.0 cannot create a Unicode aware key file, so we must recreate it under 6.0

Finally, compare your Release 5.0 'appx.env' file to your Release 6.0 'appx.env' file, and add any necessary settings to the Release 6.0 version. Do not simply copy your Release 5.0 file to 6.0, as you will lose some Release 6.0 settings. This is a good time to review these settings to see if they are still required. If you are not sure what an setting is used for, use the Environment Variable Wizard to check it.

If you changed your 'appx.env' file, log off & on again. Check your System Administration files to make sure everything was migrated correctly, i.e., Users, Printers, Forms, Applications, Databases, etc.

If all is well, continue with migrating your Applications.

Preliminary Tasks

  1. Ask all users to log off
  2. Verify the integrity of all files in your system and correct any errors.
    • System Administration Files
      • System Administration (Option 3) > System Setup (Option 1) > System Administration File Management (Option 2) > Select All (Option 2) > END > Verify Files (Option 12) > Verify Integrity of APPXIO Files (Option 1) Should be on file system path similar to \Appx\data\0SA\Data\*
        • Each file should have a status of OK, or Skipped: Temporary or Non-indexed File.
    • Design Files
      • System Administration (Option 3) > Database/Applications (Option 3) > Design File Management (Option 5) > Enter the Application and Version number for each application that you want upgraded to APPX 5 > Select all files > Verify Files (Option 12) > Verify Integrity of APPXIO Files (Option 1) Should be on a file system path similar to \Appx\data\00\TGL\Data\*. Look for failures. Skips are okay.
    • Data Files
      • System Administration (Option 3) > Database/Applications (Option 3) > File Maintenance - Database / Applications (Option 2) > Select the database (RETURN, RETURN) > For each application select Database Management (Option 5) > Select All (Option 2) > END > Verify Files Menu (Option 12) > Verify Integrity of APPXIO Files (Option 1. Look for failures. Skips are okay. Path will be similar to \Appx\data\TGL\TGL\Data\*
  3. Backup your system
  4. Obtain a new Release 5.0 License from your Reseller or Distributor

Convert Your System Administration Files

The first step of upgrading your APPX 4.2.a installation to APPX 5 is to convert your System Administration files to the new APPX 5 format. The System Administration files for APPX 4.2.a are not compatible with APPX 5 and must be converted to the APPX 5 format. Follow the directions below to convert your System Administration files.

Configure the Upgrade Application

After installing the Upgrade Application, you must run APPX as an APPX System Administrator and configure the Upgrade Application.

Add the upgrade application (5SA 00) to the Applications file.

System Administration (Option 3) > Database / Application (Option 3) > File Maintenance - Applications (Option 1)


Add5SAApplication.png

Create the Design Files for Application 5SA.

5SA-Create-Design-Files.png

The Create Files menu selection above should report "File Already Exists" for each file as shown below. If not, the application was not installed in the correct location. Repeat the installation steps above, specifing the correct location

Screen_shot_2009-11-10_at_2.46.40_PM.png

Add the database (5SA) for the Upgrade Application to the Databases file.

System Administration (Option 3) > Database / Application (Option 3) > File Maintenance - Databases / Applications (Option 2)


Add5SADatabase.png

Run Database Management for the Upgrade Application and Database.


DatabaseMgt.png

Run Create Files.


RunCreateFiles.png

Run the Upgrade Application

After configuring the Upgrade Application, you must run the Upgrade Utility to convert your System Administration files.

Run an Application (Option 1). 5SA.

RunDatabase5SA.png

Click on the "Convert" button to run the conversion utility.

5SA-Running-Conversion-Program.png

The conversion utility will create a log. Specify the appropriate disposition options to print the conversion log.


ConversionLogDispositionScreen.png

The conversion log will inform you of any problems that may have been encountered while running the conversion utility.


ConversionLog.png

Install the Upgraded System Administration Files

Before you install the APPX Utility, you must first replace your old System Administration files with the new System Administration files that were created when you ran the upgrade utility to convert your System Administration files to the new APPX 5.0.0 structure. You can use a copy command similar to the example below to replace your old System Administration with the upgraded files. Be sure to edit the copy command to reference the directory where APPX is installed on your system if APPX is not installed in "C:\Appx"

COPY C:\Appx\data\5SA\5SA\Data\ C:\Appx\data\0SA\Data\*

If you are prompted to overwrite any files answer Yes or All.

You should also remove the System Administration structure files. You can use a delete command similar to the example below to remove your System Administration structure files. Be sure to edit the command to reference the directory where APPX is installed on your system if APPX is not installed in "C:\Appx".

DEL C:\Appx\data\0SA\Struct\*

You are now ready to install Release 5 on top of your existing installation. Before installing APPX you should:

  1. Stop the APPX Connection Manager service(s).
  2. Terminate (kill) any APPX sessions that are still active (there shouldn't be any if everyone has logged off)
  3. Terminate (kill) the APPX License Server session
Then follow these steps:


Overview

Two different methods are provided to install APPX on Windows. There is a GUI installer and a Console Mode (character mode) installer. Most sites will use the GUI Installer, the character mode installer is intended for sites using Windows Core Server (Windows without a GUI). The same installer is used for both methods. The installer will automatically detect if it is being run as a command or from a GUI Desktop, although in some cases you may have to add "-c" to the command line to force the character installer. Regardless of which installation method is used, the result is the same. A typical APPX installation on a system where APPX has not been previously installed performs the following steps:

  1. Creates the destination directory and installs APPX into it.
  2. Sets the appropriate permissions
  3. Runs APPX to allow you to complete the configuration
    • Add APPX System Administrators to the APPX user file
    • Configure and start the APPX Login Manager service
    • Configure and start the APPX Audit Manager service
    • Install the license key

GUI Installation on Windows

Log in to your system as an administrative user.

Download and run the APPX GUI installer (appxsetup-windows.exe) from the APPX web site or the APPX ftp server.

After a few moments, the APPX Setup Wizard should display the Welcome screen. Click on the "Next" button to continue. If you are presented with a Security Warning dialog, click on the "Run" button to continue with the installation.


Welcome.PNG

Read and accept the license agreement.


AcceptLicense.PNG

Specify the Destination Directory into which APPX is to be installed. As a matter of convention, APPX is usually installed into C:\appx but may be installed into the drive and directory of your choice, but do not choose a directory with spaces in the name.


SelectDestinationDirectory.PNG

You will be warned if the destination directory already exists. Otherwise, the APPX Setup Wizard will create it.

The APPX Setup Wizard can optionally create a Start Menu. You must specify the appropriate options. If you don't know what to specify on this screen, simply accept the recommended options by clicking on the "Next" button to proceed with the installation.


SelectStartMenu.PNG


APPX will then be installed into the specified destination directory.


InstallingFiles.PNG

Finally, you may specify whether or not you want the APPX Setup Wizard to create a shortcut on your desktop and/or a quick launch icon on the taskbar. After specifying the appropriate options, click on the "Finish" button to end the APPX Setup Wizard.


CompletingSetup.PNG

Character Mode Installation

If you are running Windows Core Server, you can run the Appx installer in character mode by appending "-c" to the command line. After a few moments, the Appx Setup Wizard should display the Welcome message. Press Enter to continue the installation.

C:\Appx>setup.exe -c

Unpacking JRE ...
Preparing JRE ...
Starting Installer ...
This will install Appx on your computer.
OK [o, Enter], Cancel [c]


Next, read and accept the License agreement. Press Enter as each page is displayed.

Please read the following License Agreement. You must accept the terms of this agreement before continuing with the installation.

Software License

APPX Utility - Release 5.0.0

_ Important! _

Please read this carefully before you click on the Accept button.

Definitions:

"Software License Agreement (SLA)" shall mean this Software License document and the associated *License Key document collectively.

[Enter]

After the agreement has been displayed, enter 1 to accept the license agreement, or 2 to cancel the installation.

.
.
.
For inquires regarding this agreement, please contact: APPX Software, Inc., 11363 San Jose Blvd., Suite 301, Jacksonville, Florida 32223, USA

I accept the agreement

Yes [1], No [2]


Choose the directory where APPX should be installed and the other installation options.

Where should Appx be installed?

[C:\APPX]

Create a desktop icon?

Yes [y, Enter], No [n]

Create a Quick Launch icon?

Yes [y, Enter], No [n]


Install a new APPX 5.x License Key

Double click the C:\Appx\AppxDesktopClient.exe file to start the Appx Desktop Client. Click on the 'Local' tab, enter the location of the APPX engine (the appx.exe file) and click the connect button. You should be presented with the following System Registration screen. Notice that the Effective Date field on this registration is blank. Starting with APPX 5.0.0, all License Keys include an Effective Date. You must install an updated License Key before you will be able to run APPX 5.x. Note that in Release 5 and higher you can copy your registration to the clipboard, and APPX will detect it when you choose "Typical Import" from the "Import Menu" below.

License_win_before.PNG

After installing a new 5.x License Key, your System Registration screen should include an Effective Date.

License_win.PNG

Configure the new APPX Login Manager

APPX 5 includes the new APPX Login Manager service. This service replaces the Connection Manager (AppxdSvc) which was included with APPX releases prior to APPX 5.0.0. The old Connection Manager will not work with APPX 5 and higher, and should not be used. You should remove the services installed by appxdsvc using the '-remove' keyword:

C:\Appx\tools>appxdsvc -remove -name=Appx8060

To configure and start the new APPX Login Manager service, log in as an administrative user and execute a command similar to the following:

C:\Appx>CD services
C:\Appx\services>appxLoginMgr.exe -install -name=appx8060 -displayName=appx8060 -port=8060 -engine=C:\Appx\appx.exe

You should see the following messages:

appx8060 Created
appx8060 Configured

appx8060 Started
appx8060 will start automatically each time you boot your system

After executing the above command, users should be able to use the APPX 5.0.0 Desktop Client to successfully login on port 8060. For additional information on managing APPX Login Services, please refer to the complete documentation.

Final Tasks

  1. Review your 'appx.env' file. Ensure any settings from 4.2.x are still there. Remove any obsolete settings.
  2. Update the SYSDIR.
    1. System Administration (Option 3), System Setup (Option 1), System Administration File Management (Option 2), Update SYSDIR (Option 14).
    • update-sysdir.png
  3. Create the new System Administration files ("System Administration/File Management/System Admin Files" on pull down menu).
    • Final-Steps-01-Create-New-SA-Files.png
  4. Upgrade Design Files
    • Remove the Em, Dbg and Structure files for each of your applications. It is not necessary to do this to the applications supplied with Appx (0AD, 0LA, 0DB, 0SA, 1EX, DMO, etc)
      • For example, your GL application's path for Em, Dbg and Struct files might look similar to: C:\Appx\data\01\DGL\Struct\* and C:\Appx\data\01\DGL\Em\* and C:\Appx\data\01\DGL\Dbg\*
    • Run Create Files for each of your applications
      • System Administration (Option 3), Database / Applications (Option 3), Design File Management (Option 5). Specify your Application and Version, Create Files (Option 3).
      • create-design-files.png
      • create-design-files2.png
    • Run 'Sync Widget Elements' for each of your applications from the Utilities Menu in Application Design. This is optional, as APPX will force you to do this the first time you go into an application after installing Release 5.0
      • sync-widgets.png
    • Run 'Load Initial Audit History' for each of your applications. This is optional, as APPX will automatically build the history as you make changes to your application. For example, the first time you go into INPUTs, APPX will see that the audit history is missing and it will create it as it reads the input process records. Regardless of whether you run this, APPX will start keeping a detailed audit history of changes in applications from this point on. However, you should decide now whether to run this step now or not. If audit information already exists in the audit file when you run this step, it will duplicate the data
    • Run 'Sync Design Elements' for each of your applications.
  5. If you are using Custom Fonts in your applications (i.e., bar codes, etc) and you have not already updated your Resources for the new method, follow these steps, otherwise they will not print.
  6. Install the new APPX Desktop Client for all users
  7. If you were using Appx/ODBC, you must install the new version. The old version is not compatible with Release 5 and will not work. See this page for installation instructions.
  8. Configure new features as desired

Comments:

Read what other users have said about this page or add your own comments.



-- SteveFrizzell - 2 Nov 2009

Edit | Attach | Watch | Print version | History: r18 | r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r2 - 2018-02-22 - JeanNeron
 
  • Edit
  • Attach
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback