Skip to content

Adding an application with Step by Step (advanced configuration)

In DevOps Cockpit, you can add an application with the advanced configuration.

User Interfaces of "General Application Settings"

Application Settings: You can select the type of application and infrastructure.

general-app-settings

Parameter Description
Application Type You can create three types of applications: Standard, Operations Insight Plugin and API.
Infrastructure Two types of infrastructures are available: Self-hosted and MindSphere Cloud Foundry.
Note:
MindSphere Cloud Foundry infrastructure is available to host your application in MindSphere platform. To activate this infrastructure, you need to buy this add-on from IIoT Data Package.

General Information: You can enter the application field parameter for the configuration.

general-app-information

Parameter Description
Display Name Enter the name of the application that you want to display in DevOps Cockpit. This field does not support any special characters and it is limited to 50 characters only.
Internal Name By default, the "Internal Name" is auto-filled by entering the display name in lower case and without special characters. The internal name is 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 By default, "v1.0.0" version is auto-filled in the version field and it can be changed as per the requirement. 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 letters for naming versions is not allowed. However, it supports the following special characters:
- '#'
- '$'
- '.'
- ';'
- '+'
- '-'
- '_'
- '@'
In the version field in DevOps Cockpit, if there are any special characters (except "@", "."), the provisioning workflow will be failed.
For all the applications, the following format needs to be followed: v<version>.<revision>.<patch>-<label(optional)>, for example v1.0.0
- <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 This check box is used to notify the users that a Mendix license is needed to run the app.
Description Add a description for the application. This is an optional field. This provides information about the application and will be visible to the user.
Icon Icon of the application is displayed in DevOps Cockpit and Launchpad.
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.
Access Details
Content-Security-Header Configuring Content Security Policy header, helps to prevent possible attacks and execution of malicious content or code, and makes your application more secure. For more information, see Configuring Content Security Policy.
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 With Cache control, each cache will be revalidated before using a cached response to capture the uncacheable responses.
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.
Plugin Settings With plugin settings, you can directly configure your application into Operations Insight. To configure your application with "Plugin Settings", refer to Plugin Settings in DevOps Cockpit.
Note:
This feature is only applicable for "Operations Insight" type of applications.

Note

For API application, there are no default configurations in "Access details" section.

Component details: You can enter the component details of the application. You can add new component endpoints for the application.

component-details

Parameter Description
Components Details Adding components to your application are used to structure your application and register it accordingly in the MindSphere Gateway. However, it is mandatory to have a minimum of one component with one endpoint for an application. Add at least one component to your application, if the application is a self hosted based application.
Endpoints The application will be added with the default endpoint. You can add multiple new endpoints for your application.
Name Enter the name of the component. The following conditions hold while naming a component:
- It should not include alphanumeric and '-', '_', '.' special characters.
- A maximum of 40 characters are allowed.
- The "Name" field of the application in the component tab supports only lower-case letters.
Url Enter the direct URL for each of the components for an application. The URL format should be valid in the format and not malicious: https://apps.example.com/<ContextPath>.

Dependencies: MindSphere allows a user to develop backend applications, to support single or multiple UI apps. These applications are called API type apps. The developer can re-use the functional logic in multiple applications.

You can configure the internal or external the API dependencies for the application by adding the API dependency. For more information about how to add API dependency, see Adding API dependency to the application.

dependencies-api

Note

For API type applications, dependencies are not supported.

Authorization Information: You can add the authorization information for the application. For more information about "Authorization Information", see Authorizing the application Roles and Scopes in DevOps Cockpit.

authorization-information-ui

Parameter Description
Application Scopes You can add your application scopes under the "Application Scopes" section. By default, an admin role with a scope is created for an application. You can create the scopes, apart from the default scope.
Third Party App Roles You can add the dependent third party API role and assign it to the application role under the "Third Party API Roles" section.
MindSphere API Roles You can add your application scope to the MindSphere specific API roles under the "MindSphere API Roles" section.
Add a Role You can add a new customized role for the application and add scope(s) for the newly added role.

Note

  • By default, the application scope with "Admin" role is automatically assigned to a newly created application.
  • Once you create another role and scope, you can delete the default role and scope.
  • At least, one role and scope is required to access the application.
  • Adding new roles and scopes is not possible to the application which is registered and provisioned to test environments.

Procedure

To create an application with advanced configuration, follow these steps:

  1. In DevOps Cockpit "Application" tab, click “Create App step by step”.
  2. In "Application Settings" tab, select the type "Application" and "Infrastructure" and then click "Next".
  3. In "General Information" tab, enter the application field parameters and upload the "Application Icon" and then click "Next".
  4. In "Components Details" tab, enter the component field parameters and click "Next".
  5. In "Dependencies" tab, add the API dependency and click "Next" (optional).
  6. In "Authorization Information" tab, assign "Roles" and "Scopes" for the application and click "Next" (optional).
  7. In "Application creation almost complete" dialog, select the possible actions and click "Save".

    application-creation-almost-complete

    ① Registers the application and provision it to development environment

    ② Provisions the application to test(s) environment

    ③ Assigns the application role to the application created user

    ④ Opens the application in the new browser tab for testing

  8. In "Application Lifecycle Management", the application will be automatically registered to the development environment and provisioned to the test environment(s).

  9. After the application is tested in the provisioned test environment(s), select "Prepare Release" and configure the "App Credentials" for the application and then click "Submit".

    Note

    With "None" App Credentials, you are not allowed to perform all CRUD operations.

  10. After the application is set to "Ready for Production", enter the Developer Admin's "Primary Email" and "Alternate Email".

  11. Read and accept MindSphere agreement and then click "Submit".

set-to-ready-in-production

Note

Result

The application is successfully provisioned to the Production Environment and assigned to the Operator. Click "Assign to operator" to view the assigned operator details and status.

created-adv-application

① Allows to assign application to other Operator (Internal or External)

② Refresh to update the application assign status

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.


Last update: September 2, 2022