APS Contributions

Makefile

@@ -0,0 +1,27 @@
+TOP = .
+
+default:
+
+support: 
+	$(TOP)/sbin/names_install_support.sh
+
+configuration:
+	$(TOP)/sbin/names_create_configuration.sh
+
+schema:
+	$(TOP)/sbin/names_create_db_schema.sh
+
+backup:
+	$(TOP)/sbin/names_backup.sh
+
+restore:
+	$(TOP)/sbin/names_restore.sh
+
+payara-configure:
+	$(TOP)/sbin/names_payara_config_create.sh
+
+payara-unconfigure:
+	$(TOP)/sbin/names_payara_config_remove.sh
+
+deploy:
+	$(TOP)/sbin/names_deploy.sh

README.md

@@ -0,0 +1,67 @@
+
+# DISCS Collaboration: Naming System Module
+
+Description: A web-based system to manage naming convention of a particle accelerator facility.
+
+### Contents:
+   - data: sample data
+   - design: design artifacts (SQL, MWB, Enterprise Architect files)
+   - docs: documentation
+   - src: source code
+   - sbin: support scripts and binaries 
+   - etc: configuration
+
+## Deployment 
+
+### Pre-requisistes
+
+- mariadb
+- conda
+
+### Structure 
+
+- NAMES_INSTALL_DIR
+  - NAMES_DIST: Names distribution
+  - etc: Configuration
+  - support-`hostname -s`: support binaries such as java and payara.
+  - backup: db snapshots 
+
+### Instructions
+
+The deployment can be driven by creating a well defined configuration file. This is done in the `make configuration` step below. 
+
+```sh
+# Create a installation directory
+mkdir $NAMES_INSTALL_DIR
+cd $NAMES_INSTALL_DIR
+
+## Download the names release/repo
+# git clone ...
+# wget names-release.tar.gz && unzip names-release.tar.gz
+cd $NAMES_DIST
+source setup.sh
+
+# Create a configuration file for the deployment. 
+make configuration
+
+# Install necessary support
+make support
+
+# Deploy schema 
+make schema
+
+# Configure payara server
+make payara-configure
+
+# Deploy naming app
+make deploy
+```
+
+### Update SSL certificate on payara
+
+```sh
+cd $NAMES_DIST
+
+# Provide path to key and cert 
+./sbin/names_update_ssl.sh ../etc/ssl.key ../etc/ssl.cer
+```

Release-Notes.txt

@@ -6,6 +6,13 @@ Release Notes: Naming System Application
 
 Overview: Naming System is for managing the FRIB Naming Convention. 
 
+Naming System Version 2.6.0 Date: 2020-Oct-16
+
+Summary of Changes from Previous Version:
+  - Customised it for APS requirements
+  - Name categories are changed.
+  - Home page is changed.
+
 Naming System Version 2.5.1  Date: 2015-Feb-19
 
 Summary of Changes from Previous Version:

data/patch-1.sql

@@ -0,0 +1,25 @@
+-- This patch is to modify category names:
+
+-- Increase size of column id in table name_category
+ALTER TABLE name_category MODIFY id VARCHAR(32);
+
+-- Increase size of column name_category_id in table name_event
+ALTER TABLE name_event MODIFY name_category_id VARCHAR(32);
+
+-- Disable foreign key checks otherwise update fails.
+SET FOREIGN_KEY_CHECKS=0;
+
+-- Make the modifications
+update name_event set name_category_id="primary-machine" where name_category_id='system';
+update name_category set id="primary-machine", name="Primary Machine/Sub-Area", description="Primary Machine/Sub-Area", version=0 where id='system';
+update name_event set name_category_id="system" where name_category_id='subsystem';
+update name_category set id="system", name="System", description="System", version=0 where id='subsystem';
+
+-- Delete category names only if there is no relative name event present.
+delete from name_category where id='signal-type' and not exists(select 1 from name_event where name_category_id='signal-type');
+delete from name_category where id='signal-suffix' and not exists(select 1 from name_event where name_category_id='signal-suffix');
+delete from name_category where id='signal-domain' and not exists(select 1 from name_event where name_category_id='signal-domain');
+
+-- Enable foreign key checks again
+SET FOREIGN_KEY_CHECKS=1;
+

data/patch-2.sql

@@ -0,0 +1,5 @@
+-- This patch is to modify category names:
+
+-- Make the modifications
+-- Add a category name Signal
+insert into name_category (id, name, description, version) values ("signal", "Signal", "Signal", 0);

design/names_schema_v2.4.1.sql

