Installation

Initial Installation

Database

• Connect to the sbcs main database and create the faw schema. Exit afterwards (e.g. using Ctrl+d)

  psql --host=localhost --user=sbcs --db=sbcs

  CREATE SCHEMA faw;

Smart-BCS

• Install the Forms and Workflows Service

  apt install sbcs-faw

• Create JWT for the Forms and Workflows Service. Copy the output of this command, it is required for the next step.

  sbcs-create-ticket --sub sbcsfaw

• Edit the Forms and Workflows Service configuration file at /etc/ecm4u/sbcs-faw/config. You need to change some values here to fit your environment, these are at least:
  • FAW_JWT
  • FAW_LDAP_HOST
  • FAW_LDAP_BIND_DN
  • FAW_LDAP_PASSWORD
  • FAW_LDAP_USER_SEARCH_BASE
  • FAW_LDAP_GROUP_SEARCH_BASE
  • FAW_LDAP_USER_QUERY
  • FAW_EMAIL_HOST
  • FAW_EMAIL_USERNAME
  • FAW_EMAIL_PASSWORD

### Forms and Workflows ###
# FAW server runs in development mode and reads modules from the filesystem.
FAW_DEVELOPMENT_MODE=false

# The FAW server must be given a JWT issued by your SBCS Ticket Server.
# This JWT is used by the FAW server in all requests to other SBCS servers.
FAW_JWT=previsously_generated_JWT

# Name of the DB database.
FAW_DB_DB=sbcs

# Any options to append to the JDBC URL.
FAW_DB_OPTIONS=currentSchema=faw

# Password to access th DB database.
FAW_DB_PASSWORD=3KS2AfjdnwZU9dVAk92dY7v7JeVfnoaTmffJ

# File to read global properties from.
FAW_GLOBAL_PROPERTIES=/etc/ecm4u/sbcs-faw/faw-global.properties

### RabbitMQ ###
# User to access the RabbitMQ server.
FAW_AMQP_USER=sbcsfaw

# User to access the RabbitMQ server.
FAW_AMQP_PASSWORD=HpQM7WS4bnxBTUhnPJFdq9xk72AtTm5FVZsB

### LDAP ###
# LDAP host.
FAW_LDAP_HOST=ldap_host

# LDAP bind user.
FAW_LDAP_BIND_DN=ldap_bind

# LDAP bind user password.
FAW_LDAP_PASSWORD=ldap_password

# LDAP user search base.
FAW_LDAP_USER_SEARCH_BASE=OU=users,OU=company,DC=intra

# LDAP group search base.
FAW_LDAP_GROUP_SEARCH_BASE=OU=groups,OU=company,DC=intra

# LDAP user query.
FAW_LDAP_USER_QUERY=ldap_user_query

### E-Mail ###
# SMTP server.
FAW_EMAIL_HOST=email_host

# SMTP username.
FAW_EMAIL_USERNAME=email_user

# SMTP password
FAW_EMAIL_PASSWORD=email_password

• TODO Create profile (depends on deployed modules)

  
  # ##################################
  # profile alf-sbcs-ecm4uBizDocs
  # ##################################

AMQP

alf-sbcs_ecm4u_intra.sys_amqpExchange=sbcs

Resource Service

alf-sbcs_ecm4u_intra.resourceServiceBackendId={$alfresco_host}

transfer mappings

alf-sbcs_ecm4u_intra.transferTargetType=alfresco

transfer mapping 'alfresco'

alf-sbcs_ecm4u_intra.transferTargets.alfresco.urlTemplate=http://{$alfresco_host}/alfresco/service/ecm4u/faw-properties alf-sbcs_ecm4u_intra.transferTargets.alfresco.username={$alfresco_transfer_user_name} alf-sbcs_ecm4u_intra.transferTargets.alfresco.password={$alfresco_transfer_user_pw}

own domains (see https://support.ecm4u.de/issues/6538)

alf-sbcs_ecm4u_intra.sbcsDocumentDataCapture.ownDomains={$own_domains}

alf-sbcs_ecm4u_intra.mdhHost=http://{$mdh_host}/mdh

script names

alf-sbcs_ecm4u_intra.calculateRolesScriptName=calculateRoles.js alf-sbcs_ecm4u_intra.initializeTaskInstanceScriptName=sbcs-document-data-capture-initializeTaskInstanceScript.js

email

alf-sbcs_ecm4u_intra.emailHost={$email_host} alf-sbcs_ecm4u_intra.emailSender={$email_sender_name} alf-sbcs_ecm4u_intra.emailPassword={$email_sender_pw} alf-sbcs_ecm4u_intra.sys_emailFrom={$email_from}

* TODO Create client config (depends on deployed modules / host)

hotfolder: alf-sbcs-ecm4uBizDocs: profile: alf-sbcs-ecm4uBizDocs path: ~/documents-inbound/alfsbcs taskType: UploadNewDoc module: ecm4uBizDocs flowType: Inbound Document Flow

faw: base: http://{$faw_host}/faw/ api: api/v1/ webview: resources/webview/ preview: resources/preview/web/viewer.html

ticketserver: base: http://{$ticketserver_host}/ticketserver/api/v1/ cookie: ecm4u-jwt

amqp: host: {$amqp_host}

* Create required tables in the `faw` schema

sbcs-faw-migrate migrate

* Start the Resource Service

systemctl start sbcs-faw

## Upgrading

TODO