Integration Development Standards
In an effort to avoid assumptions by either party on projects, we have created the Rixxo integration development Standards. They exist to ensure that the best resources are available for integrations, and how we will deal with situations where these are not available.
Rixxo's Integration Development Standards represent the culmination of years of experience in delivering successful integration on time and on budget.
Developed through a rigorous process of refinement and adaptation, these standards embody our commitment to excellence in every aspect of integration development.
Drawing from a wealth of hands-on experience and industry insights, our standards serve as a guiding framework to ensure that each integration project is executed with precision, efficiency, and utmost client satisfaction.
With a steadfast focus on delivering results that exceed expectations, our standards form the cornerstone of our approach to integration development, reflecting our unwavering dedication to achieving unparalleled success for our clients, on time and on budget.
Staging Environment
Aspect | Details |
---|---|
Standard | Rixxo requires a staging environment mirroring the live setup for safe integration testing. |
Explanation | We require a staging environment that replicates the live setup, ensuring safe testing of integrations. To maintain privacy, actual customer data is anonymised, thereby preventing unintended real-world notifications. |
Rationale | A staging environment that mirrors the live setup provides a controlled environment for testing integrations without risking disruption to live operations. This means we can develop on as close to the real thing as possible, without any of the risk. |
If not met | If a staging environment cannot be provided, Rixxo will simulate the live environment using tools like Postman. Once the calls successfully operate in this simulated environment, further steps will be taken to cautiously implement these changes on the live service and address any necessary modifications. |
Privacy and Safety Measures
Aspect | Details |
---|---|
Standard | Rixxo mandates the sanitisation of any real contact information within the system. |
Explanation | In this staging area, we anonymise genuine customer data, such as email addresses, to prevent any real-world notifications or messages during testing. For instance, transforming "jane.doe@example.com" to "test.jane@example.staging" ensures privacy protection and eliminates any real-world mishaps. |
Rationale | To ensure effective development, it's crucial to treat the data realistically and conduct end-to-end tests of the system. Using real customer data poses the risk of sending irrelevant or compromising notifications. Sanitising client information is thus a fundamental standard at Rixxo to prevent such issues and avoid unnecessary expenses. |
If not met | If this standard is not met, Rixxo will undertake additional efforts to sanitise the data. If sanitisation is not feasible for any reason, Rixxo will disable any functionality for sending emails and other notifications from the software, testing them only with isolated and secure data. If Rixxo is informed that the data is sanitised and it is found not to be, Rixxo will not accept responsibility for any communication sent. |
Data mapping
Aspect | Details |
---|---|
Standard | Rixxo requires data mapping to complete an integration correctly and efficiently. |
Explanation | Data mapping is the act of assessing which field in one system will link to which field in another system. This can also involve the transformation of the data. For example one system may store the data in the D-M-Y format and the other may use the M-D-Y format needing the date to be transformed. Rixxo requires the client to do as much of the mapping as possible. Rixxo will provide assistance with templates and guidance, but by having as much client involvement as possible we can reduce the chance of mistakes or misunderstandings occurring in the integration. |
Rationale | The client knows what each piece of data means within their system and the result they want to achieve. This means that they will be able to achieve the mapping with greater accuracy. For example, if one system had only one field for colour, but in the second system there were “Main colour, display colour, marketing colour”, the client would know what the correct field to use would be. |
If not met | If this standard is not met, Rixxo will undertake additional efforts to map the data, requesting advice and approval from the client and using our best judgment and experience. This can however lead to changes being required and longer estimates. |
Documentation
Aspect | Details |
---|---|
Standard | Rixxo mandates full access to the latest documentation regarding the system and the API for the software under integration. |
Explanation | We provide a comprehensive guide detailing our system's interaction with the integrated software. This includes descriptions of all commands, their usage, and common error messages. |
Rationale | Accurate and up-to-date instructions are imperative for understanding system interactions and building effective solutions. Relying on outdated or incomplete instructions leads to inaccurate estimates and jeopardises successful integration. |
If not met | If this standard is not met, Rixxo will allocate additional time to attempt to acquire the documentation from the software owner. If Rixxo is unable to retrieve the documentation independently, the project will be temporarily paused until the necessary documentation is obtained. |
Collaborative Testing and Quality Assurance
Aspect | Details |
---|---|
Standard | Rixxo mandates collaborative handling of QA tasks related to object creation, editing, or deletion within the software. |
Explanation | Testing involves Rixxo, the client, and the integrations expert, ensuring issues are identified and resolved before impacting the live environment. |
Rationale | Leveraging the expertise of the client or professional enhances testing accuracy, minimising errors and ensuring successful integration. |
If not met | In the event of this standard not being met, Rixxo will proceed with the integration work. However, adjustments to the project timeline will be necessary to accommodate the additional time required for navigating, documenting, and aligning the system with the client's requirements. |