Du får vist hjælpeindhold for version:

Overview

AEM Forms allows you to save a form as a draft. The draft functionality lets you maintain a work-in-progress form, which you can complete and submit later from any device.

By default, AEM Forms stores the user data associated with the draft and submission of a form in the /content/forms/fp node on the Publish instance. In addition, the AEM Forms portal components provide data services, which you can use to customize the implementation of storing user data for drafts and submissions. For example, you can store user data in a data store.

Draft data service

To customize the storage of user data for drafts, you need to implement all the methods of the DraftDataService interface. The following sample code describes the methods and arguments.

public interface DraftDataService {
	
    /**
     * To save/modify user data for this userDataID, it will be null in case of creation 
     * @param userDataID, unique identifier associated with this user data
     * @param formName, name of the form whose draft is being saved
     * @param formData, user data associated with this draft
     * @return userdataID, corresponding to which user data has been stored and which can be used later to retrieve this user data
     * @throws FormsPortalException
     */
	public String saveData (String userDataID, String formName, String formData) throws FormsPortalException;
	
	/**
	 * Returns the user data stored against the ID passed as the argument
	 * @param draftDataID unique data id for data associated with a draft
	 * @return user data associated with this data ID
	 * @throws FormsPortalException
	 */
	
	public byte[] getData (String draftDataID) throws FormsPortalException;
	
	/**
	 * To delete data associated with this draft
	 * @param draftDataID unique data id for data associated with a draft
	 * @return status of delete operation on data associated with this draft 
	 * @throws FormsPortalException
	 */
	
	public boolean deleteData (String draftDataID) throws FormsPortalException;
	
	/**
	 * Saves the attachment for current form instance 
	 * @param draftID associated with this draft
	 * @param attachmentsBytes would expect byte array of the attachment to be saved
	 * @return unique id for the attachment just saved (so that it could be retrieved later)
	 * @throws FormsPortalException
	 */
	public String saveAttachment (String draftID, byte[] attachmentBytes) throws FormsPortalException;
	
	/**
	 * To delete an attachment
	 * @param attachmentID, unique id for this attachment
	 * @return status of delete operation performed on attachment corresponding to this attachment ID
	 * @throws FormsPortalException
	 */
	public boolean deleteAttachment (String attachmentID) throws FormsPortalException;
	
	/**
	 * To get attachment bytes
	 * @param attachmentID, unique id for this attachment
	 * @return data corresponding to this attachmentID
	 * @throws FormsPortalException
	 */
	public byte[] getAttachment (String attachmentID) throws FormsPortalException;
}

Submission data service

To customize the storage of user data for submissions, you need to implement all the methods of the SubmitDataService interface. The following sample code describes the methods and arguments.

public interface SubmitDataService {
	
	/**
	 * Submits the user data passed in argument map
	 * @param userDataID, unique identifier associated with this user data
	 * @param formName, name of the form whose draft is being submitted
	 * @param formData, user data associated with this submission
	 * @return userdataID, corresponding to which the user data has been stored and which can be used later to retrieve this data
	 * @throws FormsPortalException
	 */
	public String saveData (String userDataID, String formName, String formData) throws FormsPortalException;
	
	/**
	 * Gets the user data stored against the ID passed as argument
	 * @param userDataID, unique id associated with this user data for this submission
	 * @return user data associated with this submission
	 * @throws FormsPortalException
	 */
	public byte[] getData(String userDataID) throws FormsPortalException;
	
	/**
	 * Deletes user data stored against the userDataID
	 * @param userDataID, unique id associated with this user data for this submission
	 * @return status of the delete operation on this submission
	 * @throws FormsPortalException
	 */
	
	public boolean deleteData(String userDataID) throws FormsPortalException;
	
	
	/**
	 * Submits the attachment bytes passed as argument
	 * @param submitID, unique id associated with the submission metadata
	 * @param attachmentsBytes would expect byte array of the attachment for this submission
	 * @return id for the attachment just saved (so that it could be retrieved later) 
	 * @throws FormsPortalException
	 */
	public String saveAttachment(String submitID, byte[] attachmentBytes) throws FormsPortalException;

	/**
	 * To delete an attachment
	 * @param attachmentID, unique id for this attachment
	 * @return status of delete operation performed on attachment corresponding to this attachment ID
	 * @throws FormsPortalException
	 */
	public boolean deleteAttachment (String attachmentID) throws FormsPortalException;
	
	/**
	 * To get attachment bytes
	 * @param attachmentID, unique id for this attachment
	 * @return data corresponding to this attachmentID
	 * @throws FormsPortalException
	 */
	public byte[] getAttachment (String attachmentID) throws FormsPortalException;
}

Forms portal uses Universally unique identifier (UUID) concept to generate a unique ID for every draft and submitted form. You can also generate a unique ID of your own. You can implement the interface FPKeyGeneratorService, override its methods, and develop a custom logic to generate a custom unique ID for every draft and submitted form. Also, set service rank of custom ID generation implementation higher than 0. It ensures that the custom implementation is used instead of the default implementation.

public interface FPKeyGeneratorService {
    /**
     * returns a unique id for draft and submission
     *
     * @param none
     * @return unique id in string format as per the implementation
     * @throws FormsPortalException
     */
    public String getUniqueId() throws FormsPortalException;
}

Dette arbejde har licens under en Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Opslag på Twitter™ og Facebook er ikke omfattet af vilkårene for Creative Commons.

Juridiske meddelelser   |   Politik for beskyttelse af personlige oplysninger online