diff --git a/Tombolo/server/seeders/20190924045211-identitydetails.js b/Tombolo/server/seeders/20190924045211-identitydetails.js index 5bedd3a1..1e4db8bf 100644 --- a/Tombolo/server/seeders/20190924045211-identitydetails.js +++ b/Tombolo/server/seeders/20190924045211-identitydetails.js @@ -1,130 +1,137 @@ -'use strict'; -const { v4: uuidv4 } = require('uuid'); +"use strict"; +const { v4: uuidv4 } = require("uuid"); module.exports = { up: (queryInterface, Sequelize) => { - return queryInterface.bulkInsert('data_types', [{ - id: uuidv4(), - name : 'Drivers License', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Credit Card', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'PHI', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'SSN', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'DOB', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Policy Number', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Zipcode', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Medical Record Number', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'License Number', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'IP Addresses', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Phone Number', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Street Address', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Name', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Passport Number', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Login Details', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Email Address', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Other Unique Identifiers', - createdAt : new Date(), - updatedAt : new Date() - }, - { - id: uuidv4(), - name : 'Geo Coordinate', - createdAt : new Date(), - updatedAt : new Date() - },{ - id: uuidv4(), - name : 'State/Province', - createdAt : new Date(), - updatedAt : new Date() - },{ - id: uuidv4(), - name : 'City', - createdAt : new Date(), - updatedAt : new Date() - }], {}); - + return queryInterface.bulkInsert( + "data_types", + [ + { + id: uuidv4(), + name: "Drivers License", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Credit Card", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "PHI", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "SSN", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "DOB", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Policy Number", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Zipcode", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Medical Record Number", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "License Number", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "IP Addresses", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Phone Number", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Street Address", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Name", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Passport Number", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Login Details", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Email Address", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Other Unique Identifiers", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "Geo Coordinate", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "State/Province", + createdAt: new Date(), + updatedAt: new Date(), + }, + { + id: uuidv4(), + name: "City", + createdAt: new Date(), + updatedAt: new Date(), + }, + ], + {} + ); }, down: (queryInterface, Sequelize) => { - return queryInterface.bulkDelete('data_types', null, {}); - } + return queryInterface.bulkDelete("data_types", null, {}); + }, }; diff --git a/docs/docs/Developer-Guides/Contribute.md b/docs/docs/Developer-Guides/Contribute.md deleted file mode 100644 index 6ab18b1e..00000000 --- a/docs/docs/Developer-Guides/Contribute.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Contribute - -Our Developer Guides are currently under construction and should be released soon. diff --git a/docs/docs/Developer-Guides/_category_.json b/docs/docs/Developer-Guides/_category_.json deleted file mode 100644 index 2d30aa75..00000000 --- a/docs/docs/Developer-Guides/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Developer Guides", - "position": 3, - "link": { - "type": "generated-index", - "description": "Developer Guides to learn how to intereact with Tombolo's Codebase, API, and create Integrations." - } -} diff --git a/docs/docs/Developer-Guides/integrations.md b/docs/docs/Developer-Guides/integrations.md deleted file mode 100644 index d7ee13b6..00000000 --- a/docs/docs/Developer-Guides/integrations.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 -label: "Integrations" -title: "Integrations" ---- - -# Integrations - -Our Developer Guides are currently under construction and should be released soon. diff --git a/docs/docs/Quick-Start/Installation.md b/docs/docs/Quick-Start/Installation.md index 2ec1cdd6..d191f5d5 100644 --- a/docs/docs/Quick-Start/Installation.md +++ b/docs/docs/Quick-Start/Installation.md @@ -72,16 +72,22 @@ npm i npx sequelize db:migrate ``` +```bash +npx sequelize db:seed:all +``` + ```bash node server.js ``` -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. +The `cd` command changes the directory you're working with. The `npm i` command installs dependencies located in the package.json file necessary for running and compiling the code. The `npx sequelize db:migrate` command installs dependencies located in the package.json file necessary for running and compiling the code. +The `npx sequelize db:seed:all` command seeds the database with necessary data for runtime. + The `node server.js` command starts the backend server and associated API's necessary for the front end ## Start the front end @@ -89,7 +95,7 @@ The `node server.js` command starts the backend server and associated API's nece Open a seperate terminal, and navigate to your installation location ```bash -cd client-reactjs +cd tombolo/client-reactjs ``` ```bash @@ -100,7 +106,7 @@ npm i npm start ``` -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. +The `cd` command changes the directory you're working with. The `npm i` command installs dependencies located in the package.json file necessary for running and compiling the code. @@ -108,4 +114,4 @@ The `npm start` command starts your front end development environment at [http:/ ## Congratulations -Your Tombolo installation is now up and running. Lets learn some of the core concepts of the software. +Your Tombolo installation is now up and running. Navigate to [http://localhost:3000/](http://localhost:3000/) to start the new user tutorial. Tombolo has a built in tutorial that will walk you through the final steps to getting your installation up and running. diff --git a/docs/docs/Quick-Start/application.md b/docs/docs/User-Guides/application.md similarity index 100% rename from docs/docs/Quick-Start/application.md rename to docs/docs/User-Guides/application.md diff --git a/docs/docs/User-Guides/assets.md b/docs/docs/User-Guides/assets.md index 9429707f..eafe14ce 100644 --- a/docs/docs/User-Guides/assets.md +++ b/docs/docs/User-Guides/assets.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 label: "Assets" title: "Assets" --- @@ -28,7 +28,7 @@ project by clicking on the GitHub Projects link in the left navigation bar. ## Index -For indexes, you can search and add them using the auto-complete search field. A minimum of three characters +For indeces, you can search and add them using the auto-complete search field. A minimum of three characters is required to trigger the search. You can view the payload and workunit related to the imported indexes. ## Query diff --git a/docs/docs/Quick-Start/cluster.md b/docs/docs/User-Guides/cluster.md similarity index 100% rename from docs/docs/Quick-Start/cluster.md rename to docs/docs/User-Guides/cluster.md diff --git a/docs/docs/User-Guides/user-interface.md b/docs/docs/User-Guides/user-interface.md index ca3a49e1..f4fe0202 100644 --- a/docs/docs/User-Guides/user-interface.md +++ b/docs/docs/User-Guides/user-interface.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 8 label: "User Interface" title: "User Interface" --- @@ -16,39 +16,48 @@ Tombolo's user interface is divded into three major zones. The left hand navigation is the primary method Tombolo uses to navigate to it's different functionalities and settings. It is split into three different sections. -1. [General](#general) -2. [Settings](#settings) -3. [Admin](#admin) +1. [Workflows](#workflows) +2. [Monitoring](#monitoring) +3. [Connections](#connections) +4. [Admin](#admin) -### General +### Workflows -The general section contains all of Tombolo's functionalities for communicating with HPCC Clusters, including: +The workflows section contains all of Tombolo's functionalities for setting up, monitoring, and running workflows within an HPCC system. + +### Monitoring + +The monitoring section contain's a set of tools to monitor assets within HPCC. + + -### Settings +### Connections -The settings section contain's a set of tools to configure tombolo's connections to other platforms, including: +The connections section contain's all of Tombolo's external connection tools including: ### Admin -The admin section contain's a set of tools to configure tombolo's administrative settings, including: +The admin section contains all of application management tools including: ## Top User Menu diff --git a/docs/docs/User-Guides/workflows.md b/docs/docs/User-Guides/workflows.md index 0519ff15..10f4ceb3 100644 --- a/docs/docs/User-Guides/workflows.md +++ b/docs/docs/User-Guides/workflows.md @@ -1,9 +1,67 @@ --- -sidebar_position: 8 +sidebar_position: 10 label: "Workflows" title: "Workflows" --- # Workflows -Our Workflows Guides are currently under construction and should be released soon. +Workflows are Tombolo's way of setting up a method for running a set of HPCC workunits, or jobs in a logical workflow. + +## Setup + +To set up a workflow, go to the "Workflow" screen under the "Workflows" section of the left navigation. Once there, use the blue "add" button on the top right-hand side of the screen. Once there, fill out the fields, described below. + + + +## Designer + +Tombolo's Workflow Designer utilizes an simple, low code approach to designing your Workflows. Simply click on the title of the workflow that you wish to edit and you will enter the workflow designer screen. + +## Designer UI + +The workflow designer utilizes three main areas. + +1. [Left Navigation](#assets) - Here you will find your [Asset](#assets) nodes that you can drag onto the workflow designer screen +2. [Top Navigation](#top-navigation) - The top navigation contains several useful items, including versioning of your workflow, synchronizing, a version indicator, and an info dropdown which gives a description of the appearance of nodes and connections between them. +3. [Designer screen](#designer-screen) - The main screen where you will interact with nodes and set up the logical flow of your workflow. + +### Assets + +On the left navigation bar, you will see the different assets that you can drag onto the designer screen to be utilized inside of the workflows. In order to use any of these, simply drag the node on to the [designer screen](#designer-screen) and double click the node to select the desired asset to associate with that node. + + + +### Top Navigation + +The top navigation contains several useful items, including versioning of your workflow, synchronizing, a version indicator, and an info dropdown which gives a description of the appearance of nodes and connections between them. + + + +### Designer Screen + +The main screen where you will interact with nodes and set up the logical flow of your workflow. Simply drag items from the assets bar onto the screen to begin interacting. Each node that you drag onto the screen will have anchors on the 4 sides of the node that you can use to make a connection to adjacent nodes. Double clicking a node will open up a selection screen to select the desired asset of the same type that you wish to use for that node. Below is an image of the different node types and connections that you will find within the designer screen. + +![Workflow Items](/img/Workflow-Nodes.png) diff --git a/docs/static/img/Workflow-Nodes.png b/docs/static/img/Workflow-Nodes.png new file mode 100644 index 00000000..6c3852a3 Binary files /dev/null and b/docs/static/img/Workflow-Nodes.png differ