DocumentationAEM 6.4Forms Guide

Manage form metadata manage-form-metadata

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Overview  overview-nbsp

Metadata allows for easier categorization and organization of assets and helps users who are looking for a specific asset.

AEM Forms, by default, provides a defined set of metadata for each asset type. Beyond the default metadata, you can add custom metadata to each of the asset types. AEM Forms also provides you with the right means of creating, managing, and exchanging all this metadata efficiently for your forms.

If you’re a developer or a site owner, you can customize Forms Portal, the end-user interface for AEM Forms to reflect the metadata you’re using in your organization. For more information abouts Forms Portal, see Introduction to publishing forms on a portal.

Metadata in AEM Forms  metadata-in-aem-forms-nbsp

In AEM Forms, the list of metadata properties associated with an asset depends on its type. Also, if you add any custom metadata property, it is added across all the assets of the type on which the custom metadata was added.

Asset types  asset-types-nbsp

The following asset types are supported in AEM Forms:

  • Form templates (XFA forms)
  • PDF forms
  • Document (flat PDFs)
  • Adaptive forms
  • Resources
  • XFS

Extensive list of metadata extensive-list-of-metadata-nbsp

The following is an extensive list of metadata properties supported in AEM Forms:

Property name
Asset type
Description
Title
All but resource
Display name of the form.
Description
All but resource
Description of the form. The user can specify this value.
Type
All

A read-only value specifying the type of asset. It can have one of the following values:

  • Form template
  • PDF form, PDF form (Acroform), or PDF form (Signed)
  • Document, Document (Signed)
  • Adaptive form
  • Resource
Created
All
A read-only value specifying the time of asset creation.
Last modification date
All
A read-only value specifying the time when the asset was last modified.
Author
All but resource

A read-only value that is automatically computed based on the form type.

  • PDF/Form template/Document - fetched from the uploaded binary file.
  • Adaptive form - Logged in user at the time of form creation.
Status
All but resource

A read-only value that defines one of the following states of a form:

  • No value: If a form has never been published.
  • Published: When a form is published.
  • Modified: When a form was modified after having been published once.
Last publish date
All but resource
A read-only value specifying the time when form was last published.
Publish on/off time
All but resource

Time at which the form is scheduled to be automatically published/unpublished. The user sets this value on editing metadata.

  • Both Publish On and Off time should be beyond current date.
  • Publish Off time should be beyond the publish On time.
Submit URL

Form template

PDF form

To configure a user-specified URL for submitting form data to a servlet.

Submit URL can be configured using any of the following methods, listed in order of precedence:

  • Specify a submit URL directly in a Form Template by using the HTTP Submit button while creating an XFA form in AEM Forms Designer.
  • In AEM Forms UI, select a form and specify a submit URL on editing the metadata properties.
  • In Forms Portal, edit the Search & Lister component and specify a submit URL under the Form Link tab.
HTML render profile
Form template
The HTML render profile used while rendering a Form Template in HTML format.
Render format

Form template

Adaptive form

This option allows the user to specify the rendering format of the form when the forms are published:

  • HTML
  • PDF
  • Both

This option is used for restricting the rendering format of the forms only on forms portal where they are visible to the end user.

Tags
All but resource
Labels associated to the form to facilitate quick and easy search.
References

Adaptive form

Form template

Resource

List of assets (other forms or resources) that this form is related to. These assets can fall in following two categories:

  • Refers: Assets that the current form refers to.
  • Referred by: Assets that refer to the current asset.

These assets are displayed as links and their metadata can be accessed directly by clicking them.

Form model (XDP/XSD) selection
Adaptive form

Specifies which form model is used while authoring the adaptive form. This property can have following values:

  • Form template: A form template is selected from the ones existing in the repository. This value can be updated.
  • XML schema: An XSD file is uploaded. This value can be updated.
  • None

A form model once selected can be updated but not removed.

View form metadata view-form-metadata-nbsp

Assets have existing property values, which can be viewed in read-only mode. This metadata is originated at the time of form upload or form creation.

  1. Navigate to the location of the asset for which you want to view metadata.

  2. Open the properties page using one of the following ways:

    1. Click the View Properties e_reviewmode_properties_n icon from Quick Actions.

      note note
      NOTE
      Quick Actions are the action items that get displayed over a thumbnail on mouse hover.

    2. Select the form and click the View Properties e_reviewmode_properties_n icon that appears in the toolbar.

    3. Navigate to the form details page by clicking the form thumbnail when not in the selection mode. Now, click the aem6forms_eye_viewon eye icon on the upper right, and then click Properties in the list beneath it.

  3. The property page that opens displays a schema containing only those metadata properties that hold some value.

    The properties page has a toolbar containing two action icons:

    • Edit: aem6forms_edit Edit the metadata property values
    • View: aem6forms_eye_viewon Navigate to the form details page, which opens the form in the preview mode.

    The content portion is divided in two parts:

    • Left panel contains thumbnail of the form
    • Right panel contains metadata properties in the read-only mode, distributed across various tabs.

