Once you have created a report in Airtable, you might need to export it in various formats for analysis, presentation, or sharing purposes. Kognitos simplifies this process by allowing you to specify the desired export format directly in your command.

Exporting to CSV

export the report "Projects by Status" from airspot to CSV

This command instructs Kognitos to export the "Projects by Status" report from Airtable in CSV format. The CSV format is versatile and widely used for data manipulation and analysis in various software, including spreadsheet applications.

Exporting to PDF

export the report "Monthly Project Performance" from airspot to PDF

Exporting a report to PDF is particularly useful when you need a static snapshot of your data for sharing or presentation purposes. PDFs maintain formatting and are ideal for distributing reports that should not be altered, such as project performance summaries or quarterly reviews.

Exporting to Excel

export the report "Employee Performance Metrics" from airspot to Excel

Exporting reports to Excel allows for further data analysis and manipulation using Excel's robust set of features. Excel files can accommodate complex calculations, charts, and pivot tables, making them suitable for in-depth data analysis tasks.

Creating a report in Airtable involves selecting the type of report, defining the criteria, and choosing the fields to display. In Kognitos, you can specify the type of report you need, the records it should cover, and any specific conditions that must be met. For example:

create a report in airspot with
    the report name is "Quarterly Project Summary"
    the report type is "Tabular"
    the fields are "Project Name", "Start Date", "Status"
    the filter is "Start Date this quarter"

This command tells Kognitos to create an Airtable report for projects from the last quarter, including specific fields. Kognitos translates this into the appropriate Airtable report creation process, selecting the correct report type and applying the specified filters.

Adding New Records

To add a new record to Airtable, you need to specify the type of object you're creating and provide the necessary field values. For example:

the project is
    the name is "New Initiative"
    the start date is "2023-10-01"
    the status is "Planning"
add the project in airspot

This command creates a new project named "New Initiative" with a specified start date and status.

Updating Existing Records

To update an existing Airtable record, you must identify the record by its ID and specify the fields you want to update. For example:

the project's ID is "rec123456789"
change the project's status to "In Progress" in airspot

This command updates the status of the specified project to "In Progress".

Deleting Airtable Records

Single Deletion

To delete a specific Airtable record, you need to specify the record and its ID. For example:

the record's ID is "rec123456789"
delete the record

This command deletes the record with the specified ID.

Fetching Data using Custom Queries

To fetch data from Airtable using custom queries:

obtain airspot's Projects table where
    the required foreign columns are "Project Manager"

Fetching Data using Direct Queries

To fetch data from Airtable using direct queries:

obtain airspot's Employees table where
    the required foreign columns are "Manager"

What is a Book?

Learning Books

Before using a Book’s procedures in an automation, you must learn the Book by adding it to your agent. Follow the steps below to get started.

1. In the left navigation bar, click on Books.

2. Click on + New Book.

3. Search for the Book you'd like to add and click on it.

Note: If the Book requires configuration, you will be prompted to provide configuration details.

1. Click Add to finish adding your Book.

Introduction

The Airtable Book integrates with Airtable and helps automate data management. You can read, update, and organize records using natural language, making workflows faster and easier.

Prerequisites

1. Airtable Account: You need to have an active Airtable account. If you do not have one, you can sign up for an Airtable trial account to get started.

2. API Access: Ensure that your Airtable account has API access enabled. API access is required for Kognitos to communicate with Airtable.

3. API Token: Obtain your Airtable API token, which is used to securely access Airtable via the API. You can generate this token in your Airtable account settings under "API".

Required Credentials

To connect to Airtable, you will need the following credentials:

1. Airtable Token: The API token for your Airtable account. This token is used to authenticate API requests.

2. Airtable Base: The name of the Airtable base you want to connect to. This base contains the tables and records you will interact with.

Connecting to the Airtable Book in Kognitos

1. Navigate to Books in the left sidebar menu.

2. Click on + New Book.

3. Search for Airtable and then click on the Book that appears.

1. Add in the credentials when you are prompted

1. Connection Established: Once the connection is successfully established, you are ready to perform various operations on Airtable. You can now fetch data, create new records, update existing ones, delete records, and more.

This procedure uploads a specified file to an AWS S3 bucket at the given path. The file will be stored in the designated S3 location, making it accessible based on the bucket's permissions and policies.

Example:

the file
dump the file to aws s3 with
    the s3 path is "s3://mybucket/reports/2023/report.pdf"

This procedure lists file paths from an AWS S3 bucket. Optionally, it can filter the results based on a file prefix, allowing users to list files within a specific folder or matching a particular naming pattern.

Examples:

list files from aws s3
    the bucket is "bucket-name"

list files from aws s3
    the bucket is "bucket-name"
    the file prefix is "folder1"

Overview

Managing files within Airtable records is a common requirement for many business processes. Whether it's attaching contracts to projects, downloading report attachments for analysis, or removing outdated files, efficient file management is crucial.

Attaching Files to Airtable Records

Example: Attaching a PDF Contract to a Project

attach the file to the airspot record with
    the file path is "/path/to/contract.pdf"
    the record's ID is "rec123456789"
    the file type is "PDF"

This command specifies the file to attach (contract.pdf), identifies the Airtable record by its ID, and indicates the file type. Kognitos handles the process of attaching the file to the specified Airtable record.

Downloading Files from Airtable Records

Example: Downloading a Contract Attached to a Project

download the file from the airspot record with
    the record's ID is "rec123456789"
    the file name is "contract.pdf"

This command retrieves an attached file (contract.pdf) from a specified Airtable record. Kognitos facilitates the download process, making the file available for local use or review.

Detaching Files from Airtable Records

Example: Removing an Outdated Contract from a Project

detach the file from the airspot record with
    the record's ID is "rec123456789"
    the file name is "old_contract.pdf"

When a file, such as an outdated contract, needs to be removed from an Airtable record, this command specifies the record and the file to be detached. Kognitos processes the request, removing the specified attachment from the Airtable record.

This procedure purges a specified file from an AWS S3 bucket. The operation requires appropriate permissions to delete objects from the specified S3 bucket.

Example:

purge the file from aws s3
    the file path is "s3://mybucket/myfile.txt"

This procedure uploads a string to an S3 bucket.

Example:

the string is "Hello, World!"
dump the string to aws s3
    the s3 path is "s3://mock-s3-bucket/kognitos-data.txt"

This procedure retrieves a file from AWS S3.

Example:

get the file from aws s3 with
    the bucket is "mybucket"
    the file path is "folder/subfolder/filename.ext"

Overview

The AWS S3 Book integrates with Amazon S3, making it easy to store, retrieve, and manage files through automation. With natural language commands, you can seamlessly upload, download, and organize data, reducing manual work and streamlining workflows.

Prerequisites

1. AWS Account: You need to have an active AWS account. If you do not have one, you can sign up for an AWS account to get started.

2. AWS S3 Bucket: Ensure that you have an S3 bucket created in your AWS account. You can create a new bucket through the AWS Management Console.

3. AWS Access Credentials: Obtain your AWS access key ID and secret access key. These credentials are required for Kognitos to communicate with AWS S3 securely. You can generate these credentials in the AWS Management Console under "IAM" > "Users" > "Security credentials".

