Skip to content

qbicsoftware/barcode-dragon-portlet

Repository files navigation

Barcode Dragon Portlet

Barcode Dragon Portlet, Portlet which allows the creation of sample sheets for customers.

Build Maven Package Run Maven Tests CodeQL release license language

How to Run

This portlet requires the following installations on the executing system:

  1. Python 2.7
  2. Ghostscript
  3. Pdflatex

Additionally the following repositories have to be downloaded and setup as outlined in the properties section:

  1. postscriptbarcode
  2. barcode-creation

Compile the project with java 8 and build a web application archive with Maven:

mvn clean package

The WAR file will be created in the /target folder:

|-target
|---barcode-dragon-portlet-<VERSION>.war
|---...

The application can be run as follows:

mvn jetty:run 

Configuration

The default configuration of the app binds to the local port 8080 of the systems localhost:

http://localhost:8080

Properties

To run the tool you need to fill in a multitude of credentials. To do so you can copy and adapt the following template portlet.properties found in the setup_samples directory:

Property Description Default Value
datasource.url The URL to the host of the openBis instance localhost
datasource.user The openBis user name openbisusername
datasource.password The openBis user password openbispassphrase!
tmp.folder Path into which the postscript tmp files should be stored my/postscript/tmp/folder!
barcode.postscript Path to the downloaded postscriptbarcode repository /downloads/postscriptbarcode/
barcode.result Path where the created barcodes should be stored /my/created/barcodes
barcode.scripts Path to the downloaded barcodescripts repository downloads/barcodescripts/
path.variable Path to the Python 2.7 installation on the executing system /my/python/path/
mysql.host The URL to the host of the user database localhost
mysql.db The name of the database user_management_database
mysql.user The database user name dbusername
mysql.port The port on which the user database can be accessed 8080
mysql.pass The database user password dbpassphrase!
mysql.input.usergrp The liferay user group able to view the barcode printer privilegedliferayuser
mysql.input.admingrp The liferay admim group able to view the barcode printer privilegedliferayadmin
metadata.write.group The group able to write metadata metadata-writers

Additionally you need to provide and adapt the following repositories:

  1. Monolithic release of postscriptbarcode
    1. Adapt the barcode.postscript property in the portlet.property file of the barcode-dragon-portlet repository to the path of the downloaded postscriptbarcode repository

  2. barcode-creation
    1. Adapt the barcode.scripts property in the portlet.property file of the barcode-dragon-portlet repository to the path of the downloaded barcode-creation repository.

    2. Navigate into the folder wizard_scripts of the cloned barcode-creation repository and create the following files:

      1. properties_path.txt file solely containing the path to the portlet.properties file of the barcode-dragon-portlet repository:

        /path/to/barcode-dragon-portlet/portlet.properties
        
      2. test.properties file containing the same property specification as are set in the portlet.property file of the barcode-dragon-portlet repository:

          barcode.postscript = <path/to/postscriptbarcodefolder>
          barcode.results = <path/to/postscriptbarcodeoutputfolder>
          tmp.folder = <path/to/postscriptbarcodetmpfolder>
        

An example for both files are provided in the setup_samples folder of the barcode-dragon-portlet repository

How to use

barcode_screenshot_1

This portlet allows the creation of sample sheets and barcode stickers for customers. Sample sheets contain QBiC's logo, QBiC's contact information, the customer's name and address and finally the respective QBiC contact's name and contact information. Additionally, barcodes and detailed information related to the barcodes is added in their respective columns. Barcodes can be customized, take a look at the screenshots.

barcode_screenshot_2

License

This work is licensed under the MIT license.

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 10