C# Class Sage.Integration.Northwind.Application.NorthwindConnector

Name of CRUD status Linked Entity in CRM Create Update Delete Account Read Only Bidirectional ERP to CRM Bidirectional Person Updateable Bidirectional Bidirectional Bidirectional Address Updateable Bidirectional bidirectional Bidirectional Phone Updateable Bidirectional bidirectional Bidirectional Email Updateable Bidirectional bidirectional Bidirectional Order Read Only Bidirectional ERP to CRM no delete Product (& Family) Read Only ERP to CRM ERP to CRM ERP to CRM Pricing List (& Family) Read Only ERP to CRM ERP to CRM ERP to CRM Units of Measurement (& Family) Read Only ERP to CRM ERP to CRM ERP to CRM

Inheritance: INorthwindConnector

Show file Open project: Sage/SData-Contracts

Public Methods

Method	Description
CheckPrice ( Pricing PricingInformation, NorthwindConfig northwindConfig ) : Pricing
CloseSession ( string SessionKey ) : void	CloseSession is called at the end of every session, regardless of the authentication type supported.
ExecuteTransactions ( string EntityName, Transaction TransactionData, NorthwindConfig config ) : Sage.Integration.Northwind.Application.API.TransactionResult[]	of following entities: • Account • Order
GetAuthenticationScheme ( NorthwindConfig config ) : AuthenticationResult	There are three authentication types supported by CRM. When CRM connects to an ERP system for the first time it calls GetAuthenticationScheme to find out what authentication type is supported by the ERP system. Subsequent calls will use the supported authentication type.
GetChangeLog ( string entityName, string token, NorthwindConfig config ) : ChangeLog	• Account • Order • Product • ProductFamily • Price • UnitOfMesure • UnitOfMeasureFamily
GetConfiguration ( NorthwindConfig nwConfig ) : Configuration	GetConfiguration is called after GetAuthentication when a new integration is created. It is also called when an integration is enabled. GetConfiguration is a request to the ERP system for configuration information. This will be used to populate the configuration area of the integration in CRM.
GetCustomisations ( NorthwindConfig nwConfig ) : ERPCustomisations	GetCustomisations is called after GetConfiguration, either when a new integration is being created or when an integration is enabled. It is a request to the ERP system for customisation information.
GetPricingDetails ( OrderDetailInformation OrderDetails, NorthwindConfig config ) : PricingDetail
NorthwindConnector ( ) : System	The Constructor.
OpenSession ( NorthwindConfig config ) : SessionOpenResult	OpenSession is called at the start of every call to the ERP system. If OpenSession returns a token, then it is passed in the header for subsequent calls.
ViewRealTimeData ( string entityName, string selectFields, SearchField searchFields, string orderFields, int rowsPerPage, int pageNumber, NorthwindConfig northwindConfig ) : ViewRealTimeDataResult	ViewRealTimeData is a request to the ERP system for real time viewing data from the ERP system.

Private Methods

Method	Description
AddCustomisations ( XmlDocument &resultDoc, string name ) : void
AddSelesReps ( XmlDocument &resultDoc, NorthwindConfig nwConfig ) : void

Method Details

CheckPrice() public method

public CheckPrice ( Pricing PricingInformation, NorthwindConfig northwindConfig ) : Pricing
PricingInformation	Sage.Integration.Northwind.Application.API.Pricing
northwindConfig	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.Pricing

CloseSession() public method

CloseSession is called at the end of every session, regardless of the authentication type supported.

public CloseSession ( string SessionKey ) : void
SessionKey	string
return	void

ExecuteTransactions() public method

of following entities: • Account • Order

public ExecuteTransactions ( string EntityName, Transaction TransactionData, NorthwindConfig config ) : Sage.Integration.Northwind.Application.API.TransactionResult[]
EntityName	string
TransactionData	Sage.Integration.Northwind.Application.API.Transaction
config	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.TransactionResult[]

GetAuthenticationScheme() public method

There are three authentication types supported by CRM. When CRM connects to an ERP system for the first time it calls GetAuthenticationScheme to find out what authentication type is supported by the ERP system. Subsequent calls will use the supported authentication type.

public GetAuthenticationScheme ( NorthwindConfig config ) : AuthenticationResult
config	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.AuthenticationResult

GetChangeLog() public method

• Account • Order • Product • ProductFamily • Price • UnitOfMesure • UnitOfMeasureFamily

public GetChangeLog ( string entityName, string token, NorthwindConfig config ) : ChangeLog
entityName	string
token	string
config	NorthwindConfig	the configuration object
return	Sage.Integration.Northwind.Application.API.ChangeLog

GetConfiguration() public method

GetConfiguration is called after GetAuthentication when a new integration is created. It is also called when an integration is enabled. GetConfiguration is a request to the ERP system for configuration information. This will be used to populate the configuration area of the integration in CRM.

public GetConfiguration ( NorthwindConfig nwConfig ) : Configuration
nwConfig	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.Configuration

GetCustomisations() public method

GetCustomisations is called after GetConfiguration, either when a new integration is being created or when an integration is enabled. It is a request to the ERP system for customisation information.

public GetCustomisations ( NorthwindConfig nwConfig ) : ERPCustomisations
nwConfig	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.ERPCustomisations

GetPricingDetails() public method

public GetPricingDetails ( OrderDetailInformation OrderDetails, NorthwindConfig config ) : PricingDetail
OrderDetails	Sage.Integration.Northwind.Application.API.OrderDetailInformation
config	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.PricingDetail

NorthwindConnector() public method

The Constructor.

public NorthwindConnector ( ) : System
return	System

OpenSession() public method

OpenSession is called at the start of every call to the ERP system. If OpenSession returns a token, then it is passed in the header for subsequent calls.

public OpenSession ( NorthwindConfig config ) : SessionOpenResult
config	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.SessionOpenResult

ViewRealTimeData() public method

ViewRealTimeData is a request to the ERP system for real time viewing data from the ERP system.

public ViewRealTimeData ( string entityName, string selectFields, SearchField searchFields, string orderFields, int rowsPerPage, int pageNumber, NorthwindConfig northwindConfig ) : ViewRealTimeDataResult
entityName	string
selectFields	string
searchFields	Sage.Integration.Northwind.Application.API.SearchField
orderFields	string
rowsPerPage	int
pageNumber	int
northwindConfig	NorthwindConfig
return	Sage.Integration.Northwind.Application.API.ViewRealTimeDataResult