Data Providers
You create data providers on the Data Providers (SM206015) form. To create a provider, you specify its name and type, the access parameters to the source, and the data schema.
Data Provider Types
Excel spreadsheets or files in CSV format are generally used for data exchange between different ERP products, because most ERP products support exporting and importing data in these formats. Besides using files in an external format as a data source, you can import data from or export data to an external application directly. For example, you can connect to a Microsoft SQL Server and download data from it or upload data to it.
MYOB Acumatica provides a number of built-in types of data providers through which the application can efficiently import data from external files or third-party software to MYOB Acumatica, or export data from MYOB Acumatica to external destinations. These types of data providers, which you use when you configure a provider on the Data Providers form, are listed below:
- File providers that you use to access data in external files:
- CSV Provider (PX.DataSync.CSVSYProvider): For import from and export to files in CSV format
- Excel Provider (PX.DataSync.ExcelSYProvider): For import from and export to Excel spreadsheets
- XML Provider (PX.DataSync.XMLSYProvider): For import from and export to files in XML format
- Providers that are preconfigured for importing data from and exporting data to external
systems:
- Salesforce Provider (PX.DataSync.SFSYProvider): For import from and export to SalesForce CRM by using the Simple Object Access Protocol (SOAP).
- Salesforce Sync Provider (PX.Salesforce.SalesforceProvider): For real-time synchronization of data between MYOB Acumatica and Salesforce. For details, see Setting Up Synchronization with Salesforce.
- MS SQL Provider (PX.DataSync.MSSqlSYProvider): For import from and export to Microsoft SQL Server.
- HubSpot Provider (PX.DataSync.HubSpot.HSSYProvider): For exporting leads to HubSpot for nurturing and importing leads to MYOB Acumatica for processing. You can find more information in Integration with HubSpot: General Information.
- HubSpot Enhanced (PX.DataSync.HubSpot.HubSpotProvider): For synchronization of data between MYOB Acumatica and HubSpot. This data provider supports the use of the OAuth protocol for authorization in HubSpot. For details, see Integration with HubSpot: Enhanced HubSpot Data Provider.
- Providers for exporting payment data to external payment systems:
- ACH Provider (PX.DataSync.ACHProvider): For exporting data for processing in the Automated Clearing House (ACH) system. You can find more information in Processing ACH Payments.
- ACH Download Provider (PX.DataSync.ACHPDownloadrovider): For exporting data for processing in the Automated Clearing House (ACH) system, with the ability to create prenotes.
- Giro Payment Provider (PX.DataSync.Banks.GIROPaymentProvider): For exporting data for processing in giro-based payment systems.
- CPA 005 Provider (PX.Objects.Localizations.CA.DataSync.CPA005ExportProvider): For exporting data for processing in the Electronic Funds Transfer (EFT) system (used in the Canadian localization).
- Business Process Provider (PX.DataSync.BusinessProcessSYProvider): For business process monitoring in MYOB Acumatica. You generally do not create data providers of this type manually. The system creates providers of this type automatically when you click on the table toolbar of the Subscribers tab of the Business Events (SM302050) form. For details, see Business Events: Subscribers.
- Provider for importing data from generic inquiries: PX.DataSync.GenericInquirySYDataProvider: The data provider type to use Generic inquiry as data provider for import scenario.
To import data from other sources, you need to create a custom data provider by using the API provided by MYOB Acumatica.
Provider Parameters
To define a particular data source to be used for import or export, you define the parameters of the data provider on the Data Providers (SM206015) form. The set of parameters depends on the data provider type, as described below:
- Parameters of file providers: File providers generally have a simple set of
parameters that specify the file properties necessary for accessing data in the file. Each
of the file providers has the FileName parameter, which specifies the path to the
file that should be used for data import or export. The path to the file is set
automatically after you have uploaded an external file to the provider. The
FileName parameter displays the path to the uploaded file in the internal format:
Data Providers (<Data Provider Name>)\<File Name>
, where<Data Provider Name>
and<File Name>
are replaced with the corresponding values.Other parameters of a file provider depend on the provider type. You should specify these parameters so the system can correctly open the file and process the contents of the file.
- Parameters of providers that connect to external data systems: For providers that
connect to external data systems, such as SalesForce or MS SQL provider, you specify a set
of parameters for connecting MYOB Acumatica to the external system. Each of these providers has a parameter that you use to specify
the location of the remote resource. This parameter is either the URL of a remote service
or the path to a local server.
Other parameters are specific to each provider type. These parameters are necessary for authentication on the remote resource.
External Data Schema
Data that you are going to transfer between an external data source and MYOB Acumatica usually has a table structure. That is, the data includes a number of data records, and each record has a list of parameters specified.
You specify the structure of an external data source for a data provider by defining the external data schema—that is, you specify the objects and fields of the data source. The object is usually the whole data source or a part of the data source that corresponds to a complete data table. For example, for an Excel file, objects correspond to spreadsheets. For the source objects that should be used for import or export, you should select the Active check box in the Source Objects table on the Schema tab of the Data Providers (SM206015) form.
Source fields are defined by the list of attributes that are specified for each record. For an Excel file, source fields correspond to columns on a spreadsheet. For each field you want to use the field in a scenario, you should select the Active check box in the Source Fields table on the Schema tab of the Data Providers form.
Data Provider Creation
You create data providers on the Data Providers form. The process of creating a data provider consists of the following general steps:
- Reviewing the structure of external data
Before you create the data provider, you review the external source to identify the needed provider type and the external data schema. If you are going to import data to MYOB Acumatica, you review the source data to determine the needed provider type, to check that the data meets the requirements, and to see the external data schema. If you are going to export data from MYOB Acumatica, you review the data schema in the target file or application to which you want to export the MYOB Acumatica data, or create a file to hold the data to be exported and provide field names matching the intended use of the data.
- Creating a provider and setting its type
On the Data Providers form, you create the data provider. You specify the name of the provider, which usually describes the data you will transfer by using this provider. You also select the needed type of the provider. You can use built-in provider types or develop a custom data provider type.
- Specifying the provider parameters
On the Parameters tab of the Data Providers form, you specify the particular data source. You attach a file or specify the location of the remote source. You also specify the source-dependent parameters, if necessary.
- Filling in the source objects and fields of the provider
On the Schema tab of the Data Providers form, you fill in objects and fields from the attached file or remote resource to the data provider.
After that, the data provider is ready and can be edited as needed. For a file provider, you can upload the new version of an attached file and then update source objects and fields. For a provider connected to a remote system, you can reload the data schema from the server if you make any changes.