What are we going to build?

This tutorial will cover the following functions: 

1. LoginAs and session management using API.

2. Upload of a sample Tutorial Application into a

   

   designer account. 

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

   1. List Applications, Forms and Flows 

   2. Raw and Pop-Up links to use Forms/Flows 

   3. Edit link to edit Forms/Flows in design mode 

   4. View Submissions link to list all Form/Flow Submissions

4. TaskFeed: embed task list

5. SubmissionFeed: Logout of user account using API

   1. List of all Form/Flow 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

What are we going to need?

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

1. Install and start up 

   

   .  (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

      

       bundle.

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

Installing the Client Libraries and Dependencies

 The Live Forms Java Client Library has the following dependencies:

• com.frevvo.forms.java-5.2.jar　

• com.frevvo.forms.java-5.2-javadoc.jar

• commons-io-2.0.1.jar

• activation-1.1.1.jar

• mail-1.4.4.jar

• json-1.0.0.jar

• commons-httpclient-3.1.jar

• commons-codec-1.2.jar

• commons-logging-1.0.4.jar

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 Live Forms 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 Application with the .jar files located in the <frevvo-home>\ext\client directory of your 

build.

Follow these steps to perform the replacement:

1. Stop

   .

2. Copy the latest jar files from <frevvo-home>\ext\client directory of your 

   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 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 Live Forms server and port number:

      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: 

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

2. Save the file and re-start

   (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:

LoginAs

The FormsService instance is state-full and the same instance needs to be used throughout the session. This is especially the case when rendering form URLs in the browser since an API key is automatically appended and bound to the FormsService session. As soon as you logout(), the API key becomes invalid. Typically, in a web application context, the FormsService instance is stored in the HTTP session that the user has with your web application.

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

1. This JSP page contains a small HTML form with a username field which accepts the 

   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: 

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