ERP API Performance & Plugin development

[georgschwienbacher]

This issue is used by CoolOrange to:

• summarize Key findings about the API / ERP-System in the comments
• store API performance results in the API Performance section below
• have a checklist which basic functionalities have to be implemented in the PowerGate Plugin

API Performance

After we have received all API requirements from the Customer mentioned in the following issue ,
we can start with the Performance tests.

• Delivery of NAV API sample calls + documentation #196
• Delivery of ERP API sample calls + documentation #97

In order to understand at the beginning of the project if the performance of the ERP API is good enough to process all request in a reasonable amount of time we need to create a script/code.

• Create a Performance Test script and store it in the powerGatePlugin folder, for example:
  Files/powerGatePlugin/ErpServices/Powershell_Tests/Performance-Test-Script.ps1
• Comment below where the Performance Test script is stored
• Fill the Performance Test Table below

Examples

• PowerGate cmdlets Example
• C# Example with Visual Studio "Connected Service"

Operations to test the performance

Performance test	Duration	Notes
Created 100 ERP items	N/A	Not tested the performance
Retrieved 100 ERP items one by one	N/A	Not tested the performance
Updated 100 ERP items one by one	N/A	Not tested the performance
Created 10 ERP BOMs and each one with 90 items	N/A	Not tested the performance
Retrieved 10 ERP BOMs with all those children one by one	N/A	Not tested the performance
Updated in all 10 ERP BOMs each bom row one by one	N/A	Not tested the performance

Plugin development

After the Performance tests are done, the following functionalities should be developed in the plugin for the standard integration:

• Create a PowerShell script where each implemented Plugin operation must have an example with powergate so that the Client Developer for Vault/Inventor knows how to communicate with the plugin. Example

Items

• Create a new ERP item
  • The Number can be set manually
  • The Number can be generated by the ERP
• Update an existing ERP item
• Read one ERP item
• Read multiple ERP items with search criteria such as “contains”

Bill of Materials

• Create a new Bill of Material (only first level)
  • Update Bill of Material header information
  • Update one ERP item of the existing Bill of Material
  • Add one ERP item to the existing Bill of Material
  • Delete one ERP item from the existing Bill of Material
• Read one Bill of Material header with Bill of Material positions (only first level)