Introduction 1 Prerequisites 2 Application Lifecycle in MindSphere 3 System Manual User interfaces "Developer Cockpit" 4 User rights in "Developer Cockpit" 5 Workflow of Developer Cockpit 6 Develop applications 7 Assign Roles & Scopes 8 Register applications 9 Hand over applications to operators 10 09/2018 V1801.K0910
Legal information Warning notice system This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. DANGER indicates that death or severe personal injury will result if proper precautions are not taken. WARNING indicates that death or severe personal injury may result if proper precautions are not taken. CAUTION indicates that minor personal injury can result if proper precautions are not taken. NOTICE indicates that property damage can result if proper precautions are not taken. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens products Note the following: Trademarks WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. Siemens AG Division Digital Factory Postfach 48 48 90026 NÜRNBERG GERMANY V1801.K0910 P 09/2018 Subject to change Copyright Siemens AG 2018. All rights reserved
Table of contents 1 Introduction...7 2 Prerequisites...9 3 Application Lifecycle in MindSphere...11 4 User interfaces ""...13 4.1 User interface "Dashboard"...13 4.2 User interface "Promoted Apps"...14 4.3 User interface "Roles & Scopes"...15 5 User rights in ""...17 6 Workflow of...19 7 Develop applications...21 7.1 Applications for MindSphere...21 7.2 Create a new application...22 7.3 Components for applications...24 7.4 Create a new version of an application...25 7.5 Configure a newly created application...28 8 Assign Roles & Scopes...29 8.1 Management of Roles & Scopes...29 8.2 Assign Roles and Scopes...31 9 Register applications...35 9.1 Application registration...35 9.2 Register an application in MindSphere...38 10 Hand over applications to operators...41 10.1 Application handover...41 10.2 Manage uploads of an application...42 10.3 Approve upload of an application...46 10.4 Application upload in progress...50 10.5 Configure service plan...51 10.6 Manage service plan uploads...55 10.7 Assign to an Operator...58 System Manual, 09/2018, V1801.K0910 3
Table of contents 4 System Manual, 09/2018, V1801.K0910
is a system tool from MindSphere, the industrial IoT platform from Siemens. allows you to generate working skeleton code with appropriate project structure and build tool integration for your micro-service based web application. You can also register and deregister your application in MindSphere. System Manual, 09/2018, V1801.K0910 5
6 System Manual, 09/2018, V1801.K0910
Introduction 1 MindSphere enables developers to create and manage applications within the MindSphere platform and use various services. The MindAccess Developer Plan includes Cloud Foundry Compute Resources for developing applications using various buildpacks. Overview of helps developers to manage their applications developed on the platform. In the MindSphere context, an application may consist of multiple Cloud Foundry apps with multiple endpoints. To make the distinction easier, we are using the term component for Cloud Foundry applications and applications developed (with CF) for combining one or more components. The applications need to be registered on the platform in order to be accessible from outside. The platform service that manages these registrations is called MindSphere Gateway and only registered applications are allowed to be accessed. Components define the locations and paths of the microservices implementing the web application or service. Functionalities The path values need to match at MindSphere Gateway and the corresponding component. See the Developer Documentation for possible mappings of gateway to component paths. provides the following functionalities: Create, configure and transfer applications to the production environment. An overview about developed applications. Configure applications, e.g. "Application Icon" or "Display Name". Secure applications at the endpoint level. Bring applications to the Launchpad of MindAccess Developer Plan. Manage application specific roles. Promote and transfer applications from developer to productive environment. MindSphere uses a positive security concept that supports developers by securing their applications using application specific roles, referred to as "Scopes" in this document. Developers need to define at least two application specific roles and an application specific scope in order to protect their application from being accessed by users without access rights or privileges. System Manual, 09/2018, V1801.K0910 7
Introduction Start screen 1 2 3 4 MindSphere Home button Navigator Application handler Available applications 8 System Manual, 09/2018, V1801.K0910
Prerequisites 2 The following prerequisites must be fulfilled in order to access : MindAccess Developer Plan WebKey Login Role: mdsp:core:developer or mdsp:core:developeradmin assigned via the MindSphere component User Management System Manual, 09/2018, V1801.K0910 9
Prerequisites 10 System Manual, 09/2018, V1801.K0910
Application Lifecycle in MindSphere 3 The Application Lifecycle depicts the beginning from the development of an application until the release of an application. It defines all steps and processes that can be assigned to Operator Cockpit. The Application Lifecycle describes the correlation between the developer and the operator. Therefore, the Application Lifecycle structures the processes into the following plans: Developer Plan Operator Plan IoT Value Plan The following graphic depicts the Application Lifecycle with the respective processes: System Manual, 09/2018, V1801.K0910 11
Application Lifecycle in MindSphere Develop app Register and test app Sell and provide app Buy and use app MindSphere Upload Public selling Editor of choice Assign Operator Cockpit Launchpad Update Private selling MindAccess DevOps Plan MindAccess IoT Value Plan 1 2 3 4 Develop an application: Develops the application in the developer's local environment Register and test the application: Implements the application in the Tests the application in the Development test system Assigns the application to operators Sends the binaries of a registered application to the Application Repository Sell and provide the application: Operator downloads the application from the Application Repository and deploys the application using the Cloud Foundry Command Line The operator deploys the application to the productive system The operator sets a route to the tenant Operator Cockpit publishes the application in the MindSphere Store Operator Cockpit provisions the application in a customer Launchpad Buy and use the application: Users can make a subscription for applications from the MindSphere Store Users can access the application via the Launchpad 12 System Manual, 09/2018, V1801.K0910
User interfaces "" 4 4.1 User interface "Dashboard" The "Dashboard" gives you a quick overview of all available applications in. The following graphic shows the dashboard of the. Dashboard start screen 1 2 3 4 Navigator tabs Application handler Available applications Search options System Manual, 09/2018, V1801.K0910 13
User interfaces "" 4.2 User interface "Promoted Apps" Symbols Symbol The following table shows the buttons of the start screen: Description Filter the search based on the state of the application. The states available are: In development Upload initiated Ready to upload Upload in progress Failed Search the application by name. Parameters Parameter State Version Registration Description Available progress of the applications: Only registered applications In development Upload initiated Ready to upload Upload in progress Failed Version of the application If registered or unregistered 4.2 User interface "Promoted Apps" The "Promoted Apps" screen shows all applications that can be handed over to the operator. 14 System Manual, 09/2018, V1801.K0910
User interfaces "" 4.3 User interface "Roles & Scopes" Promoted Apps screen 1 2 3 Navigation tabs Apps displayed in the Promoted Apps area Search application field 4.3 User interface "Roles & Scopes" The "Roles and Scopes" screen can assign the required scopes and roles to application specific roles, for a selected application. System Manual, 09/2018, V1801.K0910 15
User interfaces "" 4.3 User interface "Roles & Scopes" Roles and Scopes screen 1 2 3 Navigation tabs Selection of an application Table display of the Scopes / Core Role assigned for the selected application 16 System Manual, 09/2018, V1801.K0910
User rights in "" 5 is available with two different user roles, Developer and Developer Admin, that enable different functionalities. The key difference between a Developer and a Developer Admin is the ability to transfer the developed application to the MindSphere Application Repository and assign the application to one or more operator accounts. Developer Within the "Developer" role, the following functionalities are available: Management of applications. Management of application versions. Registration and deregistration of applications. Management of application roles. Preparation of binary and metadata uploads. Developer Admin Within the "Developer Admin" role, the following functionalities are available: All developer functions as described in the section above. Approval of prepared uploads to the Application Repository. Assignment of uploaded applications to an operator. Quick view of roles The following table gives a quick view of the assignment of roles: Role Right Developer Developer Admin Create applications Assign roles and scopes Register applications Deregister applications List all applications Manage uploads (upload artifacts, save metadata) Promote applications Manage assignments Delete applications System Manual, 09/2018, V1801.K0910 17
User rights in "" 18 System Manual, 09/2018, V1801.K0910
Workflow of 6 The following schema describes the communication between the Developer and the Operator using and Operator Cockpit. MindSphere - Develop applications and hand over from Operator to Customer Create a new application Add roles and scopes and register application Upload meta data and application binaries Hand over to operator Operator Cockpit Application on productive system Available in "My Applications" Accept handover Customer Launchpad Application available on Launchpad 1 2 Create application Add roles and scopes and register application: Use to create a new application. Add roles and scopes for the created application. Use the for application registration. Upload meta data and application binaries to MindSphere: Upload meta data like the mainfest file. Enter binded service names. Upload zip-file with application binaries. System Manual, 09/2018, V1801.K0910 19
Workflow of 3 4 5 6 Hand over application to Operator Cockpit: Assignment of successfully uploaded application data to a known operator. Operator accepts the assignment in Operator Cockpit. Accept handover: After acceptance is received from the operator, the developer assigns the application to an operator. Application will be deployable for an operator inside Operator Cockpit. Deployment in productive system: In Operator Cockpit, the operator deploys application to the productive system. Operator can publish application to MindSphere Store, or provision application to known customers. Provisioning to Customer: In Operator Cockpit, the operator provisions the application to the known customers. If the operator has published an application to the MindSphere Store, a subsrciption notification to provision to a new customer is received. 20 System Manual, 09/2018, V1801.K0910
Develop applications 7 7.1 Applications for MindSphere Cloud Foundry supports MindSphere applications that consist of one or more micro services. Each micro service is represented by an Cloud Foundry application that all must be run within a single Cloud Foundry Space. Currently, MindSphere supports only Cloud Foundry applications that have a single Cloud Foundry Manifest configuration. You are required to use <appname>-<tenantname> for Cloud Foundry hosts in Cloud Foundry Manifest files. You can also use <tenantname> or random routes in Cloud Foundry Manifest files. Start screen 1 2 3 MindSphere Home button Enter field parameters Save and Reset Buttons System Manual, 09/2018, V1801.K0910 21
Develop applications 7.2 Create a new application Parameters table Parameter Name Display Name Version Landing Page Path (Home URL) Description Edit icon Components Name Cloud Foundry Direct URL Endpoints Add Component button Add New Endpoint Path Actions Configurations Key Value Create New Version New Version Description Enter the name for the application with the following conditions: Only lower case alphabets are allowed A maximum of 20 alphanumeric characters are allowed 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. Enter the version of the application. Insert the URL for landing on the page. Add description for the application. Upload an image to represent the application. Enter the name of the component. Enter the URL for the component. The endpoints section will remain disabled untill "Name" and "Cloud Foundry Direct URL" have values. Click the "Add" button to add endpoints. For new application, the "Edit" button will remain disabled since a new application is being added. Add a new row with the parameters "Name", "Cloud Foundry Direct URL" and "Endpoints". Enter the path of the new endpoint. Select the actions for the new endpoint. By default, All (GET, POST, PUT, DELETE, PATCH) will be selected. By default, the configuration key is taken for the cspheader and cache-control. The cspheader header value can be only 1000 characters long. By default, the configuration value is taken for the cspheader and cache-control. Enter the new version number of the application. See also Developer_Documentation (https://developer.mindsphere.io) 7.2 Create a new application These instructions describe how a developer can create new applications. 22 System Manual, 09/2018, V1801.K0910
Develop applications 7.2 Create a new application Procedure 1. Login to. 2. Click on Create new Application. 3. Enter the field parameters, as per the following conditions: "Name": Used later in the URL and must be unique for your tenant. "Version": Application Version, should be of the format 1.x.x. The version of the format 0.x.x is not supported. "Display Name": Name that is displayed on Launchpad. This is restricted to 50 characters only. "Application Type": This section gives a user to select an application type. The available option types are: UI and API. When you select API type, an API app icon will get autoloaded in the "App icon" section. "Description": Short description about the application. This will be used for Launchpad and subsequent processes. "Application Icon": Upload an icon for the application (recommended resolution of 512x512 is suitable for both high and low resolution screens). System Manual, 09/2018, V1801.K0910 23
Develop applications 7.3 Components for applications 4. Add at least one component to your application. For information on adding components, see Components for applications (Page 24). 5. The configurations will be set up by default with two keys: content-security policy header and cache-control. "cspheader": The header will be set to a default value. You can change if required. The field allows only 1000 characters. "cache-control": The cache control field will be defined with a default value. 6. Save your application. To make the application available, refer Configure a newly created application (Page 28). 7.3 Components for applications Components A Component represents a single micro service but is not limited to this. It is recommended to have one component for each Cloud Foundry application and each component can have multiple endpoints. However, it is mandatory to have a minimum of one component with one endpoint for an application. Depending on the complexity of your application, you can add multiple components. You can add one for the frontend and one for the backend as shown in the following figure: Note The "Name" field for the application name currently supports only lower case letters. Accordingly, name your application in the manifest file, or during the push operation. Otherwise, the automatic registration on an Operator tenant will fail. For adding endpoints, click the button. 24 System Manual, 09/2018, V1801.K0910
Develop applications 7.4 Create a new version of an application You can manage the endpoints by using "Edit" or "Delete" buttons. You can add arbitrary paths including wildcards here except /api, as this is reserved for calling MindSphere APIs from the browser client of your application. The mapping matches URLs using the following rules:? matches one character ** matches zero or more directories in a path a specific path, e.g. /machines a path with wildcard /machines/* a patch with general wildcard /** that matches also zero or more sub paths Examples /machines/drill-? matches machines/drill-1 but also machines/drill-2 or machines/drill-a /monitoring/machines/drill-* - matches all drill-* endpoints in the / monitoring/machines endpoint /machines/**/list matches all list endpoints underneath the /machines path Matching Order The MindSphere Gateway selects the first matching endpoint based on the request URL. Currently there is no proximity matching in place. 7.4 Create a new version of an application Based on one application version it is possible to create a new version by cloning an already existing application. System Manual, 09/2018, V1801.K0910 25
Develop applications 7.4 Create a new version of an application Procedure 1. Open the Dashboard. 2. Click on Create new version. 3. Select an existing application version. 26 System Manual, 09/2018, V1801.K0910
Develop applications 7.4 Create a new version of an application 4. Enter the "New Version" number. 5. Click on "Clone". System Manual, 09/2018, V1801.K0910 27
Develop applications 7.5 Configure a newly created application The new version is created and you can now change the configuration, e.g. modifying endpoints etc. 7.5 Configure a newly created application After you create a new application (Page 22), follow the steps below to make your application available. Configure the application specific Roles & Scopes for your application. For more information on assigning roles, see the chapter Assign roles and scopes to an application (Page 31). Register the application. For more information on registering applications, see Register an application in MindSphere (Page 38). Assign yourself at least one application specific role in order to access it. Note The name and version of the application cannot be changed after its creation. However, you can change the Application Icon, Display Name, Description and endpoint configuration. The configuration of an application can only be changed when it is not registered on the Gateway. An application cannot be registered if it does not have any Roles, since this information needs to be provided to the MindSphere Gateway. Applications and application versions that have been submitted to the Application Repository cannot be changed afterwards. You need to create a new application version in order to make changes and register this new version. 28 System Manual, 09/2018, V1801.K0910
Assign Roles & Scopes 8 8.1 Management of Roles & Scopes Every application in MindSphere needs at least one application specific role and permission. Additionally, if you want to use MindSphere APIs you need to add one or more API specific roles to your application roles in order gain access. The assigned rights are application specific scopes (permissions). These rights are accessible only to certain MindSphere APIs. Some of the examples include: Read acess only. Write access only. Asset management files. Access to certain files, etc. The scopes can be assigned to one or more default application roles. You can find those API specific roles in the Developer Documentation (https:// developer.mindsphere.io) with detailed descriptions and all available scopes. The following roles are available for every application: Admin:The one who has all the administrative privileges. The privileges includes creating new assets, deleting time series data, developing application configurations. User: The one who uses the application. The user will not be able to delete asset or access certain application specific endpoints, that are managed by the administrator. Additional information Every application specific scope is automatically prefixed with the application name. Every role can be found in the MindSphere component "User Management" with the following scheme: mdsp:<tenantname>:<application>.<role> System Manual, 09/2018, V1801.K0910 29
Assign Roles & Scopes 8.1 Management of Roles & Scopes Start screen 1 2 3 Navigation tabs Selection of application Table display of the roles and scopes assigned for the selected application Parameters table Parameter Description Select an application Select the application from the drop down menu. Roles and Scopes are application specific, and not version specific. Scope / Core Role Lists the scope and the core role of the application. admin user Create new scope Scope Name Admin User Add new core role Search Core Roles Admin User If the check box is enabled, the role has already been assigned the admin. If the check box is enabled, the role has already been assigned to a user. Enter the name of the scope. Enable the check box, if the role is to be assigned to the Admin. Enable the check box, if the role is to be assigned to a User. Select a role from the drop down menu. Enable the check box, if the scope is to be assigned to the Admin. Enable the check box, if the scope is to be assigned to a User. Data is displayed on the UI. If applicable, check both based on the role. If applicable, check both based on the scope. 30 System Manual, 09/2018, V1801.K0910
Assign Roles & Scopes 8.2 Assign Roles and Scopes 8.2 Assign Roles and Scopes Procedure to assign Roles and Scopes (default) 1. Click on "Roles & Scopes" tab. 2. Select application from the Select application dropdown. System Manual, 09/2018, V1801.K0910 31
Assign Roles & Scopes 8.2 Assign Roles and Scopes Create new core role 1. Click on the button. 2. Fill the application role name with description in the dialog box. 3. Save the role name. 32 System Manual, 09/2018, V1801.K0910
Assign Roles & Scopes 8.2 Assign Roles and Scopes Create Scope 1. Click on the button. 2. In the "Add Scope" window, enter Scope Name and enable the check box for Admin or User or both, as per requirement. 3. Save the scope. Next steps Assign roles to your user via "User Management", in order to access the application. Register your application. System Manual, 09/2018, V1801.K0910 33
Assign Roles & Scopes 8.2 Assign Roles and Scopes 34 System Manual, 09/2018, V1801.K0910
Register applications 9 9.1 Application registration In order to use any application in the MindSphere environment you will need to register the application. The registration enables an official mapping between your internal Cloud Foundry application and an internet exposed URL. Example URL-Schema: <tenantname>-<applicationname>- <tenantname>.apps.region.mindsphere.io Using this official mapping, users are redirected to the login and the platform provides the application specific permissions for this application based on the application configuration and the Roles of the users. Additionally, the registration is required so that the application appears on Launchpad. The application is only visible to those users who have one of the application specific Roles assigned. System Manual, 09/2018, V1801.K0910 35
Register applications 9.1 Application registration Application registration screen 1 2 3 4 5 Application details Application components Application configuration Application icon Tools menu Parameters table Parameter Name Display Name Version Description Edit icon Components Description Minimum of one component is mandatory. Name for the application. This field will be disabled from editing. The name of the app will be embedded in this field during app creation. Enter the name that you want to display for the application. Version of the application. This field will be disabled from editing. The version of the app will be embedded in this field during app creation. Enter a short description for the application. Upload an image to represent the application. Each component must contain a minimum of one endpoint. Name Cloud Foundry Direct URL Enter the name of the component. Only lowercase alphanumeric characters are allowed. Maximum length allowed is 40 characters. Enter the URL for the component. The URL format should be valid in the format : https:// <name>.apps.eu1-dev.mindsphere.io 36 System Manual, 09/2018, V1801.K0910
Register applications 9.1 Application registration Parameter Endpoints Add Endpoint Description The endpoints section will remain disabled until "Name" and "Cloud Foundry Direct URL" have values. Click the "Add Endpoints" button to add endpoints. Path Start the path name with "/". Actions Edit Endpoint Select Endpoint Select the actions for the new endpoint. By default, all (GET, POST, PUT, DELETE, PATCH) will be selected. Select the endpoint from the dropdown menu. The "Add" and "Edit" buttons will remain disabled if "Name" and "Cloud Foundry Direct URL" do not have data. Path Start the path name with "/". The fields appear only when Actions Select the actions for the new endpoint. an endpoint is selected from the drop down menu. By default, all (GET, POST, PUT, DELETE, PATCH) will be selected. Delete Endpoint Delete Endpoint Configurations cspheader cache-control Deletes the endpoint. This field has a defined value. You can change the field values as per requirements. The field allows a limit upto 1000 characters. The cache control field has default values defined. Note Currently, it is not possible to add or delete arbitrary key-value pairs in the "Configuration" section. MindSphere uses strict default values for the following cobfigurations: The "cspheader" configuration for content security policy The "cache-control" and controlling the cache. However these values can be edited. If the configuration fields are left blank, the application will override with the default configuration values. See also Developer Documentation (https://developer.mindsphere.io) System Manual, 09/2018, V1801.K0910 37
Register applications 9.2 Register an application in MindSphere 9.2 Register an application in MindSphere Procedure 1. Go to the "Dashboard". 2. Search for an application which is in the "In-Development" state. 3. Select the application to view the application details. You can use the search and filtering in the upper right corner if you have many applications. 4. Click on "Register". 38 System Manual, 09/2018, V1801.K0910
Register applications 9.2 Register an application in MindSphere 5. Confirm the Dialog by clicking "Proceed With Registration". 6. Click Back To Home. 7. Search the application on the "Dashboard" and verify that the application is registered. Result It is now possible to access the application via a direct link or Launchpad. If your application does not appear on Launchpad, ensure that your user has the assigned role for this application. You can assign roles via User Management. Note It is only possible to register one version of an application. It is not possible to register another version without deregistering the existing version. You can circumvent this limitation by using different application names. Next steps Go to the Launchpad and open the application for testing. Assign one of your application specific Roles to your users in the MindSphere Component "User Manager". System Manual, 09/2018, V1801.K0910 39
Register applications 9.2 Register an application in MindSphere 40 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10 10.1 Application handover Application handover is the process of transferring new or updated applications to a MindAccess Operator Plan Account. You decide which application you want to make available for productive deployment by uploading it together with additional information to an intermediate Application Repository. The transfer process cannot be withdrawn after the upload. You will be notified via the "" and via email once the transfer of your application has been successful and the application is available to run on the MindAccess Operator Plan Account. Preparation for handover The handover is a threefold process consisting of the following phases: 1. Prepare application upload. This is usually done by the developers. 2. Approve application upload. This is done by the Developer Admin. 3. Assignment of the successfully uploaded application to an operator. The application must be uploaded as a single zipped archive. You need to use a single Cloud Foundry manifest.yml that contains the configuration of all Cloud Foundry applications that are from your application. Note Please use only zip-archives and not any other compression algorithms for bundling your applications. States of handover There are four states in the handover process: 1. In-Development: The first state is the application being in the "In-Development" phase. An application will move to this phase after its creation. The application thereafter needs to be registered. 2. Upload Initiated: This is the second phase of the process. After pushing the binaries into the application, the application will move to this state of initiating the upload. System Manual, 09/2018, V1801.K0910 41
Hand over applications to operators 10.2 Manage uploads of an application 3. Ready-to-upload: This is the third phase of the application handover. An application reaches this phase when its metadata information are submitted succesfully. 4. Upload in progress: This is the last phase before pushing the application to the "Promoted Apps" tab. An application after being ready for uploading submits its requirements for getting approval from the administrator of the requested service plans. You can successfully submit the application for approval only if the application has one role and one scope added in it. Thereafter, the application moves to the last state. 10.2 Manage uploads of an application The upload of the application to the Application Repository for handover to an operator can only be started after your application has been registered. During application registration, additional verification steps would be performed in the background. Prepare release app screen 1 2 3 4 5 Application details Application components Application configuration Application icon Tools menu 42 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.2 Manage uploads of an application Parameters table Parameter Description Name Name of the application. By default, the fields will be Display Name Displayed name of the application. disabled for editing. For verfication purpose, the user Version Version of the application. can check the displayed data. Landing Page Path URL of the application. Description State Components Short summary of the application. State of the application. Name Name of the component. By default, the fields will be Cloud Foundry Direct URL URL of the component. disabled for editing. For verfication purpose, the user Endpoints Click the "View" button to view the endpoints. can check the displayed data. View Endpoint Select Endpoint Select the endpoint from the dropdown menu. Path View the path name with "/". The fields appear only Actions View the actions for the new endpoint. By default, All (GET, when an endpoint is selected from the drop down POST, PUT, DELETE, PATCH) will be selected. menu. Configurations cspheader cache-control This field has a defined value. You can change the field values as per requirements. The field allows a limit upto 1000 characters. The cache control field has default values defined. System Manual, 09/2018, V1801.K0910 43
Hand over applications to operators 10.2 Manage uploads of an application Procedure 1. Click applications which are in the "In-Development" state. 2. Click to start the process of uploading the application. 44 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.2 Manage uploads of an application 3. Browse and upload the zipped archive that contains the binaries for this application. 4. Browse and upload "manifest" in ".yml" format. This will have the configuration for all Cloud Foundry applications which are included in your application. 5. You now have two options: You can continue configuring the service plans and submit. For detailed information refer Configure Service Plan (Page 55). While configuring plans, you can upload the binaries and manifest and can submit the uploads later. In that case the application will be managing the uploads at the backend. The state of the application will change to "Upload Initiated". You can refer to the Manage Service Plan Uploads (Page 55)to know the detailed procedure. Result The application will change its state to "Ready-to-Upload". System Manual, 09/2018, V1801.K0910 45
Hand over applications to operators 10.3 Approve upload of an application Next step After submitting the upload, a user with the Developer Admin role can approve the upload which then triggers the upload to the Application Repository. See also Configure service plan (Page 51) Approve upload of an application (Page 46) 10.3 Approve upload of an application Once a developer completes the uploading of an application, a Developer Admin can approve the same. Approve app screen 1 2 3 4 5 Application details Application components Application configuration Application icon Tools menu 46 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.3 Approve upload of an application Parameters table Parameter Description Name Name of the application. By default, the fields will be Display Name Displayed name of the application. disabled for editing. For verfication purpose, the user Version Version of the application. can check the displayed data. Landing Page Path URL of the application. Description State Components Short summary of the application. State of the application. Name Name of the component. By default, the fields will be Cloud Foundry Direct URL URL of the component. disabled for editing. For verfication purpose, the user Endpoints Click the "View" button to view the endpoints. can check the displayed data. View Endpoint Select Endpoint Select the endpoint from the dropdown menu. Path View the path name with "/". The fields appear only Actions View the actions for the new endpoint. By default, All (GET, when an endpoint is selected from the drop down POST, PUT, DELETE, PATCH) will be selected. menu. Configurations cspheader cache-control This field has a defined value. You can change the field values as per requirements. The field allows a limit upto 1000 characters. The cache control field has default values defined. System Manual, 09/2018, V1801.K0910 47
Hand over applications to operators 10.3 Approve upload of an application Procedure 1. Search for the applications that are in the "Ready to upload" state, and click on any application. 2. Click on. 48 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.3 Approve upload of an application 3. Add an alternate e-mail address that will be used for contact if any problem occurs and as a contact for production usage. 4. Confirm that your application complies with the MindSphere DevOps Guide (https:// mindsphere.io/terms) and other requirements set in the MindSphere Master Agreement or applicable Order Form. System Manual, 09/2018, V1801.K0910 49
Hand over applications to operators 10.4 Application upload in progress 5. Accept the information that submissions to the Application Repository may incur costs if you are over your included limits. 6. Click on. After approving the upload, the application can no longer be changed. If you wish to continue working on this application, then you will need to create a new version of the application. The status of the upload can be seen on the Dashboard. The aim is to minimize the time until the application is released for productive use. Usually this will take a few days and should not exceed 14 days. Developers should consider this period in their planning and refrain from requesting development support. An email notification is sent to the developer as soon as the application is available for productive use. Next steps After successful upload you can assign the application to an operator. You can deregister the application and continue working on a new or different version. 10.4 Application upload in progress Once the application is submitted for app validation, the state of the application will change to "Upload-in-progress". 50 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.5 Configure service plan Upload in progress screen 1 2 3 4 5 Application details Application components Application configuration Application icon Tools menu Passed and failed application states After a tenure of 14 days, the application will move to the next state. If the applicatication is approved, it will be moved to a "Passed" state. If not approved, the application will be in a "Failed" state. The passed applications will be moved to the "Promoted tabs" section while the failed applications will be visible to the user in the "Dashboard". 10.5 Configure service plan Configure all Backing Services that your application requires in order to run. The service name needs to match the exact names in the provided manifest.yml. We need this information as the manifest.yml does not contain the information about the type and size of the Backing Services. System Manual, 09/2018, V1801.K0910 51
Hand over applications to operators 10.5 Configure service plan Configure service plan screen 1 2 Service configuration details Tools menu Parameters table Parameter Binary Manifest Service Service Plan Service name Service List Description Description Browse and upload the binary file. Browse and upload the manifest file. Select the service from the drop down menu. Select the Service plan from drop down menu. Enter a unique name for the service. Displays the list of added services. Short summary of the application. 52 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.5 Configure service plan Procedure 1. Select an application in the "Upload initiated" state, from the "Dashboard". 2. Click "Manage Uploads". 3. Select a service from the "Service" drop down menu. System Manual, 09/2018, V1801.K0910 53
Hand over applications to operators 10.5 Configure service plan 4. Select a service plan from the "Service Plan" drop down menu. Choose "n/a" for User Provided Services. 54 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.6 Manage service plan uploads 5. Enter a service name and click "Add service". Note The Service name must be unique for each of the Service Plan. If you try to enter a Service name that is already existing, a message will be displayed to inform you that the Service name is already present. In such a scenario, you should enter a different Service name. 6. Enter the "Description" and click "Submit". 10.6 Manage service plan uploads If you close the metadata dialog box by entering the binaries and manifest files, you can configure the service plans later and submit thereafter. The allows you to save the entries of the binaries and manifest files once they are uploaded. You can configure the rest of the service plan later. System Manual, 09/2018, V1801.K0910 55
Hand over applications to operators 10.6 Manage service plan uploads Once the uploading is done on clicking "Manage Uploads", the application changes its state to "Upload Initiated" state. Manage uploads screen 1 2 3 4 5 Application details Application components Application configuration Application icon Tools menu Parameters table Parameter Description Name Name of the application. By default, the fields will be Display Name Displayed name of the application. disabled for editing. For verfication purpose, the user Version Version of the application. can check the displayed data. Landing Page Path URL of the application. Description State Components Short summary of the application. State of the application. Name Name of the component. By default, the fields will be Cloud Foundry Direct URL URL of the component. disabled for editing. For verfication purpose, the user Endpoints Click the "View" button to view the endpoints. can check the displayed data. 56 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.6 Manage service plan uploads Parameter View Endpoint Select Endpoint Description Select the endpoint from the dropdown menu. Path View the path name with "/". The fields appear only Actions View the actions for the new endpoint. By default, All (GET, when an endpoint is selected from the drop down POST, PUT, DELETE, PATCH) will be selected. menu. Configurations cspheader cache-control This field has a defined value. You can change the field values as per requirements. The field allows a limit upto 1000 characters. The cache control field has default values defined. Procedure 1. Click applications which are in the "Upload Initiated" state. 2. Click on the button to continue. System Manual, 09/2018, V1801.K0910 57
Hand over applications to operators 10.7 Assign to an Operator 3. Configure the service plans and submit. For detailed information refer Configure Service Plan. 4. Click Submit. Note If your application utilizes Cloud Foundry User Provided Services like access to an AWS S3 bucket outside of MindSphere, you must configure this as well. Additionally, you must add this information in the description. 10.7 Assign to an Operator After successful upload of an application to the Application Repository, it is then possible to assign the application to an operator account. The assignment requires confirmation of the developer and the operator. 58 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.7 Assign to an Operator Assign app to operator screen 1 2 3 4 5 Application icon Application details Application endpoints Application assignment to operator details Tools menu Prerequisites Name of the operator account, here as "operatorname". One contact e-mail address of the operator account for notifications. Developer Admin role. Parameters table Parameter Description Name Name of the application. By default, the fields will be Display Name Displayed name of the application. disabled for editing. For verfication purpose, the user can Version Version of the application. check the displayed data. Landing Page Path URL of the application. Description State Application Endpoints Add Assignment Operator Name Email Field displayed in table Short summary of the application. State of the application. Point of HTTP client at to interact with data resources. Enter operator name if required to add assignment. Add email address to add a new assignment. System Manual, 09/2018, V1801.K0910 59
Hand over applications to operators 10.7 Assign to an Operator Parameter Operator Name Assignment Status Actions Description Name of the operator. The current status of the assignment. Actions to be taken. Procedure 1. Go to Promoted Apps tab. 2. Select your application. 60 System Manual, 09/2018, V1801.K0910
Hand over applications to operators 10.7 Assign to an Operator 3. Enter the name of the operator in the "Operator Name" field. 4. Enter the contact e-mail address. System Manual, 09/2018, V1801.K0910 61
Hand over applications to operators 10.7 Assign to an Operator 5. Click on "Add Assignment". 6. Wait for the operator to acknowledge the assignment. 7. Click on "Confirm". Once an assignment has been completed, you cannot undo this. Therefore, a multi-step workflow is recommended in order to prevent accidental assignments. 62 System Manual, 09/2018, V1801.K0910