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 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
maxLevel1



...

So you if you want to connect to a  install frevvo install running on localhost you can do as follows, replacing 'forms-cli.jar' with the current jar filename.

...

The following topics show how to log in to the  server frevvo server and use the command line API to interact with the server, projects, and forms and workflows.

...

The example below shows how to log in to a local  serverfrevvo server. In this example, the login user name is david, the name of the tenant is monahan.com, and the user password is david (e.g., login david@monahan.com david).

...

Code Block
localhost:8082/david@monahan.com> ?list

Name     Abbr     ArgNum     Descr
apps                0        SELECT apps for this user (e.g. 'apps')
subs                0        SELECT subs for this user (e.g. 'subs') you
tasks               0        SELECT tasks for this user (e.g. 'tasks')
themes              0        SELECT themes for this user (e.g. 'themes')
link      l         1        OPEN a link in the browser (e.g. 'link {link#}')
descr     d         1        UPDATE this entry's description (e.g. 'descr {newDescription}')
links     l         0        SHOW all entry links (e.g. 'links')
links     li        1        SHOW feed links for given rel attr (e.g. 'links {relAttr}')
name      n         1        UPDATE this entry's name (e.g. 'name {newName}')
print     p         0        PRINT this entry (e.g. 'print')
delete    d         0        DELETE this entry (e.g. 'delete')
refresh   r         0        REFRESH this entry (e.g. 'refresh')

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

...

You can use the apps > down and up commands to download projects to a local drive and upload them to the  serverfrevvo server.

Download

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

...

Source Code Example

Java Docs

Upload

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

...

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

...

Once you've selected a form, you can use it; this is, you can run the form as an end-user would. See the Editing a Form/Workflow topic above for instruction on selecting a form. Then simply type use at the command prompt and press Enter.  opens frevvo opens the form or workflow in your browser.

...

Now, the purchaseorder.xsd has been upload and you can verify that this is the case by going directly to the  UI frevvo UI in Projects->Schemas.


Add an new XSD data source to a form

...

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.

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

...