Overview

This procedure converts a string to a JSON object by parsing the string content. The string should contain valid JSON syntax. The procedure automatically handles strings that may have extra text before or after the JSON content by identifying and extracting the JSON portion (looking for opening { or [ and corresponding closing } or ]).

Input Concepts

Output Concepts

Examples

1. Converting a simple JSON string

This example converts a string containing JSON to a JSON object.

2. Converting a string with JSON object

This example converts a string representation of a JSON object to an actual JSON object.

3. Converting and accessing JSON fields

This example shows converting a JSON string and then accessing its fields. The result would be "0.5% 10 NET 45" for Description and "38" for TermsCode.

4. Converting a JSON array string

This example demonstrates converting a string containing a JSON array to an actual JSON array with multiple product objects.

5. Converting complex nested JSON

This example shows converting a complex nested JSON structure from a string and then accessing a field. For a JSON with nested objects like {"u_project_name": {"link": "...", "value": "..."}, "state": "4"}, this would return "4".

Convert from Word Document to PDF

To convert from Word (.doc or .docx) to portable document format (.pdf):

the file is the document
read the file as a pdf

Convert Picture to PDF

To convert a picture (.jpg / .png) to portable document format (.pdf):

Working with .tif and .tiff Files

To work with .tif or .tiff files in Kognitos, you can convert them to PDF format and use PDF operations on them. To convert to PDF, use the following syntax:

Removing Duplicates with a Confidence Threshold

To remove duplicates from a PDF with a specified confidence threshold, use the following syntax:

get the pdf
the department's duplicate confidence threshold is 0.95
remove duplicates from the pdf

Removing Duplicates without a Confidence Threshold

To remove duplicates from a PDF without specifying a confidence threshold, use the following syntax:

Saving to a Local Path

To save a PDF to a local path, use the following syntax:

get the pdf
save the pdf to a file with
    the target is "/local/path/to/save/the/pdf"

Saving to an S3 URL

To save a PDF to an S3 URL, use the following syntax:

Overview

This procedure opens and reads a JSON file from either a specified S3 URL or uploaded directly to Kognitos. It retrieves the file content, parses it as JSON, and returns the JSON object.

Input

Output

Examples

1. Opening a JSON file from S3

This example opens a JSON file stored at the specified S3 URL and returns the parsed JSON object.

2. Opening a JSON file from an uploaded file

This example opens a JSON file that was uploaded by the user to Kognitos.

3. Reading a JSON file from S3

This example reads a JSON file stored at the specified S3 URL and returns the parsed JSON object. This is an alternative syntax to "open a json at a file" and provides the same functionality.

4. Reading a JSON file from an uploaded resource

This example demonstrates reading a JSON file containing student and course information from a test resource. The result would be a JSON object with nested structures for student details and course arrays.

5. Error handling for invalid JSON files

This example shows the error handling when attempting to read an invalid or non-existent JSON file. The system will prompt with "Could not read a json from a file."

Overview

This procedure converts a JSON object to its text (string) representation. The resulting string is a properly formatted JSON string that can be used for storage, transmission, or display purposes. Non-ASCII characters are preserved in the output (not escaped).

Input

Overview

This procedure sets or changes a specific value within a JSON object to a new value. The verbs "set" and "change" are interchangeable. It supports both simple field names and nested paths using dot notation (e.g., settings.notifications.enabled). If the field does not exist, it will be created. The JSON object is modified in place.

Input

Output

This procedure modifies the JSON in place and does not return a value.

Examples

1. Setting a simple field value

This example sets the "age" field of the JSON object to 23.

2. Setting a field using the set command

This example sets the "name" field of the JSON object to "John Doe".

3. Setting a nested field using dot notation

This example sets a deeply nested field using dot notation.

4. Setting and modifying fields in sequence

This example shows multiple sequential modifications to JSON fields. The TermsCode is changed from "38" to 39.

5. Using set command explicitly

This example uses the explicit "set" command to modify a field.

6. Using change command

This example uses the "change" command, which is equivalent to "set".

7. Adding a new field to a JSON object

This example adds a new field "Label" to an existing JSON object. The result would be: {"TermsCode": 42, "Description": "0.5% 10 NET 45", "Label": "Default"}

8. Setting nested JSON structures

This example demonstrates setting one JSON object as a field within another JSON object.

9. Setting a list as a field value

This example shows setting a list as a field value in a JSON object.

10. Setting array element by ordinal

This example demonstrates setting array elements using ordinals like "first", "second", and "last".

11. Setting nested array fields

This example shows setting fields within objects that are elements of an array.

Overview

