Difference between revisions of "Dashboard Technical Specifications"

From DolceraWiki
Jump to: navigation, search
(→‎Deployment Architecture)
 
(42 intermediate revisions by the same user not shown)
Line 22: Line 22:
 
The Dolcera Dashboard is an interactive web application used to:
 
The Dolcera Dashboard is an interactive web application used to:
 
# Organize large quantities of patent, scientific and product literature
 
# Organize large quantities of patent, scientific and product literature
−
# Manage patent management and review workflows  
+
# Manage patent review workflows  
 
# Assist in collaboration with colleagues and partners around the world
 
# Assist in collaboration with colleagues and partners around the world
 
# Help technology teams, patent counsels, and key decision makers in monitoring the competitive landscaping and finding key partners
 
# Help technology teams, patent counsels, and key decision makers in monitoring the competitive landscaping and finding key partners
−
 
−
===Terminology===
 
−
* ''Dashboard'': The online application used to view and manage patents, product information, and scientific literature
 
−
* ''Charts'': A set of graphs that can be viewed within the dashboard and exported in image or PDF formats
 
−
* ''Data'':
 
−
* ''Export''
 
−
* ''Assignee''
 
−
* ''Inventor''
 
−
* ''Publication Year''
 
−
* ''Application Year''
 
−
* ''Priority Year''
 
−
* ''Taxonomy''
 
−
* ''Category Statistics''
 
−
* ''Title''
 
−
* ''Abstract''
 
−
* ''Claims''
 
−
* ''Rating''
 
−
* ''Tags''
 
−
* ''Granted Patent''
 
−
* ''Patent Application''
 
−
* ''PCT Patent''
 
−
* ''EP Patent''
 
−
* ''US Class''
 
−
* ''IPC Class''
 
  
 
===Workflow===
 
===Workflow===
−
In a typical use case, the dashboard is used as follows:
+
A typical workflow is described below:
 
# Log into the system [[Image:login.png|thumb|center|500px||Login screen]]
 
# Log into the system [[Image:login.png|thumb|center|500px||Login screen]]
 
# Select the dashboard (workfile)  [[Image:Dashboard_Select.png|thumb|center|500px||Select dashboard]]
 
# Select the dashboard (workfile)  [[Image:Dashboard_Select.png|thumb|center|500px||Select dashboard]]
−
# Create categories (taxonomy) [[Image:Taxonomy_Add.png|thum|center|500px|Add taxonomy categories]]
+
# Create categories (taxonomy) [[Image:Taxonomy_Add.png|thumb|center|500px|Add taxonomy categories]]
−
# Add patents [[Image:Patents_Add.png|thum|center|500px|Add patents]]
+
# Add patents [[Image:Patents_Add.png|thumb|center|500px|Add patents]]
−
# Review charts [[Image:Charts.png|thum|center|500px|Review charts]]
+
# Review charts [[Image:Charts.png|thumb|center|500px|Review charts]]
−
# Review patents [[Image:Patents.png|thum|center|500px|Review patents]]
+
# Review patents [[Image:Patents.png|thumb|center|500px|Review patents]]
−
# Search patents [[Image:Search.png|thum|center|500px|Search patents]]
+
# Search patents [[Image:Search.png|thumb|center|500px|Search patents]]
−
# Tag patents [[Image:Patents.png|thum|center|500px|Review patents]]
+
# Tag patents [[Image:Tag.png|thumb|center|500px|Tag patents]]
−
# Add review notes for patents [[Image:Patents.png|thum|center|500px|Review patents]]
+
# Add review notes for patents [[Image:Notes.png|thumb|center|501px|Patent notes]]
−
# Export patents and analysis  [[Image:Export.png|thum|center|500px|Export patents]]
+
# Export patents and analysis  [[Image:Export.png|thumb|center|500px|Export patents]]
 +
 
 +
==Deployment Architecture==
 +
[[Image:Deployment Architecture.png|thumb|center|700px|Dolcera Dashboard Deployment Architecture]]
  
 
==Hardware Requirements==
 
==Hardware Requirements==
−
===Server===
+
As seen in the deployment architecture diagram, the typical deployment environment for the Dolcera Dashboard application consists of two main servers:
−
The Dolcera Dashboard requires the following server configuration:
+
# Server running the Dolcera Dashboard web application
 +
