Submitting a blueprint to the public marketplace
Overview
This document outlines the approval process for developers submitting blueprints for inclusion in the Patchworks marketplace. The Patchworks marketplace is a platform where users can discover, install, and use various pre-built blueprints to accelerate the onboarding process.
Submission requirements
You must ensure that your blueprint meets the following requirements.
| Requirement | Summary |
|---|---|
Compliance | The blueprint must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights. |
Functionality | The blueprint must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues. |
Quality | The blueprint must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the Patchworks platform. |
Security | The blueprint must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling. |
Marketplace compatibility | The blueprint should be compatible with the Patchworks platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies. |
Connector compatibility | The blueprint should use existing connectors found in the Patchworks marketplace. Any modifications to existing connectors in order to support the blueprint must be submitted separately prior to the blueprint review process. |
Documentation | You should provide clear and comprehensive documentation for your blueprint, including installation instructions, usage guidelines, and troubleshooting tips if any are required. Documentation can be provided as http links in multiple sections of the connector builder. Alternatively documentation can be submitted along with your blueprint. We will host this documentation on our public documentation platform. |
Submission Process
The submission process for public blueprints consists of the following steps:
Step 1: Declaration of intent
Before the development of the blueprint commences, you are encouraged to submit in writing (to your partner manager) the following details on any blueprint(s) you intend to create.
| Item | Summary |
|---|---|
Developer name | The name and email address of your company or developer. |
Patchworks company profile | The Patchworks dashboard company profile name under which you will create the new blueprint(s). |
Blueprint name | The name of the blueprint to be displayed in the Patchworks marketplace. |
Expected completion date | If known, provide the expected completion date for development. |
Connectors | Specify the name of any connectors to be included in the new blueprint(s). If these connectors do not exist or require modifications, you must provide details about the required modifications. |
Process flows | Provide information about any process flows that you intend to build utilising the specified connectors. This information should include the purpose of the process flow and any custom scripts that will be built. |
Step 2: Pre-submission review
Before submitting a blueprint for approval, you are encouraged to conduct a thorough review to ensure that your blueprint meets all requirements outlined above.
This includes testing for functionality, performance, and security.
Step 3: Blueprint submission
Once the blueprint is ready, you can submit it via your account manager. The submission should include the following:
Documentation and user guides
Screenshots or demo videos
Contact information for the developer or support team
Step 4: Review meeting
Once the blueprint and associated information are submitted, the Patchworks team will schedule a review meeting with the developers. During this meeting, you should be prepared to:
Go over the changes required for connectors, if any.
Review the proposed process flows and confirm their functionality.
Demonstrate working flows by showing data transmission between source and destination systems.
Review any scripts or custom components used in the blueprint.
Post-approval responsibilities
After a blueprint is approved and listed in the Patchworks marketplace, you have certain responsibilities to maintain the app's quality and compliance.
| Responsibility | Summary |
|---|---|
Updates & maintenance | You should regularly update and maintain you blueprint(s) to ensure it remains compatible with the Patchworks platform and any relevant changes or updates. |
Support | You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner. |
Compliance | You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise. |
Conclusion
The approval process outlined above is designed to ensure that public blueprints included in the Patchworks marketplace meet our high standards for quality, functionality, and security. By following this process and meeting our submission requirements, you can contribute to a vibrant ecosystem of third-party blueprints that enhance the user experience on the Patchworks platform.
For further information or assistance with the blueprint submission process, please refer to the Patchworks support team.
Last updated