The World Remembers NDSA Technical guide - WINDOWS.pdf

THE WORLD REMEMBERS — LE MONDE SE SOUVIENT 19181914

33 PRINCE ARTHUR AVENUE, TORONTO, ON M5R 1B2 | WWW.THEWORLDREMEMBERS.CA | WWW.LEMONDESESOUVIENT.CA

TECHNICAL GUIDE FOR THE NAMES DISPLAY SOFTWARE APPLICATION (NDSA)

Basic Technical Steps to Create The World Remembers Names Display in Your School or Organization

FOR WINDOWS 8

11 AABBOOUUTT TTHHIISS SSOOFFTTWWAARREE .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. 22

1.1 TWO NDSA VERSIONS ....................................................................................................................................... 2

22 RREEQQUUIIRREEMMEENNTTSS:: WWHHAATT YYOOUU WWIILLLL NNEEEEDD FFOORR TTHHEE WWOORRLLDD RREEMMEEMMBBEERRSS NNAAMMEE DDIISSPPLLAAYY SSOOFFTTWWAARREE .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. 55

2.1 Choose the right computer for job and prepare it for use .............................................................................. 5

33 TTHHEE NNAAMMEE DDIISSPPLLAAYY SSOOFFTTWWAARREE –– MMAANNUUAALL MMOODDEE AANNDD TTIIMMEEDD MMOODDEE .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. 88

3.1 USING MANUAL - MODE ................................................................................................................................... 8

3.2 Running Manual Mode (use only for testing) ................................................................................................ 11

44 RRUUNNNNIINNGG TTHHEE TTIIMMEEDD MMOODDEE DDIISSPPLLAAYY-- PPLLEEAASSEE UUSSEE TTHHEE TTIIMMEEDD MMOODDEE FFOORR YYOOUURR FFIINNAALL NNAAMMEESS DDIISSPPLLAAYY .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. .. 1133

4.1 Manually starting a TIMED Mode Display ..................................................................................................... 13

4.1.1Task Scheduler .............................................................................................................................................. 18

2 33 PRINCE ARTHUR AVENUE, TORONTO, ON M5R 1B2 | WWW.THEWORLDREMEMBERS.CA | WWW.LEMONDESESOUVIENT.CA


1 ABOUT THIS SOFTWARE

The NAMES DISPLAY SOFTWARE APPLICATION (NDSA) is lightweight software application and database that creates a timed display of the names of the thousands of soldiers who lost their lives in the First World War. The software can be installed on multiple computers and doesn’t use the Internet in order to run. This guide lists out the steps to create The World Remembers Names Display (NDSA) on a Windows computer.

11..11 TTWWOO NNDDSSAA VVEERRSSIIOONNSS There are two different versions of NDSA and you will be provided with the version appropriate to your country. The installation and operation of the two versions are identical. COUNTRY-SPECIFIC VERSION FOR CANADA, THE UNITED KINGDOM, TURKEY, GERMANY AND IRELAND This version is configurable for a specific country. Names from the specific country will appear in the centre of the display area in the National Names Area with the international names appearing in the surround.



GENERIC VERSION This version isn’t specific to any country. This version shows all names from all participating countries. The title that is shown when the software runs (1914 – Centennial - 1918) will appear in the languages of all participating countries.





2 REQUIREMENTS: WHAT YOU WILL NEED FOR THE WORLD REMEMBERS NAME DISPLAY SOFTWARE

1. A Copy of the Name Display Software Application (NDSA) If you don’t have a copy on a USB drive, you can download the Name Display Software Application from The World Remembers website http://www.theworldremembers.ca. You will need the specific password that we provided when you registered with us for the download of the NDSA. This password is specific only for the software download.

2. A Working Browser The Name Display Software Application requires Windows, and a modern Browser such as Internet Explorer, Firefox, or Chrome. The browser should be in full screen mode activated by using the F11 key.

3. Computer Permissions: Administrative Rights

To install the Name Display Software Application, you must have administrative rights (the password) to the computer on which you are installing the software. You will be changing the computer’s configuration, so ideally you should have some comfort with technical administration tasks.

2.1 Choose the right computer for job and prepare it for use

