Skip to content
Nappai Documentation

JSON Document Builder

This component takes information from another document in Nappai and organizes it into a standard JSON format. JSON (JavaScript Object Notation) is a way of storing data that many systems can easily read and use. Think of it as a very organized way to package your data.

Relationship with JSON

This component uses a special way of creating JSON documents that’s designed to be fast and efficient. It ensures your data is packaged correctly and quickly for use in other parts of Nappai.

Inputs

  • Key: This is the name you want to give to the data within the JSON document. Think of it as a label for your data. For example, you might use “customer_details” as the key.
  • Document: This is the source document in Nappai containing the data you want to include in your JSON document. This could be data from a spreadsheet, database, or another part of your workflow.

Outputs

The component produces a new document containing your data formatted as a JSON object. This new document can then be used by other parts of Nappai that need structured data, such as sending data to another application or storing it for later use. It’s ready to be used by other processes that understand JSON.

Usage Example

Let’s say you have a document containing customer information (name, address, etc.). You want to create a JSON document with this information. You would:

  1. Provide a “Key” (e.g., “customer_data”).
  2. Select the document containing the customer information as the “Document” input.
  3. The component will create a new document containing a JSON object like this: {"customer_data": [customer information]}.

Templates

[List of templates where the component can be seen and its configuration - To be filled by Nappai team]

[Links to other related components and a brief description of each - To be filled by Nappai team]

Tips and Best Practices

  • Make sure the “Document” input contains the data you want to include in your JSON.
  • Choose a descriptive “Key” that clearly identifies the data within the JSON.

Security Considerations

[If applicable, include appropriate security considerations - To be filled by Nappai team]