Skip to content

Commit 010f7e6

Browse files
Merge pull request #583 from mulesoft/W-21215932-Update-Mule-runtime-content-CP
W-21215932-Update-Mule-runtime-content-CP
2 parents 676116b + be60f02 commit 010f7e6

9 files changed

Lines changed: 151 additions & 20 deletions

modules/ROOT/pages/_partials/acb-runtime-java.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
//
33
// tag::runtime-java-download[]
4-
You can select any of the supported Mule runtime and Java versions. The IDE saves your version settings to the project's `mule-artifact.json` file.
4+
You can select from locally available Mule runtime and Java versions. The dropdown shows only the Mule runtime versions that are installed on your local disk, including bundled Mule runtime versions that are available immediately after installation. The IDE saves your version settings to the project's `mule-artifact.json` file. Bundled Mule runtime versions enable instant project opening and design. To install additional Mule runtime versions, use the `MuleSoft: Install Runtime` command.
55
// end::runtime-java-download[]
66
//
77
//
@@ -19,7 +19,7 @@ To set default Mule runtime and Java versions for the projects you create, see x
1919

2020
//
2121
// tag::runtime-java-notification[]
22-
The IDE provides a notification if it is necessary to download the selected Mule runtime or Java version for the project. Mule runtime downloads to `${user.home}/AnypointCodeBuilder/runtimes`, and the selected Java version downloads to `${user.home}/AnypointCodeBuilder/java`.
22+
Projects open instantly using the bundled Mule runtime versions. The IDE provides a notification only if you must download a specific Mule runtime version or Java version for running or debugging your application. The Mule runtime versions download to `${user.home}/AnypointCodeBuilder/runtimes`, and the selected Java version downloads to `${user.home}/AnypointCodeBuilder/java`.
2323
// end::runtime-java-notification[]
2424
//
2525

modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ MuleSoft hosts this control plane within Canada (North America) data centers.
4545
+
4646
MuleSoft hosts this control plane within Japan (APAC) data centers.
4747

48-
Anypoint Platform hosts deployment targets for managed runtimes and related data, including data and metadata about your Mule implementations.
48+
Anypoint Platform hosts deployment targets for managed Mule runtime versions and related data, including data and metadata about your Mule implementations.
4949

5050
To change the host from the default (US), see xref:start-acb.adoc#change-clouds[Set the Desktop IDE to a Different Control Plane].
5151

modules/ROOT/pages/int-create-integrations.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,13 @@ Partial searches are accepted.
8787
====
8888
. Select a *Mule runtime* and *Java* version.
8989
+
90+
The dropdown shows only the Mule runtime versions that are installed on your local disk, including bundled Mule runtime versions that are available immediately after installation. By default, the latest bundled Mule runtime version (Java 17 compatible) is selected. For Java 8 projects, select Mule runtime version 4.8 (Java 8 compatible, reduced).
91+
+
9092
//Info about downloads and versioning:
9193
include::anypoint-code-builder::partial$acb-runtime-java.adoc[tags="runtime-java-download;runtime-version-note;runtime-java-defaults"]
9294
. Click *Create Project*.
9395
+
94-
//Info about download notifications and location:
95-
include::partial$acb-runtime-java.adoc[tags="runtime-java-notification"]
96+
Your project opens instantly using the bundled Mule runtime versions. No Mule runtime download is required to start designing your integration. If you need a specific Mule runtime version for running or debugging, you can install it later using the `MuleSoft: Install Runtime` command. See xref:int-versions.adoc#install-additional-runtimes[Install Additional Mule Runtime Versions].
9697

9798
When you create an integration project from scratch or if your project from Exchange does not contain a flow structure (Flow, Subflow, or Error handling component), the canvas provides the option to create one. Otherwise, the canvas generates a graphical representation of the imported asset's components that you can use to start your configuration.
9899

