Skip to main content
Version: Next

Windows

Prerequisites

  • Docker needs to be installed andd running

Step 1: Download the GitHub Repository

In this initial step, download the Forms Flow AI Deployment GitHub repository by simply clicking Here

A zip file will be downloaded.

Step 2: Extract the downloaded .zip file

extracted folder preview

Now double click and open the exctracted folder and go to the scripts folder:

scripts folder preview

There you can see an install.bat file:

.bat file preview

Step 3: Double click the install.bat file to proceed with installation

a) If you encountered this warning from Microsoft Defender click run anyway and proceed with the installation:

warning preview

b) The installation starts with the following question:

Redash analytics prompt

  • If you need Redash Analytics Engine in the installation, provide ‘y’ as the answer, or else answer ‘n’. (To know more about Redash Analytics Engine, please visit Redash ).

c) Verify the IP address is valid or incorrect after that. If true, provide ‘y’ as the answer, or else answer ‘n’:

IP Address prompt

d) As part of the installation, if the user has chosen the option to install with “Analytics” the user is asked to enter the Redash API key after the successful installation of Redash.

redash api key prompt

  • The Redash application should be available for use at port defaulted to 7000. Open http://localhost:7001/ on your machine and register with any valid credentials: redash landing page

  • To get the Redash API key, log in to http://localhost:7001/, Choose Settings > Account, and copy the API Key and paste it into the cmd. The installation will continue. redash setings page

e) Now it will ask to include formsflow data analysis api in the installation. Chose 'y' or 'n' according to your preference:

formsflow data analysis api prompt

f) Once the installation is complete, the command prompt displays the Formsflow.ai is successfully installed and press any key to finish the installation. The Docker Desktop displays all the installed containers:

Successfull installation

Step 4: Mail-Configuration

For the email-configuration, follow the steps below:

configuration folder

Create a folder inside the configuration folder(Inside docker-compose directory) named bpm-mail-config.

mail configuration file

Create a file name mail.config.properties inside the bpm-mail-config folder that just created and copy the below contents and update the values as needed:

# Send mails via SMTP. The given settings are for Gmail 
mail.transport.protocol=smtp

mail.smtp.host=smtp.gmail.com
mail.smtp.port=465
mail.smtp.auth=true
mail.smtp.ssl.enable=true
mail.smtp.socketFactory.port=465
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

# Poll mails via IMAPS.
mail.store.protocol=imaps
mail.imaps.host=imap.gmail.com
mail.imaps.port=993
mail.imaps.timeout=10000

mail.sender=donotreply
mail.sender.alias=DoNotReply

mail.attachment.download=true
mail.attachment.path=attachments

# Credentials
mail.user=CHANGEME@gmail.com
mail.password=CHANGEME

  • Now run the container to verify the changes.

Verifying the Installation status

The following applications will be started and can be accessed in your browser.

Srl NoService NameUsageAccessDefault credentials (userName / Password)
1KeycloakAuthenticationhttp://localhost:8080admin/changeme
2forms-flow-formsform.io form building. This must be started earlier for resource role id's creationhttp://localhost:3001admin@example.com/changeme
3forms-flow-analyticsRedash analytics server, This must be started earlier for redash key creationhttp://localhost:7001Use the credentials used for registration / Default user credentials
4forms-flow-webformsflow Landing web apphttp://localhost:3000Default user credentials
5forms-flow-apiAPI serviceshttp://localhost:5001Authorization tocken from keycloak role based user credentials
6forms-flow-bpmCamunda integrationhttp://localhost:8000/camundaDefault user credentials

Uninstall Formsflow

To uninstall formsflow installed through quick installation, click the uninstall file in the \forms-flow-ai-deployment\scripts directory:

uninstall formsflow

If you face any issues while installing ,please connect with us.