# Building a private blueprint ## Introduction This guide steps through the process of building and publishing a new, private blueprint. As soon as a blueprint is published, it becomes available for any of your linked (i.e. child) companies to [install](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/installing-a-private-blueprint). {% hint style="info" %} If you'd like to make your blueprint available in the Patchworks public marketplace, you should [submit it for approval.](https://doc.wearepatchworks.com/product-documentation/marketplace/marketplace-blueprints/submitting-a-blueprint-to-the-public-marketplace) {% endhint %} ## Need to know * To build blueprints, your user account must be associated with an `administrator` role. For more information, please refer to our [Roles & permissions summary](https://doc.wearepatchworks.com/product-documentation/users-roles-and-permissions/roles-and-permissions-summary) page. * To be available for selection in a blueprint, a process flow must be deployed (either to a virtual environment or to `no environment`). * When process flows are selected for inclusion in a blueprint, the last deployed version is added. ## The steps {% stepper %} {% step %} **Log in to your own company profile** Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've [switched to your own profile](https://doc.wearepatchworks.com/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company). {% endstep %} {% step %} **Build & deploy required process flows** Ensure that all required process flows are built, tested, and deployed - for example:
{% hint style="info" %} A process flow must be deployed before it can be added to a blueprint. {% endhint %} {% endstep %} {% step %} **Access the blueprints section of the marketplace** Select `marketplace` from the left-hand navigation menu, then select `blueprints` and your `private` marketplace. For example:
{% endstep %} {% step %} **Launch the new blueprint wizard** Click the `build a new blueprint` button:
{% endstep %} {% step %} **Complete general details for the blueprint** Enter general details for this blueprint:
Available fields are summarised below:
FieldSummary
NameEnter a name to be displayed for this blueprint wherever it is displayed in the dashboard.
VisibilityAlways set to private. If you would like to submit a blueprint for availability in the Patchworks marketplace, please refer to Submitting a blueprint to the public marketplace.
LabelsAny labels defined for your company profile are available for selection.
Help guideIf available, enter a link to a help guide for this blueprint.
Post-install default

Select what action (if any) should be shown to users as the default whenever this blueprint is installed manually:

  • None. The blueprint is installed, but the associated process flows are not deployed.
  • Package flows. The blueprint is installed and the associated process flows are added to a new package, ready for manual deployment to virtual environments.
  • Package and redeploy. The blueprint is installed and the associated process flows are redeployed wherever they currently exist - i.e. to any child companies (and any virtual environments) where this blueprint is presently installed.

When someone chooses to install this blueprint, they can change this option. All you're setting here is what the default setting will be.

{% endstep %} {% step %} **Confirm general details** Click the `create` button to confirm general details. For example:
{% endstep %} {% step %} **Configure the blueprint manifest** The `manifest` page is where you configure which process flows and resources to include in this blueprint:
First, choose which process flows to include. For example:
{% hint style="info" %} When a process flow is selected, the last deployed version is added. {% endhint %} As you select process flows, any associated resources are added to the manifest. For example:
{% endstep %} {% step %} **Review & update the blueprint manifest** Review the updated `manifest` page. By default, all resources needed for each selected process flow will be included; however, you can add more resources if necessary. {% hint style="info" %} Changes to this page are saved as a [draft](#blueprint-drafts) automatically. {% endhint %} {% endstep %} {% step %} **Publish the blueprint** If you're ready to make this blueprint available in your private marketplace, click the `publish` button at the top of the manifest. For example:
When a blueprint is published, it is queued for upload to your private marketplace, and a notification is generated upon completion. To prevent timing conflicts, an 'update in progress' banner is displayed at the top of the manifest for the duration of the publish process. For example:
During this time, the blueprint is locked - it can't be changed or installed until the upload is complete. Once the upload is complete, the blueprint becomes available in your private marketplace. {% hint style="info" %} Publishing a new blueprint makes it [active](https://doc.wearepatchworks.com/product-documentation/blueprints/about-blueprint-versions#the-active-version), so it becomes available to install from your private marketplace - it does not deploy anything automatically. {% endhint %} {% endstep %} {% endstepper %} ## Blueprint drafts As soon as you confirm the general details for a blueprint (step 6 [above](#the-steps)), the blueprint is saved to the `unpublished` section of your private marketplace. For example:
From here, you can click any item to access the manifest, then make changes and publish the blueprint. {% hint style="info" %} In a draft state, component counts on blueprint tiles will always be 0. {% endhint %} ## What next? Having published a new blueprint, it becomes available in your private marketplace, ready for child companies to install. When installing the blueprint for a child company for the first time, [installation must be completed manually](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/installing-a-private-blueprint). Thereafter, any updates can be promoted automatically. ### Published blueprint options At the top of the configuration page for a published blueprint, you'll see some new options:
These options are summarised below.
FieldSummary
VersionWhen a blueprint is published for the first time, version 1 (v1) is generated. If the blueprint is subsequently updated and re-published, the version number is incremented. The first version is always set to be the active, version. For more information, please see About blueprint versions.
InstallClick this option to install the blueprint for the current company profile.
...

The ellipsis icon provides access to the following options:

  • View installs. View and manage installations of this blueprint for your 'child' companies. From here, you can see where the blueprint is installed and promote an update to multiple companies. For more information, please refer to Rolling out blueprint updates.
  • Open draft. Create a draft manifest and update the blueprint. For more information, please refer to Updating a private blueprint.
  • Delete. Remove this blueprint from your private marketplace. Note that this does NOT remove or disable associated process flows that may already be deployed.