Aangepaste opslag voor concepten en verzendingscomponenten custom-storage-for-drafts-and-submissions-component
Overzicht overview
Met AEM Forms kunt u een formulier opslaan als concept. Met de conceptfunctionaliteit kunt u een formulier bijhouden dat u later vanaf elk apparaat kunt invullen en verzenden.
Standaard slaat AEM Forms de gebruikersgegevens die zijn gekoppeld aan het concept en de verzending van een formulier op in het knooppunt /content/forms/fp op het Publish-exemplaar. Daarnaast bieden de AEM Forms Portal-componenten gegevensservices waarmee u de implementatie van het opslaan van gebruikersgegevens voor concepten en verzendingen kunt aanpassen. U kunt bijvoorbeeld gebruikersgegevens opslaan in een gegevensopslag.
Vereisten prerequisites
- Laat Forms Portal componententoe
- Creeer a de Portaalpagina van Forms
- Laat adaptieve vormen voor Forms Portaltoe
- Leer implementatiedetails van douaneopslag
Conceptgegevensservice draft-data-service
Als u de opslag van gebruikersgegevens voor concepten wilt aanpassen, moet u alle methoden van de interface DraftDataService implementeren. In de volgende voorbeeldcode worden de methoden en argumenten beschreven.
/**
* DraftDataService service will get/delete/save user data (attachments and form data) filled with a draft instance of Form
*/
public interface DraftDataService {
/**
* To save/modify user data for this userDataID, it will be null if there is creation
* @param draftDataID: unique identifier associated with the form 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 draftDataID, String formName, String formData) throws FormsPortalException;
/**
* Returns the user data stored against the ID passed as the argument
* @param userDataID: unique data id for user data associated with a draft
* @return user data associated with this data ID
* @throws FormsPortalException
*/
public byte[] getData (String userDataID) throws FormsPortalException;
/**
* To delete data associated with this draft
* @param userDataID: 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 userDataID) throws FormsPortalException;
/**
* Saves the attachment for current form instance
* @param attachmentsBytes: byte array of the attachment to be saved
* @return unique id (attachmentID) for the attachment just saved (so that it could be retrieved later)
* @throws FormsPortalException
*/
public String saveAttachment (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;
}
Verzendgegevensservice submission-data-service
Als u de opslag van gebruikersgegevens voor verzending wilt aanpassen, moet u alle methoden van de interface SubmitDataService implementeren. In de volgende voorbeeldcode worden de methoden en argumenten beschreven.
/**
* SubmitDataService service will get/delete/submit user data (attachments and form data) filled with a submission of Form
*/
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;
/**
* Submits the user data provided as byte array
* @param id
* @param data
* @return id corresponding to saved data
* @throws FormsPortalException
*/
public String saveData (String id, byte[] data) throws FormsPortalException;
/** Submits the user data provided as byte array asynchronously for the user name provided in the options map
* @param data data to be saved in bytes
* @param options map containing options that affect this save
* @return id of the saved data instance
*/
public String saveDataAsynchronusly(byte[] data, Map<String, Object> options) 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 attachmentsBytes: would expect byte array of the attachment for this submission
* @return attachmentID for the attachment just saved (so that it could be retrieved later)
* @throws FormsPortalException
*/
public String saveAttachment(byte[] attachmentBytes) throws FormsPortalException;
/** Submits the attachment bytes passed as argument asynchronously for the user id provided in options map.
* @param attachmentBytes would expect byte array of the attachment for this submission
* @param options map containing options that affect this save
* @return attachmentID for the attachment just saved (so that it could be retrieved later)
* @throws FormsPortalException
*/
public String saveAttachmentAsynchronously(byte[] attachmentBytes, Map<String, Object> options) 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 gebruikt UUID-concept (Universally Unique IDentifier) om een unieke id te genereren voor elk concept en elk verzonden formulier. U kunt ook een eigen unieke id genereren. U kunt de interface FPKeyGeneratorService uitvoeren, zijn methodes met voeten treden, en een douanelogica ontwikkelen om een douane unieke identiteitskaart voor elk ontwerp en voorgelegd vorm te produceren. Ook, plaats de dienstrang van de generatie van douaneID hoger dan 0. Het zorgt ervoor dat de douaneimplementatie in plaats van de standaardimplementatie wordt gebruikt.
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;
}
U kunt de onderstaande aantekening gebruiken om de servicerangschikking te verhogen voor aangepaste id's die met bovenstaande code zijn gegenereerd:
@Properties(value = { @Property(name = "service.ranking", intValue = 15) } )
Als u de bovenstaande annotatie wilt gebruiken, importeert u het volgende naar uw project:
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;