SAP Dynamic Forms

https://help.sap.com/docs/SAP_DYNAMIC_FORMS/
Admin
SAP Dynamic Forms is a platform that allows users to design, deploy, and use basic and complex forms...
Tokens:7,842
Snippets:23
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### XBL Components Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section offers a guide to XBL (XML Binding Language) components, explaining how they can be used to create reusable UI elements and extend XForms functionality.

```XML
<!--
  XBL Component Example Placeholder
  This section would typically show examples of XBL component definitions and usage.

  Example (XBL definition):
  <xbl:definition element="my-custom-input">
    <xbl:binding ref="./@value">
      <xf:input ref="."/>
    </xbl:binding>
  </xbl:definition>

  Example (XBL usage):
  <my-custom-input value="instance('data')/someValue"/>
-->
```

--------------------------------

### XML Platform Developer's Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

A guide for developers focusing on the XML Platform aspects of SAP Dynamic Forms. It explains how to leverage the XML platform for form development.

```English
Information for developers about the XML Platform.
```

--------------------------------

### Form Runner User Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

User guide for end-users on operating the Form Runner feature of SAP Dynamic Forms. It provides instructions on how to fill and submit forms.

```English
Information for end users about the Form Runner feature.
```

--------------------------------

### Template Management Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

Learn how to create, manage, and configure form templates for SAP Dynamic Forms. This guide is essential for efficient form lifecycle management.

```English
Learn about how to create, manage and configure form templates.
```

--------------------------------

### XForms Developer's Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

Technical documentation for developers working with XForms within SAP Dynamic Forms. It covers the specifics of XForms implementation and usage.

```English
Information for developers about XForms.
```

--------------------------------

### Form Explorer User Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

Guide for end-users on utilizing Form Explorer in SAP Dynamic Forms. It explains how to manage the relationship between SAP business objects and forms.

```English
Information for end users about how to use Form Explorer, which is the central tool for managing the relationship between SAP business objects and forms.
```

--------------------------------

### Form Builder Developer's Guide

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

Information for developers on using the Form Builder component of SAP Dynamic Forms. This guide details how to design and build forms within the platform.

```English
Information for developers about the Form Builder.
```

--------------------------------

### XForms Output Control

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section details the XForms output control, used for displaying data to the user. It explains how to present data from the model.

```XML
<!--
  XForms Output Control Example Placeholder
  This section would typically show an example of an <xf:output> element.

  Example:
  <xf:output ref="instance('data')/totalAmount" label="Total Amount:"/>
-->
```

--------------------------------

### SAP Dynamic Forms API Documentation

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/docs/dynamic-forms

Developer guide for the SAP Dynamic Forms API, enabling custom development and integration. This documentation is crucial for extending the functionality of SAP Dynamic Forms.

```English
This section provides developer guides for the SAP Dynamic Forms API to create custom development.
```

--------------------------------

### XForms Input Control

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section describes the XForms input control, used for capturing user data. It covers its attributes and how it binds to data models.

```XML
<!--
  XForms Input Control Example Placeholder
  This section would typically show an example of an <xf:input> element.

  Example:
  <xf:input ref="instance('data')/userName" label="User Name:">
    <xf:label>Enter your name:</xf:label>
  </xf:input>
-->
```

--------------------------------

### XForms XPath Expressions

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section provides guidance on using XPath expressions within XForms for data navigation, manipulation, and condition evaluation.

```XML
<!--
  XForms XPath Expression Example Placeholder
  This section would typically include examples of XPath usage in XForms.

  Example:
  <xf:bind ref="instance('data')/fullName" calculate="concat(instance('data')/firstName, ' ', instance('data')/lastName)"/>
-->
```

--------------------------------

### XForms Variables

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section covers the use of variables within XForms to store and manage data. It explains how to declare and utilize variables in form logic.

```XML
<!--
  XForms Variable Example Placeholder
  This section would typically show examples of using variables in XForms.
  Variables can be used to hold state or temporary data.

  Example:
  <xf:instance id="vars">
    <data>
      <myVar>Initial Value</myVar>
    </data>
  </xf:instance>
  <xf:setvalue ref="instance('vars')/myVar" value="'New Value'"/>
-->
```

--------------------------------

