Skip to main content
Version: 1

Deployment in Plinqx


Available: Starter and Premium


Deploying configurations in Plinqx is a critical process that requires careful attention to detail and adherence to Salesforce best practices. This guide outlines the necessary steps to deploy APIs, Steps, and Mappings in Plinqx and highlights the importance of thorough testing before moving configurations to a production environment.

Deploying APIs

To deploy APIs in Plinqx:

  1. Metadata Types:

    • Ensure you deploy the corresponding Plinqx__Event__mdt and Plinqx__Event_Object_And_Field__mdt records. These metadata types contain crucial configuration information for your APIs.
  2. Include Custom Components:

    • Along with the metadata records, include any custom Apex classes or Flows that are used for the API configuration.

Deploying Steps

For deploying Steps in Plinqx:

  1. Metadata Types:

    • Deploy the Plinqx__Step_Config__mdt and Plinqx__Step_Item__mdt records. These are essential for the configuration of the Steps in your Plinqx integration.
  2. Include Custom Components:

    • Similar to API deployment, include all related custom Apex classes or Flows used in the Step configuration.

Deploying Mappings

When deploying Mappings:

  1. Metadata Type:

    • Deploy the Plinqx__MappingAndFunction__mdt records. This metadata holds the details of your data mappings and transformations.
  2. Include Custom Components:

    • Include any custom Apex or Flows that are integral to the Mapping configuration.

Salesforce Deployment Best Practices

  • Test Before Deployment:

    Always test your configurations in a sandbox or testing environment before deploying to production. This helps identify and rectify any issues beforehand.

  • Use Deployment Tools:

    Utilize Salesforce deployment tools such as Change Sets, Salesforce CLI, or Metadata API for a controlled and traceable deployment process.

  • Backup Your Configuration:

    Before deploying, ensure you have a backup of your current production configuration to safeguard against any unforeseen issues.

  • Phased Deployment:

    Consider a phased approach for large or complex deployments, gradually rolling out changes and monitoring their impact.

Importance of Testing

Testing is not just a best practice but a crucial step in the deployment process. It ensures that:

  • Your configurations work as expected.

  • There are no negative impacts on existing functionality.

  • All integrations and workflows operate smoothly post-deployment.


Successful deployment in Plinqx involves meticulous planning, adherence to Salesforce deployment best practices, and thorough testing. By following these guidelines, you can ensure a smooth and efficient transition of your Plinqx configurations into the production environment.