the world remembers ndsa technical guide - mac.pdf

8/10/2019 The World Remembers NDSA Technical guide - MAC.pdf

1/28

THE WORLD REME MBERS 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 MAC OS X

1 ABOUT THIS SOFTWARE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

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

2 REQUIREMENTS: WHAT YOU WILL NEED FOR THE WORLD REMEMBERS NAME DISPLAYSOFTWARE .. . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . 4

2.1 CHOOSE THE RIGHT COMPUTER FOR JOB AND PREPARE IT FOR USE............................................................ 4

3 INSTALLING MONO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . 5

4 THE NAME DISPLAY SOFTWARE MANUAL MODE AND TIMED MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.1 USING MANUAL - MODE ................................................................................................................................ 12

4.2 RUNNING MANUAL MODE (USE ONLY FOR TESTING) .................................................................................... 13

5 RUNNING THE TIMED MODE DISPLAYPLEASE USE THE TIMED MODE FOR YOUR FINAL NAMES DISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

5.1 MANUALLY STARTING A TIMED MODE DISPLAY .......................................................................................... 16


2/28

2


THE WORLD REMEMB ERS LE MONDE SE SOUVIENT 19181914

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 doesnt use the Internet in order

to run.

This guide lists out the steps to create The World Remembers Names Display (NDSA) on a Mac using OS

X.

1.1

TWO NDSA VERSIONS

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

IRELANDThis 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.


3/28

3



GENERIC VERSIONThis version isnt 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.


4/28

4



2 REQUIREMENTS: WHAT YOU WILL NEED FOR THE WORLD

REMEMBERS NAME DISPLAY SOFTWARE

1.

A Copy of the Name Display Software Application

If you dont have a copy on a USB drive, you can download the Name Display Software Applicationfrom 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.

MONO Software

Before the application can be run on Mac OS X, the Mono platform (http://www.mono-

project.com/Start) must be installed. Mono allows applications created using Windows based .NET

framework run on other platforms e.g. Mac OS X, Ubuntu.

3.

MAC OS X and a Working Browser

The Names Display Software Application requires a Mac running at least OS X, and a modern

Browser such as Safari (Safari is recommended for Mac OSX), Firefox, or Chrome. The browser

should be in full screen mode activated by using the F11 key

4. 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 computers

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

Dont use the computer for any other purpose when the display is not running.

Once youve installed the software, the computer shouldnt be connected to the Internet at

all, either wire or wireless connection, otherwise this will interfere with the display 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 anyother 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 computers processing power and can also restart a


5/28

5



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 dateEnsure 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.

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.


6/28

6



3 INSTALLING MONO

In order for the NDSA Software to work on a Mac OS X computer, MONO Software must be installed.

Mono helps Mac computers read the .NET technology that the application was created in, so it works

somewhat like a translation tool.

If Mono is not installed then it must be installed in order for the NDSA to function. Please follow these

steps to install Mono on a Mac OS X computer.

1. Open a browser and go to http://www.mono-project.com/download/

2.

Select Mac OS Xas the platform, and click the Download Mono MREbutton.

Clicking on Download Mono MREwill download a file called MonoFramework-MRE-

3.6.0.macos10.xamarin.x86.pkg to your local computer.

3.

Open this package file by double-clicking the file.

Press Continue


7/28

7



Press Continue again and Agreeto the software license agreement.

Press the Installbutton


8/28

8



You will need to put in an Administrators Name and Password to install MONO.

The Installation should be successful.


9/28

9



CHECK TO SEE IF MONO IS INSTALLED CORRECTLY

To check if Mono is installed correctly open up a Terminal window by going to the Applications folder

expanding the Utilities, folderand double-clicking onTerminal. Once Terminalis open, type the

following command: mono -- versionand press enter.

If Mono is installed then you should see the MONO version details show up in the Terminal window.

If you see this information, Congratulations! You have installed MONO software. The next step is

installing The World Remembers NDSA software.


10/28

10



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

Documents/NDSA. You should end up with something like the following screenshot.

This may look like a lot of files but dont worry. Anything with the extension *.dllare needed so

that the application can run. The only file that you need to worry about is the one called

HostApplication.exe. Unfortunately because were not on a Windows environment, we cant justdouble-click this file. We have to run this file on the MONO platform.

3. Open up a Terminal Window

Go to Applications > Utilities > Terminal

4.

In Terminalchange the directory to the directory where the NDSA files were copied to in step 2.

For example, if the NDSA folder is in Documents then you would type in cd Documents/NDSA


11/28

11



5.

To run the hosting application on the mono platform, type in the command mono

Hostapplication.exe.

6.

This window references the URL (http://localhost:3579). The software has now started and is

running locally on your local computer with port 3575.

Dont close Terminal!

Please note that the software will not function if the Terminal window is closed, so it

should be left open at all times when the display is running because it is running via

MONO using Terminal. If you shut Terminal it must be restarted again with steps 4 and 5above in order to display properly.


12/28

12



4 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

and

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.

4.1 USING MANUAL - MODE

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).

