diff --git a/modules/ROOT/assets/images/icons/email.svg b/modules/ROOT/assets/images/icons/email.svg new file mode 100644 index 00000000..38020a1a --- /dev/null +++ b/modules/ROOT/assets/images/icons/email.svg @@ -0,0 +1,44 @@ + + + diff --git a/modules/ROOT/assets/images/icons/slack.svg b/modules/ROOT/assets/images/icons/slack.svg new file mode 100644 index 00000000..fb55f724 --- /dev/null +++ b/modules/ROOT/assets/images/icons/slack.svg @@ -0,0 +1,6 @@ + diff --git a/modules/ROOT/assets/images/icons/teams.svg b/modules/ROOT/assets/images/icons/teams.svg new file mode 100644 index 00000000..3409e6cf --- /dev/null +++ b/modules/ROOT/assets/images/icons/teams.svg @@ -0,0 +1,22 @@ + + diff --git a/modules/ROOT/assets/images/partner-process/integration-steps.svg b/modules/ROOT/assets/images/partner-process/integration-steps.svg new file mode 100644 index 00000000..a7af0cbd --- /dev/null +++ b/modules/ROOT/assets/images/partner-process/integration-steps.svg @@ -0,0 +1,435 @@ + + + + diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index bdb38fea..0cc1b5cb 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -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] @@ -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] diff --git a/modules/ROOT/pages/applications.adoc b/modules/ROOT/pages/applications.adoc index bb9cd507..b473ef6d 100644 --- a/modules/ROOT/pages/applications.adoc +++ b/modules/ROOT/pages/applications.adoc @@ -108,7 +108,7 @@ After submitting, DKE will receive a notification and set the status to _Approve [NOTE] ==== -Please be aware of xref:../service-support.adoc#contact[support business hours]. +Please be aware of xref:service-support.adoc#contact[support business hours]. ==== .agrirouter warning diff --git a/modules/ROOT/pages/introduction.adoc b/modules/ROOT/pages/introduction.adoc index f0794c2e..0e9b4b01 100644 --- a/modules/ROOT/pages/introduction.adoc +++ b/modules/ROOT/pages/introduction.adoc @@ -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 @@ -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] diff --git a/modules/ROOT/pages/partner-process/becoming-a-partner.adoc b/modules/ROOT/pages/partner-process/becoming-a-partner.adoc new file mode 100644 index 00000000..35121c1a --- /dev/null +++ b/modules/ROOT/pages/partner-process/becoming-a-partner.adoc @@ -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. + +== Business / 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]. \ No newline at end of file diff --git a/modules/ROOT/pages/partner-process/development-process.adoc b/modules/ROOT/pages/partner-process/development-process.adoc new file mode 100644 index 00000000..adf141e3 --- /dev/null +++ b/modules/ROOT/pages/partner-process/development-process.adoc @@ -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] \ No newline at end of file diff --git a/modules/ROOT/pages/partner-process/integration-process.adoc b/modules/ROOT/pages/partner-process/integration-process.adoc new file mode 100644 index 00000000..2a5cd31c --- /dev/null +++ b/modules/ROOT/pages/partner-process/integration-process.adoc @@ -0,0 +1,78 @@ += Interface Integration in Production +:imagesdir: _images/ + +== General process of integration in Production + +image::partner-process/integration-steps.svg[] + +== Create developer account + +include::partial$different-accounts.adoc[] + +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 URL for signup xref:../urls.adoc[here]. + +include::partial$approval-manually-support-times.adoc[] + +== Register & submit your solution + +For communication with agrirouter, you need to xref:../applications.adoc[setup an application]. + +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]. + +include::partial$approval-manually-support-times.adoc[] + +== 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]. + +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_ . + +== 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). + +To connect your app to the production environment, You need to update the following information in your application: + +* applicationId +* certificationVersionId +* Certificate for the authorization process (if Telemetry Platform or Farming Software) +* The URLs for: +** authorization +** onboarding +** re-onboarding +** revoking + +The URLS can be found xref:../urls.adoc[here]. + +[IMPORTANT] +==== +Each agrirouter account has a limited number of endpoints, see xref:../limitations.adoc[here]. +==== + + +== 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 +* advertising it +* flashing hardware with it +* etc. + +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]. \ No newline at end of file diff --git a/modules/ROOT/pages/partner-process/integration-prod.adoc b/modules/ROOT/pages/partner-process/integration-prod.adoc deleted file mode 100644 index 8a588afb..00000000 --- a/modules/ROOT/pages/partner-process/integration-prod.adoc +++ /dev/null @@ -1,76 +0,0 @@ -= Interface Integration in Production -:imagesdir: _images/ - -== 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::general/process_integration_prod_v2.png[] - -== 4.1 Create developer account - -Once you're done with testing in QA, you can xref:../registration.adoc[create an account in the productive environment]. - -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]. - -== 4.2 Register & submit your solution - -For communication with agrirouter, you need to setup an xref:../applications.adoc[application] in the productive environment. - - -== 4.3 Approval from the certification company - -The certification company will perform the certification - with your support - and create a certificate to proof that your solution is compatible with agrirouter. - -[IMPORTANT] -==== -Please recognize that the certification will be done in the quality assurance environment. -==== - - -== 4.4 Approval from support team -When the certification is successfully approved, the app will be set to status _Approved_ . - -[NOTE] -==== -If your app is a CU, it will from this point on be visible to all users wanting to add a new Telemetry connection. -==== - - -== 4.5 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). - -To connect your app to the production environment, You need to update the following information in your application: - -* applicationId -* certificationVersionId -* Certificate for the authorization process (if Telemetry Platform or Farming Software) -* The URLs for: -** authorization -** onboarding -** re-onboarding -** revoking - -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 -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 -* advertising it -* flashing hardware with it -* etc. - -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]. diff --git a/modules/ROOT/pages/partner-process/integration-qa.adoc b/modules/ROOT/pages/partner-process/integration-qa.adoc deleted file mode 100644 index 92d5bc45..00000000 --- a/modules/ROOT/pages/partner-process/integration-qa.adoc +++ /dev/null @@ -1,115 +0,0 @@ -= 3. Interface Integration in Quality Assurance -:imagesdir: _images/ - -== Before we begin - -Before starting with the integration, it's important to understand the xref:../basic-concepts.adoc[basic concepts of agrirouter]. - -[IMPORTANT] -==== -Each agrirouter account has a limited number of endpoints, see xref:../limitations.adoc[here]. -==== - -== Development Resources - -There are several development resources which can be found in xref:../development-resources.adoc[the list of development resources] including topics like: - -* xref:../keys.adoc[The keys & Certificates] -* link:https://github.com/DKE-Data/agrirouter-postman-tools[Postman collection for onboarding and Revoking] -* xref:../tools/paho.adoc[Paho for MQTT Connection] -* xref:../tools/arts.adoc[The agrirouter protobuf toolset] -* link:https://github.com/DKE-Data[The github Account with documentation and APIs] -* link:https://github.com/DKE-Data/agrirouter-api-developer-tutorial[A video tutorial on the integration process] - -== General process of integration in QA -image::general/process_integration_qa_v2.png[] - - - -== 3.1 Create developer account -To start the development, you will need to xref:../registration.adoc[create a developer account]. - -== 3.2 Register & Submit your solution - -For communication with agrirouter, you need to xref:../applications.adoc[setup an application] in the Quality assurance environment. - -== 3.3 Waiting for approval by the support team - -Whenever you create a new application version, the agrirouter support team will have to approve this application. Please send an email to support@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]. - -== 3.4 Contact certification company - -Every app needs to be certified to communicate with the agrirouter. Further information can be found xref:../certification.adoc[here]. - -Once you know, which kind of application you want to create, you should get in contact with one of the link:https://docs.agrirouter.com/agrirouter-interface-documentation/latest/certification.html#certification-companies[certification companies] 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#Prerequistes[prerequistes] available. - - -== 3.5 Integrate interface in your solution - -The following chapters describe all requirements to integrate an application with agrirouter. - -=== Before we begin -First, you should always keep in mind the xref:../integration/general-conventions.adoc[General conventions]. - -There are several environments for test and production in different areas of the world. Their different parameters like URLs and certificates can be found in the xref:../integration/environments.adoc[Environments]. - -=== General lifecycle of an endpoint -image::graphs/lifecycle.svg[] - -=== Connecting your app instance - -==== Authorization -Farming Software and Telemetry Platforms have to perform an xref:../integration/authorization.adoc[Authorization Process] to clarify that the account user is known. - -==== Onboarding - -To communicate with the agrirouter, an application Instance needs to be xref:../integration/onboarding.adoc[onboarded]. An application instance can be xref:../integration/reonboarding.adoc[Re-onboarded]. - - -=== Communicate with agrirouter endpoints - -==== Building messages - -To send a message, it has to be built first. Read xref:../integration/build-message.adoc[here] about building messages and commands. - -List of possible message content: - -* xref:../commands/overview.adoc[Commands to interact with the agrirouter] -* xref:../tmt/overview.adoc[Technical message types to exchange data between endpoints of the agrirouter] - -==== Sending messages and commands - -Every application instance can xref:../integration/message-sending.adoc[send messages] and commands the same way. - -While xref:../tmt/overview.adoc[messages] are meant to be forwarded to other endpoints, xref:../commands/overview.adoc[commands] are used to xref:../commands/ecosystem.adoc[explore the ecosystem], xref:../commands/endpoint.adoc[configure your endpoint] and xref:../commands/feed.adoc[request messages from the feed]. - -==== Receiving messages and command answers - -Command results and messages from other endpoints will be xref:../integration/message-receiving.adoc[received through the outbox] by the receiving application instance. - -Messages from other endpoints are put into the outbox by xref:../integration/push-notification.adoc[push notifications] as well as by xref:../commands/feed.adoc[requesting the feed content]. - -==== Analysing messages - -Depending on the xref:../integration/analyse-result.adoc#ResponseType[resultType], the result can be xref:../integration/analyse-result.adoc[analysed]. - -=== End of life for an endpoint - -When an endpoint shall be deleted, it can be xref:../integration/revoke.adoc[Revoked]. - -== 3.6 Test Interface and messaging - -In status _Approved for Testing_, application developers can xref:../invite-testers.adoc[add other accounts for testing their application]. If a certification version is in status _Approved for Testing_, instances with this certification version can be onboarded in these test accounts and an external test can be started. The developers account automatically is an end-user account that is a test account. This means that a developer can onboard an endpoint in his account. - -[IMPORTANT] -==== -As the application currently only communicates with the agrirouter Quality assurance environment, it cannot be onboarded in the Production environment. See xref:../partner-process/integration-prod.adoc[Integration in Production] for those further steps. -==== - - -== How to proceed - -Once you finished the tests and see your app ready to be published, you can proceed with the xref:../partner-process/integration-prod.adoc[integration in the productive environment]. diff --git a/modules/ROOT/pages/partner-process/legal-agreement.adoc b/modules/ROOT/pages/partner-process/legal-agreement.adoc new file mode 100644 index 00000000..3cd85114 --- /dev/null +++ b/modules/ROOT/pages/partner-process/legal-agreement.adoc @@ -0,0 +1,293 @@ +:fn-turnover: pass:c,q[footnote:turnover[The term _turnover_ always refers to the <>]] + += Business / Legal agreement + +== Business model of DKE-Data + +DKE-Data operates as a non-profit company. This means that all financial contributions are only as high as necessary to cover the cost of continued operation, maintenance and future development of agrirouter and its surrounding solutions. + +== Who needs a legal agreement? + +All companies that want to *provide a product with agrirouter integration to an end-customer* must enter one of the legal agreements outlined below. + +Specifically, companies that only offer their products to other companies who then bring it to the market (OEM providers), do not _need_ to be an agrirouter member, but can be if they choose to do so. + +Also, farmers and contractors, as the users of the agrirouter itself, do _not_ need to become a member, but can if they choose to do so. For this group, special membership rates for the <> are being offered. + +== Who can become a partner? + +Only companies that are "qualified agribusiness market participants" may become a member of DKE-Data GmbH & Co. KG. + +A qualified agribusiness market participant is + + * any business from farmers and suppliers of farmers + * any customer of farmers such as wholesalers of agricultural products and + * any business part of the agricultural and food production chain, such as mills, bakeries, and food manufacturers. + +Excluded from the agricultural production chain in our definition are food retailers, even in case they directly procure from farmers. + +== Participation options + +There are generally five different roles in which a company can participate in the eco system: + +[cols="3,^2,^2,^2,^2,^2", stripes=even] +|=== +h| Model +h| Association Member (1) +h| Business Partner (2A) +h| Shareholder (2B) +h| Business Partner (3A) +h| Shareholder (3B) + + +| <> limit +| < 60 Mio EUR/year +4+| _none_ + +| <> vote +| only one for the whole association +| ✅ +| ✅ +| ✅ +| ✅ + +| Shareholder Meeting vote +| ❌ +| ❌ +| ✅ +| ❌ +| ✅ + +| Financial Contribution +3+| fixed fee, based on <> +2+| cost distribution, based on <>; fixed fee for companies < 60 Mio EUR/year + +| Binding Period +| 1 year +2+| 2 years +2+| 3 years + +|=== + + +The options in more detail: + +[#association] +=== Member of DKE-Data agrirouter e.V. (option 1) + +All companies with a <> less than 60 Million Euro per year can access the agrirouter by becoming a member of the association DKE-Data agrirouter e.V. + +These members pay a fixed yearly fee that is based on their annual <>. + +https://dke-data.com/association[Becoming a member] of the association provides access to production use of the agrirouter, as well as to the participation of regular meetings of the association, where information about current proceedings is distributed and feedback and requests from members is collected and discussed. + +The association as a whole is then represented in the <> that decides on the agrirouter roadmap. + +To become an association member, just fill out the https://dke-data.com/association[respective form on our website]. + +The cost contribution for being a member of DKE-Data agrirouter e.V. is: + +[cols="^3,^2", stripes=even] +|=== +h| <> [Mio. EUR] +h| Yearly Contribution [EUR] + +| >35 - 60 +| 3.000 + +| >10 - 35 +| 2.000 + +| <10 +| 1.000 + +| Contractor +| 500 + +| Farmer +| 250 +|=== + +[NOTE] +==== +Farmers and Contractors who are simply using the agrirouter through our members' solutions do *not need* to become a member. +They may do this voluntarily if they want to become involved directly with the future of agrirouter. +==== + +=== Business Partner of DKE-Data GmbH & Co. KG (options 2A/3A) + +All companies may choose to become a Business Partner of DKE-Data GmbH & Co. KG. + +After an optional introduction period of two years, where a fixed fee based on the company's annual <> has to be paid, the financial share is defined by distributing the total remaining running cost of DKE-Data GmbH & Co. KG across all business partners and shareholders of DKE-Data GmbH & Co. KG, after all revenues (research funding, contributions of association members etc.) have been deducted. This financial share in about the same value as the fixed fee in the initial period. + +Business Partners have a vote in the <> that decides on the agrirouter roadmap. + +Cost contribution *during the trial period*: +[cols="^3,^2,^3,^2", stripes=even] +|=== +h| <> + +[Mio. EUR] +h| Yearly Contribution + +[EUR] +h| <> + +[Mio. EUR] +h| Yearly Contribution + +[EUR] + +| > 8.500 +| 180.000 +| > 273 - 453 +| 18.000 + +| > 5.249 - 8.500 +| 130.000 +| > 162 - 273 +| 13.500 + +| > 3.233 - 5.249 +| 95.000 +| > 94 - 162 +| 9.000 + +| > 1.988 - 3.233 +| 67.500 +| > 60 - 94 +| 7.500 + +| > 1.220 - 1.988 +| 50.000 +| > 35 - 60 +| 6.000 + +| > 745 - 1.220 +| 36.000 +| > 10 - 35 +| 4.000 + +| > 453 - 745 +| 25.000 +| < 10 +| 2.000 +|=== + +Cost contribution *after the trial period*: +[cols="^3,^2", stripes=even] +|=== +h| <> [Mio. EUR] +h| Yearly Contribution [EUR] + +| > 60 +| _dynamic_, see description above + +| > 35 - 60 +| 6.000 + +| > 10 - 35 +| 4.000 + +| < 10 +| 2.000 +|=== + +=== Shareholder of DKE-Data GmbH & Co. KG (options 2B/3B) + +All companies may choose to become a Shareholder of DKE-Data GmbH & Co. KG. + +After an optional introduction period of two years, where a fixed fee based on the company's annual <> has to be paid, the financial share is defined by distributing the total remaining running cost of DKE-Data GmbH & Co. KG across all business partners and shareholders of DKE-Data GmbH & Co. KG, after all revenues (research funding, contributions of association members etc.) have been deducted. This financial share in about the same value as the fixed fee in the initial period. + +Shareholders, like Business Partners, have a vote in the <> that decides on the agrirouter roadmap. +Additionally, Shareholders have a seat and vote in the Shareholder Meeting, where all topics that are required by law to be discussed and decided in the shareholder meeting are placed. + +Keep in mind that, while the financial contribution for Business Partners and Shareholders is the same, being a Shareholder comes with additional legal obligations! + +[#one-vote] +== One Vote Principle + +Every company that is a Business Partner or a Shareholder of DKE-Data GmbH & Co. KG only has **one vote**, irrespective of the financial share they cover. This ensures equal participation of all involved companies. + +This, however, does not apply to members of the DKE-Data agrirouter e.V. association, as they have actively chosen to only participate in the platform with only little influence over its future. Every company has the right to instead become a business partner or a shareholder! + +[#weighted-ag-turnover] +== Weighted Ag Turnover + +To find a fair contribution model, we are basing all contributions on the "Weighted Ag Turnover". + +This is how it is calculated: + +==== +Weighted Ag Turnover = <> of the <> * <> +==== + +.Calculation Example +==== +Your company belongs to a group of companies. + +The whole turnover is *120 Million Euros*. + +70 Million Euros are earned in the field of road construction + +=> *Ag Turnover of the company group = 50 Mio* + +Your Ag return on sales before tax is 0.5% for the relevant years + +=> *RoS factor = 0.25* + +=> *Weighted Ag Turnover =* 50,000,000 EUR * 0.25 = *12,500,000 EUR* +==== + +[#company-group] +=== Company Groups/Holdings + +If your company belongs to a larger group of companys, the *total turnover* of the whole group has to be taken into consideration. + +If the owning entity holds more than 50% of *either* the shares _or_ the voting rights of another entity, these entities belong to the same group. + +[#ag-turnover] +=== Ag Turnover + +Only turnover in the agricultural sector is taken into consideration. Should your company have other fields of business, the turnover from these fields can be deducted from the official turnover. + +[#ros-factor] +=== Ag Return on Sales factor + +Based on your company's return on sales, the Weighted Ag Turnover is calculated: + +[cols="^3,^2", stripes=even] +|=== +h| Ag Net RoS (before tax) [%] +h| Correction Factor + +| <0 - 0.75 +| 0.25 + +| >0.75 - 1.75 +| 0.50 + +| >1.75 - 3.0 +| 0.75 + +| >3.0 +| 1.00 +|=== + +[#psc] +== Product Steering Committee + +The Product Steering Committee (PSC) regularly holds meetings, currently once a month. + +Subject of the PSC are all topics related to operation and future development of the agrirouter, such as: + +* presenting current topics of agrirouter operations +* discussing existing feature requests/ideas regarding necessity and priority, feature consolidation +* discussing design ideas for features (on a rough specification level) or organize subsequent meetings with interested parties for those discussions +* prioritizing product backlog items + +Every member may send up to three representatives into the Product Steering Committee, but only with <>. +This rule also applies to the DKE-Data agrirouter e.V. association, as it itself is a shareholder. The representatives from the DKE-Data agrirouter e.V. will be elected in the association's yearly general assembly. + +== General process + +If you are interested to discuss the options or want to receive a copy of the contract, please contact Dr. Johannes Sonnen, see link:https://dke-data.com/#team[the contacts page]. + +[NOTE] +==== +These contacts are only relevant for the business side, for development or end user support, please refer to the xref:../service-support.adoc[Service&Support] +==== \ No newline at end of file diff --git a/modules/ROOT/pages/service-support.adoc b/modules/ROOT/pages/service-support.adoc index 5a3e0cef..da8a018e 100644 --- a/modules/ROOT/pages/service-support.adoc +++ b/modules/ROOT/pages/service-support.adoc @@ -132,9 +132,6 @@ All of the above can be found in the endpoint details by clicking the ‘Info’ .Relevant information for agrirouter support image::ig1/image46.png[Relevant information for agrirouter support,586,335] - - - ==== For commands related incidents Please provide the commands sent from and received by the endpoint if available. The communication protocol can be provided as log file for example. diff --git a/modules/ROOT/pages/urls.adoc b/modules/ROOT/pages/urls.adoc index 53a10af7..1f2f7873 100644 --- a/modules/ROOT/pages/urls.adoc +++ b/modules/ROOT/pages/urls.adoc @@ -10,7 +10,7 @@ On this page you will find a list of URLs and hosts relevant for your work with |==== |Area |Environment |URL |EU |agrirouter 2.0 QA | https://app.qa.agrirouter.farm/ -|EU |Production |https://goto.my-agrirouter.com/ +|EU |Production | https://app.agrirouter.com/ |==== == User Registration @@ -19,8 +19,8 @@ On this page you will find a list of URLs and hosts relevant for your work with [cols="1,2,5",options="header",] |==== |Area |Environment |URL -|EU |agrirouter 2.0 QA | https://app.qa.agrirouter.farm/ -|EU |Production |https://goto.my-agrirouter.com/um/register/user +|EU |agrirouter 2.0 QA | https://app.qa.agrirouter.farm/ _Note:_ Follow the Link for the registration process. +|EU |Production | https://app.agrirouter.com/ _Note:_ Follow the Link for the registration process. |==== [NOTE] @@ -36,7 +36,7 @@ accounts there when explicitly asked for it! |==== |Area |Environment |URL |EU |agrirouter 2.0 QA | _Note:_ there is no special sign up for developers; please create a regular user account and apply for developer permissions in your user settings! -|EU |Production |https://goto.my-agrirouter.com/um/register/developer +|EU |Production | _Note_: there is no special sign up for developers; please create a regular user account and apply for developer permissions in your user settings! |==== [NOTE] @@ -52,7 +52,7 @@ accounts there when explicitly asked for it! |==== |Area |Environment |URL |EU |agrirouter 2.0 QA | https://app.qa.agrirouter.farm/ -|EU |Production |https://goto.my-agrirouter.com/app +|EU |Production | https://app.agrirouter.com/ |==== @@ -64,7 +64,10 @@ These are the base hosts for onboarding requests: |==== |Area |Environment |Host |EU |agrirouter 2.0 QA | https://endpoint-service.qa.agrirouter.farm -|EU |Production |https://onboard.my-agrirouter.com +|EU |Production | https://onboard.agrirouter.com + + [line-through]*https://onboard.my-agrirouter.com* (deprecated in 2024) + + [line-through]*https://agrirouter-registration-service.cfapps.eu10.hana.ondemand.com* (deprecated in 2020) + + [line-through]*https://agrirouter-registration-service.cfapps.eu1.hana.ondemand.com* (deprectead in 2019) |==== Use the following paths: @@ -87,8 +90,8 @@ Sending an onboarding request is described xref:./integration/onboarding.adoc[he [cols="1,2,5",options="header",] |==== |Area |Environment |URL -|EU |agrirouter 2.0 QA |https://app.qa.agrirouter.farm/application/\{applicationId}/authorize -|EU |Production |https://goto.my-agrirouter.com/application/\{applicationId}/authorize +|EU |agrirouter 2.0 QA | https://app.qa.agrirouter.farm/application/\{applicationId}/authorize +|EU |Production | https://app.agrirouter.com/application/\{applicationId}/authorize |==== The description on creating a full authorization URL can be found xref:./integration/authorization.adoc#generating-an-authorization-url[here] diff --git a/modules/ROOT/partials/different-accounts.adoc b/modules/ROOT/partials/different-accounts.adoc new file mode 100644 index 00000000..eeb0e993 --- /dev/null +++ b/modules/ROOT/partials/different-accounts.adoc @@ -0,0 +1,7 @@ +[NOTE] +==== +Currently, different accounts are required for the following systems: + + * agrirouter application (different accounts for production and QA environments, if applicable for you) + * IO-Tool +==== \ No newline at end of file