Documentation Center

write

Xform write function

Description

When a new XForm is created or an existing XForm modified, this function is called to create or update an XForm in the database.

Parameters

action
write
fid
ID of the XForm definition.
docid
The document ID scope to use, when querying XForms. The XForm is created or updated even if the document ID is not found.
mytitle
Title of the XForm. In the comment and issue report, it is Summary.
name
User form name same as profile, preference.
xml
XML instance of a requested form.
type
Form type: system, floating or doc.
user
User name of the requested form.

Example URL

http://<host>:<port>/<context>/web/xforms.xql?action=write&fid=<value>&docid=<value>&mytitle=<value>&name=<value>&xml=<value>&type=<value>&user=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.