Required Credentials

You will need the following access credentials:

1. AWS Access Key ID: The access key ID associated with your AWS account.

2. AWS Secret Access Key: The secret access key associated with your AWS account.

3. AWS S3 Bucket Name: The name of the S3 bucket you wish to interact with.

Connecting to the AWS S3 Book in Kognitos

1. Navigate to Books.

2. Click on + New Book.

3. Search for AWS S3 and click on the Book that appears.

1. Add in the credentials when you are prompted

1. Connection Established: Once the connection is successfully established, you are ready to use the procedures in the AWS S3 Book in your automation.

To retrieve a file from Azure Blob Storage, you need to specify the file path and optionally the container URL for retrieving the file.

Examples of Usage:

1. Retrieving a File with a Specific Path:

   Copy

   get a file from azure blob storage with
       the file path is "documents/report.pdf"

2. Retrieving a File with Both Container URL and File Path:

   Copy

   the container url is "https://example.blob.core.windows.net/mycontainer"
   get a file from azure blob storage with
       the container url
       the file path is "images/photo.jpg"

To upload a file to Azure Blob Storage, you need to specify the file path where the file will be stored in Azure Blob Storage.

Examples of Usage:

1. Uploading a File to a Specific Path:

   Copy

   upload a file
   dump the file to azure blob storage where
       the file path is "reports/2023/report.pdf"

2. Uploading a Different File to Another Path:

   Copy

   upload a file
   dump the file to azure blob storage where
       the file path is "data/2023/data.csv"

This procedure uploads a CSV to a specified AWS S3 bucket at the given path. The CSV content is stored as an object in the specified S3 location, making it accessible based on the bucket's permissions and configurations.

Example:

the csv
dump the csv to aws s3 with
    the bucket is "mybucket"
    the csv path is "data/csvs/myfile.csv"

Approval Processes in Airtable

Approval processes in Airtable are automated sequences that an organization can use to approve records for database operations. These processes are crucial for maintaining data integrity and ensuring that changes or additions to records meet specific criteria set by the organization. The integration of Kognitos with Airtable simplifies the interaction with these processes, making it easier for users to submit objects for approval and track their status.

Understanding Approval Processes

Approval processes in Airtable are defined workflows that specify the steps required to approve a record. These processes can be applied to various Airtable tables, such as Projects, Employees, or custom tables, depending on the organization's needs. Approval processes typically involve one or more of the following components:

• Criteria for entering the process: Defines what records are eligible for approval. For example, a project might need to have a budget greater than $10,000 to require approval.

• Approval steps: The sequence of approval actions that need to be taken. This can involve multiple approvers at different stages.

• Approval actions: Actions taken when a record is approved, rejected, or recalled, such as updating fields, sending email notifications, or executing custom logic.

Submitting Records for Approval

With Kognitos, users can submit Airtable records for approval using natural language commands. This simplifies the process, especially for users who may not be familiar with Airtable's interface or approval process configurations.

Example:

submit the project for approval with
    the project's ID is "rec123456789"
    the comment is "Requesting approval for high-budget project"

In this example, a project is submitted for approval by specifying its ID and providing a comment to give context to the approver. Kognitos translates this command into the appropriate Airtable operation, automating the submission process.

Overview

The Azure Blob Storage Book integrates with Azure Blob Storage, allowing you to manage and store data effortlessly. Using natural language commands, you can upload, download, and organize files, simplifying your workflow and reducing manual tasks.

Prerequisites

1. Azure Account: You need to have an active Azure account. If you do not have one, you can sign up for a free Azure account to get started.

2. Azure Blob Storage: Ensure that you have an Azure Blob Storage account set up. You can create one through the Azure portal.

3. Access Keys: Obtain the access keys for your Azure Blob Storage account. These keys are required for Kognitos to authenticate and interact with your storage account.

Required Credentials

To connect to the Azure Blob Storage Book, you will need the following credentials:

1. Storage Account Name: The name of your Azure Blob Storage account.

2. Access Key: The access key for your Azure Blob Storage account. You can find this in the Azure portal under your storage account settings.

Connecting to the Azure Blob Storage Book in Kognitos

1. Navigate to Books.

2. Click on + New Book.

3. Search for Azure Blob Storage and then click on the Book that appears.

1. Add in the credentials when you are prompted

1. Connection Established: Once the connection is successfully established, you are ready to perform various operations on Azure Blob Storage. You can now upload files, retrieve files, and manage your storage efficiently.

Sending messages to an Azure Service Bus queue is a fundamental operation when integrating Azure Service Bus with Kognitos. This section covers how to send messages to a specified queue.

Action Description: Sends a message to an Azure Service Bus queue.

Required Concepts:

• Message (string): The message to be sent.

• Queue name (string): The name of the Azure Service Bus queue the message will be sent to.

Language Example:

the message is "Hello, World!"
send the message to azure service bus with
    the queue name is "myqueue"

This command sends the message "Hello, World!" to the specified queue "myqueue".

This procedure purges a CSV file from an AWS S3 bucket. The operation requires appropriate permissions to delete objects from the specified S3 bucket.

Example:

purge the csv from aws s3 with
    the bucket is "mybucket"
    the csv path is "sales-data/Q1-sales.csv"

Receiving messages from an Azure Service Bus queue is another core functionality when integrating Azure Service Bus with Kognitos. This section covers how to receive the latest message from a specified queue.

Action Description: Receives the latest message from an Azure Service Bus queue.

Required Concepts:

• Queue name (string): The name of the Azure Service Bus queue from which to receive the message.

Output Concepts:

• Message (string): The latest message received from the specified Azure Service Bus queue.

Language Example:

receive a message from azure service bus with
    the queue name is "myqueue"
the message

This command receives the latest message from the specified queue "myqueue" and outputs the message.

Overview

These procedures allow you to get and retrieve records from a database.

Retrieving All Records

To retrieve all the records from a specific table in your database, use the following syntax, replacing table with the table name.

Syntax

get a database's {table}

Examples

get a database's User

get a database's person

get a database's EmployeeData

Retrieving Specific Records

To retrieve specific records from a database table, you can specify filter conditions.

Using a Filter Condition

Use the whose keyword followed by the condition for which to filter.

Syntax

get a database's {item} whose {field} is {value}

Examples

get a database's WorkOrder whose ID is 3

get a database's User whose email is "user@gmail.com"

Using Multiple Filter Conditions

You can combine multiple filter conditions using the and keyword.

Example

get a database's person whose FirstName is "Jane" and whose LastName is "Doe"

Storing Retrieved Records

After retrieving records from the database, you can store them in an automation for later reference. To do this, use the following phrase, replacing plural data name with any meaningful plural term.

use the above as the {plural data name}

To reference a specific record within the retrieved database records, write an additional line using positional keywords like first, second, etc.

use the {position} record as the {singular data name}

Example

In the following example:

• All the retrieved database records from the query are stored as the records.

• Only the first database record is stored as the employee.

get a database's person whose FirstName is "Nancy"
use the above as the records
use the first record as the employee

To create a new database record, use the following procedure:

Syntax

