Digital Signing Application

GitHub Repository | npmjs package | Unpkg CDN | Esign Bundle | Project documentation

Esign - The digital signature service at the university.

Prerequisites

• You need the API server running
• You need the DbpRelayEsignBundle to allow signing of PDF files
• For more information please visit the ESign project documentation

Local development

# get the source
git clone git@github.com:digital-blueprint/esign-app.git
cd esign-app
git submodule update --init

# install dependencies
npm install

# constantly build dist/bundle.js and run a local web-server on port 8001
npm run watch

# constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_custom/
npm run watch-custom

# run tests
npm test

Jump to http://localhost:8001 and you should get a Single Sign On login page.

To use the Nextcloud functionality you need a running Nextcloud server with the webapppassword Nextcloud app like this Nextcloud Development Environment.

Using this app as pre-built package

Install app

If you want to install the DBP Signature App in a new folder signature-app with a path prefix / you can call:

npx @digital-blueprint/cli install-app signature signature-app /

Afterwards you can point your Apache web-server to signature-app/public.

Make sure you are allowing .htaccess files in your Apache configuration.

Also make sure to add all of your resources you are using (like your API and Keycloak servers) to the Content-Security-Policy in your signature-app/public/.htaccess, so the browser allows access to those sites.

You can also use this app directly from the Unpkg CDN for example like this: dbp-signature/index.html

Note that you will need a Keycloak server along with a client id for the domain you are running this html on.

Update app

If you want to update the DBP Signature App in the current folder you can call:

npx @digital-blueprint/cli update-app signature

Activities

This app has the following activities:

• dbp-acquire-3g-ticket
• dbp-show-active-tickets
• dbp-show-reference-ticket

You can find the documentation of these activities in the esign activities documentation.

Adapt app

Functionality

You can add multiple attributes to the <dbp-signature> tag.

attribute name	value	Link to description
provider-root	Boolean	app-shell
lang	String	language-select
entry-point-url	String	app-shell
keycloak-config	Object	app-shell
base-path	String	app-shell
src	String	app-shell
html-overrides	String	common
themes	Array	theme-switcher
darkModeThemeOverride	String	theme-switcher
gp-search-hash-string	String	greenlight activities
gp-search-self-test-string-array	String	greenlight activities
gp-self-test-valid	Boolean	greenlight activities
ticket-types	Object	greenlight activities
show-preselected	Boolean	greenlight activities
preselected-option	String	greenlight activities
file-handling-enabled-targets	String	file-handling
nextcloud-web-app-password-url	String	file-handling
nextcloud-web-dav-url	String	file-handling
nextcloud-file-url	String	file-handling
nextcloud-auth-info	String	file-handling
nextcloud-name	String	file-handling
allow-annotating	Boolean	esign activities
file-handling-enabled-targets	String	esign activities

Mandatory attributes

If you are not using the provider-root attribute to "terminate" all provider attributes you need to manually add these attributes so that the topic will work properly:

<dbp-signature
        auth
        requested-login-status
        analytics-event
        initial-file-handling-state
        clipboard-files
>
</dbp-signature>

Design

For frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the theming documentation.

"dbp-signature" slots

These are common slots for the app-shell. You can find the documentation of these slots in the app-shell documentation. For the app specific slots take a look at the esign activities documentation.