Save Source

1. Log in to the Kuika platform.
2. Open the project you will work on from the Apps screen.
3. While in the UI Design module, open the Properties panel on the right side.

4. Select Initial Actions → Searching → Save Source from the +ADD ACTION drop-down menu.
5. In the settings panel that opens, configure the following fields:

• Source Type: Specifies the type of source. One of Google Drive, AWS S3 or Manual source types must be selected.
• Name: The identifying name given to the source.
• Update Interval In Hour: Specifies how often the resource will be synchronized, in hours.

6. Click the + ADD OPTIONAL PARAMETER drop-down menu and add the following parameters:
   
   • Collection Name: Specifies the database or collection name. This defines the structure in which the data is stored.
   • Correlation ID: A unique ID associated with the transaction or user session. For example, it can be used to track the response to an API call or to associate an error message with a specific transaction.
7. Click SAVE to complete the configuration process.

1. Click on the drop-down menu “+ ADD OPTIONAL PARAMETER” (1).
2. Configure the following parameters from the drop-down menu:

• Collection Name: Specifies the name of the database or a collection and defines the structure in which the data is stored. For example, in a NoSQL database this is the name of the collection where the data is grouped.
• Correlation ID: A unique ID associated with a transaction or user session. It is used for tracking and correlating transactions and events. For example, it can be used to track the response of an API call or to associate an error message with a specific process.

      3. Then click “SAVE” (2) to complete the configuration process.

An authorized Google Console account is required to use Google Drive.

Creating and Selecting Projects

1. On the Google Cloud Console page, access the APIs & Services screen.

2. Create a new project or select an existing project.

3. If the resource to be added belongs to an organization account, the project must be derived from that organization.

Google Drive API Activation

1. Access the APIs & Services screen.
2. Enable the Google Drive API.

Service Account Creation and Access

1. Access the IAM & Admin screen.

2. Create a new Service Account if necessary.
3. Select “Viewer” from the role list.

Key Creation

1. Go to Manage Keys in the Service Account section.

2. Click on Create New Key and create a key in JSON format.

3. Get the following information from the downloaded JSON file:
   
   • private_key
   • client_email
   • token_uri

The private_key information should be added to include the BEGIN and END PRIVATE KEY fields.

Getting FileID and FolderID

1. Copy the sharing link of your file in Google Drive.
2. Save the fileID and folderID information in the link.

Example link:

https://drive.google.com/file/d/1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_/view?usp=sharing

Here 1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_ is the fileID.

Defining Save Source

• Source Type: Google Drive
• Name: File name
• Update Interval in Hour: Determines how often the resource will be synchronized.
• Client Email, Private Key, Token Uri, Folder Id and File Id must be retrieved from the JSON file of the Google Drive service account.

For Amazon S3 usage, an account with read access to S3 is required.

IAM User Creation

1. Go to the IAM section and click on the Add Users button.

2. Specify the user name and proceed.

3. Assign the AmazonS3ReadOnlyAccess policy from the “Attach policies directly” option.

4. After creating the user, create an Access Key from the Security Credentials screen .
5. Save the Access Key and Secret Access Key information somewhere.

This information is displayed only once.

Defining Save Source

1. Source Type → AWS
2. Name → File name
3. Update Interval in Hour → Synchronization time
4. Add the required information:
   
   • awsAccessKeyId
   • awsSecretAccessKey
   • bucketName
   • S3uri

Manual upload allows uploading files in Base64 format.

Convert to Base64 Format

1. Convert your file to Base64 format using a conversion site such as https://base64.guru/converter/encode/file.

Defining Save Source

1. Source Type → Manual
2. Name → File name
3. Update Interval in Hour → Synchronization time
4. Base64 Content → Base64 format file content

Getting and Using Folder Id and File Id Parameters in Google Drive Save Source Action

Retrieve File IDs in Google Drive

1. In Google Drive, right-click on the file added inside a folder and select
2. Click Share → Share.
3. On the screen that opens, make sure that the service account user account has viewing access.
4. Click the Copy Link button.
5. Paste the copied link somewhere.
6. Get the File ID and Folder ID in the link:
7. Example link:

https://drive.google.com/file/d/1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_/view?usp=sharing

8. Field here: 1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_ → File ID
9. Link example for folder:

https://drive.google.com/drive/folders/18V8ZSYTNE8T_gKum3ZVUK5wHZQM3s2aa

10. This field here 18V8ZSYTNE8T_gKum3ZVUK5wHZQM3s2aa → Folder ID

Creating a Save Source Action in the Interface

1. In the UI Design module, add a Button element from the Elements panel on the left side.
2. Define the Save Source action in the onClick action of this button.
3. Configure the following parameters:

Save Source Parameters for Google Drive

• Source Type: Google Drive
• Name: Name of the file (set by the user)
• Update Interval in Hour: 1 (This specifies how often the system will synchronize the file)
• Client Email: test-652@vector-search-test-443209.iam.gserviceaccount.com (In Google Drive environment, service account email address with viewing authorization)
• Private Key:

-----BEGIN PRIVATE KEY-----

.......

-----END PRIVATE KEY-----

• (private key information in Google Drive JSON file)
• Token Uri: https://oauth2.googleapis.com/token (Token URI taken from the JSON file when preparing the Google Drive environment)
• Folder Id: 18V8ZSYTNE8T_gKum3ZVUK5wHZQM3s2aa (Google Drive Folder ID)
• File Id: 1vNG371Q2ZAkC0X7e8AHm2lftTMRSqWO_ (Google Drive file ID)
• Collection Name (optional): googledrive1 (Specifies a specific collection name in the Qdrant system. If not entered, it is taken as DefaultCollection).
• Correlation Id (optional): cor relationId (Allows the record to be re-added when the source is updated or ID changes.)

Creating the Save Source Action for Amazon S3

1. In the UI Design module, add a Button.
2. Define the Save Source action in the onClick action of this button.
3. Configure the following parameters:

Amazon S3 Save Source Parameters

• Source Type: AWS
• Name: Name of the file (set by the user)
• Update Interval in Hour: 1 (Specifies how often the file is synchronized.)
• awsAccessKeyId: key (AWS access key)
• awsSecretAccessKey: key (AWS secret access key)
• Bucket Name: test-bucket-vector-search (bucket name used in AWS environment)
• S3uri: s3://test-bucket-vector-search/s3Folder/ (S3 file path in AWS environment)
• Collection Name (optional): googledrive1
• Correlation Id (optional): correlationId

Creating a Manual Save Source Action

1. In the UI Design module, add a Button.
2. Define the Save Source action in the onClick action of this button.
3. Configure the following parameters:

Manual Save Source Parameters

• Source Type: Manual
• Name: Name of the file (set by the user)
• Update Interval in Hour: 1 (Specifies how often the file is synchronized.)
• Folder Path: null
• File Path: null
• Base64 Content:

data:<mimetype_of_file>;base64,......

• (A Base64 conversion site can be used to get the content of the file in Base64 format)
• Collection Name (optional): googledrive1
• Correlation Id (optional): correlationId

By following these steps, you can successfully manage your resources on Kuika platform with Google Drive, AWS S3 or Manual methods.