### XForms Repeat, Insert, and Delete Actions

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section details the XForms actions for repeating elements, inserting new instances, and deleting existing ones, crucial for dynamic form structures.

```XML
<!--
  XForms Repeat/Insert/Delete Action Example Placeholder
  This section would typically demonstrate XForms actions for managing repeating data.

  Example:
  <xf:repeat nodeset="instance('data')/items/item">
    <xf:input ref="."/>
  </xf:repeat>
  <xf:action ev:event="click" target="#repeat-container">
    <xf:insert context="instance('data')/items" nodeset="item" at="index()"/>
  </xf:action>
  <xf:action ev:event="click" target="#delete-button">
    <xf:delete context="instance('data')/items/item[index()]"/>
  </xf:action>
-->
```

--------------------------------

### XForms Scripting Actions

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section explains how to use scripting actions within XForms to execute custom logic, often involving JavaScript, to enhance form behavior.

```XML
<!--
  XForms Scripting Action Example Placeholder
  This section would typically show examples of using <xf:script> or similar actions.

  Example:
  <xf:action ev:event="domActivate">
    <xf:script>
      // JavaScript code to execute on activation
      alert('Element activated!');
    </xf:script>
  </xf:action>
-->
```

--------------------------------

### Embed SAP Dynamic Forms using JavaScript API

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_form_runner_user_guide_locale=en-US&state=PRODUCTION&version=2505

This section explains how to embed SAP Dynamic Forms into web applications using the JavaScript Embedding API. It covers the necessary JavaScript code to initialize and interact with the form runner within a browser environment.

```JavaScript
// Example of using the Form Runner JavaScript Embedding API
// This is a conceptual example and requires the SAP Dynamic Forms JavaScript library to be included.

// Assuming you have a container element in your HTML, e.g., <div id="form-container"></div>
// const formContainerId = 'form-container';

// Load a form definition (e.g., from a URL or a JavaScript variable)
// const formDefinitionUrl = '/path/to/your/form-definition.xml'; // Replace with actual URL

// Initialize the Form Runner
// if (window.SAPDynamicForms && window.SAPDynamicForms.FormRunner) {
//     const formRunner = new window.SAPDynamicForms.FormRunner(formContainerId);

//     formRunner.loadForm(formDefinitionUrl, {
//         onSuccess: function(formInstance) {
//             console.log('Form loaded successfully!');
//             // You can now interact with the formInstance, e.g., get values, set values
//         },
//         onError: function(error) {
//             console.error('Error loading form:', error);
//         }
//     });

//     // Example of submitting form data
//     // const formData = formRunner.getFormData();
//     // fetch('/api/submit-form', {
//     //     method: 'POST',
//     //     body: JSON.stringify(formData),
//     //     headers: {
//     //         'Content-Type': 'application/json'
//     //     }
//     // })
//     // .then(response => response.json())
//     // .then(result => console.log('Submission result:', result))
//     // .catch(error => console.error('Submission error:', error));
// } else {
//     console.error('SAP Dynamic Forms JavaScript library not loaded.');
// }
```

--------------------------------

### XForms JSON Support

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section covers the support for JSON data formats within XForms submissions, enabling data exchange with JSON-based services.

```XML
<!--
  XForms JSON Submission Example Placeholder
  This section would typically show how to configure XForms submissions for JSON.

  Example:
  <xf:submission id="submitJson" ref="instance('data')" method="post" action="/api/data" encoding="application/json"/>
-->
```

--------------------------------

### XForms Binds

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

XForms binds are used to associate data elements with UI controls and define properties like relevance, readonly, and required. This section covers their implementation.

```XML
<!--
  XForms Bind Example Placeholder
  This section would typically demonstrate XForms binds in XML.
  It shows how to link data to controls and define their behavior.

  Example:
  <xf:bind id="myBind" ref="instance('data')/myField" required="true()"/>
  <xf:input ref="bind('myBind')"/>
-->
```

--------------------------------

### Embed SAP Dynamic Forms using Java API

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_form_runner_user_guide_locale=en-US&state=PRODUCTION&version=2505

This section details how to embed SAP Dynamic Forms into your applications using the Java Embedding API. It outlines the necessary steps and considerations for integrating the form runner functionality within a Java environment.