create a {table} in database with
  {field} is {value}

Components

• table - The name of the database table where the new record will be added.

• field - A specific field in the table (e.g., LastName, FirstName).

• value - The data you want to store in that field.

Example

create a person in database with
  the LastName is "Smith"
  the FirstName is "John"
  the Address is "123 Apple St"
  the DOB is "1980-04-03"

In this example, person is the name of the database table. A new record is created in that table with the information provided after with. Each indented line represents a column (LastName, FirstName, etc.) and its corresponding value.

Overview

The Azure Translate Book integrates with Azure Translate, allowing you to automate language translation in your processes.

Prerequisites

1. Learning the Translator Book

In order to work with these operations, you must first learn the Translator Book in Kognitos. To do so:

1. In the left sidebar, click on Books.

2. In the search bar, search for Translator.

3. Click on + Book. A pop-up window will appear asking to Add New Book. Click Add.

2. Azure Setup

These are prerequisite steps for configuration within Azure.

Create an Azure Storage Account

1. Open the Azure Portal and go to Storage accounts from the menu.

2. Click Create.

3. Provide the necessary details, including:

   1. Subscription

   2. Resource Group

   3. Storage Account Name

   4. Region

4. Under Performance, select Standard.

5. For Redundancy, choose LRS (Locally Redundant Storage).

6. In the Advanced tab, enable:

   1. Secure transfer

   2. Anonymous access to individual containers

   3. Storage account key access

7. Review your settings, then click Review + Create to finalize.

Create a Container in Azure

1. Navigate to your new storage account in the Azure Portal.

2. In the left menu of the storage account, scroll to the Data storage section and select Containers.

3. Click on + Container.

4. Provide a name for your container.

5. Set the level of anonymous access for the containers and blobs.

Create a Translator in Azure

1. Open the portal menu and go to All Services.

2. Search for "Translators". Select Translator under Azure AI services.

3. Click on Create Translator.

4. Fill in the Project Details and Instance Details for your translator.

5. Click on Review + create.

6. After your translator has been created, you will need to retrieve your translator key from Keys and Endpoint.

3. Connecting to the Translator in Kognitos

After the Book is learned and the translator infrastructure is set up in Azure, you’ll need to connect to the translator within the Kognitos platform. Add the following lines to your Playground or Processes to establish the connection.

Syntax

the department's translation engine is "azure"
connect to translator with
    the translator name is "{translator name}"
    the translator key is "translator key}"
    the storage account name is "{storage account name}"
    the storage account key is "{storage account key}"
    the container name is "{container name}"

Parameters

1. translator name: The name of the Azure translator.

2. translator key: The key for the Azure translator.

3. storage account name: The name of the Azure storage account.

4. storage account key: The key for the Azure storage account.

5. container name: The name of the Azure container.

Kognitos will attempt to connect to the translation service using the provided credentials. If the connection is successful, you can proceed with translation operations. Otherwise, please verify your credentials and try again.

This procedure uses Optical Character Recognition (OCR) to extract text from image files or PDF documents. This is useful for processing scanned documents, invoices, receipts, or any files where text is embedded in an image.

Syntax

get the file as a scanned document

This will perform OCR on the file concept. If the file does not exist, a question will be asked prompting you to Please provide the file or document. The following file types are supported for upload for this operation:

To dump a file to Google Cloud Storage, you need to specify the file and the Google Cloud Storage path. For example:

get the file
the gs path is "gs://my_bucket/path/to/file"
dump the file to google cloud storage

To purge a file from Google Cloud Storage, you need to specify the file path. For example:

the file path is "gs://my-bucket/path/to/my-file.txt"
purge the file from google cloud storage

This purges the specified file from Google Cloud Storage.

To dump a CSV to Google Cloud Storage, you need to specify the CSV path and optionally the bucket prefix and folder.

Example 1:

get the csv
the csv path is "data_exports/my_export.csv"
dump the csv to google cloud storage

This dumps the specified CSV to the given Google Cloud Storage path.

Example 2:

get the csv
the csv path is "data_exports/my_export.csv"
the bucket prefix is "my_bucket"
the folder is "2023/exports"
dump the csv to google cloud storage

This dumps the specified CSV to the given Google Cloud Storage path with the specified bucket prefix and folder.

To purge a CSV from Google Cloud Storage, you need to specify the CSV path and the Google Cloud Storage path.

Example 1:

purge the csv from google cloud storage with
  the gs path is "gs://my-bucket/folder1"
  the csv path is "in-folder-path/to/your/csvfile.csv"

This purges the specified CSV from the given Google Cloud Storage path.

Example 2:

the csv path is "datasets/2023/march/sales_data.csv"
the gs path is "gs://my-bucket/folder2"
purge the csv from google cloud storage

This purges the specified CSV from the given Google Cloud Storage path.

To enrich a question with additional information, you need to specify the details to be enriched. For example:

enrich the question with
  the foo is "example"
  the bar is "detailed example"
  the baz is "further information"

the foo is "example"
the bar is "detailed example"
the baz is "further information"
enrich the question

This enriches the question with the specified details.

Overview

If you have HTML content containing tables, you can use the following procedure to extract those tables. After extracting a table, you can continue working with the data using Kognitos’ table procedures for further manipulation.

Syntax

1. Providing HTML Directly

Use this syntax when you want to pass the HTML code as text directly in the Playground. The placeholder {html} should be well-formed HTML code containing one or more tables.

the html is "{html}"
get the html's tables

Example

the html is "<html><body><table><tr><th>First Name</th><th>Last Name</th></tr><tr><td>John</td><td>Smith</td></tr></table></body></html>"
get the html's tables

2. Prompting for HTML Input

Use this syntax if you want the system to raise a question that prompts you to provide the HTML manually:

the html
get the html's tables

Here, the html will raise a question asking you to provide the data. For the resolution method, you can select Write in answer and paste your HTML code. After submitting, the automation will continue processing.

Retrieve a File at a URL

To retrieve a file from a specified URL, use the following syntax:

the string is "https://example.com/data/report.pdf"
get a file at the string

the string is "http://www.example.org/images/photo.png"
get a file at the string

the url is "http://www.example.org/images/photo.png"
get a file at the url

Send a GET Request

To send a GET request to a specified URL, use the following commands:

the url is "https://api.example.com/data"
send a GET request to the url
the request's response

the url is "https://api.example.com/data"
the query text is "{\"key\": \"value\"}"
the header is "{\"Authorization\": \"Bearer token\"}"
the timeout is 30
send a GET request to the url with
    the query text
    the header
    the timeout
the request's response

the url is "https://api.example.com/upload"
get the file
send a GET request to the url with
    the data is the file
the request's response

Send a DELETE Request

To send a DELETE request to a specified URL, use the following syntax:

set the url to "https://api.example.com/items/12345"
send a DELETE request to the url
the request's response

set the url to "https://api.example.com/items"
set the query parameters to "{\"item_id\": \"12345\"}"
send a DELETE request to the url with
    the query parameters
the request's response

set the url to "https://api.example.com/items/12345"
set the header to "{\"Authorization\": \"Bearer <token>\"}"
send a DELETE request to the url with
    the header
