Form Builder

The ReadyWorks Form Builder is an essential tool that allows users to create custom forms for capturing data, streamlining workflows, and updating asset records within the ReadyWorks platform. This tool is particularly useful for creating forms to interact with asset data, manage updates, and control user input, making it a key component of the ReadyWorks automation and reporting capabilities. 

Key Features of Form Builder

1. Customizable Form Fields:
   • Users can define various types of data fields, including text boxes, drop-down menus, checkboxes, and multi-select fields, to capture the required data.
   • Data types such as single-line text, multi-line text, dropdowns, and lookups can be integrated into the form depending on the specific asset type.
   • Fields can be set as Required, Read-Only, or have Limited Values to control user input:
     • Required: Ensures that users must provide input before submitting the form.
     • Read-Only: Displays field data without allowing edits (useful for fields like asset names to prevent unintended changes).
     • Limit Values: Restricts input to a predefined set of values, particularly useful for dropdowns or lookups.
2. WYSIWYG Interface:
   • The Form Builder offers a “What You See Is What You Get” interface, making it easy to design forms without extensive technical knowledge.
   • Users can visually arrange form fields, set their widths (full or half-width), and preview the form to see how it will appear to end-users.
3. Single Asset Focus:
   • Forms are designed to interact with one asset type at a time. This means you cannot edit fields from multiple asset types within a single form.
   • This limitation ensures data integrity and simplifies the form creation process.
4. Dynamic Data Handling:
   • Form Builder can pull in dynamic data based on asset type relationships. For example, you can map fields to asset tables, ensuring that the forms automatically populate relevant data for each asset.
5. Validation Rules:
   • Add validation rules to ensure data accuracy. For instance, setting required fields, defining minimum/maximum character limits, or applying specific formatting rules for fields like email or date inputs.
6. Pre-populated Data:
   • Pre-fill form fields using asset data already stored within ReadyWorks, minimizing the need for manual input and enhancing the efficiency of data updates.
   • By default, the asset’s name field is included in the form (typically set as read-only) to confirm that the user is updating the intended record.
7. Integration with Reports:
   • Forms can be added to reports, allowing users to edit asset data directly from the report interface.
   • This streamlines workflows by enabling quick updates without navigating away from the report.
8. Design Customization:
   • Users can customize the form’s appearance, including form size (small, medium, large), color schemes, and button icons.
   • Labels, tooltips, and descriptive text can be added to form fields to guide users in providing the correct information.
9. JavaScript Integration:
   • Customize form behavior with JavaScript to enhance functionality, such as auto-populating fields or adding custom validations.

1. Accessing Form Builder:
   • Navigate to the Admin > Configuration > Form Builder section within ReadyWorks.
2. Creating a New Form:
   • Click on New Form to start designing a new form.
   • Provide a Form Name and Title (the title is what users will see when they open the form).
3. Selecting the Data Source:
   • Choose the Data Source (asset type) that the form will interact with.
   • Remember that forms can only interact with one asset type at a time.
4. Defining Form Properties:
   • Decide whether the form will Create a New Record or Update the Selected Record.
     • Create a New Record: Use this when you need to add new assets to the system.
     • Update the Selected Record: Ideal for updating existing asset information.
5. Adding Fields to the Form:
   • Use the Form Fields section to add fields to your form.
     • Field Selection: Choose from the list of available fields associated with the selected asset type.
     • Required: Mark fields as required to ensure they are filled before submission.
     • Read-Only: Set fields to read-only to display information without allowing edits.
     • Limit Values: Restrict input to specific values (useful for dropdowns).
     • Labels and Tooltips: Customize the field label and add tooltips or descriptive text to guide users.
     • Width: Set the field display width (full or half-width) to control the form layout.
6. Designing the Form Layout:
   • Use the Design tab to adjust the overall appearance of the form.
     • Form Size: Choose the size of the form window (small, medium, large).
     • Colors and Icons: Customize the form’s color scheme and button icons to match your branding or preferences.
7. Previewing the Form:
   • Use the Preview feature to see how the form will look to end-users.
   • Make adjustments as necessary to ensure the form is user-friendly and intuitive.
8. Saving and Enabling the Form:
   • Once satisfied with the form design, ensure that the Enabled option is set to Yes to make the form available for use.
   • Save the form.
9. Integrating the Form with Reports:
   • Add the form to relevant reports to allow users to access it directly from the report interface.
     • In the report settings, associate the form with the report.
     • Users can then select records in the report and launch the form to update data.

1. Maintain Data Integrity:
   • Set critical fields (like asset names) to Read-Only to prevent unintended changes.
   • Use Required fields to ensure essential data is collected.
2. Simplify User Experience:
   • Only include necessary fields in the form to avoid overwhelming users.
   • Use clear labels, tooltips, and descriptive text to guide users through the form.
3. Consistent Design:
   • Keep the form design consistent with other forms and reports in your ReadyWorks environment.
   • Use consistent color schemes and field widths for a professional appearance.
4. Test Forms Before Deployment:
   • Use the Preview feature to test the form’s functionality and appearance.
   • Ensure all validation rules and field settings work as intended.
5. Leverage Integration with Reports:
   • Add forms to reports where users frequently need to update data.
   • This streamlines workflows by allowing data edits without navigating away from reports.
6. Understand Limitations:
   • Remember that forms can only interact with one asset type at a time.
   • Plan your forms accordingly to match your data editing needs.

1. Updating Asset Information:
   • Quickly update fields like device status, location, or assigned user directly from a report using a form.
2. Data Correction:
   • Use forms to correct or add missing information to asset records, ensuring data accuracy.
3. Workflow Approvals:
   • Create forms for managers or team leads to approve changes or updates to assets.
4. End-User Input:
   • Incorporate forms into self-service portals (if enabled) to allow end-users to submit requests or update their own information.