modules/ROOT/pages/int-versions.adoc

Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,39 @@ include::reuse::partial$java8-eoss-banner.adoc[tag="java8-eoss"]
44
//used in procedures::open-project: Open your implementation or integration project//
55
Set Mule runtime engine (Mule), Java, and connector versions to use in your projects.
66

7-
* <<default-versions, Default versions>>: Set default Mule and Java versions to display in version drop-down menus.
7+
Anypoint Code Builder includes bundled Mule runtime versions that enable you to open and design projects instantly without mandatory Mule runtime downloads. The IDE uses these bundled Mule runtime versions for editing and DataSense. Exact Mule runtime versions are only required when you run or debug your applications.
8+
9+
* <<bundled-runtimes, Bundled runtimes>>: Learn about the Mule runtime versions included with Anypoint Code Builder.
10+
11+
* <<default-versions, Default versions>>: Set default Mule and Java versions to show in version dropdown menus.
812
913
* Project-level versions: Set versions to use in a specific project.
1014
** For Mule and Java versions, see <<project-version-mule-java>>.
11-
** For connector versions, see <<project-versions-connectors>>.
15+
** For connector versions, see <<project-versions-connectors>>.
16+
17+
* <<install-additional-runtimes, Install additional runtimes>>: Download specific Mule runtime versions when needed for run or debug operations.
18+
19+
[[bundled-runtimes]]
20+
== Bundled Mule Runtime Versions
21+
22+
Anypoint Code Builder includes two bundled Mule runtime versions that are available immediately after installation:
23+
24+
* **Mule 4.8 (Java 8 compatible)**: A minimal Mule runtime version bundle compatible with all Java 8-based Mule 4.4 and later projects. This Mule runtime version is used for design-time activities with Java 8 projects and serves as the default fallback for legacy applications. You can't use this version to run Mule applications.
25+
26+
* **Latest Runtime (Java 17)**: The most recent supported Mule runtime version (Edge or LTS) bundled with Anypoint Code Builder at the time of release. For example, Mule 4.11. This Mule runtime version supports Java 17 and can be used for both designing and running applications. Projects configured for Mule 4.6, 4.9, and 4.10 are compatible with this bundled Mule runtime version.
27+
28+
The IDE automatically selects the appropriate bundled Mule runtime version based on your project's Java version:
29+
* Java 8 projects use the bundled 4.8 minimal Mule runtime version
30+
* Java 17 projects use the latest bundled Mule runtime version
31+
32+
These bundled Mule runtime versions guarantee that the design service can always start and serve the canvas and design-time needs without requiring runtime downloads. Projects open instantly using these bundled Mule runtime versions. Download a specific Mule runtime version if you want to run or debug your application with an exact version that isn't available locally.
1233

1334
[[default-versions]]
1435
== Select Default Mule and Java Versions
1536

1637
Select the default Mule and Java versions for new implementation and integration projects. The defaults appear in drop-down menus from which you select a version, for example, when creating a project.
1738

18-
Versions not present in the IDE append a message similar to *downloads upon project creation*. Versions that don't support a feature typically append a message, such as *AsyncAPI implementation unsupported* for Mule 4.4.
39+
The dropdown shows only locally available Mule runtime versions, including the bundled ones. Versions that don't support a feature typically append a message, such as *AsyncAPI implementation unsupported* for Mule 4.4.
1940

2041
You can set a different version at the project level (see <<project-version-mule-java>>).
2142

@@ -35,21 +56,29 @@ include::partial$acb-runtime-java.adoc[tags="runtime-java-version-selection"]
3556
[[project-version-mule-java]]
3657
== Select Mule and Java Versions for a Project
3758

