Integration & Web Services


Introduction

[email protected] software is designed to integrate with the world's leading Business Applications, including Infor's SunSystems, Microsoft Dynamics 365 Business Central and SAP Business One

Using the latest Web Services protocols and technologies we can ensure that clients using [email protected], [email protected] and [email protected] can integrate their reference and transaction data easily and accurately.

Web Services provided by [email protected][email protected] and [email protected] can import most of the entities used in our software and also be used to export transaction data to 3rd party systems such as Dynamics 365 Business Central, SAP Business One and Infor SunSystems.

[email protected] Integration Web Services uses the SOAP communication protocol and provides the following services:

  • PSWAuthentication
  • DataIntegration

Each of the web services provides its description in WSDL by calling the service.

For Example:

http://my.domain.com/TWS64/PSWAuthentication.asmx?WSDL

Only XML structured data is accepted as an input or provided as an output.

Image
Image
Image
Image

PSWAuthentication Web Service

This service is needed to open a connection to [email protected] software that can be used to transfer data.

In order to do that the ValidateIntegrationLogin method of this web service has to be called.

The ValidateIntegrationLogin method has to be successfully called before the DataIntegration Web Service is used.

The ValidateIntegrationLogin method accepts the following parameters:

  • Login
  • Pwd
  • CallingServiceName
  • CallingServiceVersion

The Login parameter is used to hand over a Login Name for an Employee record created in [email protected][email protected] or [email protected].

The Pwd parameter is used to hand over a Password from the Employee record.

The values of CallingServiceName and CallingServiceVersion parameters are ignored unless an error occurs. In the case of an error, the values of all parameters are stored in the [email protected] database along with an appropriate error message. Therefore the CallingServiceName and CallingServiceVersion parameters can be used by third party applications for versioning or debugging purposes.

Image

DataIntegration Web Service

The DataIntegration Web Service does not send any response unless an Employee is authenticated using the ValidateIntegrationLogin method of the PSWAuthentication Web Service.

Once an active connection is opened using the ValidateIntegrationLogin method of PSWAuthentication web service then the connection can be used to call DataIntegration service.

The DataIntegration web service has two methods:

  • ExportLedgerData
  • ImportData

The ExportLedgerData method can be used to call [email protected], [email protected] and [email protected] Ledger Export profiles and hand over their results to the calling third party applications.

The ImportData method can be used to import or update [email protected], [email protected] or [email protected] setup entities using the data provided by the calling third party applications.

ExportLedgerData Method

The ExportLedgerData method accepts the following parameters:

  • ExportProfileName

The ExportLedgerData method executes standard Ledger Export procedure for a Ledger Export Profile specified as a value of the ExportProfileName parameter.

Only text with a valid XML structure can be returned by the ExportLedgerData method to the calling third party application.

ImportData Method

The ImportData method accepts the following parameters:

  • Destination
  • Operation
  • PostingMode
  • FileData

The Destination parameter supports values from a fixed list in which each value represents an [email protected], [email protected] or [email protected] setup entity or its part that can be imported or updated by the ImportData method.

The Destination parameter supports the following values:

  • AccountGroups
  • AccountingPeriods
  • AccountMasks
  • Accounts
  • AnalysisDefinitions
  • AnalysisRestrictions
  • AnalysisRoles
  • AnalysisValues
  • Calendars
  • CalendarSpecialDays
  • ChartsOfAccounts
  • ClientEmployees
  • ClientRoles
  • Clients
  • Companies
  • CompanyFormTypes
  • CompanyProjects
  • CompanyRoles
  • CreditCardTypes
  • CrossRateProviders
  • CrossRates
  • Currencies
  • DayTypes
  • DistributionMasks
  • EmployeeCreditCards
  • EmployeeFormTypes
  • EmployeeProjectRoles
  • EmployeeProjects
  • EmployeeRestrictions
  • EmployeeRoles
  • Employees
  • EmployeeSkills
  • ErrorHierarchies
  • ErrorTableDefinitions
  • ErrorTables
  • ExpenseTypes
  • FormTypeProjects
  • InvoiceSequences
  • LinksDefinition
  • MeasurementGroups
  • MeasurementValues
  • News
  • ProjectRestrictions
  • ProjectRoles
  • Projects
  • ProjectSkills
  • PSWHelp
  • Roles
  • SkillGroups
  • SkillValues
  • Statuses
  • SystemProjects
  • SystemRoles
  • TaskRestrictions
  • Tasks
  • TaskSkills
  • TimesheetPeriods
  • TransmissionTexts
  • ValueHierarchies
  • ValueTableDefinitions
  • ValueTables

The Operation parameter supports values from a fixed list in which each value represents an action which can be done with an [email protected], [email protected] or [email protected] setup entity or its part.

The Operation parameter supports the following values:

  • Insert
  • Add
  • Update
  • Replace

Each [email protected] setup entity or its part supports only two of the above Operation parameter values. It is either Insert and Update or Add and Replace.

The Insert value represents the import of a new record of a setup entity or its part.

The Add value represents the import of a new record of a setup entity or its part.

The Update value represents the update of an existing record of a setup entity or its part.

The Replace value represents replacing a current set of records with a new provided set of a setup entity or its part.

The PostingMode parameter supports values from a fixed list in which each value represents a condition that needs to be fulfilled in order to perform the import.

The PostingMode parameter supports the following values:

  • File
  • Line
  • None (aka Validate)

The File value is used for situations when all data provided by the third part application must be valid in order to be imported.

The Line value is used for situations when all data provided by the third part application does not have to be valid and only valid parts of / records from the provided data are imported.

The None value is used for situations when no data provided by the third part application is about to be imported and it only needs to be validated. This value is used mostly during the first phases of an integration process or in cases when the structure and/or information stored in the data needs to be checked.

The FileData parameter supports only a valid XML file, which needs to have one base node with multiple subnodes of one type where each represents one record ready to be process and with a structure appropriate to the value of Destination parameter.

The ImportData method takes the XML from a value of FileData parameter and hands it over to the Data Import procedure along with values of Destination, Operation and PostingMode parameters.

The Data Import procedure takes the value of the Destination parameter and maps XML nodes provided in FileData parameter to the attributes of an appropriate [email protected] entity or its part using XML node names.

Once the XML nodes are mapped, the Data Import procedure performs the actual import according to the values of Operation and PostingMode parameters.

Image