Upgrading Rich Forms

Owned by Saurabh Gupta (Unlicensed)
Last updated: Nov 23, 2021 by Ashhad AlamVersion comment
6 min read

Rich forms have an updated version now. To use the upgraded version with Adeptia Suite, you must follow these steps after you have applied the Adeptia Suite patch. 

If you have installed Adeptia Suite on HSQL database then you need to point your database to another database (SQL Server, My SQL or Oracle). You cannot upgrade Rich Forms on HSQL database. 

Prerequisites:

Ensure that you have: 

  • Applied the AdeptiaSuite patch.
  • Stopped Kernel and WebRunner.
  • Taken the backup of all the existing Rich Forms, if any. You can do this by running the Migration utility using Export option of Environment Promotion migration action. While running the utility, select All Objects option on the Select the action wizard and CustomApplication option on the Select Services to export wizard. 

To upgrade Rich Forms:

  1. Apply the Rich Form patch by following the same steps applied in Adeptia Suite patch.
  2. Import Adeptia Suite public certificate to Adeptia Suite Truststore. This step is mandatory only if you are accessing Adeptia Suite through HTTPS protocol.  
    1. Export Public Key 
      The steps to export the key varies from browser to browser. The following are the steps to export the public key in Google Chrome browser.
      1. Open the browser and type the HTTPS URL to access Adeptia Suite.
      2. Click  > More tools > Developer tools.
      3. Click Security tab. 
      4. Click View Certificate.



      5. On the Certificate window, on the Details tab, click Copy to File.



      6. Click Next to start exporting the certificate.



      7. Choose DER encoded binary X.509 (.CER) and click Next.



      8. Specify the location to save the exported file and click Next.



      9. Click Finish to export. A dialog box appears confirming the export process have been completed successfully.
      10. Click OK to exit from the wizard.
    2. Import Adeptia Suite certificate into Adeptia Suite Truststore
      1. Open Command Prompt (press Win + R and type cmd).
      2. Go to the directory where JRE is installed (for example, C:/Program Files/Java/jre8/bin).
      3. Run the following Keytool command to import a certificate
        keytool -import -trustcacerts -file <Path_of_SSL_Certificate> -alias <alias_name> -keystore <Path of Truststore file> -storepass changeit

        where,

                  <Path_of_SSL_Certificate> is the path of SSL certificate.

                  <Path of Truststore file> is the path of Adeptia Suite Truststore.

        For example, keytool -import -trustcacerts -file "/home/ec2-user/Downloads/localhost.cer" -alias selfsign -keystore "/opt/AdeptiaSuite-6.9/AdeptiaServer/ServerKernel/etc/truststore/cacerts"

  3. After applying the patch, create a new database with utf-8 character set. Depending on the database you are using, expand the database to find the query to create a new database. 

     MySQL
    create database <database_name> default character set "utf8" default collate "utf8_unicode_ci";
     SQL Server
    create database <database_name>;
     Oracle

    Adeptia supports Oracle 12c and 11g only. Depending on the version you are using, follow the wizard to create a new database.

    After creating the new database, you need to create a user other than System user and grant access to the Oracle database (created above) to the new user.

    1. Log in to the new database created above.
    2. Create a user by executing the following command:
      CREATE USER <Username> IDENTIFIED BY <Password> QUOTA UNLIMITED ON USERS;
      where,
                <Username> is the name of the user.
                <Password> is the password to authenticate a user.

    3. Run the following queries to grant permissions:

      GRANT CONNECT, CREATE SESSION, RESOURCE, CREATE VIEW TO <Username>;
GRANT create session TO <Username>;
GRANT create table TO <Username>;
GRANT create view TO <Username>;
GRANT create any trigger TO <Username>;
GRANT create any procedure TO <Username>;
GRANT create sequence TO <Username>;
GRANT create synonym TO <Username>;
GRANT create sequence TO <Username>;
GRANT create any index TO <Username>;
GRANT create sequence TO <Username>;
GRANT alter any table TO <Username>;
 
