Skip to main content
Version: 2

LWC Application Service

info

Available: Starter and Premium

Overview​

The LWC Application Service using Plinqx provides a powerful service wrapper that extends the capabilities of Salesforce Lightning Web Components (LWC) by integrating them with Plinqx's robust flow functionalities. This innovative approach enables developers to leverage server-side logic through configurable flows in LWCs, thus enhancing application capabilities with Plinqx's advanced integration features.

Adopting best design practices, this service wrapper aids in crafting reusable and modular business services, which can be seamlessly integrated and exposed via both application and service API layers.

Service Wrapper Functionality​

The Plinqx service wrapper for LWCs introduces two primary methods to enhance the LWC capabilities:

  1. callFlowWithResponse Method

    • Purpose:

      This method is designed for invoking an autolaunch flow as an application service while enabling the retrieval of results from the flow.

    • Parameters:

      • flowNameSpace

        The namespace of the flow, e.g., 'Plinqx' (string).

      • flowAPIName

        The API name of the autolaunch flow (string).

      • flowParams

        A key-value pair object representing the flow's input parameters (object).

      • flowResponseVariable

        The name of the output variable within the flow (string).

    • Response:

      Returns an object representing the JSON output provided by the flow.

  2. triggerFlow Method

    • Purpose:

      Use this method to trigger an autolaunch flow as an application service without retrieving results from the flow's output parameters.

    • Parameters:

      • flowNameSpace

        The namespace of the flow, e.g., 'Plinqx' (string).

      • flowAPIName

        The API name of the autolaunch flow (string).

      • flowParams

        A key-value pair object representing the flow's input parameters (object).

    • Response:

      This method does not return a response.

Best Practices and Use Cases​

Incorporating these methods within your LWCs aligns with Salesforce's best practices for modular and efficient application development. Developers are encouraged to utilize these methods for scenarios that require dynamic server-side interactions, data processing, or when integrating Salesforce data with external systems via Plinqx.

Additional Considerations​

  • Error Handling:

    Developers should implement robust error handling to manage any exceptions or errors that might occur during the execution of these methods.

  • Performance:

    While utilizing these service wrapper methods, it's important to consider the performance impact on your LWCs, especially in data-intensive scenarios.

Conclusion

The integration of Plinqx flows with LWCs through the application service wrapper significantly enhances the development capabilities within the Salesforce ecosystem. By following the guidelines and utilizing the provided methods, developers can create more dynamic, efficient, and integrated LWC applications.