Help Manual - JSON Destination

Using the JSON Destination Component

The JSON Destination Component does something similar to the JSON Merge component, but it is a destination component, which means that you can specify the component to write the merged JSON document to a local file or you can send it to an HTTP URL to perform a RESTful service call.

General Page

The General page determines how merged JSON documents are used. The connection manager property can either be set to an HTTP Connection Manager which is used to send the document as part of an HTTP request, or a local file which is used to output the merged JSON to a file.

Connection: Local File

• Local File Path: The path on the file system where the JSON document will be saved.

Connection: HTTP Connection Manager

If an HTTP connection manager is selected the UI will display request settings that are used to determine the content of HTTP requests.

HTTP Method

The HTTP method that will be used to send requests. Available methods include:

• GET
• POST
• PUT
• DELETE
• PATCH

Relative Path

The relative path is the second part of the URL that will be used to make the HTTP request. It is combined with the base path from the connection manager to form the full path. The relative path can contain query string parameters, but they can also be added individually in the grid below.

Query String Parameters

Query string parameters that will be appended to the full path when sending HTTP requests.

Request Headers

Request headers that will be combined with the headers in the connection manager and included with HTTP requests.

Request Body

The body of the HTTP request.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Expression Editor

Many of the properties on this page can be set as either a text-merged field or an expression. Properties default to text merge mode, but can be changed to expression mode in the Expression Editor. The expression editor for a property can be launched by clicking the fx button. The expression editor has some predefined tokens:

BatchNumber

The number of the batch that is about to be sent. On the first request, it will have a value of 1.

MergedJSON

This is the merged document that was created for the current batch.

AccessToken

Returns the access token for sending requests. The token file needs to be generated by OAuth 2 Token Generated and specified in the HTTP Connection Manager's Authentication page.

CurrentItem

This token is only available in the item key field on the output columns page. It represents an item in the array of response items.

Text Merge Mode

In text merge mode, property values will be whatever text was entered, but with any variables or special tokens replaced with their actual values before each HTTP request is sent.

Expression Editor Expression Mode

In expression mode, the property is set to an expression which is evaluated before each request to determine the value of the field. Expressions can contain variables and special tokens, but also functions and conditional logic. The functions in the Value Lookup Functions category may be particularly useful for this component, as they can be used to look up values and JSON documents and HTTP headers.

Document Designer Page

The Document Designer page allows you to build the design of the document you are trying to write to, or import the design from an existing document.

The Document Designer includes the following four tabs:

• Details View.
• Diagram View.
• Preview.
• Additional Settings.

In the Details View tab, the top part of the page is used to manually configure the nodes in the design:

• Add Node: This button will add a new node to your Document design.
• Remove Nodes: This button will remove a node from your Document design.
• Direction buttons: These buttons can be used to rearrange the position of the nodes.
• Rename Nodes: This option allows you to specify how the node name should be represented.
• • Use Qualified Names: When this option is selected, the output/column name will be set to the full qualified node name based on the node location in the document.
  • Use Short Names: When this option is selected, the output/column name will be set to the given Node Name directly.
• Filter Columns: This option allows you to show or hide certain Columns in the grid.
  • Show Basic Columns: When this option is selected, only basic columns will be shown in the grid.
  • Show All Columns: When this option is selected, all available columns will be shown in the grid.
• Filter Nodes: This option allows you to filter the list of nodes shown in the grid by typing a keyword in the textbox.

The Details View grid consists of:

• Node Type: This option allows specify the type of the Node in your document design, There are four options available:
  • Array.
  • Object
  • Value.
  • Raw: This type can be used when trying to write JSON data under a node exactly as it is in the document.
• Node Name: The Name of the Node in the document.
• Input/Column Name: The name which will be used for the node when writing to the document.
• Is Repeated: This option allows you to specify if a node is repeated within a document. (Available when Show All Columns is selected)
• Format String: This option allows you to specify the target output format for a string when converting datetime/number values to a string. It follows the same .Net formatting function found at this link. (Available when Show All Columns is selected)
• Source type: The type of input for a node, available options are:
  • Column
  • Variable
  • Property Name From Column Value (since v21.2)
