The FAQs provide some examples and code snippets for common tasks when a third-party application wants to interact with the server.
On this page:
How do I login and logout to and from a server?
See the Java code snippet below:
FormsService fs = new FormsService("localhost", 8082);
fs.login("myuserid", "mypassword");
// interact with frevvo
fs.logout();
Since there is some overhead associated with logging in and out, you need to keep the FormsService instance around for as long as you need to interact with before logging out.
How do I get the list of all applications for the current user?
FormsService fs = ...;
URL appFeedUrl = fs.getFeedURL(ApplicationFeed.class);
ApplicationFeed appFeed = fs.getFeed(appFeedUrl, ApplicationFeed.class);
for(ApplicationEntry appEntry: appFeed.getEntries()){
System.out.println("Application Name: " + appEntry.getTitle().getPlainText());
}
How do I get the list of all themes for the current user?
FormsService fs = ...;
URL themeFeedUrl = fs.getFeedURL(ThemeFeed.class);
ThemeFeed themeFeed = fs.getFeed(themeFeedUrl, ThemeFeed.class);
for(ThemeEntry themeEntry: themeFeed.getEntries()){
System.out.println("Theme Name: " + themeEntry.getTitle().getPlainText());
}
How do I get the list of all forms for the current user?
FormsService fs = ...;
URL ftFeedUrl = fs.getFeedURL(FormTypeFeed.class);
FormTypeFeed ftFeed = fs.getFeed(ftFeedUrl, FormTypeFeed.class);
for(FormTypeEntry ftEntry: ftFeed.getEntries()){
System.out.println("FormType Name: " + ftEntry.getTitle().getPlainText());
}
How do I get the list of all forms for a given application?
The code snippet below prints the name of all forms in the appEntry application:
ApplicationEntry appEntry = ...;
FormTypeFeed ftFeed = appEntry.getFormTypeFeed();
for(FormTypeEntry ftEntry: ftFeed.getEntries()){
System.out.println("Form Name: " + ftEntry.getTitle().getPlainText());
}
How do I get the list of all schemas for the current user?
FormsService fs = ...;
URL schemaFeedUrl = fs.getFeedURL(SchemaFeed.class);
SchemaFeed schemaFeed = fs.getFeed(schemaFeedUrl, SchemaFeed.class);
for(SchemaEntry schemaEntry: schemaFeed.getEntries()){
System.out.println("Schema Name: " + schemaEntry.getTitle().getPlainText());
}
How do I get the list of all schemas for a given application?
The code snippet below prints the name of all schemas in the appEntry application:
ApplicationEntry appEntry = ...;
SchemaFeed themeFeed = appEntry.getSchemaFeed();
for(SchemaEntry schemaEntry: schemaFeed.getEntries()){
System.out.println("Schema Name: " + schemaEntry.getTitle().getPlainText());
}
How do I get the url to a form so it can be embedded in my HTML pages?
First get a hold of the corresponding FormTypeEntry, then get the form url as shown in the snipped below:
FormTypeEntry ftEntry = ...;
String formUrl = ftEntry.getFormTypeEmbedLink(null);
Then using the formUrl above you can generate the following script tag in your html page:
<script type="text/javascript" src="{formUrl}"></script>
This will embed the form in your page inside an <iframe/>.
How do I get the url to the form designer so it can be embedded in my HTML pages?
First get a hold of the corresponding FormTypeEntry, then get the form url as shown in the snipped below:
FormTypeEntry ftEntry = ...;
String designerUrl = ftEntry.getFormTypeEditorEmbedLink(null);
Then using the designerUrl above you can generate the following script tag in your html page:
<script type="text/javascript" src="{designerUrl}"></script>
This will embed the form designer in your page inside an <iframe/>.
How do I get the url to the form submissions so it can be embedded in my HTML pages?
First get a hold of the corresponding FormTypeEntry, then get the form url as shown in the snipped below:
FormTypeEntry ftEntry = ...;
String formSubmissionsUrl = ftEntry.getSubmissionsEmbedLink(null)
Then using the formSubmissionsUrl above you can generate the following script tag in your html page:
<script type="text/javascript" src="{formSubmissionsUrl}"></script>
This will embed the submissions view in your page inside an <iframe/>.
How do I get a form entry based on a known id?
This is often needed when you need to relate an form with another concept your application (e.g. you application has the concept of a report that has an associated
form). In this case you will store the form id somewhere and when needed fetch the form entry to embed it in your page, delete it, etc. Here is how you get the for a form entry (in fact any entry):
FormTypeEntry ftEntry = ...;
String formId = ftEntry.getId();
And here is how you can use that id to find the corresponding form entry:
String formId = ...;
FormsService fs = ...;
URL formEntryUrl = fs.getEntryURL(FormTypeEntry.class, formId);
FormTypeEntry ftEntry = fs.getEntry(formEntryUrl, FormTypeEntry.class);
How do I delete a form (or any other entry)?
By calling the delete method on the FormTypeEnty.
FormTypeEntry ftEntry = ...;
ftEntry.delete();
How do I create a new form?
First you have to get a hold of the form feed from an existing application. See How do I get the list of all forms for a given application?
FormsService fs = ...;
ApplicationEntry appEntry = ...;
FormTypeFeed ftFeed = appEntry.getFormTypeFeed();
FormTypeEntry newEntry = ftFeed.createEntry();
newEntry.setTitle(new PlainTextConstruct("MyForm"));
newEntry.setSummary(new PlainTextConstruct("MyForm Description"));
newEntry = ftFeed.insert(newEntry);
Inserting the original newEntry will not update it, but instead a new entry will be returned.
How do I create a new form using an existing one as a template?
The only difference between creating a new form and creating a new one based on an existing form is that instead of using the entry created by calling 'ftFeed.createEntry()' you will be using an existing form entry. Find an existing form entry, update its name and description and use that entry to insert into a feed. Do not override the entry id otherwise the insert will fail.
FormsService fs = ...;
ApplicationEntry appEntry = ...; // find app entry
FormTypeEntry ftEntry = ...; // find template form entry
ftEntry.setTitle(new PlainTextConstruct("MyForm"));
ftEntry.setSummary(new PlainTextConstruct("MyForm Description"));
FormTypeFeed ftFeed = appEntry.getFormTypeFeed();
FormTypeEntry newEntry = ftFeed.insert(ftEntry);
How do I copy a form?
Copying entails inserting an existing entry into a feed. The key difference between this case and a regular feed insert() is that the entry being inserted already has an id: this will trigger a copy.
// get the FormTypeEntry you want to copy
FormTypeEntry ftEntry = ...;
// get the FormTypeFeed you will copy TO
FormTypeFeed targetFeed = appEntry.FormTypeFeed;
// Perform the copy
FormTypeEntry copy = ftFeed.Insert(FormType);
You can only insert into a feed that has an explicit owner, which is guaranteed above by getting the FormTypeFeed from the ApplicationEntry as opposed to getting a FormTypeFeed containing forms for all applications.
How do I download an existing form?
It is also possible to download a form using the API similar to the way you can download one from the UI. Consider the following code snippet:
FormsService fs = ...;
ApplicationEntry appEntry = ...; // find app entry
FormTypeEntry ftEntry = ...; // find template form entry
MediaContent mc = (MediaContent) ftEntry.getContent();
MediaSource ms = getService().getMedia(mc);
OutputStream formStream = new FileOutputStream("myform_form.zip");
saveFormToDisk(ms.getInputStream(), formStream);
How do I upload a form into an existing application?
You can also upload a form that was previously downloaded using the following code snippet:
FormsService fs = ...;
ApplicationEntry appEntry = ...; // find app entry
FormTypeFeed ftFeed = appEntry.getFormTypeFeed();
InputStream formZipStream = new FileInputStream("myform_form.zip");
MediaStreamSource formMediaSource = new MediaStreamSource(formZipStream,"application/zip");
FormTypeEntry ftEntry = ftFeed.insert(formMediaSource);
How do I use Self-signed Certificates with the API?
One approach is to modify the client code to accept self-signed certificates, but the recommended method is to use the standard Java mechanisms to trust a self-signed certificate; for example, to add the self-signed certificates to the JRE trusted keystore.
- Use a key tool to create a key
- Used installcert.java to install the certificate in a trusted keystore
- Save the keystore in the ''jre-home\lib\security'' directory
- Restart the server
How do I set a form's Deployment State?
FormTypeEntry ftEntry = setUpFormType(appEntry);
try {
System.out.println("Default State: " + ftEntry.getDeployState());
ftEntry.setDeployState(DeployState.PRODUCTION);
ftEntry = ftEntry.update();
ftEntry = ftEntry.getSelf();
assertEquals("Should be PRODUCTION state", ftEntry.getDeployState(), DeployState.PRODUCTION);
ftEntry.setDeployState(DeployState.DEVELOPMENT);
ftEntry = ftEntry.update();
ftEntry = ftEntry.getSelf();
assertEquals("Should be DEVELOPMENT state", ftEntry.getDeployState(), DeployState.DEVELOPMENT);
FormTypeFeed ftFeed = appEntry.getFormTypeFeed();
FormTypeEntry newEntry = ftFeed.createEntry();
newEntry.setTitle(new PlainTextConstruct("MyForm123"));
newEntry.setSummary(new PlainTextConstruct("MyForm123 Description"));
newEntry.setVisibility(Visibility.PUBLICTENANT);
newEntry.setDeployState(DeployState.PRODUCTION);
newEntry = ftFeed.insert(newEntry);
assertNotNull(newEntry.getSelf());
assertEquals("Should be PRODUCTION state", newEntry.getDeployState(), DeployState.PRODUCTION);
newEntry.delete();
Why are delete submissions showing up in the submissions feed?
The submissions feed will retrieve all type of submissions: submitted, saved, deleted (Deleted submissions are soft deleted meaning they are marked in the database as deleted, but the records are still present in your DB and so they will be returned in your SubmissonFeed). The Submissions UI page, by design, shows only the submissions which are completed.
Let's say you want to sort submissions that are saved versus those that are submitted. You can use SubmissionEntry.getState() parameter. This will return the current state of that particular SubmissionEntry (SAVED or SUBMITTED) and you can use this property to distinguish between your submissions.