Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Megan Ellis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...


Section


Column

This tutorial demonstrates the frevvo Data API Java Client library features using a web application and a JSP. The web application is created using JSP (Java Server Pages).  We will refer to several Java Server Page files to explain the API features. You will see these delimiters in the files:

  • <% … %> delimiters in the JSP pages enclose Java code fragments.
  • <%= ... %> delimiters are used for expressions.

 <frevvo-home> in the file paths refers to the frevvo subdirectory that was created when you installed installed frevvo.

Note

In v9.1 and later frevvo's "Applications" are known as "Projects." The API objects and methods still use the word Application.



Column
width30%

On This Page:

Table of Contents
maxLevel2
 


...

  1. LoginAs and session management using API.
  2. Upload of a sample Tutorial Project into a designer frevvo designer account. 

  3. FormTypeFeed:Initialization of a form with XML data, Attachment and Wet Signature 

    1. List Projects, Forms and Workflows 
    2. Raw and Pop-Up links to use Forms/Workflows 
    3. Edit link to edit Forms/Workflows in design mode 
    4. View Submissions link to list all Form/Workflow Submissions
  4. TaskFeed: embed task list
  5. SubmissionFeed: Logout of user account using API
    1. List of all Form/Workflow submissions
    2. Link to Edit each submission 
    3. Links to submission XMLs 
    4. Link to submission print PDF 
    5. Links to wet signatures in each submission
    6. Links to uploaded attachments in each submission

...

You will need to do the following to complete this tutorial:

  1. Install and start up up frevvo.  (e.g.http://localhost:8082)
  2. Create a tenant  (e.g. apitutorial) with a tenant admin user (e.g. admin).
  3. Add a designer user account (e.g. designer) to your tenant.

  4. Follow these steps to install the Java API tutorial web application.

    1. Download the Java API Tutorial v5.2 zipfile.

    2. Extract the web-application api.war file to the <frevvo-home>\tomcat\webapps directory.
      We are using the tomcat servlet which is included in the  bundlefrevvo bundle.

    3. Re-start frevvo. This will expand the war to the <frevvo-home>\tomcat\webapps\api directory.

...

These client libraries are already added in <frevvo-home>\tomcat\webapps\api\WEB-INF\lib directory of the web application that we are using. However, the actual jar versions may be different depending on the version of frevvo being used. To ensure that you have the latest versions of these files, it is recommended that you replace the client libraries that come with the Java API Tutorial Project with the .jar files located in the <frevvo-home>\ext\client directory of your  buildyour frevvo build.

Follow these steps to perform the replacement:

  1. Stop frevvo.
  2. Copy the latest jar files from <frevvo-home>\ext\client directory of your  buildyour frevvo build.
  3. Replace the files in the <frevvo-home>\tomcat\webapps\api\WEB-INF\lib directory with the client libraries copied in Step 2 .

Configure and Execute the Web Application

You must update the  server frevvo server and tenant information in the doLogin.jsp file for the web application to work. Follow the steps below:

  1. Edit the <frevvo-home>\tomcat\webapps\api \apitutorial\doLogin.jsp file. 

    1. On line number 14, replace the default values with your frevvo server and port number:

      Code Block
      service = new FormsService("http", "localhost", 8082, null); 
to 
service = new FormsService("http", "<your-frevvo-server-host>", <your-frevvo-server-port>, null);



    2. On line number 20, replace the default values with the admin username, tenant and admin user password previously created for this tutorial: 

      Code Block
      "admin@apitutorial", "admin"  
to 
"<your-tenant-admin-user>@<your-tenant>", "< your-tenant-admin-user-password>"


  2. Save the file and re-start frevvo (tomcat).

To check if your web application is working, browse http://<your frevvo server host>:<port>/api/apitutorial/index.html. E.g. http://192.168.1.71:8082/api/apitutorial/index.html. You should see a login page like this one:

...

  1. This JSP page contains a small HTML form with a username field which accepts the  username the frevvo username to be logged in to.

  2. It also accepts a URL parameter targeturl which is used to redirect the user after login. If a targeturl is not passed to the login.jsp page it will use formtypes.jsp as the default targeturl: 

    Code Block
    String url = request.getParameter("targeturl"); 
if (url == null)  
         url = "formtypes.jsp"; 
url = "doLogin.jsp?targeturl=" + url;


...