• Choose a computer that is available for 22 days full time Given that The World Remembers NDSA will run for an extended period of time (22 days in 2014), it is required that certain automatic processes on the display computer be disabled so that they do not interfere with the display of the names of the World War I soldiers that lost their lives.

• Your computer must be a dedicated computer for the duration of the display Don’t use the computer for any other purpose when the display is not running.

• Once you’ve installed the software, the computer shouldn’t be connected to the Internet at all, both wire or wireless connection, otherwise this will interfere with the program After you install The World Remembers NDSA, your computer must not be connected to the internet or internal network during the duration of the display. This includes both cable and wireless connections. In fact, the wireless connection on the computer should be disabled to ensure that it cannot be accessed online. Any cable connections should be removed. The names display software application (NDSA) can be installed on your computer using a USB stick or any other removable media.

• Disable the screensaver on your computer The screensaver on your computer should be disabled on the computer. This will prevent the screensaver from interrupting the display.

• Disable any automatic updates. Automatic updates can take over your computer’s processing power and can also restart a machine depending on its settings. It is best to disable the updates during the whole duration of the display. Updates can be re-enabled later.



• Set the display computer to never sleep and never power off. This will prevent the display from turning off mid-way through the names display. Your computer may be turned off after a display is over each day but it should be turned back on before the official start time of the display each day.

• Make sure your computer is set to the right time and date

Ensure that your computer clock reflects the correct time and date for where you are located. There will a daylight savings time shift during the 2014 display days. Please ensure that the clock on your computer is changed to the correct time on the day of the shift.

• All windows machines should have their theme changed to a Windows Classic theme. The reason

for this update is because of a bug in Internet Explorer (when operated in full screen mode) results in a 1 pixel line appearing at the bottom of the screen when Windows is set to use an Aero theme.

• If the NDSA application is in timed mode and is to be executed using scheduled tasks then the

default browser of the computer should be set to Internet Explorer.

Now that you have prepared your computer for use, we are ready to install the application. Upon completion of these installations and disabling computer functions that may interfere with the Display, you will be able to test the NDSA in MANUAL setting. After a successful test, you will be ready to run the NDSA on the TIMED setting for the commemoration. Please follow these instructions carefully to ensure success.



INSTALLING THE WORLD REMEMBERS NDSA

1. Copy the NDSA.zip file (from a USB stick or other removable media) to a location on the display computer.

2. Extract (copy) the contents of the file NDSA.zip onto your computer, e.g. a directory such as C:\NDSA.

The only file that you need to worry about is the one called HostApplication.exe. This is the program that turns your computer into a mini web server in order to display the names during the commemorative event.

1. Make sure that you are logged in as an Administrator. Open a command prompt by click on the Start button and then type cmd into the search box.



2. Once a Command prompt is open, type in the following command: netsh http add urlacl url=http://+:3579/ user=Everyone . This opens up a port in which to run the mini web server on.

3. Double click on the file HostApplication.exe. It will open a console window