Add/update form metadata values add-update-form-metadata-values-nbsp

You can edit the value of existing metadata properties or add new values to an existing metadata property field (for example, when a metadata field is blank).

Update metadata property values update-metadata-property-values

  1. Follow the steps mentioned in the previous section to open the properties page where existing metadata of the selected form can be viewed.

  2. From the toolbar, click the edit icon aem6forms_edit to change the mode of the page from read-only to read/write.

  3. The properties page that opens holds a schema that contains a mix of editable input fields and static text.

  4. The properties displayed in static text are the ones that you cannot edit.

  5. You can navigate to other tabs to find input fields for metadata properties placed under them.

    This page has a toolbar containing two action icons different from those in view mode:

    • Cancel: aem6forms_close Cancel any changes made to metadata property values so far
    • Done: aem6forms_check Save all the changes made to metadata property values so far

    Both these actions direct the user back to read-only mode of the properties page containing the updated values.

Update the form thumbnail  update-the-form-thumbnail-nbsp

The left panel in the properties page displays the thumbnail of the form. By default, the thumbnail displayed is the one generated at the time of form creation (adaptive form) or at the time of form upload.

For all form types, you have the option to upload an image by clicking Upload Image and browsing for an image file from the local directory. The selected image is used as a thumbnail instead of the default one.

For adaptive forms, additional functionality is provided, which allows the user to generate a thumbnail as a snapshot of the current adaptive form preview. Since AEM Forms also supports authoring of adaptive forms, the preview of the adaptive form may change every time you change the adaptive form. This functionality to generate a thumbnail helps you obtain a fresh thumbnail for the adaptive form based on the current preview status. Click Generate Preview to carry out this action.

NOTE
  • Use a square image for the thumbnail. When you use a non-square image and view the thumbnail in list view, the thumbnail appears clipped.
  • Once a new image is uploaded or generated, the thumbnail is replaced by this image and cannot be reset to the previous image.

Add custom metadata  add-custom-metadata-nbsp

Apart from the metadata provided out of the box, AEM Forms supports new custom metadata.

A tool (Metadata Schema Editor) is provided to define the schema for the metadata layout; that is, the layout of what appears in the Properties page of a form. The Metadata Schema Editor lets you add or modify a custom schema for your assets.

AEM Forms exposes the metadata schemas of the supported forms types in this tool. This way, you can access these schemas and use the functionality provided in metadata schema editor to add custom properties.

  1. Navigate to Tools > Assets > Metadata Schemas.

  2. Click forms from the listed schema forms.

  3. From the list that opens, click the asset type for which you want to add custom metadata.

    note note
    NOTE
    These schemas contain metadata properties that are provided out of box and must not be altered/edited (selecting check box and clicking edit from toolbar) to avoid functional issues.

  4. Any asset type clicked opens a list containing the extendedmetadata option. Edit this schema.

  5. Select the checkbox beside extendedmetadata and then click the edit aem6forms_edit icon that appears in the toolbar.

  6. AEM Forms opens the metadata schema editor/form builder of the selected asset type (in this case adaptive form).

    Metadata schema editor for Adaptive Form type

    Click to enlarge

    1. The left panel contains tabbed sections where the fields are placed and the right panel displays all the available UI components and the properties of the field selected from the left panel.

    2. The locked section is not editable and contains fields for all the metadata properties that are provided out of the box.

    3. You can add additional tabs by clicking the + symbol.

    4. You can add a custom field of desired type by dragging the field component from the Build Form section on to the schema page.

    5. The specifications for this field can be provided under the Settings section after clicking the field.

Add custom metadata property in schema editor  add-custom-metadata-property-in-schema-editor-nbsp

  1. Navigate to the tab (existing or new) where you want to add the custom property.

  2. Drag a component of desired type from the Build Form section to left panel and place at a convenient location.

    note note
    NOTE
    You cannot move the locked sections, but you can place your component in any of the empty spaces.

  3. Click a component that you just dragged. In the Settings tab that opens in the right panel, fill in information for the following fields:

    1. Specify a Field Label which will be used as a display name above the field placed in schema (For example: Department)

    2. Under Map to property field, you can see a prefilled value ‘./jcr:content/metadata/default’. Change the ‘default’ to a desired property name, which is used to store the property in crx repository (For example: ‘./jcr:content/metadata/department’)

      note note
      NOTE
      Do not change the prefix ‘./jcr:content/metadata/’ as it defines the path where the property is stored.
      Also, the property name must be unique to avoid writing values for two or more properties at the same location in repository. So, it is recommended that you change the value ‘default’.

    3. Fill other settings based on requirement. For example: select the Required option if you want to make the field mandatory.

    4. To delete a field you added, select the field and then click the delete delete-1 icon.

  4. If necessary, follow steps 1-3 to add another property.

  5. Click Done after making all the changes.

    You have successfully added a custom metadata property.

All the adaptive forms in AEM Forms now contain this additional metadata property. You can edit it from the properties page.

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da