# Database server running PostgreSQL or Oracle database running the dashboard database
 +
===Web Application Server===
 +
The Dolcera Dashboard requires the following application server configuration:
 
* 64-bit server
 
* 64-bit server
−
* 4-core processor with a minimum speed of 3 GHz
+
* 4-core processor with a minimum speed of 2 GHz
 
* Ethernet card
 
* Ethernet card
 
* Minimum memory configuration: 8GB DDR3 RAM
 
* Minimum memory configuration: 8GB DDR3 RAM
−
* Minimum disk usage requirement: 10 TB hard disk
+
* Minimum disk requirement: 2TB hard disk
 +
 
 +
===Database Server===
 +
* Per client database server standards
 
===Network===
 
===Network===
−
* A continuous network connection is required between the user's device and the server
+
* The bandwidth to client devices offered by the web application server should be at least 10Mbps
−
* The server should ideally support a 10Mbps connection
+
* The connection between the web application server and the database server should be at least 100Mbps
 +
* A continuous network connection is required between the user's device and the web application server, and between the web application server and the database server
 +
 
 
===Client Device===
 
===Client Device===
 
* The client application runs on any device that supports an Adobe Flash-enabled web browser
 
* The client application runs on any device that supports an Adobe Flash-enabled web browser
−
* A desktop or laptop computer with 1GB of memory, any operating system (e.g. Windows, Linux, Mac OS) and a high-speed Internet connection will be capable of running the Dolcera Dashboard application
+
* A desktop or laptop computer with 1GB of available memory, any operating system (e.g. Windows, Linux, Mac OS) and a high-speed Internet connection will be capable of running the Dolcera Dashboard application
 
* A 1Mbps or faster network connection to the server will be sufficient to run the application
 
* A 1Mbps or faster network connection to the server will be sufficient to run the application
  
 
==Software Requirements==
 
==Software Requirements==
 
The Dolcera Dashboard application is a PHP web application that runs on the Apache web server with PHP5, and connects to a PostgreSQL or Oracle database. The client application is a Flash application running inside the web browser.
 
The Dolcera Dashboard application is a PHP web application that runs on the Apache web server with PHP5, and connects to a PostgreSQL or Oracle database. The client application is a Flash application running inside the web browser.
−
===Server===
+
===Web Application Server===
 
* Operating system: Linux
 
* Operating system: Linux
 +
* Web server: Apache with support for PHP5
 +
The web application server typically runs inside a vmware Virtual Machine running on any host operating system supported by vmware.
 +
===Database Server===
 
* Database: PostgreSQL 8 or higher; or Oracle 10 or higher
 
* Database: PostgreSQL 8 or higher; or Oracle 10 or higher
−
* Web server: Apache with support for PHP5
 
−
 
 
===Client===
 
===Client===
 
* Operating system: Windows, Linux, Mac OS (or others)
 
* Operating system: Windows, Linux, Mac OS (or others)
Line 101: Line 89:
  
 
===Software Installation===
 
===Software Installation===
−
# Configure the Apache web server to listen on port 80 for the web application server
+
====Database Server====
 +
The following steps should be performed by a database administrator:
 
# Configure the database server with the appropriate database version (specified in the [[#Software Requirements|Software Requirements]] section)
 
# Configure the database server with the appropriate database version (specified in the [[#Software Requirements|Software Requirements]] section)
−
# Download the Dolcera Dashboard installation package (Dolcera_Dashboard_vxxx.zip) to the server from the location provided by the Dolcera representative
+
# Download the Dolcera Dashboard database setup files (Dolcera_Dashboard_Database_vxxx.zip) to the database server from the location provided by the Dolcera representative
 +
# Unzip the files in a folder of your choice (e.g. /tmp folder)
 +
# Create a new database named ''dolcera'' 
 +
# Run the file dolcera_dashboard_setup.sql to create the tables and other database objects: the setup script will also populate the master data for the database, and create a ''dolcerauser'' with privileges to change the data in the database, but not to alter the database; this user account will be used by the web application
 +
 
 +
====Web Application Server====
 +
# Download the Dolcera Dashboard installation package (Dolcera_Dashboard_vxxx.zip) to the web application server from the location provided by the Dolcera representative
 
# Unzip the folder in any directory (e.g. /tmp)
 