@@ -0,0 +1,94 @@
+--   -------------------------------------------------- 
+--   Generated by Enterprise Architect Version 9.2.921
+--   Created On : Thursday, 25 July, 2013 
+--   DBMS       : MySql 
+--   -------------------------------------------------- 
+
+-- Create database
+CREATE DATABASE DISCS_NAMING;
+USE DISCS_NAMING;
+
+SET FOREIGN_KEY_CHECKS=0;
+
+--  Drop Tables, Stored Procedures and Views 
+
+DROP TABLE IF EXISTS configuration CASCADE;
+DROP TABLE IF EXISTS name_category CASCADE;
+DROP TABLE IF EXISTS name_event CASCADE;
+DROP TABLE IF EXISTS name_release CASCADE;
+DROP TABLE IF EXISTS privilege CASCADE;
+
+--  Create Tables 
+CREATE TABLE configuration
+(
+	name VARCHAR(64) NOT NULL,
+	value VARCHAR(255),
+	PRIMARY KEY (name)
+
+) ENGINE=InnoDB COMMENT='Each row is a module property';
+
+
+CREATE TABLE name_category
+(
+	id VARCHAR(32) NOT NULL,
+	name VARCHAR(32) NOT NULL,
+	description VARCHAR(255),
+	version INTEGER NOT NULL,
+	PRIMARY KEY (id)
+
+) ENGINE=InnoDB COMMENT='Each row is a naming category';
+
+
+CREATE TABLE name_event
+(
+	id INTEGER NOT NULL AUTO_INCREMENT,
+	name_id VARCHAR(64) NOT NULL,
+	event_type CHAR(1) NOT NULL,
+	requested_by VARCHAR(64) NOT NULL,
+	requestor_comment VARCHAR(255) NOT NULL,
+	request_date DATETIME NOT NULL,
+	status CHAR(1) NOT NULL,
+	processed_by VARCHAR(64),
+	processor_comment VARCHAR(255),
+	process_date DATETIME,
+	name_category_id VARCHAR(32),
+	name_code VARCHAR(16),
+	name_description VARCHAR(255),
+	version INTEGER NOT NULL,
+	PRIMARY KEY (id),
+	KEY (name_category_id)
+
+) ENGINE=InnoDB COMMENT='Each row is an event in a name''s lifecycle';
+
+
+CREATE TABLE name_release
+(
+	id VARCHAR(16) NOT NULL,
+	description VARCHAR(255) NOT NULL,
+	doc_url VARCHAR(255),
+	release_date DATETIME NOT NULL,
+	released_by VARCHAR(64) NOT NULL,
+	version INTEGER NOT NULL,
+	PRIMARY KEY (id)
+
+) ENGINE=InnoDB COMMENT='Each row is a naming system release';
+
+
+CREATE TABLE privilege
+(
+	userid VARCHAR(64) NOT NULL,
+	operation VARCHAR(1) NOT NULL,
+	version INTEGER NOT NULL,
+	PRIMARY KEY (userid)
+
+) ENGINE=InnoDB;
+
+
+
+SET FOREIGN_KEY_CHECKS=1;
+
+
+--  Create Foreign Key Constraints 
+ALTER TABLE name_event ADD CONSTRAINT FK_name_event_name_category 
+	FOREIGN KEY (name_category_id) REFERENCES name_category (id)
+	ON DELETE RESTRICT ON UPDATE CASCADE;

etc/names.config.template

@@ -0,0 +1,9 @@
+NAMES_DB_NAME=naming
+NAMES_DB_USER=naming
+NAMES_DB_PASSWORD_FILE=
+NAMES_DB_HOST=127.0.0.1
+NAMES_DB_PORT=3306
+NAMES_DB_ADMIN_USER=root
+NAMES_DB_ADMIN_HOSTS="127.0.0.1"
+NAMES_DB_CHARACTER_SET=utf8
+NAMES_CONTEXT_ROOT=/

nb-configuration.xml

@@ -25,6 +25,6 @@ Any value defined here will override the pom.xml file value but is only applicab
         <org-netbeans-modules-css-prep.sass_2e_enabled>false</org-netbeans-modules-css-prep.sass_2e_enabled>
         <org-netbeans-modules-css-prep.less_2e_compiler_2e_options/>
         <org-netbeans-modules-javascript2-requirejs.enabled>true</org-netbeans-modules-javascript2-requirejs.enabled>
-        <org-netbeans-modules-maven-j2ee.netbeans_2e_hint_2e_deploy_2e_server>gfv3ee6</org-netbeans-modules-maven-j2ee.netbeans_2e_hint_2e_deploy_2e_server>
+        <org-netbeans-modules-maven-j2ee.netbeans_2e_hint_2e_deploy_2e_server>pfv5ee8</org-netbeans-modules-maven-j2ee.netbeans_2e_hint_2e_deploy_2e_server>
     </properties>
 </project-shared-configuration>