LIXI2 Customisable Forms Framework
Our LIXI2 Customisable Forms Framework gives you an incredibly fast way to prototype a set of forms for dealing with LIXI2 messages. With these forms you can create, read and edit LIXI2 messages, validate messages against the schema and/or business rules and submit directly to a pre-configured API. What used to take weeks and months can now be ready in hours!
You specify the layout of the forms in CSV files, and re-use our templated XPaths (or develop your own) to provide the mechanism to read/write the data within the control to/from the message.
Our LIXI2 Customisable Forms Framework demonstrate how easy it is to operate on the data in a LIXI2 message in a manner where the collection of data is only loosely coupled to the data transport format, encouraging innovation.
A key premise of the LIXI data standards and the way we develop and maintain them is that any participant's method for collecting the data should be completely independent of the way the data is modelled for transport.
Loose coupling of the data collection and the transport data model allows any participant in data integrations to modify their internal processes with minimal impact to other participants.
This premise is critical to LIXI2 supporting innovation in the industry, whilst maintaining the efficiencies of using data standards for transport in between participants.
View the Demonstration & Access the Demo Project Repository
Logged-in LIXI Website users can see a small set of forms that demonstrate the key features of the framework here. The demonstration was created through an automated build process in a project in LIXILab, our source code repository (members can register for a LIXILab account here). You can view the four CSV configuration files in this project.
The Customisable Forms Framework allows you to specify (in CSV files), a LIXI2 form that contains tabs, groups, labels, and controls. The framework simplifies the task of specifying the type of control by deriving the data type directly from the schema.
Each control has a carefully constructed Xpath defined that allows that control to independently read, create or overwrite an attribute from a LIXI2 message. Our framework converts the specification files into a web page with Bootstrap controls that can create a new LIXI2 message in either XML or JSON or edit an existing one.
- Configure tabs, groups, labels, and controls with associated XPaths
- Configure a range of fucntionality on the form to be available by displaying or hiding buttons and the code text box
- Configure the default data format
- Configure controls to appear only when a conditional Xpath evaluation is true
- Compatible with Schemas customised with out Customisation By Restriction Framework
- Schema validation built in (evaluates in browser)
- Schematron Business validation built in (evaluates in browser)
- Use LIXI's Schematron rule library, or add your own
- Define entity selectors for choosing/creating entities to be referenced with cross-references (value of @UniqueID using in an 'x_' field)
- View XML or JSON (switchable) directly on the form
- API Submission of either XML or JSON directly from the form
- Adding an attachment in base64 is supported and displayed for common image file types
The forms are customised using four CSV files that contain all the details of the configuration. Our automated build process processes these files, and with a specific LIXI2 schema, generates the web form.
- Overview.csv: Defines some top-level details such as the title to be displayed in the browser tab, the icon to be used on the tab and the title on the form itself. Also configures which buttons to display or hide, the default data format (XML/JSON) and whether the XML/JSON text box is displayed.
- Tabs.csv: Defines the Tabs that will be generated on the form.
- Entities.csv: Defines the entity selectors that are used in the Layout.csv file.
- Layout.csv: Describes all the groups, headings, controls, conditional logic and entity selectors.
Difference from other LIXI2 Frameworks
LIXI already has the LIXI2 XML Viewer and Editor. How does this new Customisable Forms Framework differ?
Our earlier LIXI2 ML Viewer and Editor is designed to display the LIXI2 data in exactly the manner it is laid out in the message. There is no way you can use it to display a few key data points from within the message, nor can you change the order you collect the data. With the new framework you could, for example, collect the Applicant Name and Drivers Licence number within the same group of controls.
The LIXI2 Electronic Guidebook Standard seems to offer some of the same validation features. How does this new Customisable Forms Framework differ?
The LIXI2 EGB provides a data standard for a lender to comprehensively specify to a third party everything needed to collect the right data for their product, including on-screen and print forms, rules about the product, and validation rules. The Customisable Forms Framework offers a subset of these features and is focussed on enabling quick delivery of forms for Proof of Concept or Pilot scenarios. In addition, any participant that needs to interact with a LIXI2 message will probably benefit from having access to this framework.
The framework is still under active development. Please send us any change requests and we will consider implementing them if there is value to the LIXI community. Here are some that have been raised to date.
- The Detailed Comment field (carried as element content) is not currently supported and will be added at a later date.
If you'd like to try out the Customisable Forms Framework, and you are a LIXI member, get in touch and we'll create a project in LIXILab for you to explore the framework further.
Shane Rigby, LIXI Limited CEO
First Published: July 5, 2021 | Last Updated: July 13, 2021