the request's response

Send a POST Request

To send a POST request to a specified URL, use the following syntax:

set the url to "https://api.example.com/data"
set the header to "{\"Content-Type\": \"application/json\"}"
send a POST request to the url
the request's response

send a POST request to the url with
    the url to "https://api.example.com/data"
    the header to "{\"Content-Type\": \"application/json\"}"
the request's response

set the url to "https://api.example.com/upload"
get the file
send a POST request to the url with
    the data is the file
the request's response

Send a PUT Request

To send a PUT request to a specified URL, use the following syntax:

the url is "https://api.example.com/update"
send a PUT request to the url with
    the query parameters is "{\"id\": \"123\"}"
    the header is "{\"Content-Type\": \"application/json\"}"
the request's response

the url is "https://api.example.com/update"
get the file
send a PUT request to the url with
    the data is the file
the request's response

Send a PATCH Request

To send a PATCH request to a specified URL, use the following syntax:

the url is "https://api.example.com/update"
send a PATCH request to the url with
    the query parameters is "{\"id\": \"123\"}"
    the header is "{\"Content-Type\": \"application/json\"}"
the request's response

the url is "https://api.example.com/files"
get the file
send a PATCH request to the url with
    the data is the file
the request's response

Retrieving HubSpot's Contacts

To fetch contacts from HubSpot:

connect to hubspot where
    the hubspot token is "example-token-123"
get hubspot's contacts

Retrieving HubSpot's Deals

To fetch deals from HubSpot:

connect to hubspot where
    the hubspot token is "example-token-123"
get hubspot's deals as a csv

Retrieving HubSpot's Companies

To fetch companies from HubSpot:

connect to hubspot where
    the hubspot token is "example-token-123"
get hubspot's companies as a csv

Retrieving HubSpot's Line Items

To fetch line items from HubSpot:

connect to hubspot where
    the hubspot token is "example-token-123"
get hubspot's line items as a csv

Syntax

get the document's tables

If there are multiple sections in the document that resemble tables, the system will return them as a list. Below, we show you how to narrow down to a specific table.

Extracting a Specific Table

If a document contains multiple tables, you can specify which one to extract by referencing a column name:

get the document's tables whose columns contain "Column Name"
get the above as the items table

You can also use relative keywords like first, second, or last to target specific tables:

get the document's first table
get the document's third table
get the document's last table

For more precise filtering, you can use multiple column names:

get the document's table whose columns contain "Column1", "Column2", and "Column3"

Extracting Data With Directional Keywords

Directional keywords can be used with document extraction to pinpoint specific lines.

• below: Looks beneath the reference line

• above: Looks on top of the reference line

• left: Looks left of the reference line

• right: Looks right of the reference line

Example

get the document's first line which contains "recipe"
get the lines below that as the recipe text

Overview

The Azure Service Bus Book integrates with Azure Service Bus to simplify messaging and event-driven workflows. Using natural language commands, you can send, receive, and manage messages between applications.

Prerequisites

1. Azure Subscription: You need to have an active Azure subscription. If you do not have one, you can sign up for a free Azure account to get started.

2. Azure Service Bus Namespace: Ensure that you have created an Azure Service Bus namespace. This namespace will contain your queues and topics.

3. Queue Creation: Create the necessary queues within your Azure Service Bus namespace where messages will be sent and received.

4. Connection String: Obtain the connection string for your Azure Service Bus namespace. This can be found in the Azure portal under your Service Bus namespace settings.

Required Credentials

To connect to the Azure Service Bus Book, you will need the following credentials:

1. Namespace Connection String: The connection string for your Azure Service Bus namespace. This string is unique to your namespace and can be found in the Azure portal.

2. Queue Name: The name of the queue within your Azure Service Bus namespace where messages will be sent or received.

Connecting to the Azure Service Bus Book in Kognitos

1. Navigate to Books.

2. Click on + New Book.

3. Search for Azure Service Bus and then click on the book which is shown

1. Add in the credentials when you are prompted

1. Connection Established: Once the connection is successfully established, you are ready to perform various operations on Azure Service Bus. You can now send messages, receive messages, and manage queues.

Example

get a database's person whose FirstName is "Jane"
use the above as the records
use the first record as the person
set the person's DOB to '1990-01-01'

In this example:

• Line 1: Retrieves a database record.

• Line 2: Stores the retrieved records as the records.

• Line 3: Stores only the first record from the records as the person.

• Line 4: Updates the DOB of the person.

Syntax

Two syntaxes are supported:

translate the document with
    the target language is "{target language code}"
    the target container is "{target container}"
    the processing time limit is "limit}"

translate the document to "{target language name}"

Input Parameters

1. target language code

   • The ISO 639-1 code of the target language.

   • Examples: fr, en, ja
2. target language name

   • The name of the target language.

   • Examples: hindi, japanese, english
3. target container (optional)

   • The container where the translated document will be stored.

4. processing time limit (optional)

   • The maximum time limit for processing the translation in hrs/mins/seconds.

Examples

Basic Translation

translate the document with
    the target language is "fr"

translate the document to "hindi"

Translation with Optional Parameters

translate the document with
    the target language is "id"
    the target container is "documentation"
    the processing time limit is "10 mins"

Syntax

To extract fields from a document:

get the document's {field}

get the file's {field}

Inputs

1. field:

   • The item from the document you wish to extract.

   • Example: invoice number, id, name, date of birth, supplier name

Examples

get the document's invoice number

get the document's tax id

get the file's supplier name

Video Demonstration

The video showcases how Kognitos simplifies extracting structured data from scanned documents using advanced document processing capabilities. By leveraging AI and tools like Amazon Textract, users can flexibly retrieve specific values, tables, or other data points with natural language commands.

What if Multiple Fields Share the Same Name?

If a document contains multiple fields with the same name, Kognitos will raise a Question prompting the user to select which value to use for an extracted field.

Example

Consider a document with the following information:

Customer Name: John Doe Address: 1234 Elm Street Address: 5678 Oak Avenue

If your automation is written like this:

the document
get the document's address

Kognitos will raise a Question: Multiple values found for address, please pick one. To respond, you can select Pick selected value from the drop-down menu and choose the desired address to use.

To avoid this prompt, use relative indicators like first, second, or last to specify which value to use:

get the document's first address
get the document's last address

For added clarity, you can also rename the fields:

get the document's first address as the home address
get the document's last address as the business address

Don't Worry About Field Name Formats

Kognitos is flexible about extracting specific fields. For example, if a document contains a field called Trailer No., you can extract it by writing:

get the document's trailer number

Even though the field in the document may be labeled Trailer No., the automation recognizes and understands variations in naming, allowing you to refer to it as trailer number.

Handling Extraction Failures

The automation may sometimes fail to extract a field from a document. This can happen if a field does not exist or is unable to be found. In these cases, Kognitos will raise a Question asking you to Please provide the field. Below is a table outlining the available resolution options.

Prerequisites

To use the HTTP Book, you must first learn it in your agent.

URL Manipulation

Convert Text to a URL

To convert a text string to a URL, use the following commands:

get the text "example.com"
get the text as a url

the text is "www.example.com/page"
get the text as a url

