Versions Compared

Key

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

This tutorial will walk you through a few API scenarios focusing on the design-time integration such as creating new forms, listing and managing projects, launching the designer for a workflow, downloading schemas, projects, forms and workflows, download the XSD for a form/workflow, uploading custom XSDs, using forms and workflows.

Note

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

Column
width30%

On this page:

Table of Contents
maxLevel1
 


What are we going to build?

...

The  UI displays the projects belonging to the user david@monahan.com on the projects home page.

Image Removed

The apps command displays a list of the projects in the tenant on the server — DTM July 2011'and DTM August 2011 in this example.

...

In the  UI, you can download projects individually, and select the destination directory.

Image RemovedImage Added

In this example, down downloads all the projects in the tenant to a directory on the local machine. Since down takes no arguments, the target directory depends on your local machine settings.

...

Source Code Example
Java Docs 

Upload

In the  UI, you can upload projects from the projects page.

Image Modified

In this example, up uploads a single project into the tenant. Note that we moved the ZIP files we downloaded in the previous step to a different directory before using up.

...

As with downloading projects, in the  UI, you can download individual forms and workflows and select the destination directory when you're editing a project on the projects home page.

Image Modified

In this example, down downloads all the forms and workflows in the tenant to a directory on the local machine. You can't choose which forms to download, and since down takes no arguments, the target directory depends on your local machine settings. Since the command downloads

...

You can use the forms> create command to create a new form or a workflow. You first select the project to which you want to add the new form, list its forms, and then create the form.

 


Code Block
localhost:8082/david@monahan.com> apps
-----------------------------------------------------------------------------------------
URL ! http://localhost:8082/frevvo/web/tn/monahan.com/api/apps
    # | NAME                                 | DESCRIPTION
    1 | DTM July 2011                        | Group of test forms created by DTM.
    2 | DTM August 2011                      | Forms started in August.
-----------------------------------------------------------------------------------------
localhost:8082/david@monahan.com/apps> select 2
-----------------------------------------------------------------------------------------
            ID | _5Crikb-LEeCP198_WwQSNw!david
           URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/app/_5Crikb-LEeCP198_WwQSNw!david
       UPDATED | 2011-08-10T10:22:56.851-04:00
          NAME | DTM August 2011
   DESCRIPTION | Forms started in August.
-----------------------------------------------------------------------------------------
localhost:8082/david@monahan.com/apps/DTM August 2011> forms
-----------------------------------------------------------------------------------------
URL ! http://localhost:8082/frevvo/web/tn/monahan.com/api/formtypes
    # | UPDATED                 | KIND | READONLY | VISIBILITY | NAME
    1 | 2011-08-05T13:54:58.628 | FORM | false    | PRIVATE    | Contact Form
    2 | 2011-08-09T15:29:47.477 | FORM | false    | PRIVATE    | NewForm
    3 | 2011-08-09T15:56:23.552 | FORM | false    | PRIVATE    | LodgingMeals
-----------------------------------------------------------------------------------------
localhost:8082/david@monahan.com/apps/DTM August 2011/forms> create 'TestForm'
-----------------------------------------------------------------------------------------
            ID | _X9B3YMNcEeCRfoJ9kSWZ1Q!_5Crikb-LEeCP198_WwQSNw!david
           URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/formtype/_X9B3YMNcEeCRfoJ9kSWZ1Q!_5Crikb-LEeC P198_WwQSNw!david
       UPDATED | 2011-08-10T10:23:53.442
          NAME | TestForm
   DESCRIPTION | Edit the form to change this description.
          KIND | FORM
      READONLY | false
    VISIBILITY | PRIVATE
-----------------------------------------------------------------------------------------
localhost:8082/david@monahan.com/apps/DTM August 2011/forms/TestForm>

...

Code Block
localhost:8082/david@monahan.com/apps/DTM July 2011/forms/Address Book> edit

Editing form: http://localhost:8082/frevvo/web/tn/monahan.com/user/david/app/_W0jPga4rEeCMGZK99v93jw/formtype/_fNScEK4rE
eCMGZK99v93jw?edit=true&embed=true&_method=post&apikey=IIGGTVxO1DtiDmUSnIiLzmXQjd6SGJ5c%252FpLVUNm%252FKE8AWzjV0xakncsLK
l2aocCYxj3lHuYWNr5q4Su8O%252FQlyQ%253D%253D

localhost:8082/david@monahan.com/apps/DTM July 2011/forms/Address Book>

Image RemovedImage Added

You can edit the form in the designer as if you had logged in through the UI. Make any changes you want to the form, and then click Finish or Cancel to exit the designer. You return to the UI login page.

...

Now that we have a new form, we need to add a new XSD data source to the form using the API, which is the equivalent to adding a new data source in the designer by clicking the Data Sources panel and then clicking New from XSD as shown in the following screenshots.
Image RemovedImage Added

 displays the available schemas in the current project. You can then click  to select the XSD you want to use.  adds it to the Data Sources panel. 

...

Click  next to form to add all the controls to the new form, or click the individual controls you want. frevvo adds them to the form. Click Finish when you're done to exit the UI.
Image RemovedImage Added

You can now use the new form from the command line.

...