Open Data Tool User Guide

Version 1.0 December 20, 2013

Contents

Introduction Tool Limitations [Installation] (https://github.com/wet-boew/wet-boew-wpss/wiki/_preview#installation) System Requirements Remove Existing .pl File Associations Installing the WPSS Open Data Tool Uninstall Uninstalling Perl Uninstalling Python Using the WPSS Open Data Tool Open Data Tab Configuration Tab Profiles Results Window Stopping the Analysis Reporting Passes and Fails Saving Results Command Line Interface Status and Progress Viewing Results Language Switching Troubleshooting Perl Command Line Interpreter Error 500 Internal Server Error Test Cases OD_1 - Open data URL OD_2 - Character encoding requirements OD_3 – Mark-up language requirements OD_CSV_1 – CSV Data OD_TXT_1 – TXT Dictionary OD_API_1 - Open data URL OD_API_2 - Character encoding requirements OD_API_3 – Mark-up language requirements TP_PW_OD_CSV_1 – CSV Header Row

Introduction

The PWGSC WPSS Open Data Tool provides a method to perform tests on datasets and dictionaries being submitted for the Open Data Registry to ensure they are compliant with Open Data standards. The WPSS Open Data Tool reviews all of the documents and analyses each one for Treasury Board compliance.

Tool Limitations

The output of the Open Data Tool is in English only. The tool is using third party software components. The source of these components is available only in the language that it was authored.

Installation

The WPSS Open Data Tool requires a Perl distribution installed on the workstation, and .pl files are associated with the Perl interpreter. The WPSS Open Data Tool has been tested with Strawberry Perl 5.18.1 and ActivePerl 5.14. Other versions of Strawberry Perl or ActivePerl, or other Perl installations may not work as expected or may be missing required modules.

System Requirements

• Microsoft Windows XP or Windows 7,
• Java runtime environment 1.6.0 (other versions may not work),
• Python version 2.7.3 or 2.7.6,
• Strawberry Perl 5.18.1 or ActiveState Perl 5.14 (does not support 5.16),
• Only one installation of Perl on the system. Multiple installations may cause problems.

If you do not have the Perl or Python, you will need to install them manually. You can find installations at:

• Python 2.7.6 available from http://python.org/ftp/python/2.7.6/python-2.7.6.msi
• Strawberry Perl 5.18 (32 bit) available from http://strawberry-perl.googlecode.com/files/strawberry-perl-5.18.1.1-32bit.msi
• ActiveState Perl 5.14 http://www.activestate.com/activeperl/downloads

For the Perl and Python installs, accept the default settings during the installation process.

Remove Existing .pl File Associations

Before installing the WPSS Open Data Tool, remove any existing .pl file type associations. The installation of Strawberry Perl or ActivePerl will create a new association to ensure the proper execution of Perl applications.

To remove the .pl file association:

1. Go to Start > Settings > Control Panel.
2. Click Folder Options.
3. Click the File Types tab.
4. In the Registered file types list, locate and click the .pl entry.
5. Click Delete.
6. Click OK.

Installing the WPSS Open Data Tool

To install the WPSS Open Data Tool, double-click the WPSS_Install.exe file and follow the instructions on the screen.

The default installation folder for the WPSS Validation Tool is C:\Program Files\WPSS_Tool.

Uninstall

To remove the WPSS Open Data Tool from a workstation, run the uninstall script.

To uninstall the Open Data Tool:

Go to Start > Programs > WPSS_Tool > Uninstall.

Uninstalling Perl

To remove the Perl installation:

1. Go to Start > Settings > Control Panel.
2. Click Add or Remove Programs.
3. Locate the Strawberry or ActivePerl installation and click Remove.

Uninstalling Python

To remove the Perl installation:

1. Go to Start > Settings > Control Panel.
2. Click Add or Remove Programs.
3. Locate the Python installation and click Remove.