38-
Set Mule or Java versions for a specific implementation or integration project from *Project Properties*. You can change versions at any time, but it is important to test your projects with the versions you intend to deploy.
59+
Set Mule or Java versions for a specific implementation or integration project from *Project Properties*. You can change versions at any time, but test your projects with the versions you intend to deploy.
60+
61+
The IDE uses bundled Mule runtime versions to open and edit projects immediately. The design service uses the latest Java-compatible Mule runtime version available locally. Anypoint Code Builder bundles the latest Mule runtime version (for example, 4.11) for Java 17 and a reduced Mule runtime version 4.8 for Java 8. This guarantees that the design service can always start and serve the canvas and design-time needs without requiring runtime downloads.
62+
63+
Because the bundled Mule runtime version is the latest one, you can open and edit any project regardless of its `minMuleVersion` property. The design service uses the latest Java-compatible Mule runtime version available locally for design-time activities. The `minMuleVersion` property in your project's `mule-artifact.json` file is checked only at deployment time. The `minMuleVersion` property specifies the minimum Mule runtime version required to run or deploy the application.
3964

4065
Version settings are important in several scenarios:
4166

4267
* Updating a project to use more current versions
4368
* Switching to a supported version, for example, for a project that you import into Anypoint Code Builder that uses an unsupported version
44-
* Adding a version of Mule or Java that is missing from your project
4569
* Selecting versions of Mule or Java that are compatible with each other
70+
* Specifying exact Mule runtime versions for run and debug operations
71+
72+
When you run or debug an application, the IDE checks if the exact Mule runtime version specified in your project is available locally. If not, you see a warning dialog that allows you to:
4673

74+
* Continue with the latest compatible local version
75+
* Open *Project Properties* to select or download the required Mule runtime version
76+
4777
[NOTE]
48-
Changing the minimum Mule version (`minMuleVersion`) manually can have serious implications. This requires a full test of your application so it works correctly with the target Mule runtime. Newer Mule runtimes turn on feature flags by default. See xref:mule-runtime::feature-flagging.adoc[]. This can change behavior that was fixed in later versions. Your application can rely on behavior that was later corrected or on a previous issue. Prefer changing the Mule version through *Project Properties*, and always run full regression tests after any version change.
78+
Changing the minimum Mule version (`minMuleVersion`) manually can have serious implications. This requires a full test of your application so it works correctly with the target Mule runtime version. Newer Mule runtime versions turn on feature flags by default. See xref:mule-runtime::feature-flagging.adoc[]. This can change behavior that was fixed in later versions. Your application can rely on behavior that was later corrected or on a previous issue. Prefer changing the Mule runtime version through *Project Properties*, and always run full regression tests after any version change.
4979

5080
When a Mule or Java version isn't set for a project, the IDE's canvas and notifications provide a *Set version* button that opens the *Project Properties* tab. You can also navigate directly to the *Project Properties* tab.
5181

52-
5382
[[project-versions-from-properties]]
5483
To select Mule and Java versions for a project:
5584

@@ -85,3 +114,32 @@ include::partial$acb-runtime-java.adoc[tags="open-project-properties-menu"]
85114
image::int-project-properties-connectors.png["Connector versions in Project Properties tab"]
86115
. Select connector versions. You can update Exchange connector versions for compatibility with your project's Mule runtime and Java versions.
87116

117+
[NOTE]
118+
====
119+
Connector compatibility is checked against the selected Mule runtime and Java versions. Compatibility issues appear after you apply changes in *Project Properties*.
120+
====
121+
122+
[[install-additional-runtimes]]
123+
== Install Additional Mule Runtime Versions
124+
125+
Bundled Mule runtime versions enable instant project opening and design. If you need specific Mule versions for running or debugging your applications, install these additional versions.
126+
127+
To install a specific Mule runtime version:
128+
129+
. Open *Command Palette* by pressing Cmd+Shift+P on Mac, or Ctrl+Shift+P on Windows.
130+
. Run the command:
131+
+
132+
[source,command]
133+
----
134+
MuleSoft: Install Runtime
135+
----
136+
+
137+
. Select the Mule runtime version to install.
138+
+
139+
The IDE downloads the selected Mule runtime version to `${user.home}/AnypointCodeBuilder/runtimes`.
140+
141+
[NOTE]
142+
====
143+
The dropdown in project creation and *Project Properties* shows only locally available Mule runtime versions. After installing additional Mule runtime versions, they appear in these dropdowns for future use.
144+
====
145+

