Skip to main content

Service-based

A service message type handles synchronous request/response scenarios — an external system querying D365FO data on demand. The framework standardizes what every custom service otherwise reinvents: the response contract, error handling, logging, and testing.

Base classes: DEVIntegServiceExportBase (service base), DEVIntegServiceExportResponseContract (unified response: a .NET dataset with 0..n tables, an output string, a success flag, and an error message), DEVIntegDataTableHelper (dataset building).

Writing a service​

Each service is a class extending DEVIntegServiceExportBase. The entry point is a one-liner delegating to the business logic method, which throws on errors — the framework converts exceptions into the response contract automatically:

public class DEVIntegTutorialServiceTest extends DEVIntegServiceExportBase
{
    public DEVIntegServiceExportResponseContract getSOInfoDataTable(DEVIntegTutorialServiceTestContract _contract)
    {
        return this.serviceCallProcess(methodStr(DEVIntegTutorialServiceTest, calculateGetSOInfoDataTable), _contract);
    }

    public void calculateGetSOInfoDataTable(DEVIntegTutorialServiceTestContract _contract,
                                            DEVIntegServiceExportResponseContract _response)
    {
        changecompany(_contract.parmCompanyId())
        {
            SalesTable salesTable = SalesTable::find(_contract.parmSalesId(), true);
            if (!salesTable.RecId)
            {
                throw error(strFmt("Sales order %1 not found in company %2",
                    _contract.parmSalesId(), _contract.parmCompanyId()));
            }

            this.initDataTableHelper();

            dataTableHelper.addDataTable('SOHeader');
            dataTableHelper.addRowItem('SalesId',     salesTable.SalesId);
            dataTableHelper.addRowItem('CustAccount', salesTable.CustAccount);
            dataTableHelper.addRow();

            this.addDataTableHelperToResponse(_response);
        }
    }
}

The caller checks IsSuccess, reads ErrorMessage on failure, or deserializes MessageDataSet into a System.Data.DataSet on success.

Configuration and testing​

Register the class in the Service message types form. The Test button opens the Service test form, which auto-generates the input contract — specify parameters and Execute, no external tools needed. Logging levels from statistics-only to full request/response are described under Service call log.

Tutorial​