get the text as a url with
    the text is "https://www.example.com"

get the text as an url where
    the text is "https://www.example.com"

Create a URL

To create a URL with specific components, use the following commands:

create a url with
    the domain is "api.example.com"

create a url with
    the domain is "api.example.com"
    the path is "/images"
    the query is '{"search": true}'
    the scheme is "https"

Overview

The Database Book allows you to connect to a database in Kognitos and automate creating, retrieving, updating and deleting records.

Learning the Database Book

After successfully learning the Book, you can use its procedures in your automations.

To delete a record from the database, use the following procedure:

Syntax

In the following syntax, record is the entry in the database to be deleted. The entry needs to be previously referenced in your automation before you can delete it.

delete {record} from the database

Example

get a database's person whose FirstName is "John"
use the above as the records
use the first record as the person
delete the person from the database

In this example:

• Line 3: Stores only the first record from the records as the person.

• Line 4: Deletes the person.

Prerequisites

Learning the Document Processing Book

To begin extracting information from documents, follow these steps to first learn the Document Processing Book:

1. In the left sidebar, click on Books.

2. Use the search bar to find "Document Processing."

3. Click on +Book to open the Add New Book pop-up.

4. Click on Add to finish adding the book.

Introducing Documents and File Objects

To introduce a document or file object in your automation, use any of the following lines:

the file
get the file
use the file
the document
get the document
use the document

These lines will raise a Question in Kognitos, prompting you to Please provide the file or document, as the system requires the specified object to proceed.

To Upload a Local File

1. Click on Select a method to open the drop-down menu.

2. Select Upload files. Refer to the table below for supported file types.

3. Upload your file or document and click Submit.

After uploading, you can perform additional operations on the document or file within the platform.

📘 Working with .tif and .tiff Files

Use the following syntax to upload and convert .tif and .tiff files to PDF format:

Copy

read the file as a pdf

Once uploaded and converted, you can use PDF automation procedures on the file object.

Video Example: Extracting Information

This video walks through an example of extracting information from an SAP Sales Order.

Overview

The Excel Book allows you to work with Excel files in Kognitos. This Book enables users to perform a wide variety of tasks on Excel workbooks and spreadsheets, including opening, converting, merging, and manipulating tables.

Prerequisites

Learning the Excel Book

In order to work with Excel, you must first learn the Excel book. To do so:

1. In the left sidebar, click on Books.

2. In the search bar, search for Excel.

3. Click on + Book. A pop-up window will appear asking to Add New Book. Click Add.

Once the book has been learned, you can start using Excel in Kognitos.

Note: Working with .xls and .csv Files

The .xls and .csv formats are not directly supported in the Excel Book.

Prerequisites

To use the HTML Book, you must first learn it in your agent.

Procedures

This Book currently contains one procedure for working with HTML in Kognitos, linked below.

This procedure enables you to extract tables from HTML code. Once the table is retrieved, you can further manipulate it using table procedures.

Syntax

📘 Local Excel Files

If you want to open a local Excel file with these actions, you will encounter a Question prompting you to Please Provide File. Your local Excel file can be uploaded here by selecting the Upload files method.

Inputs:

1. {the file | "<url>"}: (one is required)

• the file: Use the phrase the file to upload a local Excel file.

• "<url>": The URL to be opened, as a quoted string. Kognitos cannot open files from private cloud drives, so ensure the file is publicly accessible, configured with the necessary access permissions, or use a presigned URL with an expiration date for temporary access.

1. name: The name of the worksheet within the Excel workbook. (optional)

Examples

1. Using the file

2. Using a public URL

3. Using the file and specifying the worksheet name

4. Using a public URL and specifying the worksheet name

Send a HEAD Request

To send a HEAD request to a specified URL, use the following syntax:

Overview

You can get a table from an Excel file by specifying the column headers. Tables can be further operated on using table operations.

🔔 Note: This operation applies to a sheet.

Syntax

Inputs

1. start column: The starting column for the table.

2. end column: The ending column for the table.

Example

Consider the following table:

The following operation will retrieve a subset of the table by selecting the columns from "Name" to "Favorite Book":

This is the resulting table:

Overview

This procedure converts a file into sheet format. The input file must be one of the following types:

• .csv

• .xlsx

• .json

Syntax

Example

The rename operation is used to rename a file. It can be used to rename an Excel file.

Syntax

Inputs

1. new name: The new name for the Excel file. (required)

Example

Overview

This procedure merges multiple spreadsheet files into one. You can rename columns, ignore specific columns, and choose how the files are joined.

Syntax

Inputs

1. the files: The spreadsheet files to be merged. Supported formats are .csv and Excel. (required)

2. type: The type of join to use when merging the files. (optional) Options:

   • outer (default)

   • inner

   • left

   • right

3. original column name, new column name: A pair of column names that should be considered the same across spreadsheets. The first in each pair is the original column name, and the second is the new column name all occurrences will be renamed to.You can specify multiple column pairs, separated by commas. Example: "Name", "Full Name", "Date", "Event Date". (required)

4. ignored columns: A list of columns to be excluded from the final merged spreadsheet. (optional)

Examples

1. Merging Two Files

2. Merging Multiple Files

👉 Excel File Creation

Converting a Singular Table to an Excel File

Converting Multiple Tables to an Excel File

Converting Tables to Excel with Specified Sheet Names

Note: This procedure can also be used to rename sheets inside a workbook.

Syntax

Example

Given the following table:

This procedure would retrieve C as the column label for cell C2.

This procedure finds a cell in a specific row of a worksheet that matches a given value, regex, or column label.

Syntax

Options & Inputs

One of the following options is required:

1. the value is "{value}", where value is the value of the cell you're targeting.

2. the column label is "{label}", where label is the label of the cell you're targeting.

3. the regular expression is "{regex}", where regex is a regex that matches the cell you're targeting.

Examples

Given the following table:

Here is how we would find cell Black Panther in cell A4:

1. Using the value is

2. Using the column label is

3. Using the regular expression is

This procedure reads the original Excel workbook and the relevant worksheet in it. It applies all the accumulated changes to the worksheet, then saves the entire Excel workbook to a temporary location.

Syntax

Inputs

1. new value: The new text value to set the cell to.

Example

Given the following table and cell C3:

This operation will replace Succulent with Agave in cell C3. The new table would be:

This operation retrieves the changes made to the worksheet and returns them as a JSON object.

This operation adds a list of changelogs as changes in the worksheet's data.

Configuration

This section guides you through the requirements, installation, and configuration steps necessary to get started with using Outlook in Kognitos.

Requirements

4. 1. client ID

   2. client secret

   3. tenant ID

   4. user ID

Azure Configuration

You will need to:

1. Register Kognitos in the Azure Active directory with API permissions to Read and Send Emails.

2. Provide the user ID for Microsoft Graph API to work for any user.

Steps

1. Login to Azure Portal > Open Active Directory > App registration (In left menu)

1. Register a new app with a suitable name for the project.

1. Go to API permissions > Add permissions > Select Microsoft Graph

1. Select Application Permissions > Search for Mail and grant Read Write and Send Permissions.

1. Grant admin consent for the granted permissions.

