mfr - Field Service Management icon

mfr - Field Service Management

Field service management app for scheduling technicians.

Actions19

Overview

This node integrates with a field service management system to upload a document associated with a specific service request. It supports uploading either binary files or text content as documents linked to service requests. This is useful in scenarios where you need to attach files such as reports, images, or notes directly to a service request for record-keeping, auditing, or further processing.

Practical examples:

  • Uploading a PDF report generated by another system to a service request.
  • Attaching an image or photo taken on-site to the relevant service request.
  • Adding textual notes or logs as a document to a service request.

Properties

Name Meaning
Search Service Request Selects the target service request to which the document will be uploaded. Options: search by list or by ID.
Binary File Boolean flag indicating whether the file content to upload comes from a binary input field (true) or from plain text content (false).
File Content The textual content of the file to upload if not using binary data.
Input Binary Field The name of the binary input field containing the file to upload when "Binary File" is true.

Output

The node outputs JSON data representing the uploaded document's metadata returned by the API after a successful upload. This includes at least the document's unique identifier and related information. The output does not include the file content itself but confirms the upload and linkage to the specified service request.

If binary data is used as input, the node processes it accordingly but does not output binary data itself.

Dependencies

  • Requires an API key credential for authenticating with the field service management system's API.
  • The node makes HTTP requests to the service's endpoints for uploading documents and linking them to service requests.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Incorrect or missing service request ID: Ensure the selected service request exists and the ID is correct.
    • Binary data field not found or empty: Verify that the binary input field name matches the actual incoming binary data.
    • Authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
    • File size or format restrictions imposed by the API may cause upload failures.

  • Error messages:

    • Errors related to missing binary data will occur if "Binary File" is true but the specified binary field is absent or empty.
    • API errors during upload might indicate invalid parameters or server-side issues; check the error message for details.

Resolving these typically involves verifying input parameters, ensuring proper authentication, and confirming the availability and correctness of the binary data or text content.

Links and References

Discussion