Overview

Learn how to write procedures to operate on a department box.

What is a Department Box?

A department box is a container for storing items, managed by a specific storage engine. The procedures referenced in this section allow users to add, retrieve, remove, and export items within department boxes. Multiple storage engines are supported, including S3 and DynamoDB.

Prerequisites: Setting Up a Department Box Connection

Required Credentials

To connect to a department box, you will need the following credentials:

1. Storage Engine Type: The type of storage engine you are using (e.g., "s3" or "dynamodb").

2. Access Credentials: The necessary access credentials for your storage engine (e.g., access key, secret key for S3, or appropriate IAM roles for DynamoDB).

Connection Process

1. Connect to the Department Box: Use the following syntax to connect to the department box.

   HR is a department box
   the department box's engine is "<storage_engine>"

   Replace <storage_engine> with your actual storage engine type (e.g., "s3" or "dynamodb").

   HR is a department box
   the department box's engine is "s3"

2. Verify Connection: After executing the above command, the Kognitos will attempt to establish a connection to the specified storage engine. If the connection is successful, you can proceed with further operations like adding, retrieving, or removing items. If the connection fails, verify your credentials and ensure your storage engine type is correct.

After successfully connecting, you can use the available procedures in your automation.

Department Box Procedures