```Java
/*
 * Example of using the Form Runner Java Embedding API
 * This is a conceptual example and may require specific SAP Dynamic Forms libraries and configurations.
 */

// Assuming you have a FormRunnerService available
// FormRunnerService formRunnerService = ...;

// Load a form definition (e.g., from a file or database)
// String formDefinitionXml = "<xf:model>...</xf:model>"; // Replace with actual XML

// Create a form instance
// FormInstance formInstance = formRunnerService.createFormInstance(formDefinitionXml);

// Render the form (e.g., to an HTML output stream or a UI component)
// OutputStream outputStream = ...;
// formRunnerService.renderForm(formInstance, outputStream);

// Process form data submission
// String formDataXml = "<data>...</data>"; // Replace with actual submitted data
// boolean isValid = formRunnerService.validateFormData(formInstance, formDataXml);
// if (isValid) {
//     formRunnerService.saveFormData(formInstance, formDataXml);
// }
```

--------------------------------

### XForms Validation

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section explains how to implement validation rules in XForms to ensure data integrity. It covers various validation mechanisms supported by XForms.

```XML
<!--
  XForms Validation Example Placeholder
  This section would typically provide examples of XForms validation rules.
  This could include using 'required', 'relevant', 'constraint', or 'datatype'.

  Example:
  <xf:bind id="ageBind" ref="instance('data')/age" constraint=". &gt;= 18" message="Age must be 18 or older."/>
  <xf:input ref="bind('ageBind')"/>
-->
```

--------------------------------

### XForms Extension Functions

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section lists and explains various extension functions available for use in XForms XPath expressions, enhancing data processing capabilities.

```XML
<!--
  XForms Extension Function Example Placeholder
  This section would typically demonstrate the use of specific extension functions.

  Example (hypothetical extension function):
  <xf:bind ref="instance('data')/formattedDate" calculate="my-format-date(instance('data')/rawDate, '%Y-%m-%d')"/>
-->
```

--------------------------------

### XForms JavaScript API

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

This section details the JavaScript API available for XForms within SAP Dynamic Forms. It outlines the functions and methods developers can use to interact with and manipulate XForms programmatically.

```JavaScript
/*
 * SAP Dynamic Forms XForms JavaScript API Documentation Placeholder
 * This section would typically contain examples of using the XForms JavaScript API.
 * For instance, manipulating form controls, handling events, or validating data.
 *
 * Example:
 * var myInput = document.getElementById('my-input-id');
 * if (myInput) {
 *   myInput.setValue('New Value');
 *   myInput.setFocus();
 * }
 */
```

--------------------------------

### XForms Attribute Value Templates (AVTs)

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_xforms_development_guide_locale=en-US&state=PRODUCTION&version=2505

Attribute Value Templates (AVTs) are a core feature of XForms, allowing dynamic generation of attribute values based on expressions. This section explains their usage and syntax.

```XML
<!--
  XForms AVT Example Placeholder
  This section would typically show examples of AVTs in XForms XML.
  For instance, setting an attribute value based on a variable or expression.

  Example:
  <xf:input ref="instance('data')/someValue" label="Value: {"instance('data')/someValue"}"/>
-->
```

--------------------------------

### Purging Old Data Using SQL

Source: https://help.sap.com/docs/SAP_DYNAMIC_FORMS/mobile-eam-and-field-service_dynamic-forms-documentation_form_runner_user_guide_locale=en-US&state=PRODUCTION&version=2505

This section describes how to purge old data from SAP Dynamic Forms using SQL queries. It provides guidance on constructing SQL statements to efficiently remove historical data, which is crucial for database maintenance and performance.

```SQL
-- Example SQL statement for purging old form data
-- This is a conceptual example and the actual table and column names may vary.
-- Always back up your data before running delete operations.

-- DELETE FROM FormSubmissions
-- WHERE SubmissionTimestamp < DATE('now', '-30 days'); -- Example: Delete data older than 30 days

-- Or, if you have a specific table for historical data:
-- DELETE FROM HistoricalFormData
-- WHERE CreatedDate < '2023-01-01'; -- Example: Delete data created before a specific date
```
Tokens:
Raw