• Node-Write Settings: This option allows you to specify the settings of each node such as the datatype or the Variable Name based on the selected Source Type.
• 
  • Column Name: The name of the column.
  • Data Type: The data type of the field that can be changed accordingly.
  • Length: This option allows you to specify the Length of the fields. If the data type specified is a string, the length specified here would be the maximum size. If the data type is not a string, the length will be ignored.
  • Precision: This option allows you to specify the number of digits in a number.
  • Scale: This option allows you to specify the number of digits to the right of the decimal point in a number.
  • Code Page: This option allows you to specify the Code Page of the field.
  • Format String: This option allows you to specify the target output format for a string when converting datetime/number values to a string. It follows the same .Net formatting function found at this link.

In the Diagram View tab, you would be able to view the document design as a diagram where you can link different inputs with each other in order to create the hierarchy of your document and establish relationships between the different inputs:

Create New Input

This option allows you to create a new Input and link it to an existing input if required based on the intended document design.

Delete Selected Input

This option allows you to remove existing Inputs from the diagram

Reset Layout

This option allows you to reset the layout of the diagram which would reorganize the location of each input.

In the Preview tab, the component will show a sample of the document which will be created with test values.

In the Additional Settings tab, you would find the following options:

• Encoding: The encoding of the document that will be written.
• Null Mode: This option allows you to specify the handling of Null values. There are 3 options:
  • Don't Show
  • Empty String
  • Null Value
• Empty Array Mode: This option allows you to specify how to handle empty arrays.
  • Don't Show
  • Empty Array
  • Null Value
• Empty Object Mode: This option allows you to specify how to handle empty objects.
  • Don't Show
  • Empty Array
  • Null Value
• Print Pretty: When true, the merged JSON will contain line breaks and indents. When false, the merged JSON will be a single line of text.
• Link Ids are scrambled(since v23.1): This option becomes relevant when there are multiple inputs available for the merge or writing. The option specifies whether those Link Ids are scrambled between the inputs. When the option is checked, it indicates that Link Ids can come from the source system in random orders, in which case our software will perform an in-memory matching and joining, which could substantially impact the merge/writing performance. If the incoming Link Ids are not scrambled (for instance, those Ids are properly sorted in an ascending order within each input), this option can be unchecked, which will emit some much greater merge/writing performance, and it could also avoid out-of-memory exceptions when working with a large data set if disabled.
• Merge Mode: Input rows can be batched and sent in a single request. There are 3 batch modes:
  • Every Row: This mode is like a batch size of 1. A single file will be created using the merged JSON from each input row.
  • Every Batch: This mode lets you specify the batch size. Some number of files will be created, each containing the merged JSON from the number of rows specified in the batch size property.
  • Entire Buffer: This mode is like an unlimited batch size. Only one file will be created, and it will contain the merged JSON from all the input rows.
