Documentation
E-Learning Community DXP Portal Support
Start Free Trial

You are viewing legacy documentation that is no longer updated. Go to the current documentation

Neptune DXP - Open Edition

    • Release Notes
    • 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
        • Mobile client security
        • API authentication
        • Authentication and authorization
      • Design Best Practice
      • Sizing Guide
    • Upgrade
      • Prerequisites
      • Upgrade to Neptune DXP - Open Edition 22 on Linux
      • Upgrade to Neptune DXP - Open Edition 22 on macOS
      • Upgrade to Neptune DXP - Open Edition 22 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
      • 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 AWS cloud
          • Create a key pair
          • Launch the AWS instance
          • Set up a database
          • Connect the AWS database
        • Install Neptune DXP - DXP - Open Edition on 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 Azure and virtual machines
        • Install Neptune DXP - Open Edition on the Oracle Cloud platform
          • Check for Neptune DXP - Open Edition on Oracle Cloud
          • Install Neptune DXP - Open Edition into Oracle Cloud
          • Start DXP - Open Edition with tmux
        • Install Neptune DXP - 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
    • Cockpit
      • Cockpit settings
      • Cockpit search function
      • Cockpit perspectives
      • Cockpit tools
      • Development
        • Neptune DXP Marketplace
          • Uploading a Application building block
        • Store (Deprecated)
          • Add an application building block to the Neptune DXP Marketplace
          • Delete an application building block from the Neptune DXP Marketplace
        • 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 Package
          • Modify data in GitHub from a Package
          • Working on the same repository and merging changes
        • Adaptive designer
          • Adaptive Designer user interface at a glance
            • Shell bar
            • Side navigation
            • Data Fields
            • Application tree
            • Preview
            • Settings/Properties
          • Adaptive templates
            • Adaptive list
            • Adaptive edit
            • Analytic slice and dice
            • Adaptive tile chart
            • Adaptive tile table
          • Data sources
            • Create an adaptive application based on a table definition
            • Create an adaptive application based on a server script
          • Adaptive applications templates and sources
            • Create a simple Setup and a Run script for a Connector
            • Create an advance Run script for a Connector
        • App Builder
        • App Designer
          • App Designer user interface at a glance
            • Shell bar
            • Side navigation
            • Component library
            • Custom Components
            • Application tree
            • Preview
            • Component properties
          • Ways to create an application in Neptune DXP - Open Edition
            • 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
            • Copy an app from an existing app
            • Import applications
            • Use an application building block from the Neptune DXP Marketplace
            • Export applications
          • Configure an application
          • Data Models in the App Designer
        • App Editor
          • Getting started with the App Editor
          • App editor user interface at a glance
          • Migrate applications to App Editor
          • Adding npm modules to your project
          • Deploying App Editor application
        • 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
          • Code snippets in the Script Editor
          • Key Words
        • 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
        • 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
        • NPM Modules
          • Add npm modules
        • Application trashbin
          • Delete or restore an application from the trashbin
      • Design
        • PDF Designer
          • PDF Designer elements
          • PDF Designer settings
          • Insert an interface to the PDF Designer
          • Create a new PDF template
          • Open a PDF template
          • Edit a PDF template
          • Download a PDF document
          • Export a PDF template
          • Import a PDF template
          • Generate a PDF via a script
          • PDF Designer App Implementation
        • Theme Designer
          • Add a new theme
          • Edit an existing theme
          • Delete a theme
        • Theme Import
          • Import a theme
          • Edit an imported theme
          • Delete an imported theme
        • E-Mail Template
          • Create an email template
      • 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 a 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 a definitions and properties
          • Create a table definition API with the API Designer
            • Configure a table definition
            • Add an operation
            • Add a definitions and properties
          • Import an API with the API Designer
          • Export an API from the API Designer
          • Import a definition into an API
        • 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 script
          • Create a connector for an API
          • Use connectors in the App Designer
          • OData Connector
      • Administration
        • Application Management
        • 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
        • 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
          • Add a translation for your tile group
        • Launchpad
          • Add a new launchpad
            • Configure general information about your launchpad
            • Add a tile group to your launchpad
              • Configure the layout of your launchpad
              • Further configure your launchpad
          • Enable anonymous login for a launchpad
          • Enable self-registration in a launchpad
        • 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 plugins of your mobile client
            • Further configure your mobile client
          • Producing a build
        • Mobile Debugger
          • Add a mobile debugger
        • Tile blackout
          • Enable tile blackout
          • Disable tile blackout
        • Favourite Management
          • Add favorite tiles to a launchpad
        • Translation
          • Translate artifacts in a tile or tile group
      • Monitoring
        • System Processes
        • Lock Entries
          • Remove lock entries
        • Housekeeping
        • SMTP Log
        • System Logs
        • System Reports
        • User Sessions
        • PDF Archive
        • Application Log
        • Launchpad Trace
        • Push Notification Users
          • Send a push notification
          • Delete a push notification user
        • Load Test
          • Create a load test
          • Run a load test
      • Tools
        • Job Manage
          • Create a background job
            • Configure a job
            • Define schedule of a job
            • Add steps to a job
        • Job Log
        • Table Definition
          • Configure a table definition
          • Add properties to a table definition
          • Add a foreign key to a database table
          • Add an index to a database table
          • Define reading and writing rights for a database table
        • Table Browser
          • Add data records to a database table
        • Events
          • Script triggered by an Event
          • Create and use event listener and event trigger
      • Testing
        • Define test units
          • Create a test unit
        • Plan the test
          • Create a test plan
        • Run the test
          • Run a test plan
      • 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
        • 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 a user from LDAP
          • Import a group 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/Authentication
          • License/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
            • OAuth2 authentication
              • OAuth2 Authentication with Google
            • OpenID Connect authentication
              • OpenID Authentication with Google
            • SAML authentication
            • SAP Edition authentication
          • Cloud Connector
            • Enable and configure Cloud Connector
        • Custom Settings
          • General
          • Layout/Texts
    • Add-ons
      • Forms
        • Forms at a glance
        • Building a simple Form
        • How to load Neptune Forms in Adaptive Applications
    • Integration
      • The Neptune DXP Cookbook
        • Step 1: Neptune DXP - SAP Edition installation - On Prem
        • Step 2: Neptune DXP - Open Edition installation – Neptune DXP Cloud
        • Step 3: Neptune DXP - Open Edition Remote System Set Up
        • Step 4: SAP Principal Propagation Set Up (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 Apps
      • Push Notifications
        • Set up Firebase
        • Activate Firebase and push notifications
        • Example code for push notifications
      • Integrating 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
      • Integrate Esri in Neptune DXP - Open Edition
      • Integration of APIs from the Neptune DXP Marketplace
      • Chatbot integration in Neptune DXP - Open Edition
    • Authentication
      • Use an JWT token as authentication method to access an external API
        • Download and configure an API
        • Access the API from an external system
      • 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 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
  • FAQs
22 LTS 21
Neptune DXP Documentation
Neptune DXP - Open Edition · 22 LTS

FAQs

There are the following FAQs available:

  • FAQ

  • FAQ : Neptune DXP - Open Edition and Mobile Application Management

  • FAQ - Neptune DXP - Open Edition and Node.js

  • Add URL parameters in API operations

  • Enable anonymous login for a launchpad

  • Enable self-registration in a launchpad

  • Migrate applications to App Editor

Neptune DXP documentation, © 2026 Neptune Software
Request Documentation License neptune-software.com