fastnt / epcis

.NET 5 implementation of GS1's EPCIS repository version 1.2

Check the new EPCIS repository using EntityFramework Core and .NET6 here!

FasTnT EPCIS

FasTnT EPCIS is a lightweight GS1 EPCIS 1.2 repository written in C# using .NET 5 and backed with PostGreSQL database.

Setup

Prerequisites:

• PostGreSQL 9.5 or higher
• .NET 5 SDK

Steps:

1. Download the source code, and create a new user/database in PostGreSQL for FasTnT ;
2. Start the repository with the command $ dotnet run -p src\FasTnT.Host\FasTnT.Host.csproj --urls "http://localhost:5102/" --connectionStrings:FasTnT.Database "{your connectionstring}" ;

That's it! You have a properly working EPCIS 1.2 repository.

HTTP Endpoints

EPCIS 1.2 endpoints:

The API is secured using HTTP Basic authentication. The default username:password value is admin:P@ssw0rd

• Capture: POST /v1_2/Capture
• Queries : POST /v1_2/Query.svc
• Subscription trigger : GET /v1_2/Subscription/Trigger/{triggerName}

Capture endpoint only supports requests with content-type: application/xml or content-type: text/xml header and XML payload.

Queries endpoint supports SOAP requests on endpoint /v1_2/Query.svc. Note that it will not return the wsdl on a GET request.

The file documents\EPCIS Examples - 1.2.postman_collection.json contains XML requests examples to be run in PostMan, and the file EPCglobal-epcis-query-1-2-soapui-project.xml contains a project with SOAP example requests to be run in SoapUI.

See the wiki for more details.

Implemented Features

• Capture
  • Events
  • Master Data (CBV)
• Queries:
  • GetVendorVersion
  • GetStandardVersion
  • GetQueryNames
  • GetSubsciptionIDs
  • Poll
    • SimpleEventQuery
    • SimpleMasterDataQuery
• Query Callback:
  • CallbackResults
  • CallbackQueryTooLargeException
  • CallbackImplementationException
• Subscriptions:
  • Subscribe to an EPCIS request
  • Unsubscribe from EPCIS repository
  • Trigger subscriptions that register to specific trigger name

Authors

External contributions on FasTnT EPCIS repository are welcome from anyone. Many thanks to the people who already shown interest or contributed to this project (@grudolf, @jnoruzi and many others).

FasTnT EPCIS is primarily maintained by Louis-Axel Ambroise.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details

Contact: [email protected]

epcis's Issues

Retrieve ErrorDeclaration with a join instead of a subquery

Now ErrorDeclaration of an event is retrieved with a subquery after the PR #44.
As there can only be one for every event, a JOIN during the event query will be more efficient.

Improve query parameter validation

Multiple improvements needs to be made on the query parameters in order to be EPCIS 1.2 compliant:

• Check the data type passed for every query parameter
• Check the parameter names before query execution?
• Merge all parameters with the same name in order to have a more optimized query

XML binding should use SOAP for queries

Queries with content-type application/xml or text/xml should be parsed with SOAP formatter.

Parse correctly event extensions

Currently, all events extensions are set in the deepest level when formatting events.
It should handle the fact that the extension can be in any level of tags.

The events returned by queries/subscriptions must be formatted exactly like he captured events.

PK on source_destination

Hello,

great work so far, I really like how you organized the project.

I've encountered a problem while trying to capture some eASN test data - in my case, the same type attribute "urn:epcglobal:cbv:sdt:owning_party" is used in both source and destination list, throwing a 23505: duplicate key value violates unique constraint "PK_EVENT_SOURCE_DESTINATION" exception. Same could happen to location and possessing_party types.

Extending "PK_EVENT_SOURCE_DESTINATION" from (event_id, type) to (event_id, direction, type) would fix it.

epcList should always be filled in ObjectEvents

Even if there is no epc in the list, the field should always be present in the returned XML.

Hide PostGreSQL errors in error responses

End users should not see PostGreSQL specific messages.
Maybe just leave it in development mode to ease the debug process in case of bug.

Add AS2 query capabilities

Not mandatory as per specification, but a nice-to-have.

Parse/format correctly JSON format

JSON format in EPCIS 2.0 is currently not being parsed as it should (arrays are not handled, @context is not being taken into account, etc.)

Store subscription sending results

It will be useful to keep track of the performance/history of a subscription and also detect failing destinations.

Parse OData query string for queries

Check performance of subscription task

Check the behaviour of subscription tasks when thousands of requests are pending.
It might be necessary to split the subscription run into multiple batches to improve performance and/or avoid errors.

Validate subscription controls

• Raise an exception is both "schedule" and "trigger" are omitted or filled
• Check the grammar of query schedule

Exception at first startup

When database is not migrated yet, the background task throws an exception.

Link authenticated user to captured request

Store StandardBusinessHeader if filled in

A capture event might have a StandardBusinessHeader field, containing trading partner information.
These information should be stored in the database if provided, as these information can be useful for analytic purpose.