Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The client is packaged as an executable Java JAR that includes all of the required dependencies and you can download the binaries  from here and the sources from here.

Running the command-line client

...

This means that you are up and running, but not yet connected. First you need to log in to a frevvo account. Be sure to create at least one tenant and one user for the tenant before you try to log in. See Connect to an Oracle Forms a Server and Log In below  below for instructions.

How are the sources organized?

...

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

Connect to

...

a Server and Log In

The example below shows how to log in to a local  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/apps> ?list
Name    Abbr     ArgNum     Descr
up                 1        UPLOAD an application (e.g. 'up /var/contacts_apps.zip')
down               0        DOWNLOAD ALL applications into temp folder (e.g.: 'download')
link     l         1        OPEN a link in the browser (e.g. 'openLink {link#}')
links    li        1        SHOW feed links for given rel attr (e.g. 'links {relAttr}')
links    l         0        SHOW all feed links (e.g. 'links')
next     n  0 NEXT feed page     0        NEXT feed page (e.g. 'next')
prev     p         0        PREVIOUS feed page (e.g. 'previous')
print    pr        0        PRINT current feed (e.g.: 'print')
delete   d         1        DELETE an entry (e.g. 'delete {entry#}')
create   c         1        CREATE a new entry (e.g.: 'create {name}')
refresh  r         0        REFRESH current feed (e.g.: 'refresh')
select   s         1        SELECT an entry (e.g.: 'entry {entry#}')

...

Note

After the upload, the command prompt now includes the name of the uploaded application (''../apps/DTM August 2011''). Use the '''?list''' command to see what you can do with the application.

...

Note

After the upload, the command prompt now includes the name of the uploaded form (''../forms/TitleDepartment'').

Source Code Example

Java DocsDoc===

Creating a Form/Flow

...

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

 <pre>

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>

...

Note

The command prompt includes the new form name (''../forms/TestForm>''), so you can

...

Downloading and Uploading a Form/Flow from the command line at this point.

...

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeFeed.html Java Docs]

...

Source Code Example

Java Docs

Editing a Form/Flow

...

