Skip to main content

Rygen Help Center

Search (Documents)

Every message that X1 processes represents a business document or transaction, such as an invoice, a rate request, or an order. X1 treats these messages as documents according to the Document Message pattern from the Enterprise Integration Patterns. Each document has a type that determines how it is processed.

X1 can process messages it receives in any data format, such as JSON, XML, EDI, CSV, PDF, or text. Upon receipt of the "raw" message in its original format, X1 converts it into a representation that can be stored and processed. This representation is typically a map of key-value pairs similar to JSON, but it can also be string or binary data. This representation is known as the document and is used to represent the message throughout the system.

The Documents page is where you can search for and view documents.

  2. On the Documents page, view the list of documents.

Search for a document

  2. On the Documents page, you can search for a specific document using the default search fields.

    documents_search.png

  3. In the Search Type drop-down list, select a search type. Your search and query options will vary depending on which search type you select.

See the "Document Search Type Steps" below for more information about searching for a document.

Document Search Type Steps

Search Type

Steps

Text Search

  1. Complete steps 1 - 3 in the Search for a document procedure above.

  2. In the Document Type drop-down list, select a document type.

  3. Select the Start Date and End Date ranges.

Note

In the Query field, you can optionally enter a MongoDB Query Language query to search for documents. This query is executed against the documents in the database and will return all documents that match the query.

In the top right corner of the page, select Query Guide for more information.

MQL Search

  1. Complete steps 1 - 3 in the Search for a document procedure above.

  2. In the Document Type drop-down list, select a document type.

  3. Select the Start Date and End Date ranges.

Note

You can select add_icon.png to add a new filter criterion for sorting the Documents table.

Note

In the Query field, you can optionally enter a MongoDB Query Language query to search for documents. This query is executed against the documents in the database and will return all documents that match the query.

In the top right corner of the page, select Query Guide for more information.

Natural Language Query

  2. In the Query field, enter a natural language query.

    Note

    You can optionally enter a descriptive sentence for what you want to search and select Exey.png to let the Exey chatbot create the natural language query for you.

    1. Create a sample document for the Document Type you are querying. This enables Exey to generate the query based on the fields in the sample document.

    2. Use the field names from the sample document in your query. This ensures that the query is generated correctly.

    3. Specify fields and values in the query. For example, shipment date before 2022-01-01 or request id is 12345 and shipper name is Acme Corp.

  3. Select Search.

View documents and their envelopes

You can view documents and their envelopes sorted according to specific search criteria.

When X1 receives a document message, it wraps it in an envelope. In addition to the document, an envelope contains metadata about the message, such as the sender and receiver. It's used to route the message to the correct destination and optionally includes a header.

  2. Search for a document.

The search results display various envelope properties for the document.

See the "View Envelope Field Descriptions" below for more information about the envelope fields.

View Envelope Field Descriptions

Field

Description

ID

A unique identifier for the document assigned by the system for internal reference.

Sender

The sending trading partner.

Receiver

The receiving trading partner.

Correlation ID

A unique identifier for the message flow that correlates all documents and events that occur in the flow.

Timestamp

The time the document was received by the system.

View envelope details for a document

  2. Search for a document.

  3. In the Search Documents table, next to a document, select envelope_icon2.png. The envelope details information displays.

See the "View Envelope Details Field Descriptions" below for more information about the envelope details fields.

View Envelope Details Field Descriptions

Field

Description

Document tab

Displays the message payload, which, depending on the original message payload, is represented as a map, string, or array of bytes.

Header tab

Displays an optional header that contains additional metadata about the message and can be in any shape.

Lineage tab

Displays the lineage of transformations the document has gone through.

Note

You can select Download to download the envelope details to a file.

The file is saved in your default location for file downloads.

Add a named query to a document search query

Named queries are predefined queries that can be used to search for documents. They're defined in the document type configuration and can be used to search for documents that match specific criteria.

Note

The list of named queries is comprised of the query templates you created for document types.

  2. In the Search Type drop-down list, select MQL Search.

  3. In the Document Type drop-down list, select a document type.

  4. In the top right corner of the page, select Add Named Query.

    add_named_query.png

  5. In the Add Named Query dialog box, in the Query Name drop-down list, select a query name.

  6. In the Add Named Query dialog box, in the Query Value filed, enter the value for the query.

  7. Select Add Queries. The named query is added to the Query field, above the Documents table.

In this section: