Component Definition Files

Service definitions are stored in XML format on the Cantara Access Server. The folder defined in the configuration.xml file has three sub folders, which are created automatically by the server, if required. These folders are functions, queries, and reports and store the relevant definition files that are loaded into cache when the application server is started. You should use the Cantara Administration Console to manage the component definition files. You can also edit the files directly, if required.

As a best practice, add the component definition files to your backup strategy to make sure that you can quickly recover the service definitions in case of server failure or unplanned and/or unsuccessful changes.

Function Definition Example

MyFunction.xml

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CantaraFunction name="MyFunction" jdeName="GetQuantityAvailable" locked="false">
    <FunctionParameter name="branch" jdeName="szBranchPlant" dataType="BUSINESSUNIT" direction="BOTH" inclusion="OPTIONAL" lookup="true" defaultValue="" length="12" displayDecimals="0" udcProductCode="" udcRecordType=""/>
    <FunctionParameter name="shortItemNo" jdeName="mnShortItemNumber" dataType="SHORTITEM" direction="BOTH" inclusion="OPTIONAL" lookup="true" defaultValue="" length="8" displayDecimals="0" udcProductCode="" udcRecordType=""/>
    <FunctionParameter name="lot" jdeName="szLotNumber" dataType="STRING" direction="BOTH" inclusion="OPTIONAL" lookup="false" defaultValue="" length="30" displayDecimals="0" udcProductCode="" udcRecordType=""/>
    <FunctionParameter name="lotStatus" jdeName="cLotStatus" dataType="UDC" direction="BOTH" inclusion="OPTIONAL" lookup="true" defaultValue="" length="1" displayDecimals="0" udcProductCode="41" udcRecordType="L"/>
    <FunctionParameter name="qtyAvailable" jdeName="mnQuantityAvailable" dataType="FLOAT" direction="BOTH" inclusion="OPTIONAL" lookup="false" defaultValue="" length="15" displayDecimals="0" udcProductCode="" udcRecordType=""/>
    <FunctionParameter name="location" jdeName="szLocation" dataType="LOCATION" direction="BOTH" inclusion="OPTIONAL" lookup="true" defaultValue="" length="20" displayDecimals="0" udcProductCode="" udcRecordType=""/>
</CantaraFunction>

Query Definition Example

MyQuery.xml

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CantaraQuery name="MyQuery" jdeName="V41021B" type="OWVIEW" locked="false">
    <Select>
        <QueryParameter name="shortItemNo" alias="ITM" table="F41021" tablePrefix="LI" instance="0" dataType="SHORTITEM" hidden="false" lookup="true" length="8" displayDecimals="0" sortDirection="NONE" sortSequence="0" udcProductCode="" udcRecordType=""/>
        <QueryParameter name="branch" alias="MCU" table="F41021" tablePrefix="LI" instance="0" dataType="BUSINESSUNIT" hidden="false" lookup="true" length="12" displayDecimals="0" sortDirection="NONE" sortSequence="0" udcProductCode="" udcRecordType=""/>
        <QueryParameter name="location" alias="LOCN" table="F41021" tablePrefix="LI" instance="0" dataType="LOCATION" hidden="false" lookup="true" length="20" displayDecimals="0" sortDirection="ASCENDING" sortSequence="1" udcProductCode="" udcRecordType=""/>
        <QueryParameter name="lot" alias="LOTN" table="F41021" tablePrefix="LI" instance="0" dataType="STRING" hidden="false" lookup="false" length="30" displayDecimals="0" sortDirection="ASCENDING" sortSequence="2" udcProductCode="" udcRecordType=""/>
        <QueryParameter name="primaryBin" alias="PBIN" table="F41021" tablePrefix="LI" instance="0" dataType="CHARACTER" hidden="true" lookup="false" length="1" displayDecimals="0" sortDirection="NONE" sortSequence="0" udcProductCode="" udcRecordType=""/>
        <QueryParameter name="qtyOnHand" alias="PQOH" table="F41021" tablePrefix="LI" instance="0" dataType="FLOAT" hidden="false" lookup="false" length="15" displayDecimals="0" sortDirection="NONE" sortSequence="0" udcProductCode="" udcRecordType=""/>
    </Select>
    <Filter operator="BW" type="WHERE">
        <QueryColumn name="shortItemNo" alias="ITM" dataType="SHORTITEM" length="8" displayDecimals="0" table="F41021" tablePrefix="LI" instance="0" hidden="false" udcProductCode="" udcRecordType=""/>
        <Literal></Literal>
        <Literal></Literal>
    </Filter>
</CantaraQuery>

Report Definition Example

MyReport.xml

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CantaraReport name="MyReport" jdeName="R42500" version="ZJDE0001" locked="false" printImmediate="false" batchQueue="QBATCH">
    <Filter operator="GT" type="WHERE">
        <QueryColumn name="orderNo" alias="DOCO" length="0" displayDecimals="0" table="F4211" instance="0" hidden="true"/>
        <Literal>0</Literal>
    </Filter>
    <ReportProcessingOptions>
        <ReportParameter name="nextStatusFrom" jdeName="NextStatus_From" dataType="UDC" length="3" inclusion="OPTIONAL" defaultValue="520"/>
        <ReportParameter name="nextStatusThru" jdeName="NextStatus_Thru" dataType="UDC" length="3" inclusion="OPTIONAL" defaultValue="560"/>
        <ReportParameter name="version" jdeName="VersionChoice" dataType="STRING" length="10" inclusion="HIDDEN" defaultValue="ZJDE0001"/>
    </ReportProcessingOptions>
    <ReportInterconnects>
        <ReportParameter name="orderNo" jdeName="mnDocumentOrderInvoiceE" dataType="INTEGER" length="8" inclusion="OPTIONAL" defaultValue=""/>
        <ReportParameter name="orderType" jdeName="szOrderType" dataType="UDC" length="2" inclusion="OPTIONAL" defaultValue=""/>
        <ReportParameter name="orderCompany" jdeName="szCompanyKeyOrderNo" dataType="STRING" length="5" inclusion="OPTIONAL" defaultValue=""/>
        <ReportParameter name="shipmentNo" jdeName="mnShipmentNumber" dataType="INTEGER" length="8" inclusion="OPTIONAL" defaultValue=""/>
        <ReportParameter name="asnLaunchFlag" jdeName="cASNLaunchFlag" dataType="CHARACTER" length="1" inclusion="OPTIONAL" defaultValue=""/>
        <ReportParameter name="r47032Version" jdeName="szR47032Version" dataType="STRING" length="10" inclusion="HIDDEN" defaultValue="ZJDE0001"/>
    </ReportInterconnects>
</CantaraReport>

On This Page