Skip to content

Commit 4f10422

Browse files
committed
Update Environment details
1 parent 07bab2c commit 4f10422

1 file changed

Lines changed: 36 additions & 48 deletions

File tree

content/en/docs/deployment/sap-btp/_index.md

Lines changed: 36 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ You can also transport to the required environment from the **Overview** tab of
250250
251251
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/edit-constants.png" class="no-border" >}}
252252
253-
3. In the **Scheduled Events** section, select the scheduled event you want to *Enable* or *Disable* and click **Next**.
253+
3. In the **Scheduled Events** section, select the scheduled event you want to *Enable* or *Disable* and click **Next**. For more information, refer to [Schedules Events](#schedules-events).
254254
255255
### Unbinding and Deleting Service Instances
256256
@@ -290,7 +290,7 @@ The environment details page contains the following tabs:
290290
* [Services](#binding-services) – Cloud Foundry service management
291291
* [Runtime](#runtime-tab) – custom environment variables which define **User-Provided Variables** in SAP Cloud Foundry environment — pre-defined variables can be used to control the behavior of the Mendix Runtime
292292
293-
Open the environment details by clicking details [icon] on an environment on the **Environments** page of the Development Portal. You will also be taken to this page when you successfully deploy your app.
293+
Open the environment details by clicking details [icon] on the **Environments** page of the Development Portal. You will also be taken to this page when you successfully deploy or transport your app.
294294
295295
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/env-details.png" >}}
296296
@@ -313,11 +313,11 @@ The button will change to **Start Application** which you can click to start or
313313
You may need to use this option to stop and start your app after changing one of the settings on this page.
314314
{{% /alert %}}
315315
316-
If you receive an error trying to start the app, please refer to the [App Will Not Start](#willnotstart) section under *Issues*, below.
316+
If you receive an error trying to start the app, refer to the [App Will Not Start](#willnotstart) section below.
317317
318318
#### Change Admin Password
319319
320-
Click **Change Admin Password** to change the password for the administrator account (by default, MxAdmin) in your Mendix app.
320+
Find three dots icon ({{% icon name="three-dots-menu-horizontal" %}}) and click **Change Admin Password** to change the password for the administrator account (by default, MxAdmin) in your Mendix app.
321321
322322
{{% alert color="warning" %}}
323323
The new password will not come into effect until you stop and start your environment.
@@ -329,19 +329,17 @@ Click **View Recent Log** to see recent events written to the log.
329329
330330
#### Delete Environment
331331
332-
**Delete Environment** enables you to delete the environment and, optionally, all its resources: including the app.
332+
**Delete Environment** enables you to delete the environment and, optionally, all its resources, including the app.
333333
334-
You will be asked to confirm that this environment should be removed. You will also be asked to confirm that the resources associated with the environment should also be removed. Note that the default is NOT to remove the resources.
335-
336-
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/delete-environment.png" class="no-border" >}}
334+
You will be asked to confirm that this environment should be removed. You will also be asked to confirm that the resources associated with the environment should also be removed. Note that the default is not to remove the resources.
337335
338336
{{% alert color="info" %}}
339-
If you do not select **Remove resources** in this dialog, the resources will be left in SAP BTP. This could be useful if you want to remove the environment but, for some reason, a resource cannot be removed. In this case, the resources can only be removed individually from within the SAP BTP cockpit.
337+
If you do not select **Remove resources** in the dialog, the resources will be left in SAP BTP. This could be useful if you want to remove the environment but, for some reason, a resource cannot be removed. In this case, the resources can only be removed individually from within the SAP BTP cockpit.
340338
{{% /alert %}}
341339
342340
#### Change Development Mode
343341
344-
Click **Change** to change the **Development Mode** toggle. Set it to Yes if you want the application to run with only prototype security, or completely without security. This is not recommended for acceptance or production environments.
342+
Click **Change** to change the **Development Mode**. Set it to *Yes* if you want the application to run with only prototype security, or completely without security. This is not recommended for acceptance or production environments.
345343
346344
#### Change App URL
347345
@@ -357,19 +355,19 @@ If the app is started or stopped (that is, the environment has been created succ
357355
358356
Use the **Instances** slider to change the number of instances of the app which can run. This allows you to scale the app horizontally to support a large numbers of users, or to improve the app's resilience by allowing it to continue to run if there are any issues with one of the instances.
359357
360-
Use the **Memory per instance** slider to change the amount of memory allocated to each instance of the app ("user's current memory").
358+
Use the **Memory per instance** slider to change the amount of memory allocated to each instance of the app (user's current memory).
361359
362360
Click **Scale Now** to apply the new settings. If the application is running, it will be stopped and restarted to apply the settings. If it is stopped it will not be started automatically; the new settings will be used the next time the application is started.
363361
364-
Click **Reset** to return the values to what they were before the sliders were moved.
362+
Click **Cancel** to return the values to what they were before the sliders were moved.
365363
366364
{{% alert color="info" %}}
367365
You can also make use of the **Application Autoscaler** service on SAP BTP. Mendix provides assistance in setting up the parameters needed to configure application autoscaler. For more information see [Application Autoscaler for SAP Business Technology Platform](/developerportal/deploy/sap-cloud-platform/sap-autoscaler/).
368366
{{% /alert %}}
369367
370368
#### Change License Subscription ID
371369
372-
Click **Change** to change the subscription secret which is the code which registers your production Mendix license to this environment.
370+
Click **Change** to change the **Subscription Secret** which is the code which registers your production Mendix license to this environment.
373371
374372
### Model Options Tab {#model-options-tab}
375373
@@ -379,17 +377,17 @@ This tab displays the application constants and allows you to edit them. It also
379377
You need to restart your app if you change any of these options.
380378
{{% /alert %}}
381379
382-
#### Scheduled Events
380+
#### Scheduled Events {#schedules-events}
383381
384382
You can see the status of each scheduled event. **Currently Enabled** shows the status in the running app. **Enabled** shows that status that will be applied the next time the app is restarted.
385383
386384
To change the state of a scheduled event, select it, and click **Enable** or **Disable** from **Actions** to change the **Enabled** flag.
387385
388386
#### Constants
389387
390-
You can see the value of all the constants used by the app. **Currently Value** is the value in the running app. **New Value** is the value which will be used the next time the app is restarted.
388+
You can see the value of all the constants used by the app. **Current Value** is the value in the running app. **New Value** is the value which will be used the next time the app is restarted.
391389
392-
To change a value, select the constant you want to change and click {{% icon name="pencil" %}} icon.
390+
To change a value, select the constant you want to change and click edit ({{% icon name="pencil" %}}) icon.
393391
394392
### Services Tab {#binding-services}
395393
@@ -403,7 +401,7 @@ There are a number of services which your Mendix app requires. If you unbind any
403401
* Database (PostgreSQL, Hyperscaler Option or SAP HANA schema)
404402
* Connectivity
405403
406-
You should select, bound, and unbound **Services** through **Services** page. Changes made in the SAP BTP cockpit will not be reflected in the Mendix Portal.
404+
You should select, bind, and unbind services through **Services** page. Changes made in the SAP BTP cockpit will not be reflected in the Mendix Portal.
407405
{{% /alert %}}
408406
409407
{{% alert color="info" %}}
@@ -418,15 +416,15 @@ To connect a service in the **Available Services** section, do the following ste
418416
419417
1. Select one or more services (you can search for them by name).
420418
2. Select a **Plan** for each service. This must be a plan which is part of your quota for this space.
421-
3. Select a JSON **File** to upload if you need to add extra configuration.
422-
4. Click **Connect Selected Services**.
419+
3. Select a JSON file to upload if you need to add extra configuration.
420+
4. Click **Connect Selected Services**. You can also **Review your Services** before restarting your app.
423421
424422
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/service-connect.png" class="no-border" >}}
425423
426-
The services you have selected will be added as **Services To Be Bound**. Now, you can upload JSON **File** with a configuration that will be applied to the service binding.
424+
The services you have selected will be added as **Services To Be Bound**. Now, you can upload JSON file with a configuration that will be applied to the service binding.
427425
428426
{{% alert color="info" %}}
429-
If you use the **PostgreSQL, Hyperscaler Option** service on SAP BTP, Mendix can create a JSON file for you. See [Running Mendix on PostgreSQL, Hyperscaler Option](#sap-hyperscaler) in this document for more information.
427+
If you use the **PostgreSQL, Hyperscaler Option** service on SAP BTP, Mendix can create a JSON file for you. See [Running Mendix on PostgreSQL, Hyperscaler Option](#sap-hyperscaler).
430428
{{% /alert %}}
431429
432430
{{% alert color="info" %}}
@@ -436,72 +434,64 @@ If you use the **Application Autoscaler** service on SAP BTP, Mendix can create
436434
To upload the JSON **File** for service binding, follow these steps:
437435
438436
1. Select the service in the **Service To Be Bound** section.
439-
2. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) next to the service for which you want to upload the file.
437+
2. Click three-dot icon ({{% icon name="three-dots-menu-horizontal" %}}) next to the service for which you want to upload the file.
440438
3. Select **Add Binding Configuration**.
441-
4. Select the JSON **File** to upload.
442-
5. Click **Save**.
439+
4. Select the JSON **File** to upload and click **Save**
443440
444441
The service bindings will be created with the provided configurations when you restart the application.
445442
446443
{{% alert color="info" %}}
447444
If you receive an error, and the service fails to bind, check all aspects of your SAP account. The error message may not provide full information about, for example, which plans you are allowed to choose for a particular service.
448445
{{% /alert %}}
449446
450-
If you receive an error trying to restart the app, refer to the [App Will Not Start](#willnotstart) section under *Issues* below.
447+
If you receive an error trying to restart the app, refer to the [App Will Not Start](#willnotstart) section below.
451448
452449
#### Unbinding and Removing Services
453450
454451
If you no longer require a service, you can unbind it or remove it from your app.
455452
456453
##### Unbinding a Service
457454
458-
1. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to unbind in the **Bound Services** section.
455+
1. Click three-dot icon ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to unbind in the **Bound Services** section.
459456
2. Select one of the following:
460457
* **Unbind Service** – unbind the service instance and move it to the **Services To Be Bound** section — the service will be bound again next time your app is restarted
461458
* **Delete Service** – unbind the service instance from the application and delete the service instance from your environment
462459
463-
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/service-unbind.png" class="no-border" >}}
464-
465-
3. Confirm by clicking the appropriate button
460+
3. If you wish to **Delete Service**, confirm by clicking the appropriate button:
466461
467-
* **Unbind**
468-
* **Delete & Restart App**
469-
* **Delete** – if you want to unbind more services or do not want the change to happen immediately, then you can choose *Delete*. However, this may leave the app in an unstable state as the service will be deleted from the environment
462+
* **Delete & Restart App** – to confirm the delete action and restart the app
463+
* **Delete** – if you want to unbind more services or do not want the change to happen immediately, then you can choose **Delete**. However, this may leave the app in an unstable state as the service will be deleted from the environment
470464
* **Cancel** – do not delete or unbind this service
471465
472-
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/service-unbind-warning.png" class="no-border" >}}
473-
474466
Once the service is deleted, it is deleted from the app environment and returned to the list of **Available Services**. If the service is unbound but not deleted, it is returned to the list of **Services To Be Bound**, and will be rebound next time the app is restarted.
475467
476-
##### Removing an Unbound Service
468+
##### Removing an Unbound Service {#unbound-services}
477469
478-
1. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to remove in the **Services To Be Bound** section.
470+
1. Click three-dots icon ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to remove in the **Services To Be Bound** section.
479471
480-
2. Select **Remove Service**.
481-
482-
3. Confirm by clicking **Remove**.
472+
2. Select **Remove Service** and confirm by clicking **Remove**.
483473
484474
The service is deleted from the app environment and returned to the list of **Available Services**.
485475
486-
#### Add Binding Configuration
476+
#### Adding Binding Configuration
487477
488478
When a service is in the **Services To Be Bound** section, you can add a new binding configuration, if this is supported by the service and the Mendix Portal.
489479
490-
If you want to change the configuration of a service which is already bound, you will need to unbind the service first, as described above.
480+
If you want to change the configuration of a service which is already bound, you will need to unbind the service first, as described in the [Removing an Unbound Service](#unbound-services) section above.
491481
492-
1. Click **More Options** ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to (re)configure in the **Services To Be Bound** section.
482+
1. Click three-dots icon ({{% icon name="three-dots-menu-horizontal" %}}) next to the service you want to (re)configure in the **Services To Be Bound** section.
493483
494484
2. Select **Add Binding Configuration**.
495485
496-
3. You can either use the Configurator to create your configuration by clicking **Open Editor**, or click **Browse** to upload an existing file as the configuration.
486+
3. You can either use the Configurator to create your configuration by clicking **Open Editor**, or click **Browse** to upload an existing file as the configuration.
497487
498488
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/add-binding-configuration.png" class="no-border" >}}
499489
500490
See the documentation for the service you are configuring for more information.
501491
502492
#### Service Names
503493
504-
The services which are created by the Mendix Portal will be named automatically. You will see these names in the SAP BTP cockpit. The name of the service will normally be **App name** + **_** + **Environment Name** + **_** + **a random 6-character suffix**. All spaces will be removed from the app and environment names. For example, `MyApp_Development_c7sd9q`.
494+
The services which are created by the Mendix Portal will be named automatically. You can see these names in the SAP BTP cockpit. Normally, the name of the service is **App name** + **_** + **Environment Name** + **_** + **a random 6-character suffix**. All spaces will be removed from the app and environment names. For example, `MyApp_Development_c7sd9q`.
505495
506496
However, the maximum length for the service name is 50 characters. If this limit would be exceeded by the name created above, an alternative service name will be used. The format of this is **Environment Name** + **_** + **a random 6-character suffix**. If the Environment name is longer than 43 characters, only the first 43 characters are used.
507497
@@ -530,13 +520,11 @@ You can choose to add supported variables by selecting them from a drop-down lis
530520
531521
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/custom-environment-variables.png" alt="List of custom environment variables" class="no-border" >}}
532522
533-
The variables beginning **DT_** set up Dynatrace. Setting these variables means that the Dynatrace OneAgent is loaded into your environment. You will then receive all J2EE-related metrics from your app. See [Dynatrace OneAgent](https://www.dynatrace.com/support/help/setup-and-configuration/dynatrace-oneagent/) for more information.
523+
The variables beginning with **DT_** set up Dynatrace. Setting these variables means that the Dynatrace OneAgent is loaded into your environment. You will then receive all J2EE-related metrics from your app. See [Dynatrace OneAgent](https://www.dynatrace.com/support/help/setup-and-configuration/dynatrace-oneagent/) for more information.
534524
535525
##### Unsupported Environment Variables
536526
537-
You can also enter other environment variables which can be used to support Mendix features which are in beta. In this case, click **No** for **Supported** and enter the name of the variable as well as its value.
538-
539-
{{< figure src="/attachments/deployment/sap-btp/sap-cloud-platform/custom-environment-variables-unsupported.png" alt="List of custom environment variables" class="no-border" >}}
527+
You can also enter other environment variables which can be used to support Mendix features which are in beta. In this case, click **No** for **Supported?** and enter the **Name** of the variable and **New Value**.
540528
541529
{{% alert color="info" %}}
542530
Only use unsupported environment variables if you know exactly what you are doing. Incorrect values can prevent Mendix Runtime from starting.

0 commit comments

Comments
 (0)