Surense icon

Surense

Interact with Surense API

Actions36

Report → Generate a Report

AI-generated

Overview

The node named "Surense" provides integration with the Surense API, allowing users to interact with various resources including reports. Specifically, for the "Report" resource and the "Generate a Report" operation, this node enables generating detailed customer reports based on specified parameters.

This functionality is useful in scenarios where businesses need to automate report generation for customers, such as financial advisors creating investment or insurance product summaries, or customer service teams preparing tailored reports for client meetings.

Practical examples include:

  • Generating a pre-treatment report ("טרום טיפול") for a customer before a consultation.
  • Creating a production report ("פרודוקציה") reflecting data accuracy for a specific month.
  • Including or excluding insurance and investment products, notes, and recommendations dynamically based on user input.

Properties

Name Meaning
Customer ID The unique identifier (UUID format) of the customer for whom the report will be generated.
Report Type The type of report to generate. Options: 1 (טרום טיפול - Pre-treatment), 2 (פרודוקציה - Production).
Additional Parameters A collection of optional settings to customize the report output:
- Include Insurance Products Boolean flag to include insurance products in the report.
- Include Investment Products Boolean flag to include investment products in the report.
- Include Notes and Recommendations Boolean flag to display product notes and recommendations in the report.
- Intro Page Notes Text notes to be added to the introduction page of the report.
- Productia Month Specifies the data accuracy month (format YYYY-MM, e.g., 2023-10) relevant for production reports.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each JSON object contains the generated report data returned from the Surense API. The exact structure depends on the API response but typically includes detailed customer report information based on the selected report type and additional parameters.

If errors occur during execution for any item, the output for that item will contain an error field with the error message, allowing downstream nodes to handle failures gracefully if "Continue On Fail" is enabled.

No binary data output is indicated in the source code.

Dependencies

  • Requires an active connection to the Surense API via an OAuth2 API credential.
  • The node depends on the Surense API being accessible and properly authenticated.
  • No other external dependencies or environment variables are explicitly required.

Troubleshooting

  • Common Issues:

    • Invalid or missing Customer ID (UUID format) will likely cause API errors.
    • Incorrect or unsupported Report Type values may result in failed report generation.
    • Network or authentication issues with the Surense API can cause request failures.
    • Missing or malformed additional parameters might lead to incomplete or incorrect reports.

  • Error Messages:

    • Errors thrown by the API are caught and returned in the output under an error property when "Continue On Fail" is enabled.
    • Typical error messages could relate to invalid credentials, unauthorized access, or invalid input parameters.

  • Resolutions:

    • Verify the Customer ID is correctly formatted as a UUID.
    • Ensure the OAuth2 credential is valid and has necessary permissions.
    • Double-check the report type and additional parameters for correctness.
    • Confirm network connectivity to the Surense API endpoint.

Links and References

Discussion