Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

Daimler

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

1 EWA Admin Tool Guide

2 Table of Contents

3 Overview

3.1 Purpose of this document

3.2 Introduction

4 Startup of EWA Administration Tool

5 Starting, Stopping and Monitoring of EWA core services

6 EPC net / WIS net Database Maintenance

6.1 Influence the installed Database status

6.2 Install new Databases

6.3 Update existing Databases

6.4 Delete a Database

6.5 Switching databases

6.6 Applying Daily Updates for WIS net Database

6.6.1 Configuration and Manual Run

6.6.2 Running Daily Imports Scheduled

6.7 Wiping all Database Content

7 Advanced Command line options

7.1 Database control

7.2 Update (Database and Software)

7.3 Cleanup database

8 Update Process Description

9 Logging & Troubleshooting

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

3.1 Purpose of this document

This document describes the EWA Admin Tool Interface of EWA net which is used to update, manage and maintain the WIS and EPC Databases as well as managing the state of the server.

3.2 Introduction

Besides the software installation, the applications need to have access to certain databases for content data. This content is not installed within the setup of the software but needs to be updated after installation. The aim of this behavior is to decouple software and data update and minimize the downtime of the applications.

This document describes the use and function of the EWA Admin Tool. The following use cases are documented in this description:

• Start of the Tool
• Starting and Stopping of EWA services
• Installing Databases for EPC
• Updating Databases for EPC
• Removing Databases for EPC
• Installing Databases for WIS
• Updating Databases for WIS
• Removing Databases for WIS
• Wiping Database content (Cleanup)
• Usage of the Tool
• Logging and Troubleshooting

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

The EWA net Administration tool can be started using the favorites menu inside the Internet Explorer. This entry is created during installation and is only available on the server.

Picture 1: Start of EWA net Administration tool using the favorites menu

The EWA net Administration tool can be only started on the EWA net server. If the link to this tool is not available, it can be started manually using the command

[EWA_HOME]\ewa_admin\EWAAdmin.exe

where EWA_HOME need to be replaced with the directory where EWA net was installed.

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

With the EWA Administration Tool it is possible to influence the availability of the server and see if it is running. The Administration tool acts as a service monitor and shows if the needed Windows services are running or not.

Picture 2: Service Monitor Page for the Server

Within this panel the EWA net server (application server) can be started and stopped. This is more or less a shortcut for the Windows “Services” view.

Also within this panel the user management database (i.e. for specific user data, FIN Cache,…) can be started and stopped.

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

The databases of WIS net and EPC net are maintained in a very similar way. Since there is no difference except the starting tab on the dialog, both parts will be described in a single chapter

6.1 Influence the installed Database status

On the EPC net / WIS net Screen in the Administration Tool it is possible to see the current state of the running database. If no database is installed, the traffic light will be off. If the database itself is working and the database service shows a good status, it will show a green traffic light. Else the traffic light will show a red status.

Use the “Start” and “Stop” Buttons to shutdown / start the database and the Transbase service.

Picture 3: EPC net Administration of Database

6.2 Install new Databases

To install a new database into the running application, use the “Install” button. This will start the process of copying the needed database files from DVD to hard disk and attach the databases to the running service. Once a database is installed, the button will be labeled as "Update" to indicate that this action will update the running database.

After the button is pressed, the tool will ask you to insert an EPC net / WIS net data DVD to any DVD drive of your machine. For EpC net it will try to read the “FDARequest.cfg” file which is normally in the folder “MBXX\cfg” of any data DVD. For WIS net the program tries to find the "WISCD000" file in the folder "wis" of the DVD root.

Picture 4: Admin tool requests the data DVD configuration file

If the DVD is inserted just press “OK” - the Tool will search all available drives in PC for the configuration file. If you already had a valid data DVD of EPC net in one of your DVD drives, the tool will have skipped this dialog and started installation immediately.

Note:
If the files should be installed using a network share, use the “Browse…” button and navigate to the corresponding folder on the network share and select the “FDARequest.cfg”/"WISCD000" file in the folder “MBXX\cfg”/"wis" relative from the DVD root.

The Tool will also search all hard drives and mounted Shares for data DVDs.