where,
      <Username> is the name of the new user created above.
  4. Go to .../<AdeptiaInstallFolder>/ServerKernel/etc folder.
  5. Open server-configure.properties file in the Text Editor.

    1. In Frevvo Database Configuration subgroup, provide the details of the database you are using in the properties. 

      Property Name
      Description
      abpm.frevvo.db.driver

      Name of the Frevvo database driver URL.

      MySQL: com.mysql.jdbc.Driver

      SQL-Server: com.microsoft.sqlserver.jdbc.SQLServerDriver

      Oracle: oracle.jdbc.OracleDriver

      abpm.frevvo.db.url

      Name of the Frevvo database connection URL. The format of the URL for MySQL and SQL Server database is:

      jdbc:<Database_Name>://<IPaddress_on_which_Database_is_installed>:<Database_Port_No>/<Database_Name_Created_in_Step3>

      If you are using a named instance of SQL Server database then enter the URL in the following format:

      jdbc:<Database_Name>://<IPaddress_on_which_Database_is_installed>:<Database_Port_No>/<Database_Name_Created_in_Step3>;instanceName=<instance_name>

      MySQL: jdbc:mysql://192.168.1.2:3306/frevvoDB

      SQL-Server: jdbc:sqlserver://192.168.1.1:1433;databaseName=frevvo

      SQL-Server (using instance): jdbc:sqlserver://192.168.1.1:1433;databaseName=frevvo;instanceName=adeptia

      The format of the URL for Oracle database is:

      Oracle: jdbc:oracle:thin:@<IPaddress_on_which_Database_is_installed>:<Database_Port_No>:<Database_Name_Created_in_Step3>

      for example, jdbc:oracle:thin:@192.168.1.3:1521:frevvodb

      abpm.frevvo.db.usernameDatabase username you are using. In case you are using Oracle then type the user name that you have created in the database in Step 3.
      abpm.frevvo.db.passwordPassword to access database. In case you are using Oracle then type the password that you have provided in the database in Step 3.

      To use an encrypted password of the database, change the value of 'encrypt' property to "y".
      abpm.frevvo.dbTypeDatabase you are using, for example, MySQL, SQL-Server, Oracle.



      If you are using SQL Server database, use Microsoft driver class and database URL instead of using JTDS.
    2. Save the file.
  6. Go to the extracted Rich Form patch folder.
    1. Open jetty.xml.
    2. Copy the highlighted code from the file.



    3. Open jetty.xml file from the .../<AdeptiaInstallFolder>/ServerKernel/etc/jetty folder.
    4. Replace the copied code in the file.
    5. Save the file.
  7. Go to .../<AdeptiaInstallFolder>/ServerKernel/etc/jetty/contexts folder.
  8. Rename richForms.xml_disable file to richForms.xml.
  9. Start Kernel and WebRunner. This will create Frevvo related tables in the newly created database.
  10. Open the browser and type the URL in the format: 
    <protocol_name>://<IPaddress>:<Port_No>/frevvo 
    where,
               <protocol_name> is the protocol you are using, for example, http or https.
               <IPaddress> is the domain name or IP address of the server hosting Adeptia Suite.
               <Port_No> is the port number of the server hosting Adeptia Suite.
    For example, http://192.168.1.1:8080/frevvo.

  11. On the License Expired screen, type the license key and click Submit. Contact Adeptia Support Team for the license key.

  12. Sign in to Frevvo using following default credentials and create a tenant:
    Username: admin@d
    Password: admin



    1. On the Manage server screen, click Manage Tenants.



    2. On the Tenants screen, click .
    3. On the Add New Tenant screen, type adeptia in the Tenant Id, Admin User Id, Tenant Name, Admin User Password, Tenant Description, and Re-enter Admin User Password.
    4. Type support@adeptia.com in the Admin User Email Address.



    5. Click Submit. This creates your tenant.
    6. Sign out from the user account.

  13. Now sign in to Frevvo using following credentials and deploy Adeptia Template Rich Form.   
    Username: adeptia@adeptia
    Password: adeptia
    1. Click Home.



    2. Click Upload.



    3. On the Upload Application screen, click Choose File, and upload AdeptiaTemplate_app.zip file from the folder where you have extracted Rich Form patch.



    4. Click Upload.
      This deploys Adeptia Template Rich Form.

Verifying Rich Forms Upgrade

To verify Rich Forms upgrade:

  1. Open the browser and type the URL in the format: 
    <protocol_name>://<IPaddress>:<Port_No>/frevvo 
    where,
               <protocol_name> is the protocol you are using, for example, http or https.
               <IPaddress> is the domain name or IP address of the server hosting Adeptia Suite.
               <Port_No> is the port number of the server hosting Adeptia Suite.
  2. Login using following credentials:
    Username: adeptia@adeptia
    Password: adeptia
  3. Check the Adeptia Live Forms version displayed at the bottom of the screen. If it is 7.3.2 indicates your Rich Forms version has been upgraded successfully.

If you have taken the back up of existing Rich Forms, deploy them by running the Migration utility using Deploy option of Environment Promotion migration action.

Updating SQL jar

This section is applicable if you are using the Rich Form v7.3.2 in Adeptia Suite.

In case you are using SQL as a backend database, it is recommended that you update the jar. Click here to download the compatible version of SQL jar (mssql-jdbc-6.1.4.jre8-preview.jar) and follow the steps therein to update it.