E-Learning Community DXP Portal Support
Free Trial

Neptune DXP - Open Edition

    • Release Notes
    • Overview
      • UI5 overview
      • Runtime environment
      • Comparing Neptune DXP - Open Edition and Neptune DXP - SAP Edition
      • Neptune DXP - Open Edition life cycle
      • Cockpit tool overview
      • Telemetry
      • Security overview
        • Security features overview
        • Load balancing
        • User authentication
        • API authentication
        • Authentication and authorization
      • Third-Party Libraries
      • Design best practice
      • Sizing guide
    • Upgrade
      • Prerequisites
      • Upgrade to Neptune DXP - Open Edition 24 on Linux
      • Upgrade to Neptune DXP - Open Edition 24 on macOS
      • Upgrade to Neptune DXP - Open Edition 24 on Windows
    • Installation
      • System requirements
      • Download link
      • Basic installation of Neptune DXP - Open Edition
        • Install Neptune DXP - Open Edition on Linux
        • Install Neptune DXP - Open Edition on macOS
        • Install Neptune DXP - Open Edition on Windows
          • Install Neptune DXP - Open Edition on Windows manually
          • Install Neptune DXP - Open Edition on Windows with the Neptune DXP Installer – Open Edition (Windows)
      • Run Neptune DXP - Open Edition
      • Cloud installation of Neptune DXP - Open Edition
        • Install Neptune DXP - Open Edition using Neptune DXP Cloud
        • Install Neptune DXP - Open Edition on SAP BTP
          • Set up a trial account
          • Set up a subaccount on the SAP Business Technology Platform
          • Enable Cloud Foundry
          • Create organizational spaces
          • Add a new quota plan
          • Connect your account
        • Install Neptune DXP - Open Edition on Amazon EC2
          • Create a key pair
          • Launch the AWS instance
          • Set up a database
          • Connect the AWS database
        • Install Neptune DXP - Open Edition on Microsoft Azure VM
          • Create a virtual machine
          • Connect to the virtual machine
          • Create an Azure Database
          • Configure a server-level firewall rule
          • Create a database schema
          • Connect the database
          • Further readings on Microsoft Azure and virtual machines
        • Install Neptune DXP - Open Edition on the Oracle Cloud Infrastructure
          • Check for Neptune DXP - Open Edition on Oracle Cloud Infrastructure
          • Install Neptune DXP - Open Edition into Oracle Cloud Infrastructure
          • Start Neptune DXP - Open Edition with tmux
        • Install Neptune DXP - Open Edition using Docker
        • Install Neptune DXP - Open Edition using Kubernetes
      • Database configuration for Neptune DXP - Open Edition
        • Microsoft SQL setup
          • Settings on SQL Server Management Studio and SQL Server Configuration Manager
          • Settings on Neptune DXP - Open Edition
      • Basic setup of Neptune DXP - Open Edition
        • Install npm modules
      • Advanced setup of Neptune DXP - Open Edition
        • Use npm modules on a virtual machine
        • Load balancing
        • Set up default ports in Windows
        • High-availability setup of Neptune DXP - Open Edition
      • Environment variables
    • Cockpit
      • Overview
      • Cockpit settings
      • Cockpit search function
      • Cockpit perspectives
      • Cockpit tools
      • Keyboard shortcuts in the Cockpit
      • Naia
      • Naia Agent Studio
        • Models
        • Agents
          • Agent model settings
          • Agent instructions
          • Agent playground
          • Agent context and knowledge
          • Agent tools and MCP
          • Agent guardrails
          • Connectivity
          • Assign roles to an agent
        • AI tools
          • Script tool
          • API tool
          • Web search tool
          • Table tool
          • Email tool
          • PDF tool
          • Chart tool
        • Guardrails
        • Agent Trace
        • AI components
        • Recipes
          • Build a simple agent
          • Build an advanced agent
          • Integrate an agent
            • Chatbox in an app
            • Chatbox in a launchpad
            • Agent component in an app
            • Agent in a script
      • Neptune Forms
        • Forms at a glance
        • Build a simple form
        • Load Neptune forms in adaptive applications
      • Development
        • Neptune DXP Marketplace
          • Upload an application building block
        • Development Package
          • Add a new development package and integrate with Git
          • Import a development package from Git
          • Configure data exchange with GitHub
          • Send data to GitHub from a development package
          • Modify data in GitHub from a development package
          • Working on the same repository and merging changes
          • Delete a development package and its artifacts
          • Role-based access control for development packages
            • Add a user role to a development package
        • Adaptive Designer
          • Adaptive Designer user interface at a glance
            • Shell bar
            • Side navigation
            • Field catalog
            • Application tree
            • Preview
            • Settings/properties
          • Adaptive templates
            • Adaptive list
              • Use field lookup for table/list fields in the adaptive list template
            • Adaptive edit
            • Analytic slice and dice
            • Adaptive calendar
            • Adaptive splitter/layout
            • Adaptive grid
            • Adaptive tab template
            • Adaptive tile chart
            • Adaptive tile table
          • Adaptive template settings
            • Configure color picker
            • Configure conditional visibility
            • Configure custom number decimals
            • Configure default values
            • Configure edit/display mode
            • Configure icon display
            • Configure image insertion
            • Configure input mask
            • Configure link settings
            • Configure lookup
            • Configure single or multiple selection
            • Configure switch field
            • Configure value help
          • Data sources
            • Create an adaptive application based on a table definition
              • Import table data to an adaptive application
            • Create an adaptive application based on a server script
            • Create an adaptive application in guided mode
          • Adaptive applications templates and sources
            • Create a simple setup and a run script for a connector
            • Create an advance run script for a connector
            • Create a connector in the Adaptive Designer
            • Display server scripts messages for events in adaptive templates
          • Export adaptive application
          • Create adaptive application from export
          • Create a copy of an adaptive application
          • Create an event in guided mode
          • Save filter variants in adaptive templates
          • Bind a component field to a global i18n attribute
        • App Builder
        • App Designer
          • App Designer user interface at a glance
            • Shell bar
            • Side navigation
            • Component library
              • App Designer resource components
            • Application tree
            • Preview
              • Search pane
            • Component properties
          • Ways to create an application in Neptune DXP - Open Edition
            • Custom components
            • Create an application from scratch
              • Create general structure
              • Integrate data from an API
              • Add a footer with a button
            • Create an application with a template
              • Configure an application with a SplitApp template
              • Add resources to the master page
              • Create a list on the master page
            • Add a building block into the App Designer
            • Add custom HTML in the App Designer
            • Copy an app from an existing app
            • Import applications
            • Export applications
          • Configuration of an application
            • Application Settings
            • Language Translation (Deprecated)
            • Application Flow
            • Version Management
            • i18n (binding of translatable attributes in the App Designer)
              • Manage translations via bindings of translatable attributes in the App Designer
                • Create attribute for translation
                • Create translations for an attribute on the basis of defined locales
                • Bind an attribute translation to a component property
          • Data models in the App Designer
          • Using the AppCache.Load method to run applications
        • Script Editor
          • Overview of the Script Editor
          • Getting started with the Script Editor
            • Create a project for scripts
            • Create a script
            • Run a script
            • Add resources to a script
              • Add an API to a script
              • Add a table to a script
              • Add a global script to another script
              • Add an npm module to a script
                • Import sub-modules (npm sub-path support)
          • Code snippets in the Script Editor
          • Debug a script
          • Key words
          • Use a secret in the Script Editor
          • Perform a semantic search in a script
        • Rules Engine
          • Set up a rule
          • Create attributes for the rule
          • Create a rule with conditions
          • Test your rule
          • Example use cases
          • Call a rule like an API in a script
        • Custom UI5 Control
        • Code Snippets
          • Create a code snippet
        • Documentation
          • Create documentation for an application
          • Export a documentation artifact for an application
          • Import a documentation artifact
        • Media Library
          • Import files into the Media Library
          • Export files from the Media Library
        • I18n Text & Translation
          • Manage component text and translations in the I18n Text & Translation tool
            • Create a global i18n model
            • Create attribute for translation
            • Create translations for an attribute on the basis of defined locales
        • Node Package Manager
          • Add npm modules
        • Application trashbin
          • Delete or restore an application from the Application Trashbin
      • Design
        • Launchpad Designer (Beta)
          • Launchpad Designer user interface at a glance
          • Create a user launchpad experience with the Launchpad Designer
        • UI5 Theme Generator
          • Create a custom theme
        • Global CSS Style
        • Launchpad Layout
        • Tile Layout
        • Tile Group Layout
        • PDF Designer
          • PDF Designer user interface at a glance
            • Shell bar
            • Document tree
            • Properties pane
            • PDF Designer settings
          • Create a new PDF template
          • Open a PDF template
          • Edit a PDF template
          • Export a PDF template
          • Import a PDF template
          • Generate a PDF via an API
          • Generate a PDF via a script
          • Download a PDF document
          • PDF Designer elements
        • Email Template
          • Create an email template
          • Email template code snippet
        • UI5 Theme Import
          • Import a theme
          • Edit an imported theme
          • Delete an imported theme
        • Fonts
          • Create a custom font
      • Connectivity
        • Connectivity Group
          • Create a group
        • API Designer
          • API Designer user interface
          • Create an external API with the API Designer
            • Configure an external API
            • Add an operation
            • Add definitions and properties
            • Add URL parameters in API operations
          • Create a server script API with the API Designer
            • Configure a server script API
            • Add an operation
            • Add definitions and properties
          • Create a table definition API with the API Designer
            • Configure a table definition
            • Add an operation
            • Add definitions and properties
          • API import with the API Designer
            • Import an API definition for an external API
            • Import an API for a table definition
            • Import an API for a server script
          • Export an API from the API Designer
          • Import a definition into an API
          • Implement pre-request hook script
        • API Client
        • API Trace
        • Swagger UI
        • OData Source
          • Add an OData resource
          • Add authentication to an OData resource
          • Add an endpoint for a system role
        • OData Mock Data
          • Create an OData mock data artifact
          • Add data to an OData mock data artifact
        • Connector
          • Create a connector for a table definition
          • Create a connector for a server script
          • Create a connector for an API
          • Create a connector for an API with the SAP API Factory
          • Use connectors in the App Designer
          • Create and use OData connector
      • Integration Card Test
      • SAP Integration Hub
        • Data provider class
          • Data provider class in the Hub API Designer
          • Data provider class in the Hub MCP Designer
        • Hub API Designer
          • Create an API in the Hub API Designer
          • Migration from Neptune DXP - SAP Edition Rest API to Integration Hub API
        • Hub MCP Designer
          • MCP tool design best practices
          • Create an MCP server in the Hub MCP Designer
            • Expose existing ABAP logic as MCP tools
              • Wrap a REST API class as an MCP DPC
              • Wrap an AJAX app class as an MCP DPC
          • MCP server connection details
          • Connect to an MCP server from a compatible client
          • Use an MCP server in a Naia Agent Studio agent
      • Administration
        • Application Management
        • Web App Manager
          • Create a web application
          • Import assets for a web application
        • Tile
          • Configure general information about your tile
          • Configure the layout of your tile
          • Add actions to your tile
          • Further configure your tile
          • Run integration cards and Highcharts in a tile
          • Cockpit tiles (and tile groups)
        • Tile Group
          • Configure general information about your tile group
          • Add tiles to your tile group
          • Configure the layout of your tile group
          • Restrict access to your tile group by using roles
          • Add child tile groups to your tile group
        • Launchpad
          • Launchpad settings
          • Add a tile group to your launchpad
          • Launchpad appearance
          • Configure the layout of your launchpad
          • Run Visualization
          • Enable anonymous login for a launchpad
          • Enable self-registration in a launchpad
          • Active launchpad user settings
        • Mobile Client
          • Configure general information about your mobile client
            • Configure the security settings of your mobile client
            • Configure the device settings of your mobile client
            • Configure the plug-ins of your mobile client
            • Further configure your mobile client
          • Produce a mobile build
          • Enable voice-to-text functionality for a Naia Agent Studio agent in the mobile client
        • Mobile Debug
          • Add a mobile debugger
        • Dynamic Route Rewrite
        • Tile Blackout
          • Enable tile blackout
          • Disable tile blackout
        • Favorite Management
          • Add favorite tiles to a launchpad
        • Translation
          • Translate artifacts in a tile or tile group
        • Vault
          • Create a secret in the Vault
          • Create .env file
      • Monitoring
        • System Processes
        • Lock Entries
          • Remove lock entries
        • Housekeeping
          • Manually delete logs
          • Schedule daily automated deletion of logs
        • SMTP Log
        • System Logs
        • User Sessions
        • PDF Archive
        • Application Log
        • Launchpad Trace
        • Push Notification Users
          • Send a push notification
          • Delete a push notification user
      • Tools
        • Job Manage
          • Create a background job
            • Configure a job
            • Further define the schedule of a job
            • Add steps to a job
        • Job Log
        • Table Definition
          • Configure a table definition
          • Add properties to a table definition
          • Import table data
          • Add a foreign key to a database table
          • Add an index to a database table
          • Enable vectorization for a table definition
        • Table Browser
          • Add data records to a database table
          • Import table data to an existing table
        • Events
          • Script triggered by an event
          • Create and use event listener and event trigger
      • Deployment
        • Deployment Create
          • Create a deployment package
        • Deployment Approve
          • Approve a deployment
        • Deployment Transfer
          • Export a deployment package
        • Deployment Routes
          • Create a deployment route
        • Deployment Log
          • Import a deployment package
      • Security
        • User
          • Add a new user
          • Edit an existing user
          • Delete an existing user
        • Security Group
          • Add a new security group
          • Security groups within applications, tiles, and tile groups
        • Role
          • Add a new role
          • Roles within applications, tiles, and tile groups
        • Audit Log
          • Export an audit log
        • Remote Systems
          • Add and configure a remote system to your system
          • Add an authentication method to a remote system
          • Add endpoints
        • Import LDAP
          • Import LDAP tool settings
          • Import a group from LDAP
          • Import a user from LDAP
        • Proxy Authentication
          • Add a new authentication method
          • Edit an existing authentication method
          • Delete an existing authentication method
          • Types of proxy authentication
        • Certificates
          • Generate a new certificate
          • Import a certificate
          • Delete a certificate
        • Table Audit
          • Export a table audit log
      • Workflow
        • Getting started guide
        • Overview
          • Start a workflow
          • Rerun approver determination
        • Definition
          • Add a new workflow
          • Workflow editor at a glance
          • Work with the workflow editor
          • Edit a workflow
          • Delete a workflow
          • Start a workflow
        • Task Action
          • Add a new task action
          • Edit an existing task action
          • Delete a task action
        • Approvers
          • Add a new approver
          • Edit an approver
          • Delete an approver
        • Substitutions
          • Add a new substitution
          • Manage substitutions
      • Settings
        • System Settings
          • General/Integrations/AI/Security
            • Developing CSP-safe applications
          • Database/Storage
          • License
            • Manage trial license
            • Manage online license
            • Manage offline license
            • Manage license notifications
            • Remove license
            • License configuration glossary
          • Emailing
          • Password
          • Authentication
            • Microsoft Entra ID authentication
            • Configure authentication in the Microsoft Entra admin center
            • Add Microsoft Entra ID authentication to your system
            • JSON web token (JWT) authentication
            • Lightweight Directory Access Protocol (LDAP) authentication
              • Troubleshooting LDAP configurations
            • Configure an OAuth 2.0 authentication
              • OAuth 2.0 Authentication with Google
            • OpenID Connect authentication
              • OpenID authentication with Google
            • SAML authentication
            • Neptune DXP - SAP Edition authentication
          • Cloud Connector
            • Enable and configure Cloud Connector
        • Custom Settings
          • General
          • Extended custom setting tabs
    • Add-ons
    • MCP server
      • Connect an MCP client
      • Authorization
      • Tools overview
        • Applications
        • Web apps
        • Server scripts
        • Adaptive entities
        • Tables
        • APIs
        • Development packages
        • Access control
      • Deployment
      • Configuration reference
      • Troubleshooting
      • Glossary
    • Integration
      • The Neptune DXP cookbook
        • Step 1: Neptune DXP - SAP Edition installation - On Premises
        • Step 2: Neptune DXP - Open Edition installation – Neptune DXP Cloud
        • Step 3: Neptune DXP - Open Edition remote system setup
        • Step 4: SAP principal propagation setup (optional)
        • Step 5: Neptune DXP - SAP Edition API creation
        • Step 6: Neptune DXP - Open Edition API Discovery Service
        • Step 7: Neptune DXP - Open Edition launchpad integration of Neptune DXP - SAP Edition applications
      • Push notifications
        • Enable Firebase and push notifications
        • Example code for push notifications
      • Integrate Esri in Neptune DXP - Open Edition
      • Integration of APIs from the Neptune DXP Marketplace
      • Chatbot integration in Neptune DXP - Open Edition
      • Integration of customer relationship management (CRM) services
        • Create and configure a Salesforce account
        • Connect Neptune DXP - Open Edition with Salesforce
        • Create an API to connect to your Salesforce account
        • Example: retrieve data with the Salesforce API
      • Set up SSO with SAP BTP and Neptune DXP - Open Edition
      • Install Neptune DXP - Open Edition on SAP BTP with PostgreSQL
    • Authentication
      • Microsoft Entra ID groups and roles token claims
        • Use Microsoft Entra ID groups claims
        • Use Microsoft Entra ID roles claims
      • SAP principal propagation
        • Enabling principal propagation in Neptune DXP - Open Edition
        • Generate a user certificate
        • Import the certificate to SAP (BASIS)
        • Configure parameters in the SAP system (BASIS)
        • Map user of Neptune DXP - Open Edition and user of SAP
        • Create an authentication method in Neptune DXP - Open Edition
        • Assign an authentication method
    • FAQ
    • Request documentation
