OpenRIMS Wiki - User contributions [en]

OpenRIMS-RPM - Installation Part 2

2022-06-28T18:04:02Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software.

Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

The Pharmadex Application:Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line. Name it pdx2. ''Ubuntu CLI hint (CREATE DATABASE pdx2. And restore it: $ mysql -u username -p pdx2 < DumpPdx2.sql)''

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Edit file .service and change Username '''and''' Execstart path.
# Start the service: systemctl enable myapp.service
# Change Owner of the java application to your user: sudo chmod a+rwx /home/ubuntu/applications/pharmadex2/pharmadex2-0.0.1.jar

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T17:59:28Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software.

Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

The Pharmadex Application:Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line. (Name it pdx2: CREATE DATABASE pdx2. And restore it: $ mysql -u username -p pdx2 < DumpPdx2.sql)

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Edit file .service and change Username '''and''' Execstart path.
# Start the service: systemctl enable myapp.service
# Change Owner of the java application to your user: sudo chmod a+rwx /home/ubuntu/applications/pharmadex2/pharmadex2-0.0.1.jar

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T17:54:30Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software.

Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

The Pharmadex Application:Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line. (Name it pdx2: CREATE DATABASE pdx2. And restore it: $ mysql -u username -p pdx2 < DumpPdx2.sql)

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Edit file .service and change Username '''and''' Execstart path.
# Start the service: systemctl enable myapp.service
# Copy

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:41:10Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software.

Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

The Pharmadex Application:Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line. (Name it pdx2: CREATE DATABASE pdx2. And restore it: $ mysql -u username -p pdx2 < DumpPdx2.sql)

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Start the service: systemctl enable myapp.service
# Copy

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:33:35Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software.

Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

The Pharmadex Application:Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Start the service: systemctl enable myapp.service
# Copy

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:31:56Z

KhoppenworthMSH: Formatting.

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software. Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· The MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

=== Hardware Requirements ===

==== '''Memory:''' ====
At least 2 GB of free RAM

==== '''Harddrive:''' ====
At least 10GB of free SDD/HDD

==== Internet connection: ====
Properties of it should suit minimal requirements for Google Mail

=== Software Requirements ===

==== '''Operating System:''' ====
o Windows Server 2016 and above OR

o Windows 10 OR

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

==== '''Database:''' ====
MySQL R 5.7

* Server
* Workbench

==== Java: ====

* Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

Binary Pharmadex 2 distribution (see below)

Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

A Google Mail account for OAuth Login SSO

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Start the service: systemctl enable myapp.service
# Copy

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:25:09Z

KhoppenworthMSH: /* Install as a service */

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software. Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· The MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

· At least 2 GB of free RAM

· At least 10GB of free SDD/HDD

· Operation Systems:

o Windows Server 2016 and above

o Windows 10

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

· MySQL R 5.7

o Server

o Workbench

· Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

· Internet connection. Properties of it should suit minimal requirements for Google Mail

· Binary Pharmadex 2 distribution (see below)

· Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

· The own, private Google Mail account

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
Examples of the configurations are in the binary distributive on/from GitHub. The folders are “Windows” and “Linux”.

For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

Here are detailed steps for Ubuntu 22.04:

# Copy file .service to /etc/systemd/system: sudo cp pharmadex.service /etc/systemd/system
# Start the service: systemctl enable myapp.service
# Copy

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

For Ubuntu 22.04 and Apache2 here are the steps:

# Copy pharmadex.conf to apache folder: sudo cp

== Configuring Google Authentication ==
LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:19:04Z

KhoppenworthMSH:

= Objective =
This document helps deploy Pharmadex 2 software first time, along with the demo database.

The audience of it is IT persons that are responsible to install and maintain the Pharmadex 2 software. Minimal qualification requirements are:

· Ability to install and configure programs and components in the selected Operation System.

· The MySQL knowledge.

== Pre-conditions ==
Regardless of deployment configuration selected, the following pre-conditions should be fulfilled:

· At least 2 GB of free RAM

· At least 10GB of free SDD/HDD

· Operation Systems:

o Windows Server 2016 and above

o Windows 10

o Linux, released after 2018. Tested on Ubuntu 18.04.4 LTS and above