• Batch Size: When the 'Every Batch' Merge mode is selected, the Batch Size can be specified.
• 'Is Repeated' Text Qualifier: This option allows you to specify the Text Qualifier used in a document when the Is Repeated property is set to True for one or more nodes. There are four options available:
  • Double-quote(“)
  • Single-quote (‘)
  • Tick (`)
  • None
• 'Is Repeated' Text Delimiter: This option allows you to specify the Text Delimiter used in a document when the Is Repeated property is set to True for one or more nodes. There are seven options available:
  • Newline (\n)
  • Carriage Return (\r)
  • Semicolon (;)
  • Colon (:)
  • Comma (,)
  • Tab (\t)
  • Vertical Bar (|)

Import

This option allows you to import the design of your document from one of the following five sources:

• Designer Settings: Import the design from an existing .designer.settings file.
• Input (Reset Design): Create the design based on the input columns for the upstream components.
• JSON (Local File): Import the design based on a JSON file on your local file system.
• JSON Schema (Local File): Import the design based on a JSON Schema file on your local file system.

Export

Designer Settings: This option allows you to export the current document design to a .designer.settings file which can be used later to import the same design in a different component.

Input Columns Page

The Input Columns Page of the JSON Destination Component allows you to map the columns from upstream components to the defined nodes for the designed document.

• Input Column: Select an Input Column from an upstream component.
• JSON Field: This is the field you are writing data to
• Data Type: This column indicates the type of value for the current field.
• Unmap: This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.

Output Columns Page

Output columns can be configured on this page. The values of output columns will be extracted from the response of any HTTP requests that are sent. Output columns are typically used to get success or Id information about items that were created/updated or deleted on the server.

Response Is Array

Check this property if the HTTP response will contain an array with items corresponding to your input rows. If the response does not contain information about each input item you wouldn't need to check this property.

Response Collection Base Path

If your response contains an array, the response collection base path property will be the JPath that will return the items in the array.

Response Item Lookup Strategy

If your response is an array a strategy must be selected to match input rows to response array items.

• Sequential Strategy: If this strategy is selected it is assumed there are an equal number of input rows and output array items, and they are matched in the order they appear.
• Item Key Strategy: Use this strategy when the output array items are not in the same order as the input rows. Selecting this strategy will allow you to define an item key below which will determine how input rows are matched to output array items.

Item Key

If the item lookup strategy is used an item key expression must be defined. This expression will be evaluated for each input row in the batch and each array item in the response and should return true for a match and false when they are not a match. The CurrentItem token is available in the expression editor and will allow a value from an array item to be easily compared to a column value to match rows and response array items.

Output Columns Grid

The output columns grid contains any output columns. Output column values will always come from the HTTP response. If the response is not an array the relative path should be the full JPath to the output value in the HTTP response. If the response is an array the relative path will return the value at the specified JPath for the response array item that has been matched to the current output row.

The Output Columns grid consists of:

• Column Name: Name of the column that will be outputted in the Default Output.
• Relative Path: Specify the JPath of the output value in the HTTP response.
• Data Type: The data type of this field.
• Overwrite Input: Indicate if the input column will be overwritten
• Column Properties: Properties window for the field listed. These values are configurable.
  • CodePage: Specify the Code Page of the field.
  • DataType: The data type can be changed according.
  • Length: If the data type specified is a string, the length specified here would be the maximum size. If the data type is not a string, the length will be ignored.
  • Name: Specify the Column name.
  • Precision: Specify the number of digits in a number.
  • Relative Path: Specify the JPath of the output value in the HTTP response.
  • Scale: Specify the number of digits to the right of the decimal point in a number.
• +sign: Add columns to Output Column grid.
• - sign: Remove columns from the Output Column grid.

HTTP Output Columns (since v9.0)

Checking or unchecking these columns will add or remove HTTP related additional output columns. The following columns are available:

• HttpRequestUrl: The URL of the request
• HttpRequestMethod: The HTTP method of the request
• HttpRequestHeaders: All of the HTTP headers of the request
• HttpRequestBody: The text body of the request
• HttpResponseCode: The HTTP status code of the response
• HttpResponseCodeName: The name of the HTTP status code of the response
• HttpResponseHeaders: All of the HTTP headers of the response
• HttpResponseBody: The text body of the response

Error Handling Page

The Error Handling page allows you to specify how errors should be handled when they happen along with the name of the output column that will contain the merged JSON.

Error Handling has three options available.

1. Fail on error
2. Redirect rows to error output
3. Ignore error

When the Redirect rows to error output option is selected, rows that failed to be sent will be redirected to the 'Error Output' output of the Transformation Component. As indicated in the screenshot below, the green output connection represents rows that were successfully sent, and the red 'Error Output' connection represents erroneous rows. The 'ErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by the component.