Box Connector

Live Forms v8.0 is no longer supported. Please visit Live Forms Latest for our current Cloud Release. Earlier documentation is available too.

Box Connector

The box.com connector will no longer be supported. The Save to box.com wizard will be removed in the next release.

Installing the Box Connector

Cloud Customers

If you use the Live Forms Cloud hosted server, the connector is already installed and configured. You can immediately begin to Connect your Forms/Flows using the Save to Box.com wizard.

In-house Customers using the frevvo Tomcat bundle

The Box connector can be installed behind your firewall where it can connect to your back end system in order to read/write data. These instructions assume you have an in-house installation of 

 up and running and you are using the frevvo Tomcat bundle:

To install the Box connector in the same tomcat as

:

  1. Stop

    .

  2. Download the box connector zipflile from here

  3. Extract the box.war file to your <frevvo-home>\tomcat\webapps directory.

  4. Create an Application for Live Forms on box.com

  5. Configure the Box Connector - (In-house only)

Create a Box.com Application for Live Forms

You must create a content API application for

.

Follow these steps;

  1. Navigate to https://developer.box.com/ and signup for an account.

  2. Navigate to the same link and login. Click Getting Started on the My Applications screen.





  3. You are prompted to create an box application. Give the application a unique name (name has to be unique across entire ecosystem of developer applications (both private and public)).





  4. On the General Information section of the screen, the application name and support email will be prefilled. Verify that the Content API Access Only button is checked.





  5. On the OAuth2 Parameters section of the screen,

    1. Copy the client_id and save it somewhere. You will need this to configure the box connector in the frevvo-config.properties file in 

      .

    2. Copy the client_secret and save it somewhere. You will need this to configure the frevvo.config.properties file in 

      .

    3. Enter the base uri for your installation in the redirect_uri field. Change the <your server name> and <port #> shown in the image to your information:

    4. Verify that Read and Write all files and folders stored in box is checked in the Scope section. This is the only scope required by 

      .





  6.  Save the box application.

Configure the Box connector (in-house only)

These instructions assume you are using the frevvo tomcat bundle. The Box connector is configured using properties located in the <frevvo-home>/tomcat/conf/frevvo-config.properties file.

Follow these steps:

  1. Stop

  2. Navigate to <frevvo-home>\frevvo\tomcat\conf\ directory.

  3. Edit the frevvo-config.properties file.

  4. Locate the Box Connector section of the file.

  5. Add the client id that you copied and saved earlier as the value of the frevvo.box.connector.client.id property by pasting it after the equal sign.

  6. Add the client secret that you copied and saved earlier as the value of the frevvo.box.connector.client.secret property by pasting it after the equal sign.

  7. Remove the # in front of the properties if it is there

  8. Save the changes.





  9. Start

    . If you are running
    v7.1+, make sure the Insight server is running before starting
    .

  10. Browse http://<your server:port>/box/health (replace <your server:port> with your frevvo server:port) to check the status of the connector. If the connector is up and running, you will see { "status" : "UP" }.

  11. Proceed to Connect Forms/Flows with the Save to Box.com wizard

Connect Forms and Flows with the Save to Box.com wizard

  1. Login to your box account and create a folder for your form/flow. Let's say you have an Employee On-boarding workflow and you want to store all of the submissions in a folder named Employee On-Boarding.

  2. Create your form or flow as usual. Generate a frevvo-PDF,map to your custom PDFs, upload attachments if required.

  3. Login as a 

    designer user.

  4. Click the

    Edit icon to open your form/flow.

  5. Click on the

    what happens to my data? icon on the designer toolbar.

  6. Select the Save to box.com option.





  7. In the wizard that pops up, provide your credentials. You’ll be redirected to login to box if you are logging into your account for the first time.

    1. On successful login, you are asked to either grant or deny permission to the scopes specified in the

      box application that you created earlier. Click the Grant Access to Box button to continue.





    2. When granted permission, the Oauth token is generated and stored in

      . The wizard will login to your box account, browse to find available folders and display them.


  8. Select a parent folder (e.g. Employee On-boarding) and a submission folder. Let's say you want the name of the submission folder that contains the documents to be the new employee's First Name and Last Name,. Use a template that’s dynamically generated e.g. {FirstName} {LastName}. You can select the fields in your form/flow by clicking on the dropdown to the right of the Submission folder field.



    Select the types of documents you want to send to box as part of the submission. The choices are:


    • Send the data as a PDF attachment or other image type using the Send Snapshot dropdown. The image type options are PDF, PNG or JPG.  Select the blank option from the dropdown to exclude this attachment in the submission.

    • Attach an XML data document using the Send Data checkbox. This checkbox is checked by default. Uncheck it to exclude the XML data document in the submission.

    • Attachments uploaded to your form/flow are included if the Send Files checkbox is checked. This checkbox is checked by default. Uncheck it to exclude attachments in the submission.

    • If you have Pixel Perfect mapped PDFs (ex: W-4, I-9 etc…) associated with your forms/flows, choose  the action you want to take from the Send Gen Forms control:

      • Check All to send all the Pixel Perfect PDFs. This is the default value.

      • Check None to send none of the PDFs

      • Check Select to display a list of all the PDFs associated with your form/flow. Click the ones you want to be part of the submission. Hold down the Shift key then click the files in the list to select all PDFs or hold the control key and click specific PDFs.

  9. Click Finish.

  10. Save your form or flow by clicking the

    save and exit icon.