Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
435 changes: 435 additions & 0 deletions modules/ROOT/assets/images/partner-process/integration-steps.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 4 additions & 5 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
** xref:development-resources.adoc[Development Resources]
** xref:training.adoc[Training]

* Partner Process
** xref:partner-process/provider-agreement.adoc[Provider Agreement]
* xref:partner-process/becoming-a-partner.adoc[Becoming a partner]
** xref:partner-process/integration-process.adoc[Integration Process]
** xref:partner-process/development-process.adoc[Development Process]
** xref:partner-process/solutionfinder.adoc[Solution-Finder]
** xref:partner-process/integration-qa.adoc[Integration on QA]
** xref:partner-process/integration-prod.adoc[Integration on Production]
** xref:service-support.adoc[Service & Support]

* xref:integration-steps.adoc[Integration]
** xref:integration/general-conventions.adoc[Conventions]
Expand All @@ -30,7 +30,6 @@
*** xref:certification.adoc[Certification]
*** xref:maintenance.adoc[Maintenance]
*** xref:update.adoc[Updates]
*** xref:service-support.adoc[Service & Support]
** xref:integration/endpoint-lifecycle.adoc[Endpoint Lifecycle]
*** xref:integration/authorization.adoc[Authorization]
*** xref:integration/onboarding.adoc[Onboarding App Instances]
Expand Down
12 changes: 2 additions & 10 deletions modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,9 @@ The purpose of this documentation is to create deep knowledge about the third pa
This documentation is an open source project. We invite everybody to open issues, fork the documentation or create pull requests to fix or extend this documentation.

== Adding your solution to agrirouter
In general, there are 4 major topics to add your software or hardware to the agrirouter ecosystem.

.Integration process for agrirouter
image::general/process_all_v2.png[Integration process for agrirouter]

* xref:partner-process/provider-agreement.adoc[Step 1 - Provider Agreement]
* xref:partner-process/solutionfinder.adoc[Step 2 - Solution-Finder]
* xref:partner-process/integration-qa.adoc[Step 3 - Interface Integration in Quality Assurance Environment]
* xref:partner-process/integration-prod.adoc[Step 4 - Interface Integration in Production Environment]
There are three streams that need to be completed to become a part of the agrirouter eco system.

For more details see: xref:partner-process/becoming-a-partner.adoc[]

== Quicklinks
For advanced developers, here is a list of quick links for the most common topics
Expand Down Expand Up @@ -70,7 +63,6 @@ For advanced developers, here is a list of quick links for the most common topic

There are several tools to support you in your agrirouter development


** xref:tools/io-tool/overview.adoc[IO-Tool - Simulate communication]
** xref:tools/arts.adoc[ARTS - Analyse messages]
** xref:tools/paho.adoc[PAHO - MQTT Testing]
Expand Down
22 changes: 22 additions & 0 deletions modules/ROOT/pages/partner-process/becoming-a-partner.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= Becoming a partner
:imagesdir: _images/

This section is dedicated to explaining the necessary steps and background of becoming an agrirouter partner and integrate with the agrirouter platform.

There are three streams that need to be completed to become a part of the agrirouter eco system.

== Busniness / Legal

In general, to gain production access to the agrirouter, a legal agreement has to be made. There are multiple options interested companies can choose from. For details, please contact Dr. Johannes Sonnen, see link:https://dke-data.com/#team[the contacts page].

== Integration Development

The integration process is described in detail in xref:./integration-process.adoc[].

Technical information about the actual development of your agrirouter integration can be found in xref:./development-process.adoc[].

Please also familiarize yourself with the xref:../service-support.adoc[Support Process] to learn which roles exist and how responsibilities are distributed.

== Marketing

To promote your solution and announce integration into and compatibility with agrirouter, you should put your solution into our marketplace. For details, see xref:./solutionfinder.adoc[agrirouter Solution-Finder].
46 changes: 46 additions & 0 deletions modules/ROOT/pages/partner-process/development-process.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
= Development Process
:imagesdir: _images/

== Material

We provide some material to aid during development:

=== SDKs

We provide SDKs for the following languages:

* link:https://github.com/DKE-Data/agrirouter-sdk-java[Java]
* link:https://github.com/DKE-Data/agrirouter-sdk-dotnet-standard[C#/.NET]
* link:https://github.com/DKE-Data/agrirouter-sdk-php[PHP]
* link:https://github.com/DKE-Data/agrirouter-sdk-python[Python]
* link:https://github.com/DKE-Data/agrirouter-sdk-cpp[C++] (3rd party contribution, not officially supported)

All SDKs are open source and their source code hosted on Github.

The SDKs are differing a bit in their range of features. If a certain feature is missing for your language, don't hesitate to contact us or maybe even provide a Pull Request on the respective Github project.

=== agrirouter middleware

