Version 1.4.0

Date Released: 4/18/2022

Version 1.4.0 release focuses on improvements in filtering, data import and export.

The Net.Create database/file data format has changed significantly with 1.4.0 so pre-1.4.0 data (*.loki) and template (*.json) files are no longer compatible.

Key Features

See the wiki and pull requests for details:

• #169 Filters
• #179 Export Data
• #217 Import Data
• #198 Flattened Data Format
• #194 TOML Template Editor
• Misc Changes

Filters

A new "Filters" panel allows you to:

• "Highlight" nodes and edges -- will show nodes and edges that match the criteria and "fade" nodes and edges that do not match the criteria, retaining the original shape of the graph.
• "Filter" niodes and edges -- will show nodes and edges that match the criteria and "hide" nodes and edges that do not match the criteria, redrawing the graph so that hidden nodes and edges do not change the shape of the graph.

Export Data

Currently visible nodes and edges can be exported to a comma-delimited .csv file. Nodes and edges are exported to separate files.

See Export Data for more information.

Import Data

Nodes and edges can be imported into the currently open graph via comma-delimited .csv files.

See Import Data for more information.

Flattened Data Format

The original Net.Create data format was based on the Google Fusion export format that encapsulated arbitrary fields in an attributes object. When reading and writing data, we converted back and forth between an internal representation which used a flat set of variables (e.g. node.type) to the encapsulated format (e.g. node.attributes.NodeType). This added unnecessary complexity to data handling, especially with regards to exporting, importing data and template streamlining.

With the implementation of exporting, importing, and template improvements, this seemed a natural time to also update the data format. It would simplify the implementation of those features.

Opening a pre-1.4.0 project should automatically convert it to the 1.4.0 format.

See Database Versions for more information.

TOML Template Editor

Prior to Version 1.4.0, project templates were stored as *.json files. While json files are convenient for early prototyping, they are difficult for novices to edit. With 1.4.0, we have converted the template files to a TOML format, which is easier to read and edit, AND, we have added a JSON editor.

Opening a pre-1.4.0 project and project template should automatically convert them to the 1.4.0 format.

See Using Templates for more information.

Misc Changes

See also commits by JDanish dated between Oct and Dec 2020 for miscellaneous changes.

Version 1.3.1

Date Released: 9/17/2020

Version 1.3.1 release focuses on performance optimizations, especially around network #129

Network Reliability Reporting

To improve the use of Net.Create on low-quality networks:

• Extend the wait time for heartbeats. Both the server and the client will wait for 10 seconds before declaring a disconnect. Heartbeats should be generated by the server every 5 seconds, so this gives us a large window.

• Show a specific "Client Disconnect" or "Server Disconnect" with a timestamp error for users.

  "Client Disconnected" -- Client did not receive a "ping" heartbeat from the server within the time allowed. Usually this is a result of the client losing the internet connection.

  "Server Disconnected" -- Either the server shut down, or the server did not receive a "pong" response from the client within the time allowed. Usually this is a result of the server initiating the disconnect as it shuts down.

• Log the missing "pong" message to the server logs along with the UADDR so you can identify the machine thats down. e.g.
  11:30:39 tacitus SRV-NET - UADDR_02 pong not received before time ran out -- CLIENT CONNECTION DEAD!

• Add GZIP compression for all files. In some cases resulting in an 80% reduction in data that has to be sent over the wires.
  This isn't a perfect solution but perhaps it'll give us a little more information about what's going on.

• Bugfix: Wrap standalone calls in a promise to prevent LOADASSETS lifecycle errors. Addresses #132 and #136.

• Replace font-awesome (?) badge with a css badge. This reduces load time by about 2 seconds. #136.

• Delay blocking javascript loads so that main app page will load and display. #135, #136.

• Display a "Loading Net.Create..." message so user knows the page is loading. #135, #136.

• Add minification with terser.

NodeTable / EdgeTable Improvements

• NodeTable and EdgeTable are now only loaded when their respective tab is visible. This saves about 2 seconds during page processing time. #136.
• Markdown rendering has been optimized. #139
• NodeTables and EdgeTables no longer disappear when a node is selected. #137, #138
• Degrees are now displayed again. 6fc35cc
• Properly unmount NodeTable and EdgeTable db864d6

Version 1.3.0

Date Released: 8/25/2020

Version 1.3.0 introduces two main sets of features:

• Support for running multiple instances of NetCreate on a single server
• Filtering

New Features

Support for running multiple NetCreate instances

In order to support running multiple NetCreate instances on a single serve, we need to be able to specify the ip address, ip port, websocket port, and dataset to be used with each instance.

• The ip address used to access the application can now be set via nc.js. This is necessary to enable multiple instances of NetCreate to run on the same server. f1aaadb

• The ip port used to access the application can now be set via nc.js. This is necessary to enable multiple instances of NetCreate to run on the same server. abdf0e6

• The websocket port used to access the application can now be set via nc.js. This is necessary to enable multiple instances of NetCreate to run on the same server. 5047a6c

• The currently selected dataset is now shown in the browser title field. 0f26ee5

• The currently selected dataset is now included with logs. ec402e6

Filtering #113

A new filters panel allows users to show or hide nodes and edges based on specific search criteria.

• Nodes and edges are filtered separately. 38057f3

• Available filters are determined via template settings. ca7b888

• All filters can be cleared with a "Clear Filters" button. 1fbb7ba

• A summary of active filters is displayed when the Filters panel is closed.
  997e69d

• Filtered objects are hidden (not removed). bdb4ab7

• General improvements to the InfoPanel. fc5d375 b391b26 cfc9e4e f649cb4

Token Improvements

• A dataset can be hidden by default, requiring users to provide a token in order to view. #98 The option is set via the template. 79ea683

• Tokens are now dataset-specific. #72. A token generated for one dataset cannot be used with different datsaet. c4aa0ef

Network Support

• Internet connection disruptions are now detected. #106. #107. A "Server Disconnected" message is shown. Users are allowed to manipulate the graph, but not edit it. 8648e3d f669699

• Both clients and servers now monitor their connections to each other and can detect a loss of internet as well as the server shutting down. #126.

Improvements

General

• Optimized EdgeEditor display to improve rendering times. d3c2f42

• Log file fields now all use tab delimiters. b0a7130

Improve vertical space for smaller screens. #97

• The login field is now in the navbar. bcf5ec2

• Tightened layout of navbar. 566c929

• Tightened layout of Search field and labels. 423d25b 2f74dad

• Hyphenate form labels to prevent labels from overwriting the entry fields. 19e6b2b 6a0f3be 24edcd7

• The "Extras" button visible on localhost and used mostly for dev work is now hidden. d3b4ec2

Storybook

• Introduced the Storybook framework for designing and testing components. 8cfaf61 0d02cde

Bug Fixes

• Nodes and edges locked by a client are now released when the client loses their internet connection. #126.

• Canceling Edge Edit on a new edge now properly clears unsaved edge and restores the UI state. #94, #96, #101, eeedac1

• Deleting a node no longer causes data corruption if a user adds a new edge with the deleted node. 62294cd

• The "Copyright" footer no longer displays in the wrong position on Android and iOS tablets. 2285eb4

• Fixed "Each child in a list should have a unique "key" property" error introduced with toolTipAnchor. 142a46a

• AutoComplete field is now properly re-enabled after enabling edit mode. 57ce99c

• Misc bug fixes.

Version 1.2.1:

Date Released: 5/27/2020

Tagged prior to NetCreate extension work for version 1.3.0.

• #75 -- A number of features including

  • tool tips based on the help text in the template fill
  • fixes the googlea flag so that it works, and
  • changes package to allow multiple data sets to run from one set of html

• #85 -- A number of additions required for our Spring data collection including:

  • Addition of a field (categories)
  • Performance optimizations.
  • Tooltips for the various nodes, edges, and key.
  • Updates to the template file to support those.
  • A new "cite" button for nodes and edges.
  • Tables now sort both directions.
  • Tooltips on the nodes themselves for a quick view.
  • Myriad Library updates

• #88 -- Two minor tweaks:

  • added tooltips to the graph title in the main graph area
  • moved tooltip css out of the index file to a separate tooltip,css

Version 1.2.0: DB and Template Switching

Date Released: 5/2/2019

(changes were implemented 3/12/2019)

Released prior to transfer of repository to netcreateorg.

New Features

• Console script to select database + template -- #67 -- You can now select a database file, a corresponding template file, and start the server with one command: ./nc.js --dataset=projectname. (This addresses issue #65).

• Add color key / legend -- #69 -- This implements a simple legend display across the bottom of the graph.