1.

Open a web browser on your computer and browse to http://localhost:3579

2.

Click on the Configurationmenu option in the top right corner of the browser. The following

page will be displayed:

The NDSA consists of 3 pages:

1.

The homepage http://localhost:3579

2.

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

3.

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


13/28

13



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 CONFIGURATIONDay 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 youd 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


14/28

14



4.2 Running Manual Mode (use only for testing)

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

Idand Frame Indexchange.

4.

Click the Load Databutton 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 Runbutton.

5.

Click on the Runbutton.


15/28

15



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

CONFIGURATIONback to Day Id: 1 Frame Id: 1


16/28

16



5 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 TIMED 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 of the following 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 each day 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.

5.1 Manually starting a TIMED Mode Display

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 issues such as a

power failure, your computer restarts, of if computer is powered on after the daily scheduled start time.

These steps will you to manually start a TIMED mode NDSA.

1.

Start the HostApplication.exe by following the steps outlined in section 4, steps 4 6.

2.

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


17/28

17



The NDSA consists of 3 pages:

o The homepage http://localhost:3579

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

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

3.

Click on the Configurationmenu 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 DISPLAYDay 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


18/28

18



Click Submit. You will be presented with a Loadbutton. Clicking on this button will load the data for

the configured day into the application. This data will then be used for that days display.


19/28

19



When the database is loaded, you will see Runbutton. Clicking on the Runbutton will start the

display at the correct frame for the current date and time.


20/28

20



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 thePrologue 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.


21/28

21



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 thendsa 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 Mac OS X 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

following steps outline the process that must be completed in order to create the NDSA scheduled tasks on

a Mac OS X computer.

There are two Apple scripts included among with the NDSA application files.

If the NDSA was extracted to a folder located at Documents/NDSA, as outlined above then these files

will be located at Documents/NDSA/Scripts/Mac.

1. Update the Start.scpt file to the correct file path

The Start.scpt file points to the file path that the HostApplication.exe. Using a text editor like

TextEdit, you can open the Start.scpt file to point to the correct location. For example, of the

NDSA.zip file was extracted to Documents\NDSAthen you would change the highlighted part


22/28

22



below to whatever the file path is where the HostApplication.exelives.

do script "cd Documents/Applications/TWR/NDSA; mono

HostApplication.exe;"

Once you have updated the location, then save the Start.scpt file.

2.

To create scheduled tasks using Macs Calendar application (iCal), the scripts must first beconverted into applications so that the iCal application can then schedule the new applications.

3.

To convert the scripts to applications use the Automator application. Open iCal: Applications >

Automator

4.

Select Applicationfrom the type of document selector and click Choose.


23/28

23



5.

Select the Utilitiesitem from the left hand menu. Drag Run AppleScriptfrom the right hand

menu to the content pane. This action will then allow you to paste the contents of the Start.scpt

file into the content pane.

6.

Name the application Start NDSA and save the application in the same location as the Start.scpt

and End.scptscripts.


24/28

24



7.

Repeat the process for the End.scptfile

8.

Name the application End NDSAand save it to the same location


25/28

25



9.

Both applications should now be created and stored in the same location as the script files.

10.

These applications can now be scheduled using the iCal application. Open iCal: Applications >

iCal

11.

Navigate to the month of October

12. Click on the 20th

of October to select the day

13.

Create a new event on the selected day: File > New Event

14.

A New Event panel will appear; in this panel:


26/28

26



15.

Change the name to Start NDSA.

16.

Set the From and To dates to 2014-10-20 07:30 PM (07:30AM for schools).

17.

Click on the Nonenext to the repeatlabel.

18.

Select Every Dayfrom the menu.

19.

Click on the Nevernext to the endlabel.

20.

Set the date to 2014-11-10 07:30 PM (07:30AM for schools).

21. Click on the Nonenext to the alertlabel.

22. Select Customfrom the alert menu.

23.

Select Open Filefrom the Custom dialog. Then select Otherfrom the menu

24.

An open dialog will appear; select the Start NDSA application to run.

25.

Click on the 15 minutes before.

26.

Select At time of eventfrom the menu.

27.

A new date and time control will now appear. Change this date and time control to 2014-10-20

07:30 PM (07:30AM for schools).


27/28

27



28.

The event should now be scheduled and the iCal application shows this.

29.

Repeat the process for the End NDSAapplication. This time setting the name of the task to End

NDSA, the From and To dates to 2014-10-21 07:15 AM, the end date to 2014-11-11 07:15 AM,

select the End NDSAapplication as the file to open and the on date field to 2014-10-21 07:15

AM. For schools the From and To dates should be set to 2014-10-20 07:15 PM, the end date to

2014-11-10 07:15 PM, select the End NDSAapplication as the file to open and the on date field

to 2014-10-20 07:15 PM.

30.

After all of these fields have been set the configuration of the task should look like the following


28/28


31.

Both tasks should appear in the calendar.

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 schoolcoordinator.

Thank you for taking part in this unique WWI Centenary Commemoration.