There is a 3rd party maintained solution available called the *agrirouter middleware* that further eases some aspects of the agrirouter integration by wrapping the more complex aspects of the agrirouter interface into a simple-to-use REST interface.

For further information, please see link:https://agrirouter-middleware.com[their project].

=== IO-Tool

We provide a tool that presents an endpoint to communicate with during your integration work. Further information will soon be provided here.

// TODO
//== Development overview
//
//First, you should always keep in mind the xref:../integration/general-conventions.adoc[General conventions].
//

== Support

We are there for you during the whole development process.

Whether you want to discuss your integration architecture approach, are stuck at some point during development, encounter unknown issues etc., just contact us via one of these channels:

* image:icons/email.svg[,24,24] link:mailto:developer-support@my-agrirouter.com[Email/Ticket]
* image:icons/teams.svg[,24,24] link:https://teams.microsoft.com/l/chat/0/0?users=o.rahner%40dke-data.com[Microsoft Teams]
* image:icons/slack.svg[,24,24] link:https://join.slack.com/t/agrirouter/shared_invite/zt-1eubkvbhe-KuP4naHgIOdlciuiXcztGw[Slack]
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,42 @@

== General process of integration in Production

Once the development in the Quality Assurance Environment is finished, you can start to prepare your application for the production environment
image::partner-process/integration-steps.svg[]

image::general/process_integration_prod_v2.png[]
== Create developer account

== 4.1 Create developer account
include::partial$different-accounts.adoc[]

Once you're done with testing in QA, you can xref:../registration.adoc[create an account in the productive environment].
To start the development, you will need to xref:../registration.adoc[create a developer account].

You can read xref:../accounts.adoc[here] more about the different types of accounts or directly find the URLs for signup xref:../urls.adoc[here].
You can read xref:../accounts.adoc[here] more about the different types of accounts or directly find the URL for signup xref:../urls.adoc[here].

== 4.2 Register & submit your solution
include::partial$approval-manually-support-times.adoc[]

For communication with agrirouter, you need to setup an xref:../applications.adoc[application] in the productive environment.
== Register & submit your solution

For communication with agrirouter, you need to xref:../applications.adoc[setup an application].

== 4.3 Approval from the certification company
Whenever you create a new application version, the agrirouter support team will have to approve this application. Please send an email to support@my-agrirouter.com including the application id and the certification version id to request confirmation. Find out where to find them xref:../ids-and-definitions.adoc[here].

The certification company will perform the certification - with your support - and create a certificate to proof that your solution is compatible with agrirouter.
include::partial$approval-manually-support-times.adoc[]

[IMPORTANT]
====
Please recognize that the certification will be done in the quality assurance environment.
====
== Develop your integration

Please see xref:./development-process.adoc[Development Process].

== Certify your solution

Every app needs to be certified to communicate with the agrirouter. Further information can be found xref:../certification.adoc[here].

== 4.4 Approval from support team
Once you know which kind of application you want to create, you should get in contact with one of the certification companies *early on* to clarify which specific requirements you will have to fulfil to pass the certification.
This will help you to adapt your implementation for the certification and add all requirements for certification.

Make sure to have all xref:../certification.adoc#prerequisites[prerequistes] available.

The certification company will perform the certification - with your support - and create a certificate to prove that your solution is compatible with agrirouter.

== Approval from support team
When the certification is successfully approved, the app will be set to status _Approved_ .

[NOTE]
Expand All @@ -37,7 +47,7 @@ If your app is a CU, it will from this point on be visible to all users wanting
====


== 4.5 Test Interface & Messaging
== Test Interface & Messaging

After certification is done, you can test your application in the production environment, which means that you can xref:../invite-testers.adoc[invite real test customers to test the connection in their everyday work] or just ask users to onboard your app (the tester status is not required when your app is _Approved_ but it helps to keep an overview of your testers).

Expand All @@ -54,15 +64,13 @@ To connect your app to the production environment, You need to update the follow

The URLS can be found xref:../urls.adoc[here].


[IMPORTANT]
====
Each agrirouter account has a limited number of endpoints, see xref:../limitations.adoc[here].
====



== 4.6 Approval for your end customer
== Approval for your end customer
When you decide that your application is successfully up and running and tested with the production environment, you can take all the steps relevant to publish your software to your customers like

* deploying it on the server
Expand All @@ -73,4 +81,4 @@ When you decide that your application is successfully up and running and tested
There are no additional steps required in the agrirouter UI or the agrirouter interface

== How to proceed
Once you published your software and customers start using it, you should xref:../maintenance.adoc[maintain your solution].
Once you published your software and customers start using it, you should xref:../maintenance.adoc[maintain your solution].
115 changes: 0 additions & 115 deletions modules/ROOT/pages/partner-process/integration-qa.adoc

This file was deleted.

Loading