Soundwave

Low Code Schema Customisation

Low Code Schema Customisation

Posted on: May 31, 2021 | Updated July 26, 2021


Give your non-technical Business Analysts a low-code method to customise the schema used for LIXI2 APIs.

Our Schema Customiser Application is now available for members and licensees to preview as a beta release.

This application complements LIXI's Customisation By Restriction framework by providing an easy way to create a new set of instructions or edit existing ones - allowing you to automate more of your software development processes.

The user interface allows you to search or navigate to any of the items in the LIXI Schema that you might like to customise and apply most of the instructions supported by the framework to generate a new instructions file or to edit an existing one. This eliminates the complexity of working with the instructions in XML format. The generated customisation instructions file can be used in conjunction with LIXI’s Customisation By Restriction framework to generate a fully customised schema.

Why use Customisation?

Our Customisation By Restriction framework gives you the tools to manage your subset of requirements, whilst still accessing the comprehensive data model that has been collaboratively developed over decades. Without this framework, it would be easy to be overwhelmed by complexity instead of reaping the benefits of LIXI's comprehensive elements and attributes. You can fine-tune your data model and hide complexity you don't need, saving yourself time and money.

Don't make this systems development mistake and fall into the trap of over-simplification just to get a software product out the door. Customisation By Restriction allows you to simplify the user interface and the business logic, without simplifying your data model in a way that requires endless cycles of deep refactoring.

Customisations Supported

Elements

  • Make an element mandatory within the parent element (by increasing the MinOccurs of the element to 1)
  • Exclude an element entirely
  • Increase the MinOccurs of the element
  • Decrease the MaxOccurs of the element
  • Define a set of attributes within an element to include, thus excluding all non-included attributes
  • Enter custom definitions, excerpts and customised headings to embed in the schema annotations and generated documentation for the element

Attributes - String Types

  • Enforce a regular expression pattern on a string type
  • Restrict the string type to a prescribed set of fixed values

Attributes

  • Make an attribute mandatory within the parent element
  • Exclude a specific attribute (unavailable if the attribute include feature has been used in the parent element)
  • Define a set of attributes within an element to include, thus excluding all non-included attributes
  • Enter custom definitions, excerpts and customised headings to embed in the schema annotations and generated documentation for the attribute
  • Attributes can also be restricted based on it's type, see below

Attributes - Min and Max Values
For Integer, Currency, Date, Datetime, gYear, Integer, Decimal and Percent Types:

  • Enforce a Minimum value if populated
  • Enforce a Maximum value if populated

Attributes - Simple Types (enumerated lists)

  • Exclude an enumeration
  • Include an enumeration

Getting Started

Our Customisation By Restriction Framework has become a popular tool, frequently used by our members - contact LIXI if you'd like to explore it further, either for the first time, or by making it even easier with this new application.

The preview beta release version of the application is available here to members and licensees that are logged in to the LIXI website. Once you've opened the application, there are 5 steps to generating your custom schema:

  1. Load a LIXI2 transaction schema or the LIXI Domain Model (previously referred to as the master schema) to start developing your customisation instructions. These are available in LIXILab or on the LIXI Website.
  2. Load an existing customisation instruction to edit or create a new one.
  3. Enter all the customisations you wish to perform.
  4. Manually download the customised schema.
  5. Download the customisation instruction file.
  6. Use the customisation instruction file in an automated build process to generate the customised schema (see the instruction in our blog post here).

If you have any feedback, suggestions, or experience any issues, please fill out the Contact LIXI Form available here.

Related Links



Written by:
Alireza Bayat, Business Analyst, LIXI
First Published: May 31, 2021 | Updated July 26, 2021