After the configuration file has been read successfully and the database files could be found, the tool will request to select a target drive for the database content. Select one or more drives where all database files should be copied to and click “OK”. The dialog will also show how much space is required on the destination drive.

Picture 5: Selection of the target drive for database content

The next step in the copy process is to start to copy the ROM files to hard disk. If the source DVD can not be located in any drive of the PC, the Tool will ask for a source for copying the files.

Picture 6: Selection of ROM file source

In this dialog, please select the DVD root directory when the tool requests a file. The path inside the media is searched automatically. If a network share is used as file source, please point to the folder which corresponds to the original DVD root.

The copy process will be visualized with a progress. Please wait until all data has been copied or the Tool asks you for further media.

Picture 7: Copy Progress Dialog

After all database ROM files have been copied, the tool will proceed with the following steps:

• Test all copied ROM files for consistency
  This step will verify that all files have been copied successfully

Picture 8: Database test Dialog

• Ask for confirmation to attach the new files to the running instance
  Please press “OK” here to go on with the installation process.
• The Tool will attach all new database files to the running instance.
  Please wait until the tool has finished this step.

After these steps have been completed successfully, it will show a notification that all needed databases have been copied and activated successfully. The traffic light for the EPC net / WIS net database status will turn to green now.

Picture 9: Successful installation of a database

6.3 Update existing Databases

The update of database content will almost use the same installation process like the initial installation of the database.

The difference in the update step is that you are requested to insert the DVD which contains the setup into any DVD drive. During update the normal setup will be called to update software resources. Please select the appropriate folder where the setup.exe is available if the files could not be found automatically.

Note:
When updating the server, you should ensure that no user is using the applications. Users can continue working while database ROM files are being copied to the hard disk. But after finish of this process the server will be shutdown so users might lose important data.

6.4 Delete a Database

Database can easily be deleted from the system by clicking on the “Delete” button. This button will delete the currently active database.

Note:
Be sure that you notify all users to save important data and to log off from the system as they might loose data when the database will be deleted.

6.5 Switching databases

When a database set was updated, the older version will be kept as backup database. With the activate database button it is possible to switch the backup and the active database. The former active database will be kept as backup.

Note:
Be sure that you notify all users to save important data and to log off from the system as they might loose data when switching the database.

6.6 Applying Daily Updates for WIS net Database

6.6.1 Configuration and Manual Run

The WIS net database provides the ability to apply incremental daily updates.

Note:
To use this functionality you need additional files which are supplied via ManageSoft. This is only available if you use the online update mechanism. Additionally your access authorization need to enable this feature in the application.

Picture 10: Start Dialog to configure WIS net Daily Updates

Click on the "Daily Updates..." button to configure the settings for daily updates in WIS net. A dialog will appear and give you additional configuration options. If this button is disabled, the database is not active or the access authorization does not permit the use of daily update data.

Picture 11: Configuration Dialog for Daily Update settings

This dialog provides the following options:

• ManageSoft Path Checkbox: If ManageSoft download client is installed on the same machine like EWA net, this check box will be enabled. Check this check box to use the configured download path from ManageSoft client. If ManageSoft is not installed on this machine, the check box will be disabled. In this case you need to specify the path manually.
• Path: The path selection is disabled if the ManageSoft checkbox is checked. If ManageSoft client is not installed on the EWA net machine, you need to specify the path where daily update files are downloaded to. The specified path must be the root of the ManageSoft download files (usually C:\LauncherCache). The Admin Tool excepts that the specified folder contains a folder "Common" which includes the folders of downloaded packages like "Daily-update_WISnetDocuments_DE", "Daily-update_WISnetDocuments_EN", ...
• Checkbox for Automatic Installation: If this checkbox is marked, the daily import will triggered automatically whenever a new database for WIS net  is installed or a backup database is switched to active database.
• Run Now Button: If you click this button, the daily import will be triggered manually. If this button is disabled, the configuration is not valid. Please select a language and a valid path.

Note:
The configuration for daily updates in Admin Tool does not automatically enable a daily based import of the data. Please take a look to the following chapter how to enable a schedules import by using the Windows Task Scheduler.

6.6.2 Running Daily Imports Scheduled

