Ready to get started?

Execute Stored Procedures to MYOB AccountRight in BizTalk



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

Stored procedures implement MYOB AccountRight 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 MYOB AccountRight 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:

    OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword; InitiateOAuth=GETANDREFRESH

    These properties are required when connecting to a company file (both for Cloud and On-Premise instances).

    • CompanyFileId: You can find this by starting MYOB, opening your data file, and selecting Help -> About MYOB
    • User: The username associated with your company file.
    • Password: The password associated with your company file.

    Connecting to a Cloud Instance

    To connect to a cloud instance of MYOB, you can use the embedded OAuth credentials or create an OAuth app with MYOB. This process is detailed in the Help documentation.

    Connecting to an On-Premise instance:

    When connecting to an on-premise instance, you will need to set the following connection property in addition to those above:

    • InitiateOauth: Set this to OFF.
    • Url: The Url of your MYOB instance.

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 MYOB AccountRight Adapter.
  2. If you have configured the CData MYOB AccountRight 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.