Neptune DXP - Open Edition 24.15 MTS
  • Neptune DXP
    • default
  • Neptune DXP - Evaluation Guide
    • default
  • Neptune DXP - Naia Build
    • default
  • Neptune DXP - Open Edition
    • 24.15 MTS
    • 24.14 LTS
    • 23 LTS
    • 22 LTS
  • Neptune DXP - Proxy
    • 1.0.0
  • Neptune DXP - Release Notes
    • default
  • Neptune DXP - SAP Edition
    • 24.15 MTS
    • 24.14 LTS
    • 23 LTS
    • 22 LTS
    • 21 LTS
  • Neptune DXP Cloud
    • default
  • Neptune DXP Portal
    • default
  • Neptune DXP Support Guide
    • default
  • Neptune DXP - Open Edition
  • Cockpit
  • Naia Agent Studio
  • Recipes
24.15 MTS 24.14 LTS 23 LTS 22 LTS

Recipes

In this section you will find guides for building agents, ranging from simple setups to increasingly complex configurations covering various topics.

  • Build a simple agent

  • Build an advanced agent

  • Integrate an agent

    • Chatbox in an app

    • Chatbox in a launchpad

    • Agent component in an app

    • Agent in a script

This page was built using the Antora default UI.

The source code for this UI is licensed under the terms of the MPL-2.0 license.