· MySQL R 5.7

o Server

o Workbench

· Oracle Java JDK 1.8. OpenJDK 1.8 has been tested on Linux Ubuntu, but not Windows

· Internet connection. Properties of it should suit minimal requirements for Google Mail

· Binary Pharmadex 2 distribution (see below)

· Pharmadex 2 demo database (<nowiki>https://github.com/MSH/Pharmadex2/tree/main/database</nowiki>[1])

· The own, private Google Mail account

== Pharmadex 2 binary distribution ==
The possibility to build the Pharmadex 2 software directly from the source codes is possible, however is not covered by this document. However, this manual describes deployment from the binary distribution. For current, the MSH staff may get this distribution from the corporative GitHub, address is

The descriptions of binary components may be found in the respective file README.md

= Steps to deploy =

== Prepare to install ==
1. Install using the vendor’s deployment manual:

1.1. MySQL

1.2. Java JDK 1.8

2. Restore the demo database to MySQL using MySQL Workbench or the command line

3. Copy the binary application pharmadex2-0.0.1.jar and application.properties to the dedicated folder, e.g. applications/pharmadex2

== Configure ==

== Local TCP/IP port ==
In the application.properties file edit the values marked bold (if it will be necessary):

=== Database ===
In the application.properties file edit the values marked bold:

spring.datasource.url = jdbc:mysql://localhost/pdx2?useSSL=false&useUnicode=yes&characterEncoding=UTF-8&characterSetResults=UTF-8&'''serverTimezone=Europe/Kiev'''

spring.datasource.username = '''username'''

spring.datasource.password = '''password'''

=== Logs ===
In the application.properties file edit the values marked bold:

logging.file.path=/'''home/alexk/pharmadex/log'''

the good choice is:

'''logging.file.path= ./log/'''

After configuration it will be necessary to copy Client ID and Client secret to the application.properties

<nowiki>##</nowiki> OATH2

spring.security.oauth2.client.registration.google.client-id=client_id

spring.security.oauth2.client.registration.google.client-secret=client_secret

== Install as a service ==
For Linux the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.nix-services.system-d</nowiki>

For Windows the official guide is here <nowiki>https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.installing.windows-services</nowiki>

Examples of the configurations are in the binary distributive. The folders are “windows” and “Linux”.

== Provide access from the Internet ==
To provide access from the Internet it will be a good idea to establish a proxy gateway like Nginx or Apache2. The example of virtual server configuration for Apache 2 is in the binary distributive, folder “Linux”.

Configuring Google Authentication

LINK: See '''Configuring Google Authentication for Pharmadex 2'''

== Special Configuration ==
LINK: See '''IIS as a gateway for Spring Boot application'''

----[1] For current, available only to MSH staff

OpenRIMS-RPM - Installation Part 2

2022-06-28T16:13:08Z

KhoppenworthMSH: New Page

Main Page

2022-06-27T17:22:42Z

KhoppenworthMSH:

[[File:Logo OpenRIMS.png|thumb]]
'''Please Note!'''

''We are currently uploading all system documentation to this platform.''

''The process is estimated to conclude by August 2022.''

''This will go hand in hand with rebranding to OpenRIMS which logo is seen to the right.''

Choose Module:

* OpenRIMS M2 - Marketing Authorization
* OpenRIMS M3 - Pharmacovigilance
* OpenRIMS M4 - Import/Export
* OpenRIMS M5 - Pharmacy Registration
* OpenRIMS M6 - Pharmacy Inspection
* OpenRIMS M8 - Clinical Trial

Or choose Function:

*[[Installation Part 1|Installation/Deployment Part 1]]
*[[Installation Part 2|Installation/Deployment Part 2]]
*[[User Management]]
*[[Workflows Part 1|Workflow Configuration]]

Technical Links for this Wiki:

# [[Allpages|All Pages Index]]

== Main Links for each Module ==
* User Guide for Pharmaceutical Manufacturers, Pharmacy Owners and other Clients of Regulatory Authorities
* User Guide for Regulatory Staff
* User Guide for System Administrators

Main Page

2022-06-27T17:20:37Z

KhoppenworthMSH:

[[File:Logo OpenRIMS.png|thumb]][[File:Logo OpenRIMS.png|thumb|link=http://wiki.openrims.org/index.php/File:Logo_OpenRIMS.png]]'''Please Note!'''

''We are currently uploading all system documentation to this platform.''

''The process is estimated to conclude by August 2022.''

''This will go hand in hand with rebranding to OpenRIMS which logo is seen to the right.''

Choose Module:
* OpenRIMS M2 - Marketing Authorization
* OpenRIMS M3 - Pharmacovigilance
* OpenRIMS M4 - Import/Export
* OpenRIMS M5 - Pharmacy Registration
* OpenRIMS M6 - Pharmacy Inspection
* OpenRIMS M8 - Clinical Trial
Or choose Function:
*[http://wiki.openrims.org/index.php/Installation%20Part%201 Installation/Deployment Part 1]
*[http://wiki.openrims.org/index.php/Installation%20Part%202 Installation/Deployment Part 2]
*[http://wiki.openrims.org/index.php/User%20Management User Management]
*[http://wiki.openrims.org/index.php/Workflows%20Part%201 Workflow Configuration]

Technical Links for this Wiki:

[http://wiki.openrims.org/index.php/Allpages Http://wiki.openrims.org/index.php/Special:AllPages]
== Main Links for each Module ==
* User Guide for Pharmaceutical Manufacturers, Pharmacy Owners and other Clients of Regulatory Authorities
* User Guide for Regulatory Staff
* User Guide for System Administrators

OpenRIMS - Follow–up Workflow

2022-06-27T15:54:05Z

KhoppenworthMSH: Reference Link

= Motivation =
Pharmadex 2 software tracks the lifecycle of medicinal products as well as facilities related to the import, selling, storing, and manufacturing of them. This lifecycle is managed by in-country businesses and the state National Medicine Regulatory Authority (NMRA).

The main stages of the lifecycle are:

1. Registration or approval

2. Active

3. De-registered

To enter the first step, it is enough to fill out an initial application form and submit it to the NMRA.

For the entrance to the Active stage, the application should pass the initial registration (approval) workflow. It is an internal workflow on NMRA that typically consists of screening, review, approval, and finalization steps

In the second stage, it is possible to follow-up actions like renewal or inspection as well as modifications of the initial application data. Any follow-up action backed by an internal NMRA workflow.

This manual intends to help NMRA’s Supervisor build a particular follow-up workflow as well as decide how to schedule them in the Active stage of the lifecycle.

The Pharmadex 2 configuration knowledge is required.

= Follow-up workflow =

== Application data ==
The application data for follow–up workflow is the same as for the initial application. Thus, it is not needed to configure special application data.

Figure 1 Follow-up application data and workflow data

1. Application data is the data of the initial application

2. Workflow data is data that should be collected while workflow

== Workflow data ==
A follow-up application may collect additional data i.e., documents, schedules, registers, etc. Configurations of these data blocks should be created and included in configurations of the appropriative workflow’s steps.

It is recommended to create all workflow data configurations before workflow steps.

Figure 2 Data that collected during the follow-up workflow finalization step

== Workflow steps (activities) ==
Any follow-up workflow should be defined as an item in the dictionary “dictionary.host.applications”.

Figure 4 An example of the follow-up workflow dictionary

The workflow steps definitions are similar to the initial workflow steps:

· Screening

· Review

· Approve

· Finalization

Figure 3 An example of a configuration of the workflow Finalization step

1. URL of the workflow step configuration data

2. URL for the workflow step checklist dictionary (mandatory)

Two steps are mandatory – Approve and Finalization.

The “Approve” step typically assigns a new certificate number. The “Finalization” step allows to generate and file the new certificate, as well as schedule the next follow-up renewal.

= Scheduler =
The scheduler is an on-screen component that schedules the next run of any follow-up workflow. In (MSH, 2022) the configuration of a scheduler is defined as:

Allows to run another follow-up application after the application will be approved. Examples are “scheduled renewal payment”, “scheduled inspection”, etc.

Figure 5. The scheduler component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|Offset in months from the current date to the minimal possible date to run the follow-up application
|
|-
|Maximal Offset
|Offset in months from the current date to the maximal possible date to run the follow-up application
|
|-
|required
|the scheduled date should fit the Minimal offset – Maximal offset criteria
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store the scheduler?
|pharmacy.site.renew
|-
|dictUrl
|
|
|-
|auxURL
|Which application should be scheduled?
|application.pharmacy.renew
|-
|readOnly
|Display date only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

Figure 6 The scheduled follow-up application will be shown in the Submit form on the Finalization step

1. Approval action on the finalization step

2. A list of the scheduled follow-up applications

A follow-up workflow may be scheduled once or repeated.

· To schedule the workflow once, the scheduler should be placed in the Application data only

· To schedule the workflow repeated, the scheduler should be placed in the Application Data and the workflow data.

= References =
MSH. (2022). Workflow configuration reference guide. [[Workflows Part 1]].

OpenRIMS - Follow–up Workflow

2022-06-27T15:53:03Z

KhoppenworthMSH: New Page

Common Standards for RIMS

2022-06-23T16:56:27Z

KhoppenworthMSH: New Page

== Background ==
Through a consultative proces an international team is recommending that the following standards are considered for inclusion in an RIMS design:

== Process Standards ==
{| class="wikitable"
|Good Laboratory Practices (GLP)
|-
|Monographs
|-
|ISO 9001:2015 - Quality Management System Procedures
|-
|Good Distribution Practices (GDP)
|-
|ISO 17025:2017
|-
|Good Practices For Pharmaceutical Quality Control Laboratories
|-
|Good Clinical Practice (GCP)
|-
|Good Manufacturing Practices (GMP) or ICH Q7
|-
|Good Practices For Pharmaceutical Microbiology Laboratories
|-
|Good Review Practices (GRevP)
|-
|Good Storage Practices (GSP)
|-
|ICH Q10
|-
|Good Pharmacovigilance Practices
|}

== Dictionaries & Knowledge Trees ==
{| class="wikitable"
|International Nonproprietary Names (INN)
|-
|Anatomical Therapeutic Chemical Index (ATC)
|-
|WHODrug Global
|-
|National Drug Code (NDC)
|-
|The Medical Dictionary for Regulatory Activities (MedDRA)
|-
|Chemical Abstracts Service (CAS) registry number
|-
|Unique Ingredient Identifier (UNII)
|-
|ISO 11238 Substance Identification (SubID)
|-
|GS1 Standards
|-
|ISO 11615 Medicinal Product Identification (MPID)
|}

== Data Exchange Standards ==
{| class="wikitable"
|Portable Document Format (PDF)
|-
|XML
|-
|Common Technical Document (CTD)
|-
|E2B - Pharmacovigilance: Individual Case Safety Reports (ICSR) or ISO/HL7 27953-2:2011
|-
|Structured Product Labelling (SPL)
|-
|Fast Healthcare Interoperability Standards (FHIR)
|}

OpenRIMS-RPM - User Management

2022-06-23T01:58:04Z

KhoppenworthMSH: Created page with " = Objective = The management of the NMRA users and rules to assign workflow activity executors require to collect the appropriative information. Tradition..."

= Objective =
   The management of the NMRA users and rules to assign workflow activity executors require to collect the appropriative information. Traditionally, this collection is called “Users Directory”. The Users Directory should be manageable by the Supervisor.

The directory should be flexible enough to fit any NMRA and strict enough to allow uniform user management and automated assignment of the NMRA executors for the workflow activities.

The directory should be implemented in the Pharmadex 2 database.

= The directory =
   The office is a site that serves administrative units (Figure 1). The expert is the executor of the NMRA workflow activity. The expert may be an NMRA employee, an employee of an NMRA partner like a lab, or an independent contractor. Each expert should belong to one office.

   Any workflow in NMRA is conducted by a set of experts. The specialization of the experts is defined as one or more roles[1]:

· Secretary, that is responsible for the collaboration with the business

· Screener, that is responsible for formal documents

· Reviewer, that is responsible for expertise

· Inspector, that is responsible for the inspection in the field

· Accountant, that responsible for the fee, fines, etc.

· Moderator, that is an owner of the whole process in the workflow.

The competency of an expert is defined as one or more workflows in which the expert can execute at least one activity.

Figure 1. The structure of the Pharmadex 2 directory

= The management of users =

== Office ==
1. Pharmadex 2 assumes that the structure of offices is hierarchical. The Pharmadex 2 should provide the possibility to define in the database:

1.1. The main NMRA office

1.2. The branch NMRA offices

1.3. The NMRA departments in the main and, if it will be appropriate, branch NMRA offices

1.4. The partner’s or independent consultant`s offices

2. The departments are only for convenience.

3. For any office should be defined at least:

3.1. The name (prefLabel)

3.2. The description (description)

3.3. The list of administrative units managed by this office. An empty list means the country.

3.4. At least one “permanent” Google login for secretary user

4. The properties that may be added in the future should follow the standard <nowiki>https://www.w3.org/TR/vocab-org/#org:Organization</nowiki>

5. The partners and independent contractors should be registered in the office hierarchy at the second level – as departments or branch offices

== Expert ==
1. Each expert should be explicitly registered in Pharmadex 2 as a user. The registration data are:

1.1. Full name (prefLabel)

1.2. Textual description (description)

1.3. Salutation

1.4. The list of roles in Pharmadex 2. At least one role (specialization) is mandatory

1.5. The list of workflows to define the competency. At least one competency is mandatory

1.6. Enabled or disabled

2. The properties that may be added in the future should follow the standard <nowiki>http://xmlns.com/foaf/spec/#term_Person</nowiki>

3. A business user (the applicant) should not be registered in Pharmadex 2. However, the access denied procedure should exist.

4. All users should use Google login. Additionally, for the supervisor user should exist starting login name and password.

5. Should be provided the possibility to disable any Google login to access Pharmadex 2.

= The assignments of executors =
1. The assignment of the first experts should be automated:

1.1. select an office by the administrative unit.

1.2. select experts from the selected office by appropriate competency and specialization

1.3. In case the expert cannot be selected, the secretary of the first appropriate office should be assigned

1.4. In case the appropriate office cannot be selected, all supervisors should be assigned

2. The selection of experts by other experts should be manual, using the list of all experts with the appropriative competency and specialization.

The manual selection of experts
----[1] The names of roles may be varied from country to country, however the set of roles is uniform

Main Page

2022-06-21T16:52:22Z

KhoppenworthMSH:

[[File:Logo OpenRIMS.png|thumb]]
We are currently uploading all system documentation to this platform.

The process is estimated to conclude by August 2022.

This will go hand in hand with rebranding to OpenRIMS which logo is seen to the right.

Choose Module:

* Marketing Authorization
* Pharmacovigilance
* Import/Export
* Pharmacy Registration
* Pharmacy Inspection

Or choose Function:

*[Http://wiki.openrims.org/index.php/Installation%20Part1 Installation/Deployment Part 1]
*[Http://wiki.openrims.org/index.php/Installation%20Part%202 Installation/Deployment Part 2]
*[[Workflow Configuration]]

Technical Links for this Wiki:

[./Http://wiki.openrims.org/index.php/Special:AllPages List All Pages]
== Main Links for each Module ==
* User Guide for Pharmaceutical Manufacturers, Pharmacy Owners and other Clients of Regulatory Authorities
* User Guide for Regulatory Staff
* User Guide for System Administrators

Main Page

2022-06-21T16:51:20Z

KhoppenworthMSH:

[[File:Logo OpenRIMS.png|thumb]]
We are currently uploading all system documentation to this platform.

The process is estimated to conclude by August 2022.

This will go hand in hand with rebranding to OpenRIMS which logo is seen to the right.

Choose Module:

Marketing Authorization

Pharmacovigilance

Import/Export

Pharmacy Registration

Pharmacy Inspection

Choose Function:

*[Http://wiki.openrims.org/index.php/Installation%20Part1 Installation/Deployment Part 1]
*[Http://wiki.openrims.org/index.php/Installation%20Part%202 Installation/Deployment Part 2]
*[[Workflow Configuration]]

Technical Links for this Wiki:

[./Http://wiki.openrims.org/index.php/Special:AllPages List All Pages]
== Main Links for each Module ==
* User Guide for Pharmaceutical Manufacturers, Pharmacy Owners and other Clients of Regulatory Authorities
* User Guide for Regulatory Staff
* User Guide for System Administrators

OpenRIMS-RPM - Workflow Configuration Part 1

2022-06-21T16:34:39Z

KhoppenworthMSH: Created page with "= Introduction = This guide intends to Pharmadex 2 Supervisors and contains reference data necessary to the creation of on-screen forms. The Pharmadex 2 a..."

= Introduction =
   This guide intends to Pharmadex 2 Supervisors and contains reference data necessary to the creation of on-screen forms.

The Pharmadex 2 application and workflow data forms are configurable by the Supervisor. Any given data form consists of components. Each component provides an atomic functionality, i.e., data input/display field, choices from the pre-defined set of choices, file upload, file download, etc.

To place any data component to an on-screen form the Supervisor should:

· Define a place on the form

· Provide component-specific parameters

= Form layout =
   The basic configuration layout of an electronic form is in two columns. Depending on the room on the screen a form may be represented in two or one columns. In the case of the one-column representation, the second column will be placed under the first one.

   The numbering of rows and columns starts from zero.

Figure 1. The two columns layout

The heigh of components may be very different. Thus, placing one component to a cell (row, col) is almost unusable

Figure 2. The only cell is not enough

   To avoid this, the Pharmadex 2 provides the third coordinate – an order inside the cell. The order starts from zero and allows place many components in a cell.

Figure 3. Cell and order inside a cell are acceptable

= Electronic form =

== Where to find it? ==
   The definitions of all electronic forms are in the feature Administrate-Configuration-Data Configurator.

Figure 4. Electronic form configuration feature

1. Search for electronic form definition in the list below

2. List of all electronic form definitions

3. The definition of a selected electronic form (see above Figure 3)

== Configuration data form ==
   The data form configuration consists of general data and layout configuration. In own turn, the layout configuration consists of variables.

1. Select to access the layout configuration

2. Click to edit general data

3. Add new form

The general data consists of URL and description. URL is a unique identifier of the form; the description is a description of the whole form.

Figure 5. General form data

1. Click to edit URL

2. The description of data

3. Press to save the general data

4. Press to remove the general data

5. Press to do nothing

6. Press to copy the general data and the layout configuration

== Component configuration form ==
Figure 6. Layout form data

1. Click to edit a component definition (variable)

2. Add New component definition

3. Preview the electronic form

== Component definition ==
1. Click to edit the name of the component

2. The experimental feature will be described later

3. The help texts

4. Select a type of component, e.g., text field, file uploader.

5. Validation parameters. The particular meaning for a particular component

6. Screen position – row, col, order inside a cell (see Figure 3)

7. Additional configuration data for particular components

= The components configuration reference =

== headings ==
   Headers or links to external resources
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Link to external resource
|<nowiki>https://google.com</nowiki>
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== strings ==
   Text input field
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|min length in characters
|3
|-
|Maximal Offset
|max length in characters
|1024
|-
|required
|value is required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|
|
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|the value should be unique
|
|-
|The pattern for the field or file names
|Java Regular expression pattern[1]
|[a-zA-Z]{3}
|}

== literals ==
   See “strings” above

== dates ==
   Date input control
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|months from the current date
|<nowiki>-3</nowiki>
|-
|Maximal Offset
|months after the current date
|3
|-
|required
|value is required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|
|
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== numbers ==
   Number input field
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|min value
|0
|-
|Maximal Offset
|max value
|1000000
|-
|required
|value is required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|
|
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== logical ==
   Yes/No/NA logical field
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|
|
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== dictionaries ==
   Allows selection from the pre-defined choices. For example

Figure 7. The dictionary
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|at least one choice is required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|url of the dictionary
|dictionary.guest.deregistration
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== addresses ==
   Address dictionary with the possibility to select geographical coordinates

Figure 8. The address control
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|selection and coordinates are required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|where to store and find
|nepal.address
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== documents ==
   Upload documents

Figure 9. The file uploader component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|wide of the image[2] in pixels
|300
|-
|Maximal Offset
|height of the image in pixels
|300
|-
|required
|at least one file should be uploaded
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|where to store and find
|pharmacy.documents
|-
|dictUrl
|dictionary with the list of file to uplaod descriptions
|dictionary.pharmacy.site.photos
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|file types allowed[3]
|.jpg,.png,.tiff
|}

== resources ==
   Download documents, pictures, and templates.

Figure 10. The file resource component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where are the files stored?
|pharmacy.new.invoices
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|value is read-only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== things ==
   Sub-forms or forms that placed at the right of the main form

Figure 11. The main form and sub-forms

1. The main form. This form must contain a literal with the name prefLabel.

2. Additional forms that should be included using the “thing” class
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|URL of an electronic form configuration. This form should not contain “things”, however may contain any other component
|retail.pharmacy.classifiers
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== persons ==
   Allows adding detailed records to the main data. Examples are pharmacy owners to a pharmacy or warehouses to the wholesaler.

Figure 12. The "persons" component - detail records
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|at least one detail record is required
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store detail records
|site.owners.persons
|-
|dictUrl
|
|
|-
|auxURL
|The configuration of the detail record electronic form. This configuration can contain subforms, i.e. “things”
|site.owner.person
|-
|readOnly
|
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== schedulers ==
   Allows to run another follow-up application after the application will be approved. Examples are “scheduled renewal payment”, “scheduled inspection”, etc.

Figure 13. The scheduler component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|Offset in months from the current date to minimal possible date to run the follow-up application
|
|-
|Maximal Offset
|Offset in months from the current date to maximal possible date to run the follow-up application
|
|-
|required
|the scheduled date should fit the Minimal offset – Maximal offset criteria
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store the scheduler?
|pharmacy.site.renew
|-
|dictUrl
|
|
|-
|auxURL
|Which application should be scheduled?
|application.pharmacy.renew
|-
|readOnly
|Display date only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== registers ==
   Provides assigning numbers, registration date, and expiration date like a typical filing system register does.

Figure 14. The register component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|Offset in months from the current date to the minimal possible registration date
|<nowiki>-1</nowiki>
|-
|Maximal Offset
|Offset in months from the current date to the maximal possible expiration date
|
|-
|required
|the dates should fit the Minimal offset – Maximal offset criteria
|
|-
|mult
|If true, the dates will be available. Otherwise the registration only.
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store the register?
|pharmacy.site.renew
|-
|dictUrl
|
|
|-
|auxURL
|Which application should be scheduled?
|application.pharmacy.renew
|-
|readOnly
|Display date only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|The registration number prefix. For most filing systems – code of cases
|MR/
|}

== atc ==
   ATC codes for medicines

Figure 15. The ATC codes component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|Require at least one code selected
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store the selected codes?
|medicinalproduct.productclassification
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|Display date only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== legacy ==
   Allows select objects uploaded from the legacy data. Applicable for manual legacy data export, usage the legacy data for new applications, etc.

Figure 16. The legacy data component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|
|
|-
|Maximal Offset
|
|
|-
|required
|Require the selection
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|Where to store the selected codes?
|pharmacies.registered.legacy
|-
|dictUrl
|The kind of legacy data, e.g., pharmacies, medicines, etc.
|legacy.pharmacies
|-
|auxURL
|
|
|-
|readOnly
|Display date only
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

== intervals ==
   The interval between two dates.

Figure 17. The interval component
{| class="wikitable"
|'''Parameter'''
|'''Usage'''
|'''Example'''
|-
|Minimal Offset
|The length of the interval in months
|
|-
|Maximal Offset
|The max in the interval, zero means no restrictions
|
|-
|required
|Minimal Offset and Maximal offset constraints should be applied
|
|-
|mult
|
|
|-
| colspan="3" |Auxiliary Data
|-
|url
|
|
|-
|dictUrl
|
|
|-
|auxURL
|
|
|-
|readOnly
|
|
|-
|unique
|
|
|-
|The pattern for the field or file names
|
|
|}

----[1]

[2] In case if jpg, jpeg or png file will be uploaded. For other types of uploaded files will be ignored

[3] <nowiki>https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file</nowiki> - see attribute “accept”