# Unzip the folder in any directory (e.g. /tmp)
−
# Edit the following information in the config.ini file
+
# Move the dolcera_dashboard_vm folder to the virtual machines folder on the web application server (e.g. /var/lib/vmware)
−
#* IP address of the database server
+
# Create a new vmware virtual machine instance for the Dolcera Dashboard
−
#* Database administrator username and password
+
# Point the new vmware virtual machine instance to the dolcera_dashboard_vm folder
−
#* IP address of the web application server
+
# Set the network preferences for the virtual machine to bridged networking
−
# Run the installer as superuser (sudo)
+
# Launch the new virtual machine
 +
# Log in with the root password supplied by the Dolcera representative
 +
# Change the database IP address setting as appropriate in the /srv/httpd/htdocs/dashboard/config/config.ini file
 +
# Assign a fixed IP address for the vmware instance and note this IP address
 +
# Once the software installation is complete, log into the application:
 +
#* URL: http://''ipaddress_of_web_application_server''/auth/
 +
#* Username: admin
 +
#* Password: admin (you will be able to change the password thereafter)
  
−
===Configuration Parameters===
+
===Setting up the Environment===
−
Once the software installation is complete, log into the application:
+
* Log into the URL as an administrator as described above
−
URL: http://localhost/auth/
+
* Click on the link to the "Admin Interface"
−
Username: admin
+
* Create a new project
−
Password: admin (you will be able to change the password thereafter)
+
* Create a new group and assign the project to this group
 +
* Create a new user and assign this user to the new group
 +
* Create a new dashboard and add the dashboard to the project
  
−
===Setting up Users===
 
 
===Best Practices===
 
===Best Practices===
−
# Latest database and web server patches
+
====Server Setup====
−
 
+
# The vmware virtual machine based installation of the web application server is designed for ease of installation and management
−
==Using the Dashboard==
+
# If vmware is not preferred, a different installer will be provided to run the web application directly on the server operating system
−
===Dashboard Layout===
+
# Apply the latest database and operating system patches on the servers
−
===Adding Patents===
+
# Change the admin password at regular intervals
−
==FAQ==
+
# Set up the database for backup on a nightly basis
 +
====User Management====
 +
# Remove users once they leave the company
 +
# Assign access to dashboard workfiles to users individually
 +
# Limit the access for the administrator role

Latest revision as of 19:39, 11 April 2012

Introduction

The Dolcera Dashboard is a web application for managing and organizing patents, product information, and scientific literature. This application is used for a variety of purposes including patent review/clearance, and by different enterprise users including attorneys, licensing professionals, engineers, and executives.

Use Cases

The typical use cases for the Dolcera Dashboard are as follows:

  1. Freedom-to-practice or clearance search
  2. Patent portfolio analysis
  3. Competitive intelligence
  4. Patent landscaping
  5. Patent-to-product mapping
  6. Patent-to-standard mapping

User Communities

The typical users of the Dolcera Dashboard include:

  1. Patent attorneys
  2. Patent managers
  3. Patent searchers
  4. Engineers, scientists and inventors
  5. Licensing and business development professionals
  6. Senior executives

What is the Dolcera Dashboard?

The Dolcera Dashboard is an interactive web application used to:

  1. Organize large quantities of patent, scientific and product literature
  2. Manage patent review workflows
  3. Assist in collaboration with colleagues and partners around the world
  4. Help technology teams, patent counsels, and key decision makers in monitoring the competitive landscaping and finding key partners

Workflow

A typical workflow is described below:

  1. Log into the system
    Login screen
  2. Select the dashboard (workfile)
    Select dashboard
  3. Create categories (taxonomy)
    Add taxonomy categories
  4. Add patents
    Add patents
  5. Review charts
    Review charts
  6. Review patents
    Review patents
  7. Search patents
    Search patents
  8. Tag patents
    Tag patents
  9. Add review notes for patents
    Patent notes
  10. Export patents and analysis
    Export patents

Deployment Architecture

Dolcera Dashboard Deployment Architecture

Hardware Requirements

As seen in the deployment architecture diagram, the typical deployment environment for the Dolcera Dashboard application consists of two main servers:

  1. Server running the Dolcera Dashboard web application
  2. Database server running PostgreSQL or Oracle database running the dashboard database

Web Application Server

