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

  • Getting Started Guide
    • Neptune DXP - Open Edition
      • Runtime environment
      • Comparing Open Edition and SAP Edition
      • DXP - Open Edition life cycle
      • Process overview
      • Security overview
        • Security features overview
        • Load balancing
        • User authentication
        • Mobile client security
        • API authentication
        • Authentication and authorization
      • Design Best Practice
    • Installation
      • Overview
      • System requirements
      • Download link
      • Installation guide for Neptune DXP - Open Edition
      • Basic setup of Neptune DXP - Open Edition
      • Install npm modules
        • Use npm modules on a virtual machine
      • Configure your database
      • Load balancing
      • Install DXP - Open Edition on cloud platforms
        • Install DXP - Open Edition using DXP cloud managed environments
        • Install 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 DXP - Open Edition on AWS cloud
          • Create a key pair
          • Launch the AWS instance
          • Set up a database
          • Connect the AWS database
        • Install 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 DXP - Open Edition on the Oracle Cloud platform
          • Check for DXP - Open Edition on Oracle Cloud
          • Install DXP - Open Edition into Oracle Cloud
          • Start DXP - Open Edition with tmux
        • Install DXP - Open Edition using Docker
        • Install DXP - Open Edition using Kubernetes
      • DXP - Open Edition: Sizing Guide
    • Cockpit
      • Cockpit settings
      • Cockpit search function
      • Cockpit perspectives
  • Cockpit documentation
    • DXP - Open Edition cockpit: service overview
    • Development
      • Store
        • Add an application building block to the Store
        • Delete an application building block from the Store
      • Development package
        • Add a new development package
        • Import a development package from Git
        • Configure a connection to GitHub
      • Adaptive designer
        • Adaptive Designer user interface at a glance
          • Shell bar
          • Side navigation
          • Component library
          • 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
        • Ways to create adaptive applications
      • App Designer
        • App Designer user interface at a glance
          • Shell bar
          • Side navigation
          • Component library
          • Application tree
          • Preview
          • Object properties
        • Ways to create an application in DXP - Open Edition
          • Create an application from scratch
            • Configure an application
            • 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 Store
          • Export applications
      • App Editor
        • Getting started with the App Editor
        • App editor user interface at a glance
        • Migrate applications to App Editor 2.2.0
      • Script Editor
        • Create a new project
        • Open an existing project
        • Create new scripts
        • Detailed functions of the Script Editor
        • Add a code snippet
        • Add resources to a script
        • Run a script
      • Rules Engine
        • Set up a rule
        • Create attributes for the rule
        • Create a rule with conditions
        • Test your rule
      • Code snippets
        • Create a code snippet
      • Documentation
        • Create a 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
      • 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
        • 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
        • Add URL parameters in API operations
      • API Client
      • API Trace
      • Swagger UI
        • Make a test call to an API with 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
    • Administration
      • Application Management
      • Tile
        • Add a new tile
          • Configure general information about your tile
            • Configure the layout of your tile
            • Add actions to your tile
            • Further configure your tile
      • Tile Group
        • Add a new 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
      • Mobile client
        • Add a new 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
      • 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
        • Delete Logs
      • 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
        • Create a database table in Table Definition and Table Browser
          • Configure a table definition
          • Add properties to a table definition
          • Add data records to a database table
          • 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
    • 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
        • Import a deployment package
      • Deployment Routes
        • Create a deployment route
      • Deployment Log
    • Security
      • User
        • Add a new user
        • Edit an existing user
        • Delete an existing user
      • Group
        • Add a new group
        • Edit an existing group
        • Delete an existing group
      • Role
        • Add a new role
        • Edit an existing role
        • Delete an existing role
      • Audit Log
        • Export an audit log
      • Remote systems
        • Connect to a remote system
        • 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
      • 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
        • Edit a substitution
        • Delete a substitution
    • Settings
      • System Settings
        • General/Authentication
        • License/Emailing/Password
        • Authentication
          • Azure AD authentication
          • Configure authentication in the Azure portal
          • Add Azure AD authentication to your system
          • JSON web token (JWT) authentication
          • Lightweight Directory Access Protocol (LDAP) authentication
          • OAuth2 authentication
          • OpenID Connect authentication
          • SAML authentication
        • Cloud Connector
          • Enable and configure Cloud Connector
      • Custom Settings
        • General
        • Layout/Texts
  • Additional guides and FAQs
    • FAQ
    • Additional guides
      • Use an JWT token as authentication method to access an external API
        • Download and configure an API
        • Access the API from an external system
      • Integrating Customer-Relationship-Management (CRM) services
        • Create and configure a Salesforce account
        • Connect DXP - Open Edition with Salesforce
        • Create an API to connect to your Salesforce account
        • Example: Retrieve data with the Salesforce API
      • Push Notifications
        • Set up Firebase
        • Activate Firebase and push notifications
        • Example code for push notifications
      • SAP Principal Propagation
        • Enabling Principal Propagation in 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 DXP - Open Edition
        • Assign an authentication method
      • Integrate Esri in DXP - Open Edition
      • Integrate Esri in DXP - Open Edition
      • Integration of APIs from the Store
      • Chatbot integration in DXP - Open Edition
      • Enable anonymous login for a launchpad
      • Enable self-registration in a launchpad
    • DXP Cookbook
    • Release Notes
  • Neptune DXP - Open Edition
  • Installation package
22 LTS 21
Neptune DXP Documentation
Neptune DXP - Open Edition · 21

Installation package

https://community.neptune-software.com/documentation/planet-9-install-and-configure#-planet-9-distributed-files

When you download Neptune DXP - Open Edition for your target platform, the following files are shipped in a ZIP archive:

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