Setup an Integration

Last Updated: Version R2601

Administrators can establish integrations with the external systems listed below. Once an integration is set up, the Designer can create a process flow that uses one or more of the integrations:

Microsoft OneDrive

To integrate with a folder on Microsoft OneDrive, you must authorize the integration using a Microsoft Account with Administrator privileges.

Refer to Process Flow Example: Capture Documents from OneDrive Storage for an example of how to implement a process flow after the integration is completed.

  1. Click Settings ® Integrations.

  2. Click Create New Integration.

  3. Select Microsoft OneDrive.

  4. Click Create Integration.

  5. Enter a name for the integration and then click Create Integration.

  6. A new tab will launch. Choose the Microsoft account to login with. The account must be a Microsoft Account with Admin privileges.

  7. Verify your identity.

  8. Select the OneDrive folder to proceed.

  9. Click Create Integration.

Microsoft Outlook

To integrate with Microsoft Outlook email inbox, you must choose the Microsoft account and then the associated email folder where document attachments will be sent. When a document is received in a specified inbox, the process flow can automatically retrieve the attached documents if they meet specified criteria such as file type.

You must have Administrator privileges to the Outlook email account.

This feature enables the use of metadata for document classification or as document index data, enhancing the system's integration with Microsoft Office 365

Refer to Process Flow Example: Import Documents from Microsoft Outlook Email Folder for an example of how to implement a process flow after the integration is completed.

  1. Click Settings ®Integrations.

  2. Click Create New Integration.

  3. Select Microsoft Outlook.

  4. Click Create Integration.

  5. Enter a name for the integration and then click Create Integration.

  6. A new tab will launch. Choose the Microsoft email account that you want to use.

  7. Click Send Code to obtain the login sign-in code.

  8. Check the email account and then enter the 6 digit code in the required field.

  9. Complete the Permission Requested consent verification to allow RICOH IA to access this email account. Click Accept to continue.

  10. The integration is complete, and the Designer is able to choose this integration and then select a specific email folder when creating an Import Task with a process flow. For an example, see Process Flow Example: Import Documents from Microsoft Outlook Email Folder.

AWS S3 Bucket

You can integrate an Amazon Simple Storage Service bucket to store documents over AWS Cloud. The maximum size of an AWS S3 bucket is 5TB. These instructions assume that you have logged in to the AWS Management Console and have created the storage bucket. You also need to create an access key pair within the My Security Credentials section of the AWS console before you can complete the instructions below.

  1. Click Settings ® Integrations.

  2. Click Create New Integration.

  3. Select AWS S3 Bucket.

  4. Enter the following details: 

    FieldDescription
    Integration nameEnter a unique name for this integration.
    Access Key IDEnter the unique identifier for the bucket.

    Secret access key

    		Enter the access key.

    Bucket name

    		Enter the name of the S3 bucket that will store the documents.

    Region

    		Enter the corresponding region for the selected bucket.

  1. Click Create Integration.

SFTP

The SFTP Integration allows users to securely route completed documents to a designated folder using SFTP (Secure File Transfer Protocol). This feature provides two methods of authentication (Password Authentication and Private Key Authentication) to ensure data is transferred securely to the desired destination.

  • Password Authentication: Provide a username and password for SFTP access.

  • Private Key Authentication: Provide a private key file for authentication. Optionally, a pass-phrase can be added for additional security.

Complete the following fields:

  1. Click Settings ® Integrations.

  2. Click Create New Integration.

  3. Select SFTP.

  4. Enter the following details: 

    FieldDescription
    Integration nameEnter a unique name for this integration.
    User nameEnter the Admin user for the SFTP account.

    Authentication type

    • Password: Once you choose password, a Password field appears. Enter the Admin password that corresponds to the user name you entered for the SFTP account.

    • Private Key: Once you choose Private key, a Private Key field and a Passphrase field appear. The passphrase is optional, but should be added for extra security.

    Host

    		Enter the SFTP server host name or IP Address.

    Port

    		Enter the communication port for the SFTP server.

    Root folder

    Select the root folder that will be used for storage. Drill down into the SFTP folders to select the root.

    If this folder does not exist, the system will create this subholder within the designated root directory. However, if the Operator user does not have permissions to access this folder, the batch is suspended and the user is notified.

  1. Click Create Integration.

Natif AI Integration

Complete these settings to integrate with Natif AI to run AI models on the platform using API keys.

  1. Click Settings ® Integrations.

  2. Click Create New Integration.

  3. Select Natif AI.

  4. Enter the following details: 

    FieldDescription
    Integration nameEnter a unique name for this integration.
    Base URLEnter the base URL for this integration. For example 'https://api.natif.ai'

    API Key

    Obtain and paste the Natif AI API key that will be used to authentication and connect with the Natif AI platform. Refer to https://developer.natif.ai/getting_started/create_api_key/ for instructions.

  1. Click Create Integration.

Azure AI Integration

Complete these settings to integrate with Azure AI to run AI models on the platform using API keys.

  1. Click Settings ® Integrations.

  2. Click Create New Integration.

  3. Select Azure AI.

  4. Enter the following details: 

    FieldDescription
    Integration nameEnter a unique name for this integration.
    Base URLEnter the base URL for this integration. For example 'https:/company.cognitiveservices.azure.com'

    API Key

    Obtain and paste the Azure AI API key that will be used to authenticate and connect with the Azure AI platform.

  1. Click Create Integration.

RCIP Integration

You can integrate RICOH IA with the RICOH Cloud Integration Platform to initiate a task via an API call. Set up each integration here before creating a process flow that contains a RCIP Connector.

  1. Click Settings ®Integrations.

  2. Click Create New Integration.

  3. Select RCIP.

  4. Enter a name for this integration, and then type or paste the base URL and the API key that will be used to authenticate and connect.

  5. Click Create Integration.