Steps to create user / Get user ID

1. Login to Azure portal > Go to Active directory > click on Users in menu

1. Create a new user or select any existing user.

1. Copy the value Object ID in user profile page

Learning the Microsoft Outlook Book

To interact with Microsoft Outlook in Kognitos, you need to learn the Microsoft Outlook Book. This will establish a secure connection to your account.

Prerequisites

Ensure you have all the required credentials: the client ID, client secret, tenant ID, and user ID

Steps

1. In the left sidebar, click on Books.

2. In the search bar, search for Microsoft Outlook, then click on the Book.

1. Add in the credentials when you are prompted.

2. Click Add to finish adding the Book.

📘 Actions Performed Under Your Credentials

Any actions taken will use the credentials you connect with. For example, if you send an email through Outlook, the sender will be the account linked to your connection credentials.

Overview

Managing emails effectively is a crucial aspect of using Outlook with Kognitos. This section covers various operations you can perform on emails, such as sending, receiving, forwarding, replying to, and deleting emails. Each operation is illustrated with examples.

👍 Actions Performed Under Your Credentials

Any actions taken will use the credentials you connect with. For example, if you send an email through Outlook, the sender will be the account linked to your connection credentials.

Operations

1. Sending Emails

Sending emails through Kognitos allows for the customization of recipients, subject lines, message bodies, and even attachments.

• Example: Sending an Email
• Example: Sending an Email with CC and Attachments

2. Receiving Emails

These operations retrieve emails based on specific criteria, such as the last few emails received or unread emails.

• Example: Getting the Last 5 Emails
• Example: Getting Unread Emails

3. Forwarding Emails

Forwarding emails to other recipients or groups can be easily automated using Kognitos.

• Example 1: Forwarding an Email to a Team
• Example 2: Forwarding an Email to the Manager with CC

4. Replying to Emails

These operations can automate email replies.

• Example: Replying to an Email with Feedback

5. Deleting Emails

These operations automate email deletion.

• Example: Deleting Emails by Subject
• Example: Deleting Emails by Sender and Folder

6. Marking Emails as Read or Important

Marking emails as read or flagging them as important can help prioritize your tasks and manage your inbox more efficiently.

• Example: Marking an Email as Read
• Example: Marking an Email as Important

7. Extracting Email Sender

Understanding who sent an email is crucial for many automated processes, such as filtering or responding to messages.

• Example: Getting the Email's Sender

8. Extracting Email Recipients

Knowing to whom an email was sent can help in understanding the communication flow and is useful in scenarios like auditing email communications.

• Example 1: Getting the Email's Recipients
• Example 2: Getting the Recipients for a Specific Email

9. Extracting Email Date

The date and time when an email was sent or received can be critical for organizing, sorting, or archiving emails.

• Example: Getting the Email's Date

10. Extracting Email Subject

The subject of an email often contains key information summarizing the content or purpose of the email.

• Example: Getting the Email's Subject

11. Extracting Email Attachments

Attachments are commonly used to share documents, images, and other files via email. Extracting these attachments is crucial for processing or storing these files outside the email system.

• Example 1: Getting the Email's Attachments
• Example 2: Getting Attachments from an Email by Sender

12. Extracting Email Body

The body of an email contains the main message. Extracting this content is essential for reading, processing, or analyzing the information conveyed in the email.

• Example 1: Getting the Email's Body
• Example 2: Getting the Body of an Email with a Specific Subject

Overview

These operations can retrieve the schedule for a specific entity, such as a person or a meeting room, which is essential for planning and coordination purposes.

Examples

These examples illustrate how to query various entities' schedules using Kognitos, enabling users to efficiently plan meetings, book resources, or understand the availability of individuals or assets.

Example 1: Getting the Schedule for a Person

Example 2: Getting the Schedule for a Conference Room

Overview

These operations can move emails to designated folders based on subject, sender, or content criteria.

Examples

These examples demonstrate how to use Kognitos to automate the process of moving emails into specific folders based on various criteria, helping users maintain an organized inbox.

Example 1: Moving Emails to the Archived Folder

Example 2: Moving Emails to the Important Folder Based on Subject

Example 3: Moving Emails from a Specific Sender to the HR Folder

Overview

Interacting with Power BI objects is a core functionality when integrating Power BI with Kognitos. This section covers how to fetch data, create and modify Power BI objects, and delete them when necessary.

Retrieving Data from Power BI

To fetch data from Power BI, you can use custom queries or direct commands. Below are examples of how to retrieve data using Kognitos.

Fetching Data using Custom Queries

To fetch data from Power BI using custom queries:

Fetching Data using Direct Queries

To fetch data from Power BI using direct queries:

Fetching Specific Attributes

Fetching Attributes from Retrieved Objects

Option 1: By Row Number

Syntax

Inputs

1. number: The row number.

Option 2: By Column Label & Cell Value

Syntax

Inputs

1. label: The label of the column, in quotes. Example: A, AE, D

2. value: The specific value of the cell in the target row that you want to retrieve, in quotes.

Examples

Given the following table:

Here are two examples on how to retrieve row #5:

By Row Number

By Column Label & Cell Value

Overview

The Microsoft Power BI Book integrates with Power BI, offering a powerful and intuitive way to interact with Power BI data and functionalities. This integration enables users to perform a wide range of operations on Power BI objects, including connecting to Power BI, retrieving data, and working with Power BI objects, all through the use of Kognitos’ natural language processing capabilities.

Prerequisites

1. Power BI Account: You need to have an active Power BI account. You can sign up for a Power BI trial account to get started if you do not have one.

2. API Access: Ensure that your Power BI account has API access enabled. API access is required for Kognitos to communicate with Power BI.

3. Client ID and Secret: Obtain your Power BI client ID and client secret, which are used to authenticate and authorize access to Power BI via the API. You can find these in your Power BI settings under "App registrations".

4. Tenant ID: Obtain your Power BI tenant ID, which is used to identify your organization within Power BI.

5. Workspace ID and Dataset ID: Identify the workspace and dataset you will work with in Power BI.

Learning the Power BI Book

To use the Microsoft Power BI Book, you need to learn it in your agent first.

1. Navigate to Books.

2. Search for Microsoft Power BI.

3. Click on + New Book.
4. Add in the credentials when you are prompted:

Once the book has been learned, you can perform various Power BI operations. You can now fetch data, create new records, update existing ones, delete records, manage files, and more.

To upload a file to SharePoint, use the following syntax:

Overview

The Google Cloud Storage Book integrates with Google Cloud Storage, allowing you to manage and store files effortlessly within your automations.

Prerequisites

1. Google Cloud Account: You need to have an active Google Cloud account. If you do not have one, you can sign up for a Google Cloud trial account to get started.

2. Google Cloud Storage Bucket: Ensure that you have a Google Cloud Storage bucket created. This bucket will be used to store your files and data.

3. Service Account with Storage Admin Role: Create a service account in Google Cloud and assign it the Storage Admin role. Kognitos will use this service account to interact with Google Cloud Storage.

4. Service Account Key: Download the JSON key file for your service account. This key file will be used to authenticate Kognitos with Google Cloud Storage.

