Add Document into Collection (Lookup) v1.0.0 Help ​

Creates a document in a specified Lookup collection.

How can I use the Step? ​

Use this Step to add a new document to a specific collection in the Lookup system. This can be useful for content management, organizing data, or preparing documents for further processing.

How does the Step work? ​

The Step requires the collection and document names, and optionally, a document description and URL. The Step interacts with the Lookup system to create and its associated data.

Prerequisites ​

  • For custom authentication, ensure proper cross-account settings with the Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

  • Collection: an existing Lookup collection. This field is required.
  • Name: a unique document name to add to the selected Lookup collection. This field is required.
  • Description: the document description for search purposes. It must be less than or equal to 2048 characters.
  • Document URL: the URL of the document file to add to the Lookup collection. Supported formats include PDF, text files, or web pages. This field is optional.
  • Default parameters: custom properties for the document passages. This field is optional and expects a JSON object.

Cross-account settings ​

To access the Lookup service of another Onereach account, take these steps:

  1. Enable Use custom authentication token.
  2. Choose one of the following access types:
    • Authentication token
    • Account ID
  3. Enter the token or account ID (depending on the chosen access type).

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output object has the following properties:

  • id: [string] the id of the document.
  • createdAt: [string] the creation date and time of the document.
  • updatedAt: [string] the last update date and time of the document.
  • collection: [array] an array of objects representing the collection that the document belongs to. Each object has two properties:
    • beacon: [string] a unique identifier or locator for the collection within a specific system or database.
    • href: [string] the href value of the collection, valid for direct access or reference.
  • name: [string] the name of the document.
  • sourceUrl: [string] the source URL of the document.
  • status: [string] the status of the document.

Example:

json
{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "collection": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "name": "string",
  "sourceUrl": "string",
  "status": "string"
}
{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "collection": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "name": "string",
  "sourceUrl": "string",
  "status": "string"
}

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release