Big-Data-HPC-Platform/docs/DynamicESDL/ESDL_LangRef_Includer.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book lang="en_US" xml:base="../">
  <bookinfo>
    <title>ESDL Language Reference</title>

    <mediaobject>
      <imageobject>
        <imagedata fileref="images/redswooshWithLogo3.jpg" />
      </imageobject>
    </mediaobject>

    <author>
      <surname>Boca Raton Documentation Team</surname>
    </author>

    <legalnotice>
      <para>We welcome your comments and feedback about this document via
      email to <email>docfeedback@hpccsystems.com</email></para>

      <para>Please include <emphasis role="bold">Documentation
      Feedback</emphasis> in the subject line and reference the document name,
      page numbers, and current Version Number in the text of the
      message.</para>

      <para>LexisNexis and the Knowledge Burst logo are registered trademarks
      of Reed Elsevier Properties Inc., used under license.</para>

      <para>HPCC Systems<superscript>®</superscript> is a registered trademark
      of LexisNexis Risk Data Management Inc.</para>

      <para>Other products, logos, and services may be trademarks or
      registered trademarks of their respective companies.</para>

      <para>All names and example data used in this manual are fictitious. Any
      similarity to actual persons, living or dead, is purely
      coincidental.</para>

      <para></para>
    </legalnotice>

    <xi:include href="common/Version.xml"
                xpointer="xpointer(//*[@id='FooterInfo'])"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="common/Version.xml"
                xpointer="xpointer(//*[@id='DateVer'])"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <corpname>HPCC Systems<superscript>®</superscript></corpname>

    <xi:include href="common/Version.xml"
                xpointer="xpointer(//*[@id='Copyright'])"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <mediaobject role="logo">
      <imageobject>
        <imagedata fileref="images/LN_Rightjustified.jpg" />
      </imageobject>
    </mediaobject>
  </bookinfo>

  <chapter id="ESDLOverview">
    <title>ESDL Language Overview</title>

    <para>ESDL (Enterprise Service Description Language) is a methodology that
    helps you develop and manage web-based query interfaces quickly and
    consistently.</para>

    <para>Dynamic ESDL takes an interface-first development approach. It
    leverages the ESDL Language to create a common interface “contract” that
    both Roxie Query and Web interface developers will adhere to. It is
    intended to allow developers to create production web services, with clean
    interfaces that can evolve and grow over time without breaking existing
    applications.</para>

    <para>ESDL’s built-in versioning support helps ensure compiled and
    deployed applications continue to operate while changes are made to the
    deployed service’s interface for new functionality.</para>

    <para>ESDL’s ability to define and reuse common structures helps maintain
    consistent interfaces across methods.</para>

    <para>The Dynamic ESDL service is built to scale horizontally, and hooks
    are provided to add custom logging and security to help create fully
    “productionalized” web services.</para>

    <para>Once a service is deployed, application developers and end-users can
    consume the service using REST, JSON, XML, SOAP, or form encoded posts.
    Dynamic ESDL provides quick and easy access to a WSDL, live forms, sample
    requests and responses, and testing interfaces to allow developers to test
    logic changes, data changes, or new features, as well as to interact with
    the service directly using SOAP, XML, or JSON.</para>
  </chapter>

  <chapter id="ESDLStructures" role="nobrk">
    <title>ESDL Structures</title>

    <para></para>

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPstruct.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPrequest.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPresponse.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESParray.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPenum.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPinclude.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPservice.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLESPmethod.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
  </chapter>

  <chapter id="ESDLDatatypes">
    <title>ESDL Datatypes</title>

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLbooleanbool.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLstring.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLint.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLint64.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLfloat.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLdouble.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLbinary.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLTypeMapping.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
  </chapter>

  <chapter id="ESDLAttributes">
    <title>ESDL Attributes</title>

    <para>You can use ESDL attributes to extend and override the default
    behavior of an ESDL definition. For example, adding a max_len(n) to a
    string defines the string will only need to store a certain number of
    characters.</para>

    <para>Many attributes are treated as hints that may have more effect on
    some implementations than others. For example, max_len(n) will affect
    generated ECL code, but is ignored when generating C++.</para>

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLmax_len.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_max_len.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_name.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLcounter_and_count_val.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLmax_count_var.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_null.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLleading_zero.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_hide.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_type.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLecl_keep.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLmin_ver.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLmax_ver.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLdepr_ver.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
    <xi:include href="DynamicESDL/DESDL-Mods/ESDLget_data_from.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
    <xi:include href="DynamicESDL/DESDL-Mods/ESDLoptional.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLhelp.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />

    <xi:include href="DynamicESDL/DESDL-Mods/ESDLdescription.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
    <xi:include href="DynamicESDL/DESDL-Mods/ESDLversion.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
    <xi:include href="DynamicESDL/DESDL-Mods/ESDLauth_feature.xml"
                xpointer="element(/1)"
                xmlns:xi="http://www.w3.org/2001/XInclude" />
  </chapter>
</book>