Required Credentials

To connect to Google Cloud Storage, you will need the following credentials:

1. Service Account Key File: The JSON key file for your Google Cloud service account. This file contains the credentials required to authenticate with Google Cloud Storage.

Learning the Google Cloud Storage Book

1. Navigate to Books.

2. Search for Google Cloud.

3. Click on + Book to add the Book.

1. Add in the credentials when you are prompted:

Note: In case you see Test and Production credentials separately you can add both. If you don't have two sets of credentials you can use the same credentials in both.

Once the book has been learnt successfully, you are ready to use the Book's procedures. You can now dump files, purge files, and enrich questions with additional information.

Overview

The HubSpot Book integrates with HubSpot, allowing you to seamlessly manage contacts, deals, and other CRM data within your automations.

Prerequisites

1. HubSpot Account: You need to have an active HubSpot account. If you do not have one, you can sign up for a HubSpot trial account to get started.

2. API Access: Ensure that your HubSpot account has API access enabled. API access is required for Kognitos to communicate with HubSpot.

3. Access Token: Obtain your HubSpot access token, which is used to securely access HubSpot via the API. You can generate this token in your HubSpot account settings under "Integrations" > "API Key". You may need to contact your company’s IT support for access tokens.

Required Credentials

To learn the HubSpot Book, you will need the following credentials:

1. HubSpot Access Token: The access token for your HubSpot account. This token is used to authenticate API requests and can be generated in your HubSpot account settings.

Learning the Hubspot Book

1. Navigate to Books and search for HubSpot.
2. Click on + Book.

3. Add in the credentials when you are prompted:

Note: In case you see Test and Production credentials separately you can add both. If you don't have two sets of credentials you can use the same credentials in both.

Once the book has been learned, you are ready to perform various operations on HubSpot.

Fetching a File

Syntax

Example

Fetching Files from a Folder

Syntax

Example

Fetching Specific Files from a Folder

Syntax

Example

To convert data into a SharePoint-compatible string format, use the following syntax:

Example:

To get a folder from Microsoft SharePoint, you need the URL to the folder you want:

The formatting of the URL is very important, for example:

So please note, the URL as is when you copy from Sharepoint is formatted differently than the one we use in our automations!

To move a file to a different folder in SharePoint, use the following syntax:

Example:

To delete a file from SharePoint, use the following syntax:

delete a file at "https://yoursharepointlink.com/sites/FILE_PATH"

To fetch data from Oracle Fusion:

get a fusionobject's {thing}

get fusion's {thing}

To add a new record to Oracle Fusion, you need to specify the type of object you're creating and provide the necessary field values.

Example:

create a thing in fusion with
    the thing's name is "New Purchase Order"
    the thing's date is "2023-12-31"
    the thing's status is "Pending"

This creates a new purchase order with the specified name, date, and status.

To upload a string (file content) to a folder in SharePoint, use the following syntax:

get a file at "<file-url>"
get a folder at "<folder-url>"
upload the file to the folder where
  the filename is "<new-filename>"

Example:

get a file at "https://company.sharepoint.com/sites/ProjectX/Documents/file.docx"
get a folder at "https://company.sharepoint.com/sites/ProjectX/Documents"
upload the file to the folder where
  the filename is "newfile.docx"

To create or retrieve a folder in SharePoint, use the following syntax:

get a folder at "https://company.sharepoint.com/sites/ProjectX/Documents/FolderName"

Example:

get a folder at "https://company.sharepoint.com/sites/ProjectX/Shared Documents/NewFolder"

To delete a folder from SharePoint, us the following syntax:

delete a folder at "https://test.sharepoint.com/sites/YOUR_FOLDER_PATH"

Overview

The Oracle Cloud Fusion Book integrates with Oracle Cloud Fusion, enabling seamless automation of business processes.

Prerequisites

1. Oracle Fusion Account: You need to have an active Oracle Fusion account. If you do not have one, you can sign up for an Oracle Fusion trial account to get started.

2. API Access: Ensure that your Oracle Fusion account has API access enabled. API access is required for Kognitos to communicate with Oracle Fusion.

3. Credentials: Obtain your Oracle Fusion instance URL, username, and password. These credentials are necessary for establishing a secure connection to Oracle Fusion.

Required Credentials

To connect to Oracle Fusion, you will need the following credentials:

1. Fusion Instance URL: The base URL of your Oracle Fusion instance. This URL is unique to your organization and can be found in the address bar when you are logged into Oracle Fusion. It typically follows the format https://<your_instance>.oraclecloud.com.

2. Username: The email address or username associated with your Oracle Fusion account.

3. Password: The password for your Oracle Fusion account.

Learning the Oracle Cloud Fusion Book

To use the Oracle Cloud Fusion Book, you must first learn it in your agent.

1. Navigate to Books.

2. Search for Oracle Cloud Fusion.

3. Click on + Book.

1. Add credentials when you are prompted:

Note: In case you see Test and Production credentials separately you can add both. If you don't have two sets of credentials you can use the same credentials in both.

Once the book has been learned successfully, you are ready to perform various operations on Oracle Cloud Fusion. You can now fetch data, create new records, update existing ones, delete records, manage files, and more.

Introduction

The SharePoint Book integrates with SharePoint, enabling users to perform a wide range of operations on SharePoint items, including connecting to SharePoint, retrieving files and folders, uploading and moving files, and converting data to SharePoint-compatible formats.

Prerequisites

1. Kognitos Account: You need to have an active Kognitos account. If you do not have one, you can sign up for a Kognitos trial account to get started.

2. SharePoint Account: You need to have an active SharePoint account. If you do not have one, you can sign up for a SharePoint trial account to get started.

3. API Access: Ensure that your SharePoint account has API access enabled. API access is required for Kognitos to communicate with SharePoint.

4. Client ID and Client Secret: Obtain your SharePoint client ID and client secret, which are used to authenticate API requests. You can find these in your SharePoint app registration settings.

5. Tenant ID: Obtain your SharePoint tenant ID, which is used to identify your SharePoint instance. This can be found in your SharePoint admin center.

Required Credentials

To connect to SharePoint, you will need the following credentials (these are provided when enabling the integration in the platform or when first interacting with SharePoint, depending on the flow in use):

1. SharePoint Client ID: The client ID associated with your SharePoint app registration.

2. SharePoint Client Secret: The client secret associated with your SharePoint app registration.

3. SharePoint Tenant ID: The tenant ID of your SharePoint instance.

Setting Up SharePoint Connection

Kognitos supports integration with Microsoft SharePoint via the Microsoft Graph APIs. Access is generally provided using app registration without a user via Entra ID (formerly Azure AD). This section outlines the credentials required for this connection and provides a detailed, step-by-step guide to connect successfully.

Resources Accessed

The Kognitos SharePoint integration accesses the following types of resources via the Microsoft’s Graph APIs:

• Drives/files (listing of files and folders, file uploads and downloads, file moves, file deletes) - by drive id

• Sites (for accessing, updating, and deleting lists) - by site id

Access Pattern