This procedure compares two JSON objects and identifies the differences between them. It returns a list of keys where the values differ between the two objects, including keys that exist in one object but not the other. The comparison is performed at the top level of the JSON objects.

Overview

This procedure unlocks a password-protected PDF file. It requires the original file and the correct password. If the file is not a PDF or the password is incorrect, an error will be raised.

Syntax

Setting a Field to a String

To set a field in a PDF to a string value, use the following syntax:

Changing a Field to a String

Overview

This procedure creates an empty JSON object (represented as {}). This is useful as a starting point for building up a JSON structure by adding fields one at a time. The empty JSON object can then be assigned to a fact and populated with data.

Overview

This procedure fills placeholders in a Word document (.docx) template with data from an Excel (.xlsx) file. One output document is generated per row in the spreadsheet. Placeholders in the template are marked by a pair of characters (default is "{}") and must match the column headers in the Excel file.

Syntax

Below is a line-by-line overview of the automation syntax. Expand each line to learn more.

Examples

1. Create a PDF From the Template

Overview

This procedure deletes a specified key from a JSON object. The field is permanently removed from the JSON structure. If the specified key does not exist in the JSON, the operation completes successfully without error (in the new JSON implementation). The procedure supports both simple field names and nested paths using dot notation.

Input

Output

Examples

1. Deleting a simple field

This example deletes the "username" field from the JSON object.

2. Deleting a field and verifying the result

This example deletes the "TermsCode" field and shows the resulting JSON object would be: {"Description": "0.5% 10 NET 45"}

3. Deleting a non-existent field (safe operation)

This example demonstrates that deleting a non-existent field does not cause an error and leaves the JSON unchanged at {"Description": "0.5% 10 NET 45"}.

4. Deleting nested fields using dot notation

This example shows deleting a nested field using dot notation. For a JSON like {"b": {"c": 1, "d": {"e": [1, 2]}}}, this would remove the entire "d" object.

5. Deleting fields from array elements

This example demonstrates deleting fields from specific elements in an array using ordinals. For a JSON with an "objects" array, this removes the "b" field from the second object and the "c" field from the last object.

6. Deleting from nested structures

This example shows deleting fields from nested array structures. The second command demonstrates that deleting a non-existent field ("nowhere") does not cause an error.

Overview

This procedure fills in a template with provided values. Currently, only .txt and .docx file types are supported for use as template files. This procedure is helpful in automation workflows where documents need to be dynamically generated, such as invoices, contracts, letters, certificates, or reports.

Use Cases

Input Concepts

Output Concepts

Automation Example

Consider the following .txt file, containing placeholders enclosed in < > symbols:

Note: Line 1 will raise a question, prompting you to provide or upload the template file itself.

Overview

This procedure merges two JSON objects into one. The first JSON object (target) is merged with the second JSON object (object), and the result contains all keys from both objects. The original JSON objects remain unchanged; a new merged object is returned.

Input

Overview

This procedure extracts a specific element or elements from a JSON structure based on the specified "thing" (field name or path). The thing can be specified with additional adjectives to refine the search within the JSON structure. It supports both simple field access and nested path traversal using dot notation (e.g., address.city) or possessive syntax (e.g., address's city). When the JSON is an array, it can extract values from multiple objects.

Input

Output

Examples

1. Getting a simple field from a JSON object

This example extracts the "name" field from a JSON object.

2. Getting a field with an adjective

This example extracts the "first name" field from a JSON object. If the JSON is an array, it returns the "name" field from the first element.

3. Getting nested fields using dot notation

This example extracts the "city" field from the nested "address" object using dot notation.

4. Getting nested fields using possessive syntax

This example extracts the "city" field from the nested "address" object using possessive syntax.

5. Getting fields with spaces

This example extracts a field named "address city" (a single key with a space in it).

6. Getting fields from a JSON array

This example shows how to extract fields from an array of JSON objects. When the JSON is an array like [{"Product Name": "P854282R COMP", "Price": "$53.00"}, {"Product Name": "F854734 COMP", "Price": "$34.95"}], you can use ordinals like "first" and "second" to access specific elements.

7. Getting deeply nested fields

This example demonstrates accessing deeply nested fields using multiple possessive syntax. For a JSON structure with customers, orders, and order details, this navigates through multiple levels to extract the id field.

8. Handling fields with camelCase or special naming

This example shows accessing fields with camelCase naming conventions like "threadId", "historyId", and "sizeEstimate".

Overview

There are several ways to get or extract data from a PDF in Kognitos. The procedures listed below are the most basic methods. For a more advanced method, refer to the procedure.

Getting a Label

This procedure allows you to retrieve a specific label from a PDF.

Getting a Field

This procedure allows you to retrieve a specific field from a PDF.