The Dolcera Dashboard requires the following application server configuration:

  • 64-bit server
  • 4-core processor with a minimum speed of 2 GHz
  • Ethernet card
  • Minimum memory configuration: 8GB DDR3 RAM
  • Minimum disk requirement: 2TB hard disk

Database Server

  • Per client database server standards

Network

  • The bandwidth to client devices offered by the web application server should be at least 10Mbps
  • The connection between the web application server and the database server should be at least 100Mbps
  • A continuous network connection is required between the user's device and the web application server, and between the web application server and the database server

Client Device

  • The client application runs on any device that supports an Adobe Flash-enabled web browser
  • A desktop or laptop computer with 1GB of available memory, any operating system (e.g. Windows, Linux, Mac OS) and a high-speed Internet connection will be capable of running the Dolcera Dashboard application
  • A 1Mbps or faster network connection to the server will be sufficient to run the application

Software Requirements

The Dolcera Dashboard application is a PHP web application that runs on the Apache web server with PHP5, and connects to a PostgreSQL or Oracle database. The client application is a Flash application running inside the web browser.

Web Application Server

  • Operating system: Linux
  • Web server: Apache with support for PHP5

The web application server typically runs inside a vmware Virtual Machine running on any host operating system supported by vmware.

Database Server

  • Database: PostgreSQL 8 or higher; or Oracle 10 or higher

Client

  • Operating system: Windows, Linux, Mac OS (or others)
  • Web browser: Internet Explorer 6 or higher, Firefox, Chrome, Safari, Opera
  • Adobe Flash Player 10 or higher

Installation and Setup

The server hardware and software installation steps are described below:

Hardware Installation

The server landscape can be configured with the database and web application running on the same server; alternately, the two can run on different servers.

  1. Set up a server with the specifications described above
  2. Ensure the operating system has the latest updates applied to it
  3. Ensure that both the web server and the database server (if separate) are connected to the network

Software Installation

Database Server

The following steps should be performed by a database administrator:

  1. Configure the database server with the appropriate database version (specified in the Software Requirements section)
  2. Download the Dolcera Dashboard database setup files (Dolcera_Dashboard_Database_vxxx.zip) to the database server from the location provided by the Dolcera representative
  3. Unzip the files in a folder of your choice (e.g. /tmp folder)
  4. Create a new database named dolcera
  5. Run the file dolcera_dashboard_setup.sql to create the tables and other database objects: the setup script will also populate the master data for the database, and create a dolcerauser with privileges to change the data in the database, but not to alter the database; this user account will be used by the web application

Web Application Server

  1. Download the Dolcera Dashboard installation package (Dolcera_Dashboard_vxxx.zip) to the web application server from the location provided by the Dolcera representative
  2. Unzip the folder in any directory (e.g. /tmp)
  3. Move the dolcera_dashboard_vm folder to the virtual machines folder on the web application server (e.g. /var/lib/vmware)
  4. Create a new vmware virtual machine instance for the Dolcera Dashboard
  5. Point the new vmware virtual machine instance to the dolcera_dashboard_vm folder
  6. Set the network preferences for the virtual machine to bridged networking
  7. Launch the new virtual machine
  8. Log in with the root password supplied by the Dolcera representative
  9. Change the database IP address setting as appropriate in the /srv/httpd/htdocs/dashboard/config/config.ini file
  10. Assign a fixed IP address for the vmware instance and note this IP address
  11. Once the software installation is complete, log into the application:
    • URL: http://ipaddress_of_web_application_server/auth/
    • Username: admin
    • Password: admin (you will be able to change the password thereafter)

Setting up the Environment

  • Log into the URL as an administrator as described above
  • Click on the link to the "Admin Interface"
  • Create a new project
  • Create a new group and assign the project to this group
  • Create a new user and assign this user to the new group
  • Create a new dashboard and add the dashboard to the project

Best Practices

Server Setup

  1. The vmware virtual machine based installation of the web application server is designed for ease of installation and management
  2. If vmware is not preferred, a different installer will be provided to run the web application directly on the server operating system
  3. Apply the latest database and operating system patches on the servers
  4. Change the admin password at regular intervals
  5. Set up the database for backup on a nightly basis

User Management

  1. Remove users once they leave the company
  2. Assign access to dashboard workfiles to users individually
  3. Limit the access for the administrator role
Retrieved from "https://www.dolcera.com/wiki/index.php?title=Dashboard_Technical_Specifications&oldid=10490"