Once the SharePoint integration has been configured in the Kognitos platform, the platform stores the provided client id, secret, and tenant. These are then used whenever access to SharePoint is requested by a running automation to obtain an temporary access token via a request to Microsoft’s auth endpoint. The given token is then used for that particular automation run.

The stored information can be removed or updated whenever desired from within the Kognitos platform. Only automations within the agent where SharePoint has been configured have the ability to make SharePoint requests using the configured client id and secret.

Configuring Access

To obtain a client id, secret, and tenant id:

2. Click on “App registrations”, on the left hand menu, then “New registration” on the top menu, and enter a name; the defaults should be acceptable for other fields

3. After the app registration is created, note the Application (client) ID and Directory (tenant) ID entries shown - these are the Client ID and Tenant ID values Kognitos requires.

4. Next, provision a client secret by clicking on “Add a certificate or secret”, then “New client secret”

\

1. Add a name and expiration timeline as desired - note that a new secret will have to be provided on the Kognitos platform once this secret expires. Note the Value column for the created secret - this is the Client Secret value Kognitos requires.

2. Lastly, add permissions for the app registration. Click on “API permissions”, then “Add a permission”, and select “Microsoft Graph”. Select “Application permissions”, then select permissions for sites. If desired it is possible to use the “Sites.Selected” permission instead of the broader set shown below - there are however extra steps required in this case to grant access to the desired sites. Please see Microsoft’s documentation for more details on this. Be sure to grant admin consent for the permissions you add.

Learning the SharePoint Book

To use the Sharepoint Book, you must first learn it in your agent.

1. Navigate to Books

2. Search for Salesforce.

1. Click on + Book.

2. Add in the credentials when you are prompted:

Note: In case you see Test and Production credentials separately you can add both. If you don't have two sets of credentials you can use the same credentials in both.

Once the book has been learned successfully, you are ready to perform various operations on SharePoint. You can now fetch data, create new records, update existing ones, delete records, manage files, and more.

Removing Attachments

Example: Removing an Outdated Document from an Invoice

When a file, such as an outdated document, needs to be removed from an Oracle Fusion invoice, this command specifies the invoice and the file to be detached. Kognitos processes the request, removing the specified attachment from the Oracle Fusion invoice.

Overview

Managing attachments within Oracle Fusion objects is a common requirement for many business processes. Whether it's attaching documents to invoices, downloading attachments for analysis, or removing outdated files, efficient attachment management is crucial.

Attaching Files to Oracle Fusion Objects

Example: Attaching a PDF Document to an Invoice

This specifies the file to attach (document.pdf), identifies the Oracle Fusion invoice by its ID, and indicates the file type. Kognitos handles the process of attaching the file to the specified Oracle Fusion invoice.

Example: Downloading a Document Attached to an Invoice

This retrieves an attached file (document.pdf) from a specified Oracle Fusion invoice. Kognitos facilitates the download process, making the file available for local use or review.

To update an existing Oracle Fusion object, you must identify the object by its ID and specify the fields you want to update.

Example:

This updates the status of the specified purchase order to "Approved".

Single Deletion

To delete a specific Oracle Fusion object, you need to specify the object and its ID. For example:

This deletes the Oracle Fusion object with the specified ID.

Overview

The HR Module with Paycom Book integrates with Paycom, enabling you to automate and simplify HR management. This integration enables users to perform a wide range of operations on Paycom data, including querying employee details, and managing punch entries.

Prerequisites

1. Paycom Account: You need to have an active Paycom account. If you do not have one, you can sign up for a Paycom account to get started.

2. API Access: Ensure that your Paycom account has API access enabled. API access is required for Kognitos to communicate with Paycom.

3. Credentials: Obtain your Paycom environment, username, and password. These credentials are necessary to establish a secure connection with Paycom.

Required Credentials

To connect to Paycom, you will need the following credentials:

1. Paycom Environment: The environment of your Paycom instance (e.g., "production").

2. Username: The email address or username associated with your Paycom account.

3. Password: The password for your Paycom account.

Learning the Paycom HR and Payroll Book

To use this Book, you must learn it in your agent first.

1. Navigate to Books.

2. Search for HR Module with Paycom.

3. Click on + Book on the Book that appears.

1. Add in the credentials when you are prompted:

Note: In case you see Test and Production credentials separately you can add both. If you don't have two sets of credentials you can use the same credentials in both.

Once the book has been learned, you are ready to perform various operations on Paycom.

Overview

Managing punch entries is essential for tracking employee attendance and work hours. This section covers how to create and delete punch entries for employees.

Creating Punch Entries

To create a new punch entry for an employee::

create an employee's punch entry with
    the EntryType is "clock in"
    the PunchTime is "2023-04-01T08:00:00"
    the EmployeeId is "12345"
    the PunchDesc is "Morning shift start"
    the PunchType is "start"

Deleting Punch Entries

To delete an existing punch entry for an employee:

delete the employee's punch entry with
    the punch ID is "12345"

Overview

Interacting with employee details is a core functionality when integrating Paycom with Kognitos. This section covers how to fetch employee details using specific IDs or filters.

Querying Employee Details

Get an Employee's Details

To retrieve details of a specific employee by their ID:

get an employee's details whose
    employee id is "12345"

Get Some Employees' Details

To retrieve details of multiple employees based on specific filters:

get some employees details where
    the department is "Engineering"
    the job title is "Software Developer"

Understanding Approval Processes

Approval processes in Salesforce are defined workflows that specify the steps required to approve a record. These processes can be applied to various Salesforce objects, such as Opportunities, Contacts, or custom objects, depending on the organization's needs. Approval processes typically involve one or more of the following components:

• Criteria for entering the process: Defines what records are eligible for approval. For example, an opportunity might need to have a value greater than $10,000 to require approval.

• Approval steps: The sequence of approval actions that need to be taken. This can involve multiple approvers at different stages.

• Approval actions: Actions taken when a record is approved, rejected, or recalled, such as updating fields, sending email notifications, or executing custom logic.

Submitting Sales Objects for Approval

This is the syntax for submitting a Salesforce object for approval in Kogitos:

submit the opportunity for approval with
    the opportunity's ID is "006xx000001Sv6aAAC"
    the comment is "Requesting approval for high-value opportunity"

In this example, an opportunity is submitted for approval by specifying its ID and providing a comment to give context to the approver. Kognitos translates this command into the appropriate Salesforce operation, automating the submission process.

Overview

Interacting with Salesforce objects is a core functionality when integrating Salesforce with Kognitos. This section covers how to fetch data, create and modify Salesforce objects, and delete them when necessary.

Fetching Data using custom SQL queries

To fetch data from Salesforce using custom SQL queries:

Fetching Data using Direct Queries

To fetch data from Salesforce using direct queries:

Creating and Modifying Salesforce Objects

Adding New Records

To add a new record to Salesforce, you need to specify the type of object you're creating and provide the necessary field values. Example:

This creates a new opportunity named "New Deal" with a close date and stage specified.

Updating Existing Records

To update an existing Salesforce object, you must identify the object by its ID and specify the fields you want to update. Example:

This updates the stage of the specified opportunity to "Closed Won".

Deleting Salesforce Objects

Single Deletion

To delete a specific Salesforce object, you need to specify the object and its ID.

Example: