Application parameters

"Create application" screen

138234014347.png

"Back to Overview" button: Opens the dashboard

Enter field parameters

Save" and "Reset" Buttons

Parameters table

Parameter

Description

Type

You can create four types of applications:

  • Standard: The standard types will be hosted in the LaunchPad after handover is done. Such types of applications provide a user interface for its users.

  • Fleet Manager plugin: The created applications will be visible in Fleet Manager.

  • Mobile: The mobile type represents a mobile native application connected to MindSphere. The created application is not shown on the Launchpad.

  • API: The API type represents a API dependency application connected to other types of MindSphere applications. The created application is not shown on the Launchpad.

Infrastructure

Two types are available:

  • MindSphere Cloud Foundry: Applications will be hosted in MindSphere provided Cloud Foundry space.

  • Self hosted: The self hosted applications are third party applications. Developer Cockpit provides a platform to host their applications on private infrastructure of the tenant.

Select one of the given infrastructures to create a Cloud Foundry or a self hosted application.

For mobile type application backend component can be hosted in either of the following infrastructure:

  • MindSphere Cloud Foundry

  • Self hosted

  • The mobile type might not have a backend at all

Display Name

Enter the name that you want to display for the application in the Launchpad.

This field does not support any special characters. The field is limited to 50 characters only.

Internal Name

Used later in the URL and must be unique for your tenant.

Enter the name for the application with the following conditions:

  • The name must start with an alphabet.

  • Only lower-case letters are allowed.

  • A maximum of 20 alphanumeric characters is allowed.

Version

Enter the version of the application.

The version supports alphanumeric string data. Spaces in between the nomenclature format are not supported. A maximum of 30 alphanumeric characters is allowed. Use of capital letter for naming versions is not allowed.

However, it supports the following special characters -

  • #

  • $

  • .

  • ;

  • +

  • -

  • _

  • @

There is a limitation in Operator Cockpit while using special characters. The provisioning workflow fails when there are special characters (except "@", ".") in the version string of any application from Developer Cockpit.

For API applications, the following format needs to be followed:

v<version>.<revision>.<patch>-<label(optional)>

e.g. v1.0.0, v2.1.0-alpha

  • <version> is version, number with range 1-9.

  • <revision> is revision, number with range 0-99.

  • <patch> is patch number, number with range 0-99.

  • <label> is label and optional, case insensitive alphabet.

Mendix-based application

Check the "Mendix-based application" checkbox if you are creating a mendix application.

Description

Add description for the application. This is an optional field. This will be used for Launchpad and subsequent processes.

Edit icon

By default, an application icon is loaded. Upload a different image to represent the application according to your suitability. The recommended resolution of 512x512 is suitable for both high and low resolution screens.

Components

Name

Enter the name of the component.

The following conditions hold while naming a component:

  • Component name must match Cloud Foundry application name.

  • Component name should include alphanumeric and '-', '_', '.' special characters.

  • A maximum of 40 characters are allowed.

Cloud Foundry Direct URL

Enter the URL for the component for a CF application. The URL format should be valid in the format: https://<name>.apps.eu1-dev.mindsphere.io

Direct URL

Enter the direct URL for each of the components for a self hosted application. The URL format should be valid in the format and not malicious: https://avalance.com

Endpoints

The endpoints section will remain disabled until "Name" and "Cloud Foundry Direct URL" have values.

Click the "Add" button to add endpoints of the application.

For new application, the "Edit" button will remain disabled since a new application is being added.

Add Component button

Add a new row with the parameters "Name", "Cloud Foundry Direct URL" and "Endpoints".

Add New Endpoint

Path

Enter the path of the new endpoint.

Actions

Select the actions for the new endpoint.

By default, All (GET, POST, PUT, DELETE, PATCH) will be selected.

Edit Endpoint

Select Endpoint

Select the endpoint from the dropdown menu.

Path

Start the path name with "/".

Actions

Select the actions for the new endpoint. By default, all (GET, POST, PUT, DELETE, PATCH) will be selected.

Delete Endpoint

Delete Endpoint

Deletes the endpoint.

Configurations (for Cloud Foundry and self hosted applications)

Content Security Policy

Key

By default, the first key is the content security policy.

Value

By default, the configuration value is taken for the content security policy. The content security policy header value can be only 1000 characters long, rest of the characters will be discarded.

The field cannot be empty. If you try to save the application by keeping the field empty, backend service will set the default values.

Cache control

Key

The second key defined for configuration is the cache control. The cache control value can be only 255 characters long.

Value

By default, the configuration value is taken for the cache control. The cache control value can be only 255 characters long, rest of the characters will be discarded.

The field cannot be empty. If you try to save the application by keeping the field empty, backend service will set the default values.

Configurations (for Mobile applications only)

Android

Domain validation is performed by Android, and it expects a special file assetlinks.json to be hosted under https://<domain>/.well-known/ folder.

The field value can be only 255 characters long.

iOS

Apple expects a special file apple-app-site-association (AASA) under https://<domain>/.well-known or directly under https://<domain>.

The field value can be only 255 characters long.

API Dependencies (for standard, Fleet Manager plugin and mobile applications)

Add API Dependency

Add the API from the list. Maximum 5 dependencies can be added for an application.

NOTE

API application supports version and revision unlike the other standard application.

Version is a major update, whereas revision is a minor update of current version.

Multiple versions of an API application can be registered at a time, but not multiple revisions of the same version.

e.g. an API application with following 3 versions v1.0.1, v1.1.0, v2.1.1, can register 2 versions. Either (v1.0.1, v2.1.1) or (v1.1.0, v2.1.1), but not (v1.0.1, v1.1.0).