3. The command prompt will reference the URL (http://localhost:3579). The software has now started and is running locally on your local computer on port 3575. Don’t close the Command Prompt

• Please note that the software will not function if the Command Prompt window is closed, so it should be left open at all times when the display is running. If you shut Command Prompt it must be restarted again with steps 4 and 5 above in order to display properly.

3 THE NAME DISPLAY SOFTWARE – MANUAL MODE AND TIMED MODE

The Name Display Software Application has two modes, MANUAL and TIMED. MANUAL MODE: For Testing. MANUAL mode will allow for testing the application on your computer. After testing is completed the MANUAL version can be removed from your computer and the TIMED mode version installed. TIMED MODE - will be used for the live display. TIMED mode will run automatically. You can schedule this application to as an automatic task on your computer; you will be able to run it automatically every day of the entire 22 days of the commemoration. Instructions on how to do this are below.

33..11 UUSSIINNGG MMAANNUUAALL -- MMOODDEE



The MANUAL mode of the NDSA is used for testing to ensure it will work before the start of the commemoration. In MANUAL, you can manually manage the application and decide which data should be displayed. You can select the day and frame index that the display should start at. In MANUAL mode the display will always pick up from where it left off (for example, if the host application is closed it will start from when it last stopped).

The NDSA consists of 3 pages:

o The homepage – http://localhost:3579

o The configuration page http://localhost:3579/config

o The display page http://localhost:3579/display

1. Open a web browser on your computer and browse to http://localhost:3579 2. Click on the Configuration menu option in the top right corner of the browser. The following

page will be displayed



MANUAL CONFIGURATION SETTINGS As this software will have thousands of names, and will be run on multiple days, there will be names output on multiple frames for each given day. VALUES FOR MANUAL CONFIGURATION Day Id The Day on which the data will be shown Frame Index The Frame / Screen that should be shown for the given day (i.e. Frame 1

equals, the first page of names displayed) Reset Configuration

Used to set the configuration values back to Day Id: 1, Frame Id: 1 after you finish testing in Manual Mode. When you select Reset Configuration, the Reset Button appears.

Manually Set Configuration

Selecting this will allow you to choose the day and frame that you’d like to start your Name display Manual Test. You will be prompted to put in a Day and Frame

Load the Data Clicking on the Load button will load the data from the local database file



33..22 RRuunnnniinngg MMaannuuaall MMooddee ((uussee oonnllyy ffoorr tteesstt iinngg)) To ensure that your Name Display Software Application is working correctly, run multiple tests prior to using it for The World Remembers event.

1. Select the radio button MANUALLY SET CONFIGURATION

2. You will be prompted to put in a Day Id and Frame Index (be sure to try multiple days).

3. Press Submit You should see a green message that says “Configuration values saved” and the values under Day Id and Frame Index change.

4. Click the Load Data button to load the database with the right values. It should take a few moments. When the database of names is loaded, you will see the Run button.

5. Click on the Run button.



You will see the names displayed (Note: The screenshot below shows test data)

6. To complete the test or to try a new test. Go back to the page http://localhost:3579/ and reconfigure a new test. When you have completed your testing, make sure to RESET THE CONFIGURATION back to Day Id: 1 Frame Id: 1



4 RUNNING THE TIMED MODE DISPLAY- PLEASE USE THE TIMED MODE FOR YOUR FINAL NAMES DISPLAY

The TIMED mode of the NDSA will be the mode used for the final display at all display locations. When the NDSA starts up (and is configured in this mode), it will check the current computer time and go to the database to get the frame that matches that date and time. The display will then display all frames in sequence. If the application shuts down for any reason and is then restarted, the display will once more get the frame that is assigned to the current date and time and then continue from there. You may Manually start a TIMED Mode Display or set it as a ‘scheduled task’ so that your names display is fully is automated over the entire 22 days of operation in 2014 and will not need an operator each day.

44..11 MMaannuuaall llyy ssttaarrtt iinngg aa TTIIMMEEDD MMooddee DDiissppllaayy When the NDSA is operating in timed mode, it will need to be manually shut down at the end of each display day and restarted for the next display day. You can also use these steps if there are any issues e.g. power failure, computer restarts, computer is powered on after the daily scheduled start time etc. These steps will you to manually start a TIMED mode NDSA.

1. Run the HostApplication.exe application by double clicking on it.

2. Open a browser and browse to http://localhost:3579



• The NDSA consists of 3 pages:

o The homepage – http://localhost:3579

o The configuration page http://localhost:3579/config

o The display page http://localhost:3579/display

3. Click on the Configuration menu option in the top right corner of the browser. The following page will be displayed

4. As this software will have thousands of names, and will be run on multiple days, there will be names output on multiple frames for each given day.

VALUES FOR TIMED MODE DISPLAY Day Id The Day on which the data will be shown Frame Index The Frame / Screen that should be shown for the given day (i.e. Frame 1

equals, the first page of names displayed) Set Configuration by Time

This option will set the configuration values based on the current system time To set the values based on the system time.

Load the Data Clicking on the Load button will load the data from the local database file Run Clicking on the Run button will run the display



5. Click Submit. You will be presented with a Load button. Clicking on this button will load the data for the configured day into the application. This data will then be used for that day’s display.



6. When the database is loaded, you will see Run button. Clicking on the Run button will start the display at the correct frame for the current date and time.



WHAT IF NOTHING HAPPENS? This software is configured to run during a certain period of time. The dates for the display are October 20th 2014 to November 11th 2014. The display time each day is from 7.30pm to 7.15am, for schools the display time is 7.30am to 7.15pm. Please remember that the first hour consists of an operational text screen for 40 minutes, followed by the Prologue Image for 20 minutes. We suggest the public viewing starting only when the Prologue Image is seen. This means that the first names will appear at 8.30pm (for schools the first names appear at 8.30am). If you get a Day ID: 0 and Frame Index: 0 then it is likely that your system time is not within the commemoration period.



FOR ADVANCED USERS RUNNING THE SOFTWARE AS SCHEDULED TASK – This requires some sophistication on using your computer. If you do not want to attempt this option you can run the final names display on the timed mode but you will have to manually close the browser and the NDSA at the end of each display day then restart the NDSA for the next display day using the steps outlined in section 4.1. This will have to be done for each of the display days from October 20th 2014 to November 10th 2014. A reminder that the display time each day is from 7.30pm to 7.15am and for schools the display time is 7.30am to 7.15pm. The browsers and hostapplication.exe will then have to be manually closed at the end of the display in preparation for the next day. But you can run the Name Display Software as a scheduled task on Windows so that it will run automatically. The benefit is that the NDSA display will be fully automatic (i.e. the display will automatically start at a certain time each day and will shut down at a certain time each day). The TIMED mode NDSA will be managed by scheduled tasks that will have to be created on all display computers. The creation of scheduled tasks will result in the NDSA display being fully automatic (i.e. the display will automatically start at a certain time each day and will shut down at a certain time each day).

4.1.1 Task Scheduler Task Scheduler is a component of Microsoft Windows that provides the ability to schedule the launch of programs or scripts at pre-defined times. There are 2 batch file scripts included in the NDSA application. If the NDSA was extracted to a folder located at C:\NDSA, as outlined in section, then these scripts will be located at C:\NDSA\Scripts\Windows.

1. Ensure that the scripts Start.bat and End.bat are present in the NDSA application



2. If the NDSA was extracted to any folder other than C:\NDSA then the Start.bat script will have to be updated to reflect this. To alter the path, open the Start.bat file in Notepad and change the first line (START C:\NDSA\HostApplication.exe) by replacing the C:\NDSA with the path to folder where was installed to. For example, if you installed the NDSA to C:\Applications\TWR\NDSA then you would change the first line of Start.bat to START C:\Applications\TWR\NDSA \HostApplication.exe. This is the only script change required. Save the Start.bat file.

3. Two separate scheduled tasks must be created. One to start the NDSA and the other to shut down the NDSA at the end of the display.

4. Go to Start -> All Programs -> Accessories -> System Tools -> Task Scheduler to open the Task Scheduler Management console.



5. Right click the Task Scheduler Library node and select Create Basic Task from the context menu that appears. This will open the task creation wizard.

6. Enter Start NDSA as the name of the task. Click Next.

7. Select Daily as the trigger. Click Next.

8. Set the start date to October 20th 2014. Set the time to 7.30PM (7.30AM for schools). Set the task to recur every 1 days. Click Next.

9. Select Start a program as the action. Click Next.



10. You must now select the Start.bat file as the program by browsing to it on your local machine. If

the NDSA is installed to C:\NDSA then this would look like the following

11. Clicking on Next will bring up a summary screen that lists all of the settings for the task. Review the settings in this window



12. Click Finish to create the task. The newly created task should now appear in the list of tasks in the Task Scheduler Management console.

13. Steps 1 to 11 should be repeated in order to create the task that will shut down the NDSA every day after the display has finished. This time set the name to be End NDSA, the start date to be October 23rd 2014 (October 22nd 2014 for schools), the time to 7.15AM (7.15PM for schools) and set the program to be the location of the End.bat script file. When all of these settings are complete, the summary page should be similar to the following



14. After this task has been created the list of tasks in the Task Scheduler Management console should list both tasks

15. Once the display has fully completed i.e. November 11th, the task should be disabled. Do this by right clicking the task in the Task Scheduler Management console and selecting Disable from the context menu.

THANKS! Congratulations, you have successfully installed The World Remembers NDSA on your computer and you will now be ready to:

A. Test the NDSA at your display location B. Run your 2014 names display

We can make Tech support available if you need it. Contact us through the website or through your school coordinator Thank you for taking part in this unique WWI Centenary Commemoration.

Documents

The World Remembers NDSA Technical guide - WINDOWS.pdf