Fixes / Bugs

• Allow edit target when source and target share the same parent node. -- #71 -- When the source and target nodes both point to the parent node, they could not be edited. The fix was to allow editing only of the target node. This addresses issues #68 and #70.

Version 1.1.0: Feb 2019 Study: Tacitus

Date Released: 2/3/2019

Released for the February 4, 2019 study with Tacitus.

New Features:

• Offline Netgraph Viewing -- #41, #46 -- Added the ability to archive the current model to publish as a read-only web site.
• Group ID and SubGroupID -- #42 -- Added the ability to log in by subgroup, e.g. MOD-BUGULE-LME-ID02. Added a "Login" button to acccomodate subgroup logins-- #48.
• Zoom Buttons -- #43 -- Added zoom buttons.
• Duplicate Node Title warning -- #43
• Node Table improvements
  • Show degrees -- #43
  • Table buttons and header row are now fixed and do not scroll -- #43
  • Table heights can now be resized -- #43
• Delete Node button -- #43 -- Nodes can be deleted. Any edges can be remapped to a separate node. This feature is only available on the server (localhost) machine.
• Graph is now more centered -- #43
• Node Edit Lock -- #50 -- Any node that is being edited now locks the db to prevent other users from editing the node. Other users will be notified that the node is locked if they try to edit it.
• Edge Edit Lock -- #60 -- Network db locking of edges.
• Vocabulary panel -- #57
• Google Analytics -- #61
• New templates -- #61
• DB Unlock web console commands -- #63 -- Network db locking of nodes and edges can sometimes inadvertently leave nodes and edges in a locked state. Added a web console command to unlock all, or nodes and edges separately.

Fixes / Bugs

• Node and Edge IDs now better enforce integer type IDs. -- #51
• Many errors, weird conditions, and bugs stemming from network edit activity -- #46, #58, #62

Version 1.0.1: Oct 2018 Study Day 2: Alexander

Date Released: 10/2/2018

Released for the second day (Oct 3) of the October 1, 2018 study with Ptolemy's Alexander the Great.

New Features:

• Improved Template system -- The template system can now define five aspects of the node and edge forms:

1. The form field label, e.g. "Notes" or "Signifcance"
2. The type options for both nodes and edges, e.g. "Person", 'Group", etc.
3. The color of the node type, e.g. red for "Person"
4. Whether the field should be shown or hidden on both the Node Panel and the Node Table and Edge Table views.
5. The order of the options fields are defined by the order they appear in the template.

• Modified Fields --
  • "Notes" has been renamed "Significance"
  • "Info" has been removed.
  • "Citation" has been moved ahead of "Significance"

Bug Fixes:

• Group ID information has now been restored in the research logs.

Version 1.0.0: Oct 2018 Study: Alexander

Date Released: 9/30/2018

Released for the October 1, 2018 study with Ptolemy's Alexander the Great.

New Features:

• Template system -- Define and load node types and edge types and colors via a template .json file.

• Swap Source and Target -- Added a "Swap Source and Target" button to Edge Editor.

• Change Source/Change Target -- Added buttons to change the existing source or target nodes for Edge Editor.

• Edge Weight -- Edge line weight is now determined by the number of links between nodes.

• Sessions -- Administrators can now define group login tokens. Research data logging is tagged by group id. Graphs are read-only until you log in.

• Deep State -- Data is now stored in a centralized database on the server. Network IDs are now unique.

Future Features:

• Node Edit Locking -- Nodes are not yet locked out when someone is editing them. If two people edit a node at the same time, their changes will clobber each other.

Version 0.1.0: Proof of Concept Prototype

Date Released: 8/28/2018

First major release of the tool for internal testing.

Main Features:

• Network Graph View -- Network graph view rendered via D3 that supports zooming and panning. Nodes may be selected directly by clicking. Nodes may also be dragged to view relationships.

• Search Field -- Search for existing nodes by typing in a search field that will provide auto-complete suggestions.

• Node Viewer -- View and edit a single node's parameters along with all of the edges attached to the node.

• Edge Viewer -- View and edit edge data. Edge views are collapsible to make it easier to see all of the edges attached to a node.

• Node and Edge Tables -- View all of the nodes and edges in the graph in a table list. Nodes and edges can be selected for viewing and editing directly from the table.

• Help -- Rudimentary help button that shows simple help text.