Ready to get started?

Learn more about the CData BizTalk Adapter for Sage 300 or download a free trial:

Download Now

Execute Stored Procedures to Sage 300 in BizTalk

You can use stored procedures provided by the CData BizTalk Adapter for Sage 300 to automate working with Sage 300 data in BizTalk. Stored procedures implement actions available in the underlying API.

Stored procedures implement Sage 300 actions that cannot be represented as SELECT, INSERT, UPDATE, and DELETE statements. This article shows how to generate a schema for a stored procedure. You can use the schema to execute the stored procedure from a send port.

Add the Adapter to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. The adapter will return metadata about the inputs of the stored procedure and its results. This metadata is needed to create the schema.

  1. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  2. Select Add Adapter Metadata in the resulting dialog box.
  3. In the resulting Add Adapter wizard, select the adapter from the list.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the Sage 300 Adapter.
  5. On the Connection String page, enter authentication credentials and other connection properties if they were not already configured in the send port or the receive location.

    Below is a typical connection string:

    User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

    Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

    • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
    • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
    • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

    Authenticate to Sage 300 using Basic authentication.

    Connect Using Basic Authentication

    You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

    • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
    • User: Set this to the username of your account.
    • Password: Set this to the password of your account.

Generate the Schema

After you enter connection properties in the Add Adapter wizard, the Schema wizard is displayed.

  1. On the next page, Schema Information, select the Send Port that you have configured to use the Sage 300 Adapter.
  2. If you have configured the CData Sage 300 Adapter in a solicit-response send port, disable the One-Way option.
  3. In the Command Type menu, select Stored Procedure.
  4. Select the stored procedure from the menu and enter the values for the input parameters.
  5. Confirm the settings in the summary displayed by the wizard and click Finish to generate the schema.xsd file.

Processing Schemas

To use schemas in a simple BizTalk application, see the tutorial.