To run daily imports you need to schedule a job in the Windows Task Scheduler which automatically applies the newest received data to the database. You need to configure manually a Task for running the import (i.e. via
 Start →Programs → Accessories → System Tools → Scheduled Tasks.

The executed task needs to run in the folder [EWA_HOME]\wis_case_online_importer.

The executed command is: bin\run_mimport.bat <path> <language>

<path>: Specifies the path (folder) where the import files are located.

<language>: Language code to import to database. the following language codes are supported:

Example Call: bin\run_mimport.bat C:\LauncherCache\Common\Daily-update_WISnetDocuments_DE d

Notes:
- If you want to import multiple languages, you need to run the script for each of the languages.
- You cannot call the script with arguments in Windows Scheduled Tasks. Therefore the best is to write your own small script which calls the importer for you. Then simply make this script part of your scheduled tasks.

Sample Windows script importing the German and English documentation updates which you may use as a template for own scripts - simply store it anywhere on your disk and make this a scheduled task. The parameters you have to change according to your local installation have been highlighted. Basically you have to configure the correct EWA net installation folder and the directory where your update packages for the daily updates have been stored.

@echo off
cd "C:\Program Files\EWA net\wis_case_online_importer"
bin\run_mimport.bat "C:\LauncherCache\Common\Daily-update_WISnetDocuments_DE" d
bin\run_mimport.bat "C:\LauncherCache\Common\Daily-update_WISnetDocuments_EN" e

6.7 Wiping all Database Content

To wipe out all existing database files for both WIS net and EPC net it is possible to run the EWA Administration tool in a special mode. This mode will remove all installed instances of WIS net / EPC net databases and their metadata.

To clean all databases and all metadata of installed databases run the program and go to the screen of the corresponding application. Hold down the "Ctrl" key which pressing on the "Delete" button of the screen. You need to confirm the question and then all files will be removed.

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

This chapter is mainly intended for System Integrators who want to make use of the batch mode of the Admin Tool to allow further customizing of the installation update process, one may want to make use of the command line features of the EWA Admin Tool.

Note:
EWA Admin Tool has been developed for the “local” environment where all software components will be installed on one single server. In a distributed environment like the “central” not all of the features described here will work.

To get an overview of the available options, just issue the following command on a command line:

“C:\Program Files\EWA net\ewa_admin\EWAAdmin” /?

Picture 18: Help to get Usage Hints for EWA Administration Tool

This overview will not capture all options. Further options will be available here in the documentation

7.1 Database control

Admin Tool allows starting and shutting down the Transbase databases individually without the need of knowledge about the special characteristics behind it. There are currently 3 databases that can be controlled:

• EWA user management database
• WIS net database
• EPC net database

The command line is quite easy. You specify which database you want to operate on and which operation you would like to perform: shutdown or boot. The command line for this is:

EWAAdmin.exe [/core | /wis | /epc] [/boot | /shutdown]

Description:

Example call:

EWAAdmin /wis /shutdown

will shutdown the WIS net database.

Note:
When shutting down databases in most cases it may also make sense to shutdown the application server, too. After doing your maintenance be sure to boot the application server again.
There is no command line in EWAAdmin.exe as this can easily be achieved by issuing the command lines
net stop “EWA net Server”
to stop the application server or
net start “EWA net Server”
to start the application server again. This command must be issued on the server machine where the EWA net application server is running of course.

7.2 Update (Database and Software)

If you want to start an update without the user being forced to start Admin Tool and click some buttons you can easily start the update process from the command line. Simply select the application part you would like to operate on (WIS net or EPC net). Admin Tool will then automatically start the update process for the regarding application.

The command line looks like this:

EWAAdmin.exe [/wis | /epc] [/license licensebits] [/force] [/source Path] [/target Drive]* [/exclude Drive]* [/nofork] [/noswupdate] [/unattended] [/v]

Description:

Note:
When specifying parameters containing special characters like "-" or "/" please quote those parameters.
Example:
Use
EWAAdmin.exe /source "C:\EWA-net"
instead of
EWAAdmin.exe /source C:\EWA-net
The latter one will fail as the commandline parser will think there is another parameter hidden on the commandline.

7.3 Cleanup database

You can remove any installed databases from the system by the command line, too.

The command line looks like this:

EWAAdmin.exe [/clean | /cleanwis | /cleanepc]

Description:

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

When using the update database options in the Administration tool a process is executed which handles the database update. The following steps are processed during a database update:

1. Access authorization check
   The current access authorization from the disk is read out and interpreted. If the access authorization is not valid, the update will stop and an error message will be displayed to the user.
   The interpreted access authorization can be overridden using the /license command line parameter
2. Request for Source Media
   The Administration tool searches for suitable source media. The priority is a source path which was given by command line. If none was specified or nothing was found in this path, the tool looks in all drives for suitable content. If none is found, the user is requested to select a source path or to insert a DVD media.
3. SW and Data Consistency Check
   The program checks if both WIS and EPC are in use. If both applications are used, then the program checks if a software update will also take place with the data update. If an update is also taking place which is not a "hotfix" update, then the user is requested to insert the media of the other application to show that a consistent update with both medias is possible.
   This step is skipped if the flag /noswupdate is issued.
4. Check Update Possibilities
   A small program (ewa\setup\checker.exe) is executed on the source media to check if an integrated data and software update is possible with this database release. Depending on the return code of this application, the process can continue or not.
   If the result of this application shows that the integrated update is not possible and e.g. with this data update also the Administration tool program needs to be updated, the user will be requested to have a longer downtime and run the software setup before updating the databases. Software setup is then called by the tool and after successful update it will be re-launched.
   This step is skipped if the flag /noswupdate is issued. In this case you need to ensure that the database can be installed with the current software version!
5. Read Database Definition
   The database meta information is read by the tool using the descriptor files from the source media.
6. Read Software Version
   The software version information is read from the source media for later purposes.
   This step is skipped if the flag /noswupdate is issued.
7. Database Structure Version Check
   The program checks if the new database has a structure version which is sufficient for the software which is installed. If the version is too old, the update of the database will fail and the program will complain.
8. User Update Confirmation
   The user will be asked to confirm the update to the new database version if this is not the initial database which is installed.
   This confirmation is skipped when running in /unattended mode
9. Update Lock Collision Check
   It is checked if the current active database is the same like the one which will be installed. In this case the user needs to acknowledge the shutdown of the server additionally since the web server needs to be shut down before copying the files to have the database files not locked.
10. File Copy
    All needed database files are copied from the source media to the target drive. The user will be asked for the target drive to copy to.
    The target selection can be skipped using the /target parameter
11. Test Database Files
    The database ROM files which have been copied are tested if copied successful.
12. Integrated Software Update
    If the media contains a newer software release as currently on the disk, integrated software update will be executed.
    This step will be omitted when using the /noswupdate flag. You need to manual run the software update using the command line [Source]\ewa\setup\setup.exe /u.
13. Write Database Information to Registry
    Meta information of the new database is written to system registry.
14. Web Server Shutdown
15. Database Service Shutdown
16. Old Database Detach
    The old databases are going to be detached from the Transbase database
17. Update Registry of Current Database
18. Launch Pre Installation Hook
    If a pre installation hook is specified, this will be launched.
19. Attach new Database to Transbase
20. Launch Post Installation Hook
    If a post installation hook is specified, this will be launched.
21. Remove Old or Incompatible Versions
    Database backup releases which are too old or are not compatible with the new software are removed from disk. Only one backup version is kept.
22. Re-Init Internal Objects
23. Start Database Service
24. Start Web Server
25. Clean disk and remove unused files from hard drive
26. Run actions for Daily Updates (if installation references a WIS net database, access authorization allows this and Daily Update is configured correct)
27. Show Success Message to User

If the update can proceed using a integrated update (when no major software changes are required) the application server will be down between Step 13 and Step 23. This downtime will be usually around 5 minutes. If the update check in step 4 detects that a longer downtime is required, the application will be unavailable from step 4 until step 23.

Pimpmymind Todd Valentine Verbal - Game Academy Verified [better]

If the EWA Administration tool is not working, please use the following steps to determine why the application is not working:

• Check if the application was installed successfully
• Check if enough space is available on the target drive when installing new databases
• Check the log files which are written by the EWA Administration Tool.
  The log files are located in
  “EWA_HOME\install\logs\log.0”