Generic form operations
Generic forms allow LiveContent to capture any type of user input through an XHTML form. This information can be saved, edited, deleted, and printed to PDF using these API functions. Generic forms can be used for a wide variety of purposes, from gathering direct user feedback to saving user search queries.
- Load generic form dialog
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call retrieves an XHTML interface that allows a user to create a new form, or edit an existing form. This XHTML interface includes the form's title, type, and instance ID as attributes of its top level element. - List generic form instances
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call returns a list of all of the instance IDs, form titles, and other form information for all of the instances saved under a specific form name, such asSavedSearches. - Load generic form instance XML
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call returns the XML document that represents the form instance and contains all of the values and information that a user has entered. - Load generic form list
Each LiveContent publication can register a number of generic forms to which a user is granted access. These forms can be used for anything from active or passive feedback to saving searches or saving troubleshooting sessions for later. This API call retrieves the list of names and IDs of the generic forms that are registered with this publication. Usually this API is run while opening the publication. - Print form instance
This API call is made to produce a PDF from a form instance. Often electronic forms can be used to make a paper process easier, faster, and to track the activity in electronic format. However, at the end of the day, a printed copy may still be required. The Print Form Instance API call combines the form instance XML and the form's XSL-FO stylesheets to create a PDF instance. - Save form instance
This API call is made when a user has completed editing or create a new form and wants to save that form on the LiveContent server. The API call can accept an instance ID, which indicates that the form has been edited, or be called without one, which indicates a new form instance has been created. The client is responsible for forming and sending an XML post that contains all of the form data. - Delete generic form instance
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call deletes a form instance by this ID pair. - Delete all generic form Instances of one type
Generic forms are stored and referenced by an instance ID, matched with a form name. This API call deletes all forms that a user owns that of a specific type.