modules/ROOT/pages/ref-acb-commands.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,13 @@ MuleSoft: Develop an Integration
6969
MuleSoft: Download Mule Runtime and Java Versions
7070
----
7171

72+
* Install a specific Mule runtime version for use with your projects. This command queries available Mule runtime versions and downloads the selected version to your local Mule runtime directory. See also, xref:int-versions.adoc#install-additional-runtimes[Install Additional Mule Runtime Versions].
73+
+
74+
[source,command]
75+
----
76+
MuleSoft: Install Runtime
77+
----
78+
7279
* Export a shareable JAR file that contains an integration or implementation project. Both types of projects are Mule applications. See xref:int-export-mule-project.adoc#shareable[Export to a Shareable JAR File].
7380
+
7481
[source,command]

modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33

44
include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
55

6-
Anypoint Code Builder bundles a version 4 instance of Mule runtime engine (Mule) to run your integrations and implementations.
6+
Anypoint Code Builder includes bundled Mule runtime versions that enable instant project opening and design. When you run or debug applications, the IDE checks for the exact runtime version specified in your project. If the exact version isn't available locally, error dialogs appear to help you resolve the issue.
77

88
Don't change the default locations of Mule. If you receive an error that Mule isn't found or installed, configure the Mule Home path.
99

10-
If configuring your Mule runtime, ensure you're defining the `mule.homeDirectory` property.
10+
When you configure Mule runtime, ensure you define the `mule.homeDirectory` property.
1111

1212
[NOTE]
1313
The `mule.runtime.muleRuntimesDirectory` and `mule.runtime.muleHome` properties are legacy configurations no longer used.
1414

