hpcc-systems / hpccinfo

An Info Worksheet (like a spreadsheet) to view HPCC data files and apply simple data manipulation

HPCCInfo

A Workbook (like an Excel workbook) to view HPCC data files and apply simple data manipulation

Requirements

For development, you will only need Node.js and MYSQL Server installed on your environment.

Node

Node is really easy to install & now include NPM. You should be able to run the following command after the installation procedure below.

$ node --version
v8.9.4

$ npm --version
5.6.0

Install

$ git clone https://github.com/hpcc-systems/HPCCInfo.git
$ cd HPCCInfo/server
$ npm install -g bower
$ npm install

PM2 is a production process manager for Node.js / io.js applications with a built-in load balancer. It allows you to keep applications alive forever, to reload them without downtime and to facilitate common system admin tasks.

$ npm install pm2 -g

Execute myql script located in folder HPCCInfo/server/HPCCInfo_schema.sql Update the MySql connection properties in HPCCInfo/server/DBConnection.js

$ cd HPCCInfo/client
$ bower install

Start the application

$ cd HPCCInfo/server
$ pm2 start server.js

Stop the application

$ pm2 stop server

Current Processes

$ pm2 list

More about PM2 commands here http://pm2.keymetrics.io/docs/usage/quick-start/#cheat-sheet

Open Google Chrome browser and enter the url (http://localhost:3000)

NOTE:

We recommed using Google Chrome browser. The application is only being tested using Google Chrome. If you are using any other browser, the application might not run properly.

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

hpccinfo's Issues

Add a button in the left nav top to change the title of the worksheet.

Add a button in the left nav top to change the title of the worksheet.

HPCC Info icon

Use the HPCC Icon on the main workbook page

Add new landing page

Add new landing page. The user should be able to sign-in using their google account details.

Grid UI enhancements.

1. Upgrade to vaadin-grid 2.x version
2. Make Headers bold and Center Align
3. The user should be able to sort by clicking on the column header

GRID UI Issues

1. Grid does not stretch to the maximum available space
2. Make Headers bold and Center Align
3. The user should be able to sort by clicking on the column header

Integrate google auth

Separating Editor and View into individual files

Create separate files for each Plugin editor and view and under a plugin name folder. This is what i am thinking:

When someone wants to create a new plugin they will create a plugin-name folder and editor and view files. This will provide clear separation of plugins from the base code as well as more robust code organisation.

Buttons not enabled/disabled correctly

1. Share Project button must be disabled when you log-in.
2. Edit Worksheet button must be enabled once the user opens an existing project.

Validation workflow for New Worksheet is incorrect

If validation fails on the new workbook workflow, an alert is displayed but it still creates a workbook. Should display the new workbook screen again. In fact do not even close the new workbook screen unless the validation passes.

Add a Delete button to a tab

Currently there is no way to delete a tab once it has been added. Need to be careful in one situation where the user is trying to delete an in-between tab which might affect the current project workflow.

Tab selection not shown

The current selected tab looks like any other tab

Add Save worksheet button

Need to have a button on the main page where the user can Save his current worksheet.

Migrate old UI

Migrate the old UI with Headers, Cluster properties and input data

Modify the application structure to add NodeJs Server

Modify the application structure to use NodeJS server. Separate the codebase into client and server modules. All Polymer dependencies should be under client/ and node dependencies should be under server/

When a new workbook is opened, the left drawer should be closed

Add Bar chart plugin to display data

Create a Bar chart plugin so that the user can visualize the data as a bar chart

Buttons not aligned

Grid enhancements

The user should be able to perform the following operations in grid.

1. Select a single/multiple rows and copy.
2. Select single cell and copy.

Always validate that the HPCC connection info is set before enabling the Open Workbook or New Workbook

Visual changes for better user experience

List of things to do:

1. By default, if the user has not used Info before, the workspace will be populated with a tab called ‘Input’. It will have a message (in the place where the data is shown) saying ‘Please use the edit button to select an input file’.

2. In the left navigation where the cluster details are shown, show an apply button if the user changes any of the cluster details.

3. On clicking new worksheet, accept the title. On click of OK, delete the existing tabs and add a new tab called “Input”. Follow the rest of step 2 above.

Clicking plugins should be disabled until the 'Input' file is selected

Clicking plugin should be disabled or a pop up message should be shown when a users tries to create a new plugin.

Rename worksheet to workbook

New Worksheet workflow is prompting userid/password multiple times

New Worksheet workflow is prompting userid/password multiple times

Add validation for all input forms

Add validation for all input forms

Add Db Script

Create a database script.

Change IRON-AJAX to JSONP to support for secured cluster

as IRON-AJAX does not support the cross domain web call, change it to JSONP

JS error when adding sample plugin

JS ERROR: Uncaught TypeError: view.editor.open is not a function

DOMException when adding Plugins

DOMException when adding Plugins. This maybe caused because of changing the PluginId field from disabled to editable. Refer issue #13 as to why this was implemented.

Open worksheet dialog box should be formatted as the same as other dialog boxes

OK and Cancel buttons are floating

No need to display Project Name/ID field to the user in the Open Workbook

Add a Visual indicator when grid is loading

Add a Visual indicator when grid is loading. Common scenario include:

1. Long running jobs
2. WU is queued

JS Error when adding a value field on edit plugin

Javascript Error: Cannot read property 'hasAttribute' of undefined.

This error happens only the first time when tries to enter value in the edit plugin dialog.

Consistent title labels for dialog boxes

Use Camel Case

On edit of any tab, provide an input to change the title of the tab

On edit of any tab, provide an input to change the title of the tab

Make the entire "Open Workbook" and "New Workbook" links linkable (not just the icon)

Set the default cluster setting in database for each user

Add a default cluster setting in database for individual user. If the user has never used HPCCInfo, it will be configured to work with the default cluster.

Saved project is opened after re-login, due to caching issues.

Saved project is opened after re-login, due to caching issues.

Add Google Authentication

Implement the google authentication API so that the user can login with his google account.

https://www.webcomponents.org/element/GoogleWebComponents/google-signin/google-signin-aware

Change the landing page description

TO: A Workbook (like an Excel workbook) to view HPCC data files and apply simple data manipulation

Add connection validation when new connection info is added and saved

Save and retrieve a project

We should be a able to save and retrieve a project from db. The data needs to be passed onto the client in JSON format. So we will need to write a wrapper to convert the data retrieved from db into JSON format.

Open Workbook dialog not formatted correctly

Hide Project ID field on Open Worksheet Dialog

Since this is a program generated field, it will not be useful to the end user

Project changes are not getting saved

Project changes are not getting saved when you open an existing project, modify it and save it. The changes are not getting saved in the database.

Save Cluster button needs to be update user if details are saved

When the user clicks on the Save Cluster button it should show the message to user if the details are saved or not

Footer text not aligning properly on large screens

Footer was not aligning properly on larger screens. Change it to FLEX layout.

Change the Toolbar color to match the Landing Page

Change the Toolbar color to match the Landing Page

Input as Super File is not working

Choosing the superfile in the input editor, does not show the data.

Change the HPCC Info title to include the logo

to

and add the title if it exists like "HPCC Info - [title]"

Open worksheet is throwing JS exception

Open worksheet is throwing JS exception 'Cannot read property 'FileDetail' of undefined' when trying to open a worksheet