To edit a form, you first select the application the form belongs to, and then select the form you want. See [[DataAPI_DesigntimeIntegration#Downloading_and_Uploading_a_Form.2FFlow | Downloading and Uploading a Form/Flow]] for  for instructions on selecting an application.

Once you've gotten to the application you want, you can use the '''forms''' command forms command to see what forms it contains and use '''?list''' to  to see what you can do with them. In the example below, we use '''select 1''' to  to select the first form in the list (''Address Book'').<pre>

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

...


-----------------------------------------------------------------------------------------

...


URL ! http://localhost:8082/frevvo/web/tn/monahan.com/api/formtypes

...


    # | UPDATED                 | KIND | READONLY | VISIBILITY   | NAME

...


    1 | 2011-07-25T14:31:47.118 | FORM | false    | PUBLICTENANT | Address Book

...


    2 | 2011-07-18T17:04:13.255 | FORM | false    | PUBLICTENANT | Dinner Selections

...


    3 | 2011-08-08T11:29:18.522 | FORM | false    | PUBLICTENANT | TitleDepartment

...


    4 | 2011-07-25T16:24:51.003 | FLOW | false    | PRIVATE      | Flow 42

...


-----------------------------------------------------------------------------------------

...


localhost:8082/david@monahan.com/apps/DTM July 2011/forms> ?list

...



Name     Abbr      ArgNum     Descr
up                   1        UPLOAD an application (e.g. 'upload /var/contacts_apps.zip')

...


...

...


...

...


...

...


select    s          1        SELECT an entry (e.g.: 'entry {entry#}')

...



localhost:8082/david@monahan.com/apps/DTM July 2011/forms> select 1

...


-----------------------------------------------------------------------------------------

...


            ID | _fNScEK4rEeCMGZK99v93jw!_W0jPga4rEeCMGZK99v93jw!david

...


           URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/formtype/_fNScEK4rEeCMGZK99v93jw!_W0jPga4rEeC

...

 MGZK99v93jw!david

...


       UPDATED | 2011-07-25T14:31:47.118

...


          NAME | Address Book
   DESCRIPTION | David - July 2011
          KIND | FORM
      READONLY | false
    VISIBILITY | PUBLICTENANT
-----------------------------------------------------------------------------------------

...


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

...

If you want, use

...

 ?list

...

 to see what you can do with the form.

...

Code Block
Name     Abbr      ArgNum     Descr

...


edit                 0        EDIT form (e.g. 'edit')

...


schema               0        LIST form controls (e.g. 'controls')

...


...

...


...

...


...

...


print     p          0        PRINT this entry (e.g. 'print')

...


delete

...

    d          0        DELETE this entry (e.g. 'delete')pe

...


refresh   r          0        REFRESH this entry (e.g. 'refresh')

...



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

...

To edit the form, type '''edit''' and press '''Enter''' edit and press Enter. The command line displays the response below, and frevvo launches the form designer and displays the form you selected.<pre>

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>

</pre>[[Image:api-pix_FormDesigner-EditForm.png]]Image 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 Finish or Cancel to exit the designer. You return to the UI login page.

[http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/FormTypeEntryShell.html Source Code Example]

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeFeed.html Java Doc]

=== Source Code Examples

Java Doc

Using a Form/Flow

...

Once you've selected a form, you can use it; this is, you can run the form as an end-user would. See the [[DataAPI_DesigntimeIntegration#Editing_a_Form.2FFlow | Editing a Form/Flow topic]] above  above for instruction on selecting a form. Then simply type '''use''' at use at the command prompt and press '''Enter'''. frevv opens  opens the form or flow in your browser.<pre>

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

...



Using form: http://localhost:8082/frevvo/web/tn/monahan.com/user/david/app/_W0jPga4rEeCMGZK99v93jw/formtype/_fNScEK4rEeC

...


MGZK99v93jw?embed=true&_method=post&apikey=IIGGTVxO1DtiDmUSnIiLzmXQjd6SGJ5c%252FpLVUNm%252FKE8AWzjV0xakncsLKl2aocCYxj3lH

...


uYWNr5q4Su8O%252FQlyQ%253D%253D

...



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

...

[http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/FormTypeEntryShell.html Source Code Example][http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeEntry.html

Java Doc]===

Display a List of the Controls in a Form

...

After you select a form, you can display a list of all the controls in the form. See the [[DataAPI_DesigntimeIntegration#Editing_a_Form.2FFlow | Editing Editing a Form/Flow topic]] above  above for instruction on selecting a form. Then simply type '''controls''' at controls at the command prompt and press '''Enter'''. You see the list of controls.<pre>

Code Block
localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form> controls

...


-----------------------------------------------------------------------------------------

...


URL ! http://localhost:8082/frevvo/web/tn/monahan.com/api/controltypes?ownerId=_bQdBsLSPEeCTSNrzu9T5_w!_PpnhcbSPEeCTSNrz

...

 u9T5_w!maggie

...


    # | CONTROL TYPE         | DISPLAY TYPE | READONLY | REQUIRED | COMMENTS? | NAME

...


    1 | InputControlType     | Text         | false    | true     | false     | Name

...


    2 | PanelControlType     | Panel        | false    | true     | false     | AddressPhone

...


    3 | InputControlType     | Text         | false    | true     | false     | Address1

...


    4 | InputControlType     | Text         | false    | false    | false     | Address12

...


    5 | InputControlType     |

...

 Text         | false    | true     | false     | City
    6 | InputControlType     | Text         | false    | true     | false     | State
    7 | InputControlType     | Text         | false    | true     | false     | ZipPostalCode
    8 | InputControlType     | Phone        | false    | false    | false     | HomePhone
    9 | InputControlType     | Phone        | false    | false    | false     | MobilePhone
   10 | PanelControlType     | Panel        | false    | true     | false     | Date_OrderNum
   11 | InputControlType     | Date         | false    | true     | false     | OrderDate
   12 | InputControlType     | Text         | false    | true     | false     | OrderNumber
   13 | PanelControlType     | Panel        | false    | true     | false     | OrderDesc
   14 | TextareaControlType  | TextArea     | false    | false    | false     | Description
   15 | SubmitControlType    | null         | false    | true     | false     | Submit
   16 | SubmitControlType    | null         | false    | true     | false     | Cancel
-----------------------------------------------------------------------------------------

...


localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form/controls>

...

Once you display the list, you can select a control and rename it, edit its description, or even delete it.<pre>

Code Block
localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form/controls> select 11

...



-----------------------------------------------------------------------------------------

...


            ID | _6rHRwbSPEeCTSNrzu9T5_w!_bQdBsLSPEeCTSNrzu9T5_w!_PpnhcbSPEeCTSNrzu9T5_w!maggie

...


           URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/controltype/_6rHRwbSPEeCTSNrzu9T5_w!_bQdBsLSP

...

 EeCTSNrzu9T5_w!_PpnhcbSPEeCTSNrzu9T5_w!maggie

...


       UPDATED | 2011-08-10T13:04:20.275-04:00

...


          NAME | OrderDate
   DESCRIPTION | Order Date
  CONTROL TYPE | InputControlType
  DISPLAY TYPE | Date
      READONLY | false
      REQUIRED | true
     COMMENTS? | false
-----------------------------------------------------------------------------------------

...


localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form/controls/OrderDate> ?list

...



Name     Abbr     ArgNum     Descr
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')

...



localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form/controls/OrderDate>

...

[http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/FormTypeEntryShell.html Source Code Example]

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeEntry.html Java Docs]

=== Downloading and Uploading an XSD ===

...

Source Code Example

Java Docs

Downloading and Uploading an XSD

You can download and upload the schema (XSD file) for a form. In the frevvo UI, you download a form schema from the application page when you're editing an application; you upload a schema from the schema page.====

Download

...

To download a form schema, you first select the form you want and then use the '''[[form name]> schema''' command command.<pre>

Code Block
localhost:8082/maggie@monahan.com/apps/Sand Box> forms

...


-----------------------------------------------------------------------------------------

...


URL ! http://localhost:8082/frevvo/web/tn/monahan.com/api/formtypes

...


    # | UPDATED                 | KIND | READONLY | VISIBILITY   | NAME

...


    1 | 2011-08-10T10:47:24.210 | FORM | false    | PUBLICTENANT | Order Form

...


-----------------------------------------------------------------------------------------

...


localhost:8082/maggie@monahan.com/apps/Sand Box/forms> select 1

...


-----------------------------------------------------------------------------------------

...


            ID | _bQdBsLSPEeCTSNrzu9T5_w!_PpnhcbSPEeCTSNrzu9T5_w!maggie

...


           URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/formtype/_bQdBsLSPEeCTSNrzu9T5_w!_PpnhcbSPEeC

...

 TSNrzu9T5_w!maggie

...


       UPDATED | 2011-08-10T10:47:24.210

...


          NAME | Order Form
   DESCRIPTION | Mail Order Form
          KIND | FORM
      READONLY | false
    VISIBILITY | PUBLICTENANT
-----------------------------------------------------------------------------------------

...

localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form> schema

Downloaded formtype schema: D:\downloads\OrderForm_7212269303367570502_form.xsd

localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form>
</pre>

[http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/FormTypeEntryShell.html Source Code Example]

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeEntry.html Java Doc]

==== Upload ====

TBD

[http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/SchemaFeedShell.html Source Code Example]

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/SchemaFeed.html Java Doc]

...


localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form> schema
Downloaded formtype schema: D:\downloads\OrderForm_7212269303367570502_form.xsd
localhost:8082/maggie@monahan.com/apps/Sand Box/forms/Order Form>

Source Code Example

Java Doc

Upload

TBD

Source Code Example

Java Doc

Creating a Form Instance from XML

After you select a form in an application, you can use the '''[form-name]> newXml''' command  command to create an instance of the form and fill the form with data values from an XML file. You can then submit the form, or reset it to remove the XML data.<pre>

Code Block
localhost:8082/david@monahan.com/apps/DTM July 2011/forms> select 3

...


-----------------------------------------------------------------------------------------

...


             ID | _hEahgK5GEeCMGZK99v93jw!_W0jPga4rEeCMGZK99v93jw!david

...


            URL | http://localhost:8082/frevvo/web/tn/monahan.com/api/formtype/_hEahgK5GEeCMGZK99v93jw!_W0jPga4rEeCMGZK99v93jw!david

...


        UPDATED | 2011-08-08T11:29:18.522

...


           NAME | TitleDepartment
    DESCRIPTION | Edit the form to change this description.
           KIND | FORM
       READONLY | false
     VISIBILITY | PUBLICTENANT
-----------------------------------------------------------------------------------------

...


localhost:8082/david@monahan.com/apps/DTM July 2011/forms/TitleDepartment> newXml d:\downloads\Maggie-FormData.xml

...


-----------------------------------------------------------------------------------------

...


FORM instance #1 [name=TitleDepartment, url=http://localhost:8082/frevvo/web/tn/monahan.com/user/david/app/_W0jPga4rEeCM

...


GZK99v93jw/form/_SwqY48UMEeCW_YwbL7w9ig?typeId=_hEahgK5GEeCMGZK99v93jw&locale=&embed=true&apikey=lF4OpTMA66sWnh7Z6i0tfT%

...


252BVZJd72Q91e2GaqWNwTmcP1kRYuNeW%252Bk1CC9%252BSdXGWNKQcoNY7FyU2WdcYtRs95w%253D%253D]

...


-----------------------------------------------------------------------------------------

...


localhost:8082/david@monahan.com/apps/DTM July 2011/forms/TitleDepartment/Instance #1> ?list

...



Name     Abbr     ArgNum     Descr
print               0        PRINT this instance URL (e.g. 'print')

...


reset               0        RESET this form instance (e.g. 'reset')

...


submit              0        SUBMIT this form instance (e.g. 'submit')

...



localhost:8082/david@monahan.com/apps/DTM July 2011/forms/TitleDepartment/Instance #1>

...

If you paste the form URL into your browser address bar, you can open the form instance and see the XML values in the form fields. You can Submit of Cancel the form from the browser, or you can use '''Instance #1> submit''' or ''' or Instance #1> reset''' from  from the command line.

[[Image:Api-pix_FormFromXML.png]][http://static.frevvo.com/resources/docs/site/4.1.5/com.frevvo.forms.cli/xref/com/frevvo/forms/cli/shell/FormTypeEntryShell.html Image Added

Source Code Example]

[http://static.frevvo.com/resources/docs/com.frevvo.forms.java-4.1.4-javadoc/com/frevvo/forms/client/FormTypeEntry.html Java Doc]===

Using a Custom XSD in a Form

...

You can use an XSD schema file to populate a form with controls. You can add the entire XSD schema to the form or individual controls. This example uses the API to upload a custom schema to an applicatio, add one of the top-level XSD elements to a form and then shows the result in the designer UI.====

Upload a custom XSD

...

The first step is to upload a custom XSD into an application. The following commands will list the existing schemas in the current application and then upload a new one (this assumes that there is an XSD named purchaseorder.xsd located in the /xsd folder):<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box> schemas

...


-----------------------------------------------------------------------------------------

...


URL ! http://localhost:8080/frevvo/web/tn/test/api/schemas

...

 
    # | NAME                                   | DESCRIPTION
-----------------------------------------------------------------------------------------

...


localhost:8080/admin@test/apps/Sand Box> up /xsd/purchaseorder.xsd

...


-----------------------------------------------------------------------------------------

...


            ID | _XX4VQQvREeGt8aM2YoQyaQ!_-4fOMQvQEeGt8aM2YoQyaQ!admin

...

 
           URL | http://localhost:8080/frevvo/web/tn/test/api/schema/_XX4VQQvREeGt8aM2YoQyaQ!_-4fOMQvQEeGt8aM2YoQyaQ!admin

...


       UPDATED | 2011-11-10T14:22:44.754-05:00

...

 
          NAME | http://tempuri.org/po.xsd

...

 
   DESCRIPTION | http://tempuri.org/po.xsd

...


-----------------------------------------------------------------------------------------

...


localhost:8080/admin@test/apps/Sand Box/schemas/http://tempuri.org/po.

...

xsd> 

Upload Source Code ]

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


Add an new XSD data source to a form

...

First, let's create a new form.<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box/schemas/http://tempuri.org/po.

...

xsd> exit

...


Schema http://tempuri.org/po.xsd successfully uploaded

...


localhost:8080/admin@test/apps/Sand Box/schemas> exit

...


localhost:8080/admin@test/apps/Sand Box> forms

...


-----------------------------------------------------------------------------------------

...


URL ! http://localhost:8080/frevvo/web/tn/test/api/formtypes?ownerId=_-4fOMQvQEeGt8aM2YoQyaQ!admin

...


  # | UPDATED                  | KIND    | READONLY | VISIBILITY    | NAME

...



-----------------------------------------------------------------------------------------

...


localhost:8080/admin@test/apps/Sand Box/forms> create PurchaseOrder

...


-----------------------------------------------------------------------------------------

...


            ID | _leQIIAvTEeGt8aM2YoQyaQ!_-4fOMQvQEeGt8aM2YoQyaQ!admin

...

 
           URL | http://localhost:8080/frevvo/web/tn/test/api/formtype/_leQIIAvTEeGt8aM2YoQyaQ!_-4fOMQvQEeGt8aM2YoQyaQ!admin

...


       UPDATED | 2011-11-10T14:38:37.863

...

 
          NAME | PurchaseOrder 
   DESCRIPTION | Edit the form to change this description. 
          KIND | FORM 
      READONLY | false 
    VISIBILITY | PRIVATE
-----------------------------------------------------------------------------------------

...


localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder>

...

 

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  panel and then clicking '''New from XSD''' as  as shown in the following screenshots.

[[Image:api-pix_Form-fromXSD-1.png]]frevvo displays Image Added

 displays the available schemas in the current application. You can then click [[Image:Add.png]] to Image Added to select the XSD you want to use. frevvo adds  adds it to the Data Sources panel.[[Image:api-pix_Form-fromXSD-2.png]]


Image Added

Here is how to add a new data source using the API.<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder> docs

...


-----------------------------------------------------------------------------------------

...



URL ! http://localhost:8080/frevvo/web/tn/test/api/doctypes

...

?ownerId=_leQIIAvTEeGt8aM2YoQyaQ!_-4fOMQvQEeGt8aM2YoQyaQ!admin
    # | NAME                                   | DESCRIPTION 
1 | http://www.frevvo.com/schemas/_leQIIAvTEeGt8aM2YoQyaQ#form | null

...



-----------------------------------------------------------------------------------------

...


localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder/docs>

...

 

There should be only one element in the docs feed for the default, from-palette schema. Now we need to add the '''purchaseOrder''' element purchaseOrder element from the '''http://tempuri.org/po.xsd''' XSD  XSD targetNamespace to the form:<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder/docs> add purchaseOrder http://tempuri.org/po.xsd

...


DocumentType

...

 (http://tempuri.org/po.xsd#purchaseOrder) added to form PurchaseOrder
localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder/docs>

Source Code

Let's open the designer to see the result:<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder/docs> exit

...


localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder> edit

...


Editing form: http://localhost:8080/frevvo/web/tn/test/user/admin/app/_-4fOMQvQEeGt8aM2YoQyaQ/formtype/_leQIIAvTEeGt8aM2YoQyaQ?edit=true&embed=true&_method=post&apikey=bxZrlQFZvJ%252Fj02XW1RpzECYR0i7Fu3fbdBSDDn4XovH2wLbv9H8FagSHYFOUEk%252F%252FcMlX08rSOAnPE0HHk8TQFQ%253D%253D

...


localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder> 

...

Note

It is not possible to auto-generate controls from '''Data Sources''' schemas. So the form designer would still have to perform this step manually.

Click [[Image:Add.png]] next to '''form''' to Image Added 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 Finish when you're done to exit the UI.

[[Image:api-pix_Form-fromXSD-3.png]Image Added]

You can now use the new form from the command line.<pre>

Code Block
localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder> use

...


Using form: http://localhost:8080/frevvo/web/tn/test/user/admin/app/_-4fOMQvQEeGt8aM2YoQyaQ/formtype/_leQIIAvTEeGt8aM2YoQyaQ?embed=true&_method=post&apikey=bxZrlQFZvJ%252Fj02XW1RpzECYR0i7Fu3fbdBSDDn4XovH2wLbv9H8FagSHYFOUEk%252F%252FcMlX08rSOAnPE0HHk8TQFQ%253D%253D

...


localhost:8080/admin@test/apps/Sand Box/forms/PurchaseOrder>

...