Attachments can be sent either as a stream or embedded in the payload as Base64.

In this guide, you will configure a dedicated Message as part of the Incident Guide Integration (created when following the Bidirectional Asynchronous Incident Guide). It is assumed that the Process, Web Service, Integration & Connection are already in place (if not, please ensure that those elements are in place before continuing).

The components to configure are as follows:

• Message

• Scripted REST Resource

This guide is supplementary to the Bidirectional Asynchronous Incident Guide and assumes the Process (& subsequent Scripted REST Resources) are already in place (See the Web Service page of that guide for details).

We will now examine the automatically generated Attachment Resource. If you are manually updating an existing Resource to cater for inbound streaming, ensure that it looks like the this.

Attachment Resource

The following code is extracted from the automatically generated Attachment Scripted REST Resource:

(function process( /*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

    var helper = new x_snd_eb.RestHelper('incident_guides'); // the API name of the Unifi Process
    processAttachment(helper.getRequest().getRecord());
    helper.processRequest(request, response, 'POST'); // the HTTP method of the resource

    /**
     * This scripted REST API allows an attachment to be sent into Unifi in a
     * similar way to the OOB api/now/attachment REST API, but it processes it
     * in Unifi.
     *
     */
    function processAttachment(target_record) {
        var file_name = request.queryParams.file_name;
        var reference = request.queryParams.reference;
        var mime_type = request.getHeader('Content-Type');

        if (!file_name || !reference || !mime_type) return;

        var ga = new GlideSysAttachment();

        // save the body to an attachment on the request
        var attachment_id = ga.writeContentStream(target_record, file_name, mime_type, request.body.dataStream);

        // return custom payload for the body to process
        helper._getRequestBody = function _getRequestBody() {
            return '{\n' +
                '"message":    { "name": "AddAttachment" },\n' +
                '"reference":  "' + reference + '",\n' +
                '"attachment": "<x-attachment-data sys_id="' + attachment_id + '" />"\n' +
                '}';
        };
    }

})(request, response);

With the Message & Scripted REST Resource in place, you are now ready to Test the AddAttachment Message.

Update Bonded Record (Originating Instance)

In the originating instance, select one bonded ticket and Add an attachment to the record .

Review Outbound Transport Data

From the bonded record, navigate to the Unifi Integrations related list and click to open the Bond.

From the Bond, navigate to the following related lists:

Navigate to the Bonded Attachments related list and verify that a Bonded Attachment record has been created.

Navigate to the Transactions related list and click to open the AddAttachment Transaction.

From the Transaction, navigate to the HTTP Requests related list and click to open the HTTP Request.

Note the following about the HTTP Request:

View Bonded Record (Receiving Instance)

In the receiving instance, navigate to the corresponding bonded ticket and verify the attachment has been added to the record.

Review Inbound Transport Data

From the bonded record, navigate to the Unifi Integrations related list and click to open the Bond.

From the Bond, navigate to the following related lists:

Navigate to the Bonded Attachments related list and verify that a Bonded Attachment record has been created.

Navigate to the Transactions related list and click to open the AddAttachment Transaction.

From the Transaction, navigate to the HTTP Requests related list and click to open the HTTP Request.

Note the following about the HTTP Request:

Congratulations! You have successfully configured & tested a dedicated Message to stream inbound and outbound attachments.

In Unifi Integration Designer, click on the 'Messages' icon & then New to begin configuring the AddAttachment Message.

New Message Modal

The fields to be configured for the AddAttachment New Message modal are as follows:

Your AddAttachment New Message modal should look like this:

Submit and view to further configure the Message.

Response Fields

Navigate to Message > Response.

The Response fields to be configured are as follows:

Your Response form should look like this:

Navigate to Message > Bond.

Bond Fields

The Bond fields to be configured are as follows:

*These fields are automatically populated.

Your Bond form should look like this:

Navigate to Outbound > Trigger.

Outbound Trigger Fields

The Outbound Trigger fields to be configured (as required)* are as follows:

*Outbound condition (as required):

It is not always necessary for you to enter a condition. The value given is an example. You may create any condition (or not) to align with your business process requirements. In this case, it makes sense to set the Outbound Condition to false because we do not want Unifi to send this message on any update of the source record. Typically, we would configure different messages to align with state changes (e.g. Close, Resolve).

The code in the 'Outbound condition' script field should look like this:

false

Your Outbound Trigger form should look like this:

Navigate to Outbound > Attachments.

Outbound Attachments Fields

The Outbound Attachments fields to be configured are as follows:

*This field is automatically populated.

Your Outbound Attachments form should look like this:

Navigate to Outbound > Settings.

Outbound Settings Fields

The Outbound Setting fields to be configured are as follows:

The code in the 'Path' field should look like this:

/attachment?file_name=${scratchpad.file_name}&reference=${scratchpad.reference}

Your Outbound Settings form should look like this:

Navigate to Inbound > Settings.

Inbound Settings Fields

The Inbound Settings fields to be configured are as follows:

Your Inbound Settings form should look like this:

Navigate to Advanced > Script Editor.

Script Editor Fields

When you first open Script Editor, it should look like this:

The Script Editor fields to be configured are as follows:

Stage to Request (Outbound)

The code in the ‘Stage to Request’ script field should look like this:

(function processStageToRequest(request, stage, transaction, message, bond, scratchpad) {

  // This information would normally come from the AttachmentSender
  var sender = new x_snd_eb.AttachmentSender(transaction, bond);
  sender.next();

  var file_name = sender.attachment_name;
  var mime_type = sender.attachment_type;
  var attach_id = sender.attachment_id;
  var reference = bond.getValue('external_reference');

  //-----------------------
  // Path construction
  //-----------------------
  scratchpad.file_name = encodeURIComponent(file_name);
  scratchpad.reference = encodeURIComponent(reference);

  // ?file_name=${scratchpad.file_name}&reference=${scratchpad.reference}

  //-----------------------
  // Headers construction
  //-----------------------

  // Compose the scratchpad headers and payload
  scratchpad.headers = {
    "Content-Type": mime_type
  };

  //-----------------------
  // Payload construction
  //-----------------------

  // This is the string that triggers attachment streaming outbound
  payload = 'sys_attachment:' + attach_id;

})(request, stage, transaction, message, bond, scratchpad);

Payload to Stage (Inbound)

The code in the ‘Payload to Stage’ script field should look like this:

(function processPayloadToStage(payload, stage, transaction, message) {

  // set either internal/external reference on stage depending on what is needed.
  // make sure to configure the Bond reference lookup on the Message to be Internal/External
  stage.internal_reference = payload.reference;

})(payload, stage, transaction, message);

Your Script Editor fields should now look like this:

Save the message.

Next, we shall configure the Scripted REST Resource.