15-
* *Mule runtimes*: The Mule runtimes are located in the `{yourACBHome}/runtimes` directory.
15+
* *Mule runtime versions*: The Mule runtime versions are located in the `{yourACBHome}/runtimes` directory.
1616
+
1717
Default value: `/Users/{user}/AnypointCodeBuilder/runtime`.
1818
@@ -62,18 +62,83 @@ image::troubleshoot-download-java-notification.png["Notification showing a reque
6262

6363
Instead of using this feature, you can use the command *Download Mule Runtime and Java Versions*. See xref:anypoint-code-builder::int-versions.adoc[].
6464

65+
== Mule Runtime Version Not Defined
66+
67+
The error *Mule runtime version not defined* occurs when your project doesn't specify a Mule runtime version in the project's `mule-artifact.json` file.
68+
69+
To resolve this issue:
70+
71+
. Click *Open Project Properties* in the error dialog, or run the command `MuleSoft: Open Mule Project Properties`.
72+
. In *Project Properties*, select a Mule runtime version.
73+
. Click *Apply*.
74+
75+
== Java Version Not Defined
76+
77+
The error *Java version not defined* occurs when your project doesn't specify a Java version in the project's `mule-artifact.json` file.
78+
79+
To resolve this issue:
80+
81+
. Click *Open Project Properties* in the error dialog, or run the command `MuleSoft: Open Mule Project Properties`.
82+
. In *Project Properties*, select a Java version.
83+
. Click *Apply*.
84+
85+
== Mule Runtime Version Not Found (Compatible Version Available)
86+
87+
The error *Mule runtime [version] not found* occurs when you try to run or debug an application, but the exact Mule runtime version specified in your project isn't available locally. However, a compatible local version is available.
88+
89+
To resolve this issue, you have two options:
90+
91+
* **Continue with compatible version**: Click *Continue* to use the latest local compatible version. The dialog shows which version to use.
92+
* **Select a different version**: Click *Open Project Properties* to select a different local Mule runtime version or install the exact version using the `MuleSoft: Install Runtime` command.
93+
94+
== Mule Runtime Version Not Found (No Compatible Version)
95+
96+
The error *Mule runtime [version] not found* occurs when you try to run or debug an application, but the exact Mule runtime version specified in your project isn't available locally, and no compatible version is available.
97+
98+
To resolve this issue:
99+
100+
. Click *Open Project Properties* in the error dialog.
101+
. In *Project Properties*, either:
102+
** Select a locally available Mule runtime version from the dropdown, or
103+
** Use the `MuleSoft: Install Runtime` command to download the required version.
104+
. Click *Apply*.
105+
106+
== Java Version Not Found
107+
108+
The error *Java [version] not found* occurs when you try to run or debug an application, but the Java version specified in your project isn't available locally.
109+
110+
To resolve this issue:
111+
112+
. Click *Open Project Properties* in the error dialog.
113+
. In *Project Properties*, either:
114+
** Select Java 17 (or another available version) from the dropdown, or
115+
** Use the `MuleSoft: Download Mule Runtime and Java Versions` command to download the required Java version.
116+
. Click *Apply*.
117+
118+
== Mule Runtime and Java Version Not Found
119+
120+
The error *Mule runtime [version] and Java [version] not found* occurs when you try to run or debug an application, but both the Mule runtime and Java versions specified in your project aren't available locally.
121+
122+
To resolve this issue:
123+
124+
. Click *Open Project Properties* in the error dialog.
125+
. In *Project Properties*:
126+
** Select a locally available Mule runtime version and Java 17 (or another compatible version) from the dropdowns, or
127+
** Use the `MuleSoft: Install Runtime` command to download the required Mule runtime version, and use the `MuleSoft: Download Mule Runtime and Java Versions` command to download the required Java version.
128+
. Click *Apply*.
129+
65130
[[reinstall-mule-runtime]]
66131
== Reinstall Mule Runtime
67132

68133
If your Mule runtime installation becomes corrupted, you can force a reinstallation:
69134

70135
. Close Anypoint Code Builder.
71-
. Navigate to your Mule runtimes directory: `${user.home}/AnypointCodeBuilder/runtimes`.
136+
. Navigate to your Mule runtime directory: `${user.home}/AnypointCodeBuilder/runtimes`.
72137
. Remove or rename the folder for the runtime version you want to reinstall (for example, `mule-4.6.0`).
73138
. Open Anypoint Code Builder.
74139
. Select the Mule runtime version from *Project Properties*.
75140
+
76141
The IDE downloads and reinstalls the selected version. For details on selecting versions, see xref:int-versions.adoc#project-version-mule-java[Select Mule and Java Versions for a Project].
77142

78143
[NOTE]
79-
Your projects and other installed runtimes are not affected.
144+
Your projects and other installed Mule runtime versions are not affected.

modules/ROOT/pages/troubleshooting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,5 @@ Remove any folders starting with `salesforce.mule-dx-` or `mulesoftinc.mule-dx-`
169169

170170
[NOTE]
171171
--
172-
This procedure removes downloaded Mule runtimes and Java versions. You can re-download them after reinstalling.
172+
This procedure removes downloaded Mule runtime versions and Java versions. You can re-download them after reinstalling.
173173
--

modules/ROOT/pages/tut-af-design-am-flights-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ image::acb-mulesoft-in-activity-bar.png["MuleSoft icon in the VS Code Activity B
3535
+
3636
image::design-api-1.png["Link to Design an API in the MuleSoft panel"]
3737
+
38-
If you receive the error *Mule DX API Component was not installed*, wait for Mule runtime to load and for background processes to complete. To monitor background processes, see xref:troubleshoot-loading-errors.adoc[].
38+
If you receive the error *Mule DX API Component was not installed*, wait for Mule runtime engine to load and for background processes to complete. To monitor background processes, see xref:troubleshoot-loading-errors.adoc[].
3939
. Configure your API specification project using these values:
4040
+
4141
[%header,cols="1a,1a"]

0 commit comments

Comments
 (0)