User Interface to register an application

"Cloud Foundry Application registration" screen

129118674955.png

Application details

Application components

Application configuration

Application icon

Tools menu

For self hosted applications, the "Cloud Foundry Direct URL" is replaced with "Direct URL" in the "Components" section.

"Self-hosted application registration" screen

129118686731.png

Application details

Application components

Application configuration

Application icon

Tools menu

"Mobile application registration" screen

126957093387.png

Application details

Application components

Application configuration

Application icon

Tools menu

Parameters table

Parameter

Description

Internal Name

Name for the application. This field is disabled from editing once an application is created and saved. The name of the application is embedded in this field during application creation. Only lowercase alphanumeric characters are allowed and the name must start with a letter.

Display Name

The display name entered during creation of the application is displayed. However, if you want to change it during registration process, you can still edit the field.

Version

Version of the application. This field is disabled from editing. The version of the application is embedded in this field during application creation.

Mendix-based application

Changes to check/uncheck the mendix checkbox is still applicable at this state of development.

Type

Type selected during creation of the application is displayed. This field is disabled from editing.

Infrastructure

Infrastructure selected during creation of the application is displayed. This field is disabled from editing.

State

State of the application.

Description

Edit the description of the application if required. The field is still editable and changes can be made during the registration process.

Edit icon

Change the image if required. The field is still editable and changes can be made during the registration process.

Components

Minimum of one component is mandatory.

Each component must contain a minimum of one endpoint.

Name

Edit names of the components if required.

Only lowercase alphanumeric characters are allowed. Maximum length allowed is 40 characters.

Cloud Foundry Direct URL

Edit/ enter the URL for each of the components for a CF application if required. The URL format must be valid in the format: https://<name>.apps.eu1.mindsphere.io

Direct URL

Edit/ enter the direct URL for each of the components for a self hosted application if required.

Endpoints

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

Click the "Add Endpoints" button to add endpoints.

The "Add" and "Edit" buttons remain disabled if "Name" and "Cloud Foundry Direct URL" do not have data.

Add Endpoint

Path

Start the path name with "/".

Actions

Select the actions for the new endpoint.

By default, all (GET, POST, PUT, DELETE, PATCH) are selected.

Edit Endpoint

Select Endpoint

Select the endpoint from the dropdown menu.

Path

Start the path name with "/".

The fields appear only when an endpoint is selected from the drop-down menu.

Actions

Select the actions for the new endpoint.

By default, all (GET, POST, PUT, DELETE, PATCH) are selected.

Delete Endpoint

Delete Endpoint

Deletes the endpoint.

Configurations (for Cloud Foundry and self hosted applications)

Content-Security-Policy

This field has a defined value. You can change the field values as per requirements. The field is limited to a maximum of 1000 characters.

Cache control

This field has a defined value. You can change the field values as per requirements. The field is limited to a maximum of 255 characters.

Configurations (for Mobile apps 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 of 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 of 255 characters long.

NOTE

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

Currently, it is not possible to add or delete arbitrary key-value pairs in the "Configuration" section.

MindSphere uses strict default values for the content-security-policy and cache control. You can change the values as per requirements but content-security-policy is limited to a maximum of 1000 characters only and the cache-control field is limited to 255 characters.

If the configuration fields are left blank, the application overrides with the default configuration values.