diff --git a/agent-network/1.0/modules/ROOT/pages/af-define-your-agent-network-specification.adoc b/agent-network/1.0/modules/ROOT/pages/af-define-your-agent-network-specification.adoc index bc092f967..e54f950aa 100644 --- a/agent-network/1.0/modules/ROOT/pages/af-define-your-agent-network-specification.adoc +++ b/agent-network/1.0/modules/ROOT/pages/af-define-your-agent-network-specification.adoc @@ -27,7 +27,7 @@ To get started, try one of these suggested messages. * Add a new skill to Offboarding broker. [[define-acb-ide]] -== Define a Network Using Anypoint Code Builder or IDE +== Define a Network Using Anypoint Code Builder or Your IDE If you don't want to use MuleSoft Vibes, use Anypoint Code Builder or your IDE to edit the `agent-network.yaml` and `exchange.json` files and define your agent network and authentication. diff --git a/agent-network/1.0/modules/ROOT/partials/af-shared.adoc b/agent-network/1.0/modules/ROOT/partials/af-shared.adoc index 66562e099..ad4cfe297 100644 --- a/agent-network/1.0/modules/ROOT/partials/af-shared.adoc +++ b/agent-network/1.0/modules/ROOT/partials/af-shared.adoc @@ -60,7 +60,7 @@ See xref:access-management::permissions-by-product.adoc[] for a list of all Anyp To complete these tasks, you also need: * Your Anypoint Platform credentials -* xref:anypoint-code-builder::start-acb.adoc[Anypoint Code Builder desktop] +* xref:anypoint-code-builder::start-acb.adoc[Anypoint Code Builder] + Allowlist Anypoint Code Builder URLs. For more information, see xref:anypoint-code-builder::urls-to-allow.adoc[Allow URLs for Anypoint Code Builder]. * xref:gateway::flex-gateway-managed-ingress-egress.adoc[Omni Gateway Ingress and Egress gateways] @@ -107,7 +107,7 @@ Now you're ready to create an agent network project. Choose one of these methods After you create your agent network project, configure `agent-network.yaml` and `exchange.json` to reflect the structure of your network. * xref:af-define-your-agent-network-specification.adoc#define-dev-agent[Define a Network Using MuleSoft Vibes] -* xref:af-define-your-agent-network-specification.adoc#define-acb-ide[Define a Network Using Anypoint Code Builder or IDE] +* xref:af-define-your-agent-network-specification.adoc#define-acb-ide[Define a Network Using Anypoint Code Builder or Your IDE] [[step-4-publish]] === Step 4: Publish Your Agent Network Assets diff --git a/agent-network/2.0/modules/ROOT/partials/af-shared.adoc b/agent-network/2.0/modules/ROOT/partials/af-shared.adoc index 1cead3063..e9a9ac2b0 100644 --- a/agent-network/2.0/modules/ROOT/partials/af-shared.adoc +++ b/agent-network/2.0/modules/ROOT/partials/af-shared.adoc @@ -60,7 +60,7 @@ See xref:access-management::permissions-by-product.adoc[] for a list of all Anyp To complete these tasks, you also need: * Your Anypoint Platform credentials -* xref:anypoint-code-builder::start-acb.adoc[Anypoint Code Builder desktop] +* xref:anypoint-code-builder::start-acb.adoc[Anypoint Code Builder] + Allowlist Anypoint Code Builder URLs. For more information, see xref:anypoint-code-builder::urls-to-allow.adoc[Allow URLs for Anypoint Code Builder]. * xref:gateway::flex-gateway-managed-ingress-egress.adoc[Omni Gateway Ingress and Egress gateways] @@ -107,7 +107,7 @@ Now you're ready to create an agent network project. Choose one of these methods After you create your agent network project, configure `agent-network.yaml` and `exchange.json` to reflect the structure of your network. * xref:agent-network::af-define-your-agent-network-specification.adoc#define-dev-agent[Define a Network Using MuleSoft Vibes] -* xref:agent-network::af-define-your-agent-network-specification.adoc#define-acb-ide[Define a Network Using Anypoint Code Builder or IDE] +* xref:agent-network::af-define-your-agent-network-specification.adoc#define-acb-ide[Define Your Network in Anypoint Code Builder] [[step-4-publish]] === Step 4: Publish Your Agent Network Assets diff --git a/code-builder-home/modules/ROOT/nav.adoc b/code-builder-home/modules/ROOT/nav.adoc index 187111f04..066e5833a 100644 --- a/code-builder-home/modules/ROOT/nav.adoc +++ b/code-builder-home/modules/ROOT/nav.adoc @@ -4,7 +4,6 @@ * xref:start-acb.adoc[Getting Started] ** xref:start-acb-desktop.adoc[] -** xref:start-acb-cloud.adoc[] ** xref:start-configure-permissions.adoc[] ** xref:urls-to-allow.adoc[URLS to Allow] ** xref:start-fips-compliance.adoc[Configure FIPS Compliance] @@ -103,7 +102,6 @@ * xref:troubleshooting.adoc[] ** xref:troubleshoot-missing-features.adoc[] ** xref:troubleshoot-loading-errors.adoc[] -** xref:troubleshoot-cloud-ide-disk.adoc[] ** xref:troubleshoot-dataweave.adoc[] ** xref:troubleshoot-mule-runtime-errors.adoc[] ** xref:troubleshoot-authentication-errors.adoc[] diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-component-info.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-component-info.adoc index 411fbe0cc..78522d155 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-component-info.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-component-info.adoc @@ -83,7 +83,7 @@ Built-in Anypoint connectors are available from the canvas and code editor for i Connector XML tags start with a namespace followed by an operation, following the syntax `namespace:operation`, such as `` for a Select operation in Anypoint Connector for Database (Database Connector). For more information, see xref:connectors::introduction/intro-config-use-acb.adoc[]. -Many other connectors are available from your Anypoint Code Builder IDE through Anypoint Exchange: +Many other connectors are available from Anypoint Code Builder through Anypoint Exchange: * US cloud (non-EU host): https://anypoint.mulesoft.com/exchange/[Exchange (US)^] * EU cloud (EU host): https://eu1.anypoint.mulesoft.com/exchange/[Exchange (EU)^] @@ -97,7 +97,7 @@ To find information about more connectors, see xref:connectors::introduction/int Use the Connection Management Configuration Panel to easily configure connections to third-party systems directly from the UI. -In this panel, you can create, edit, delete, and test connections directly within the IDE interface, automatically populate connection fields using metadata provided by the connector, and save and manage connection configurations without switching to the code editor. +In this panel, you can create, edit, delete, test connections , automatically populate connection fields using metadata provided by the connector, and save and manage connection configurations without switching to the code editor. To open the configuration panel: diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-deployment.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-deployment.adoc index f89dce4f6..671c99f15 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-deployment.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-deployment.adoc @@ -55,7 +55,7 @@ Use auto-complete to select a preconfigured value in `deploy.json` or `deploy_ch . Open `deploy.json` or `deploy_ch2.json` from the Explorer. + -The file is located in the project's `src/main/resources` directory. The file opens to a *deploy.json* or *deploy.json_ch2* tab in the IDE. +The file is located in the project's `src/main/resources` directory. The file opens to a *deploy.json* or *deploy.json_ch2* tab. . In `deploy.json` or `deploy_ch2.json`, highlight the value to update. . Press Ctrl+Space. . Select a different value. diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-hardware-storage.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-hardware-storage.adoc index d286b5e55..355deadcd 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-hardware-storage.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-hardware-storage.adoc @@ -1,4 +1,4 @@ -Anypoint Code Builder for Desktop relies on Visual Studio Code (VS Code), Java, Node.js, Maven, and local build artifacts. To avoid timeouts, slow dependency resolution, and poor IDE responsiveness, your environment must meet the following minimum specifications. Recommended values improve performance for larger workspaces and frequent local runs. +Anypoint Code Builder relies on Visual Studio Code (VS Code), Java, Node.js, Maven, and local build artifacts. To avoid timeouts, slow dependency resolution, and poor responsiveness, your environment must meet the following minimum specifications. Recommended values improve performance for larger workspaces and frequent local runs. For supported operating systems and extension compatibility, see xref:acb-release-notes.adoc#compatibility[Anypoint Code Builder Release Notes]. @@ -81,7 +81,7 @@ macOS: `~/.vscode` * [ ] Local Maven repository: + Windows: `%USERPROFILE%\.m2` + macOS: `~/.m2` -* [ ] System temporary directory used by the IDE and build tools: + +* [ ] System temporary directory used by Anypoint Code Builder and build tools: + Windows: `%USERPROFILE%\AppData\Local\Temp` + macOS: `$TMPDIR` (or `/tmp` when that is your temp location) * [ ] *Projects directory* — the root folder where you clone or store Mule and API projects (your `ProjectsDirectory`); exclude the entire tree, not single files diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-ide-logos.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-ide-logos.adoc deleted file mode 100644 index eba8080f3..000000000 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-ide-logos.adoc +++ /dev/null @@ -1,49 +0,0 @@ - -// tag::web-only[] - -[%noheader,cols="10,30"] -|=== -|image:anypoint-code-builder::logo-ACBweb-active.png[alt="Cloud IDE for Anypoint Code Builder",title="Cloud IDE for Anypoint Code Builder"] - image:anypoint-code-builder::logo-ACBdesktop-disabled.png[alt="No info about desktop IDE for Anypoint Code Builder",title="Desktop IDE for Anypoint Code Builder"] | - *Cloud IDE only* -|=== - -// end::web-only[] - -// tag::desktop-only[] -[%noheader, cols="10,30"] -|=== -|image:anypoint-code-builder::logo-ACBweb-disabled.png[alt="No info about cloud IDE for Anypoint Code Builder",title="Cloud IDE for Anypoint Code Builder"] - image:anypoint-code-builder::logo-ACBdesktop-active.png[alt="Desktop IDE for Anypoint Code Builder",title="Desktop IDE for Anypoint Code Builder"] | - *Desktop IDE only* -|=== -// end::desktop-only[] - -// tag::both-ides[] -[%noheader, cols="10,30"] -|=== -| image:anypoint-code-builder::logo-ACBweb-active.png[alt="Cloud IDE for Anypoint Code Builder",title="Cloud IDE for Anypoint Code Builder"] - image:anypoint-code-builder::logo-ACBdesktop-active.png[alt="Desktop IDE for Anypoint Code Builder",title="Desktop IDE for Anypoint Code Builder"] | - *Cloud and Desktop IDE* -|=== -// end::both-ides[] - -//DON'T USE: FOR UNNECESSARY CASE Does Not Apply to the IDEs -// shouldn't be needed ever, but just in case... -// tag::neither-ide[] -//|=== -//| image:anypoint-code-builder::logo-ACBweb-disabled.png[alt="No info about cloud IDE for Anypoint Code Builder",title="Cloud IDE for Anypoint Code Builder"] -// image:anypoint-code-builder::logo-ACBdesktop-disabled.png[alt="No info about desktop IDE for Anypoint Code Builder",title="Desktop IDE for Anypoint Code Builder"] -// Info not applicable to the IDEs -//|=== -// end::neither-ide[] - - -//// -logo files ----------- -logo-ACBdesktop-active.png -logo-ACBdesktop-disabled.png -logo-ACBweb-active.png -logo-ACBweb-disabled.png -//// \ No newline at end of file diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-maven-settings.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-maven-settings.adoc index 1726e9ad6..f03a29e93 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-maven-settings.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-maven-settings.adoc @@ -3,7 +3,7 @@ Use the Apache Maven file `settings.xml` to configure the Maven settings, such as repositories, proxy settings, and credentials. For detailed information, see https://maven.apache.org/settings.html[Settings Reference] in the Apache Maven documentation. -If `settings.xml` isn't found in that path, the IDE creates an empty `settings.xml` file in the default location, `${user.home}/.m2/repository`. +If `settings.xml` isn't found in that path, Anypoint Code Builder creates an empty `settings.xml` file in the default location, `${user.home}/.m2/repository`. // end::maven-settings-custom[] // diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-open-packaged-sources.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-open-packaged-sources.adoc index 1f1289871..626504b1a 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-open-packaged-sources.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-open-packaged-sources.adoc @@ -8,30 +8,15 @@ .Show me how [%collapsible] ==== -* In the desktop IDE, select *File* > *Close Folder*. -* In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *File* > *Close Folder*. +* Select *File* > *Close Folder*. ==== + If no folder is open, the Explorer provides an *Open Folder* button. + -This step prevents the import process from adding the project as a subfolder of an open folder and enables the import process to open your imported project folder automatically in the IDE. +This step prevents the import process from adding the project as a subfolder of an open folder and enables the import process to open your imported project folder automatically. // end::close-folder[] // -// tag::open-command-palette-cloud[] -//variable used in multiple places on this page: -. Open the Command Palette. -+ -.Show me how -[%collapsible] -==== -* Use the keyboard shortcuts: -** Mac: Cmd+Shift+p -** Windows: Ctrl+Shift+p -* Click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. -==== -// end::open-command-palette-cloud[] - // tag::open-command-palette-desktop[] //variable used in multiple places on this page: . Open the Command Palette. @@ -60,7 +45,7 @@ MuleSoft: Import a Mule Project . Navigate to a folder to which to unpack the JAR file, such as your home directory or any folder _outside_ of a Mule project folder. . Click *Select project folder*. + -The IDE unpacks the shareable JAR file for your project into the selected folder. +Anypoint Code Builder unpacks the shareable JAR file for your project into the selected folder. // end::load-shareable-jar[] // @@ -77,8 +62,7 @@ The IDE unpacks the shareable JAR file for your project into the selected folder + ** Mac: Cmd+Shift+u ** Windows: Ctrl+Shift+u -* In the desktop IDE, select *View* > *Output*. -* In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Output*. +* Select *View* > *Output*. ==== . Select *Mule DX Server* from the dropdown list. To see scaffolding errors only, select *Mule DX Server: Scaffolding* from the list. @@ -88,7 +72,7 @@ The IDE unpacks the shareable JAR file for your project into the selected folder // // note at the end of import procedures // tag::import-note[] -In addition to loading the graphical canvas, the IDE also loads dependencies defined in the `pom.xml` for the project. +In addition to loading the graphical canvas, Anypoint Code Builder also loads dependencies defined in the `pom.xml` for the project. //if runtime/java settings missing: include::partial$acb-runtime-java.adoc[tags="runtime-java-missing"] + @@ -111,9 +95,7 @@ Libraries load to the `target/repositories` directory within the project folder. * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* Select *View* > *Command Palette*. -// * From the desktop IDE, select *View* > *Command Palette*. -// * From the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== .. Provide this command: + @@ -128,7 +110,7 @@ image::int-drag-folder.png["Drag project folder to Explorer view"] . Select *Copy Folder*. + If you instead select *Add Folder to Workspace*, you can start over by selecting the project in the Explorer, right clicking, and then selecting *Remove Folder from Workspace*. -After removing, drag and copy the project folder to the IDE without adding it to a workspace. +After removing, drag and copy the project folder to the Explorer without adding it to a workspace. // end::import-project-folder-desktop[] // @@ -144,9 +126,7 @@ After removing, drag and copy the project folder to the IDE without adding it to * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -// * Select *View* > *Command Palette*. -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== .. Provide this command: + @@ -165,7 +145,7 @@ Example of a root folder and subdirectories of an integration or implementation image::int-open-root.png["Project folder for an integration or implementation project"] -VS Code treats the root as a workspace, which enables the IDE to load the canvas properly. +VS Code treats the root as a workspace, which enables the canvas to load properly. -- Design Project Example:: + @@ -180,30 +160,6 @@ The root of a project is the top-level folder that Anypoint Code Builder generat // end::open-workspace-root[] // -// -// tag::preliminary-cloud-import-steps[] -. Open the Command Palette. -+ -.Show me how -[%collapsible] -==== -** Use the keyboard shortcuts: -*** Mac: Cmd+Shift+p -*** Windows: Ctrl+Shift+p -// ** From the desktop IDE, select *View* > *Command Palette*. -// ** From the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. -** Click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. -==== -. Provide this command: -+ -[source,command] --- - File: Open Folder... --- -. Select your Anypoint Code Builder home directory or any directory _outside_ of a Mule project folder and click *OK*. -// end::preliminary-cloud-import-steps[] -// - // // step to test the project after opening // tag::test-project[] diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-project-migration.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-project-migration.adoc index 26447b276..9bbc6ce26 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-project-migration.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-project-migration.adoc @@ -27,17 +27,17 @@ Selecting *Attach Project Sources* flags the `-DattachMuleSources` parameter as // // tag::import-mule-project-into-acb[] -Import a shareable JAR file for a snapshot of a Mule project into the desktop IDE. +Import a shareable JAR file for a snapshot of a Mule project into Anypoint Code Builder. To create a shareable JAR, see xref:int-export-mule-project.adoc#export-mule-project[Export Mule Project]. -To import a shareable JAR file in your desktop IDE: +To import a shareable JAR file into Anypoint Code Builder: -. Make sure that no project is open in the IDE. +. Make sure that no project is open. // include for this procedure include::partial$acb-open-packaged-sources.adoc[tags="open-command-palette-desktop"] include::partial$acb-open-packaged-sources.adoc[tags="load-shareable-jar"] -. If your Mule project folder is closed, xref:int-import-mule-project.adoc#open-a-project-folder-from-the-desktop-or-cloud-ide[open a workspace] for the project at the project's _root_ directory. +. If your Mule project folder is closed, xref:int-import-mule-project.adoc#both-open-project-folder[open a workspace] for the project at the project's _root_ directory. + include::partial$acb-open-packaged-sources.adoc[tags="import-note"] //step: test project diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-reusable-steps.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-reusable-steps.adoc index 34c6782d8..b3cda3072 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-reusable-steps.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-reusable-steps.adoc @@ -8,8 +8,7 @@ * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== // end::open-command-palette[] // @@ -36,8 +35,7 @@ From the code editor, above the HTTP Listener configuration (` *Run*. -** In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Run*. +** Select *View* > *Run*. ==== // end::open-run-debug[] // @@ -54,8 +52,7 @@ From the code editor, above the HTTP Listener configuration (` *Output*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Output*. +* Select *View* > *Output*. ==== // end::open-output-panel[] // @@ -117,9 +114,8 @@ include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tag=open-source- .Show me how [%collapsible] ==== -* In the desktop IDE, select *Code* > *Settings* > *Configure Snippets*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *Preferences* > *Configure Snippets*. -* In either IDE: +* Select *Code* > *Settings* > *Configure Snippets*. +* Alternatively: .. Use keyboard shortcuts to open the Command Palette: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p @@ -135,7 +131,7 @@ Snippets: Configure Snippets // // tag::open-ide[] // Open the ACB IDE -. In the activity bar of the IDE, click the image:anypoint-code-builder::icon-ms-logo.png["",20,20] (*Anypoint Code Builder*) icon. +. In the activity bar, click the image:anypoint-code-builder::icon-ms-logo.png["",20,20] (*Anypoint Code Builder*) icon. // end::open-ide[] // // @@ -144,8 +140,7 @@ Snippets: Configure Snippets .Show me how [%collapsible] ==== -* In the desktop IDE, select *File* > *Close Folder*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *File* > *Close Folder*. +* Select *File* > *Close Folder*. ==== // end::close-project[] // @@ -252,11 +247,10 @@ When the application deploys successfully, you see a `DEPLOYED` log message in t // // tag::open-terminal[] -. From your IDE, open the Terminal window in the console: +. Open the Terminal window in the console: -* In the desktop IDE, select *View* > *Terminal*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *Terminal* > *New Terminal*. -* For either IDE: Press Ctrl and then press the backtick key (`). +* Select *View* > *Terminal*. +* Alternatively, press Ctrl and then press the backtick key (`). // end::open-terminal[] // @@ -298,29 +292,25 @@ For OAS and JSON schema, you can also specify fragment files that you create man * An administrator with an Anypoint Platform organization account must provide you with the necessary permissions. See xref:start-configure-permissions.adoc[]. -* The cloud IDE requires a non-trial Enterprise license of Mule runtime engine. See xref:access-management::managing-your-account.adoc#upgrade-account[Upgrade Your Account] and xref:mule-runtime::installing-an-enterprise-license.adoc[]. - * Anypoint Platform requires a user account. You can use an existing account or create one from Anypoint Platform (see supported xref:index.adoc#us-eu-clouds[Cloud Hosts]). // end::platform-account[] // // // tag::open-mule-settings[] -// only for desktop IDE for US/EU settings: -. If an API specification is open in the Explorer panel of the IDE, close the project to avoid a synchronization error when you switch clouds. +. If an API specification is open in the Explorer panel, close the project to avoid a synchronization error when you switch clouds. -* In the desktop IDE, click *File* > *Close Folder*. -//* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *File* > *Close Folder*. +* Click *File* > *Close Folder*. -. Open the *Settings* tab in the desktop IDE: +. Open the *Settings* panel: + -image:anypoint-code-builder::acb-activity-bar-select-cloud.png["Selecting the EU cloud from the desktop IDE"] +image:anypoint-code-builder::acb-activity-bar-select-cloud.png["Selecting the EU cloud from Anypoint Code Builder"] // end::open-mule-settings[] // // // tag::open-settings-all[] -. Open the *Settings* tab for the IDE: +. Open the *Settings* panel: // end::open-settings-all[] // @@ -352,7 +342,7 @@ For source control options, see xref:anypoint-code-builder::start-scm.adoc[]. * Have some familiarity with xref:access-management::business-groups.adoc[business groups]. + -When you publish your API spec to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. +When you publish your API spec to Exchange, Anypoint Code Builder requests the name of the business group. // end::prereq-business-groups[] // @@ -396,7 +386,7 @@ MuleSoft: Import Asset from Exchange * *GraphQL API* . If prompted, click *Allow* to allow sign in using Anypoint Platform and select the business group. . Type the name of the API spec, and press Enter. -. Wait for the IDE to load a list of matches to the name. +. Wait for Anypoint Code Builder to load a list of matches to the name. // end::import-api-exchange[] // @@ -478,7 +468,7 @@ Although it is also possible to set the versions as values to *muleRuntimeVersio // ASYNCAPI BETA ACCESS// // // tag::asyncapi-beta-access[] -Make sure that you have access to AsyncAPI implementation features from the IDE: +Make sure that you have access to AsyncAPI implementation features: . Log in to Anypoint Platform. . From Anypoint Platform, open the Anypoint Code Builder landing page. @@ -500,7 +490,7 @@ When the AsyncAPI feature is available for your organization, the Anypoint Code // // tag::prereqs-implementation[] -* xref:start-acb.adoc[Set up and access the desktop or cloud IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:des-create-api-specs.adoc[Create and test your API spec]. * xref:des-publish-api-spec-to-exchange.adoc[Publish your API spec to Exchange]. * Optionally, xref:int-create-integrations.adoc[create your integration project (Mule app)]. diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-runtime-java.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-runtime-java.adoc index 163d57149..e00ff2837 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-runtime-java.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-runtime-java.adoc @@ -1,7 +1,7 @@ // // tag::runtime-java-download[] -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. +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. Anypoint Code Builder 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. // end::runtime-java-download[] // // @@ -19,7 +19,7 @@ To set default Mule runtime and Java versions for the projects you create, see x // // tag::runtime-java-notification[] -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`. +Projects open instantly using the bundled Mule runtime versions. Anypoint Code Builder 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`. // end::runtime-java-notification[] // diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-start-cloud.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-start-cloud.adoc deleted file mode 100644 index c9ceb2da6..000000000 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-start-cloud.adoc +++ /dev/null @@ -1,72 +0,0 @@ -// -// tag::start-cloud-intro[] -Launch the cloud IDE from Anypoint Platform. Your Anypoint Platform user account and business organization are hosted in the US or EU cloud and aren't shared across the hosts. -// end::start-cloud-intro[] -// - -// -// tag::heading-before-you-begin[] -= Before You Begin with the Cloud IDE -// end::heading-before-you-begin[] -// - -// -// tag::before-you-begin[] -Meet prerequisites before attempting to launch the cloud IDE: - -//Requirements for Anypoint Platform account and account config -include::partial$acb-reusable-steps.adoc[tags="platform-account"] - -* Your organization administrator must accept the terms and conditions of the beta program for the cloud IDE from the Anypoint Code Builder landing page on your Anypoint Platform cloud host (https://anypoint.mulesoft.com/codebuilder/[US] or https://eu1.anypoint.mulesoft.com/codebuilder/[EU]). Sign-in is required. The *Terms & Conditions* button is available to the organization administrator only. -+ -image::anypoint-code-builder::start-acb-terms-admin.png["Terms and Conditions banner for organization administrators"] - -* Review important open beta information: -+ -[IMPORTANT] --- -The cloud IDE remains in an open beta period. - -During the open beta, your cloud IDE instance might get deleted, causing you to lose your integrations, automations, and APIs. - -.Click for more information: -[%collapsible] -==== -To save your work, commit your project files to a source control management (SCM) system. See xref:anypoint-code-builder::start-scm.adoc[]. - -Don't use the cloud IDE beta version of Anypoint Code Builder to develop APIs, integrations, or automations for production environments. -==== --- -// end::before-you-begin[] -// - - -// -// tag::heading-launch-cloud[] -= Open the Cloud IDE from Anypoint Platform -// end::heading-launch-cloud[] -// - -// -// tag::launch-cloud[] -To launch the cloud IDE: - -. Review the prerequisites in xref:anypoint-code-builder::start-acb-cloud.adoc#before-you-begin[Before You Begin with the Cloud IDE] so that you can use Anypoint Code Builder. -. Log in to Anypoint Platform: - -* https://anypoint.mulesoft.com/login/[anypoint.mulesoft.com] for the U.S. host (supports all non-EU regions) -* https://eu1.anypoint.mulesoft.com/login[eu1.anypoint.mulesoft.com] for the EU-compliant host -+ -If you have an account in one cloud but intend to work in another, you must create an account in that cloud to create and work on your projects. - -. From Anypoint Platform, open the Anypoint Code Builder landing page. -. From the Anypoint Code Builder landing page, click *Launch Cloud IDE*. -+ -image::acb-launch-cloud-ide.png["Launch button for the cloud IDE in Anypoint Platform"] -+ -After provisioning of your cloud IDE is complete, the IDE opens. The provisioning process can take a few minutes. -+ -Your cloud IDE environment is associated with your user account. The cloud environment also has a unique URL that only you can access and that is _not_ embedded within the Anypoint Platform UI. You can reopen your cloud IDE directly from that URL or relaunch it indirectly from Anypoint Code Builder in Anypoint Platform. -. Click the MuleSoft icon in the activity bar to see and use Anypoint Code Builder features. -// end::launch-cloud[] -// diff --git a/code-builder-home/modules/ROOT/pages/_partials/acb-start-desktop.adoc b/code-builder-home/modules/ROOT/pages/_partials/acb-start-desktop.adoc index 728a12c3f..8ad68d577 100644 --- a/code-builder-home/modules/ROOT/pages/_partials/acb-start-desktop.adoc +++ b/code-builder-home/modules/ROOT/pages/_partials/acb-start-desktop.adoc @@ -1,4 +1,4 @@ -The desktop-based IDE extensions in Anypoint Extension Pack are available from the Visual Studio Marketplace. +The extensions in Anypoint Extension Pack are available from the Visual Studio Marketplace. * <> * <> @@ -8,9 +8,9 @@ The desktop-based IDE extensions in Anypoint Extension Pack are available from t * <> [[prereqs]] -== Before You Begin Desktop IDE Setup +== Before You Begin Anypoint Code Builder Setup -Before installing the desktop extensions to VS Code, make sure you have an Anypoint Platform account with the required permissions: +Before installing the Anypoint Code Builder extensions to VS Code, make sure you have an Anypoint Platform account with the required permissions: //Requirements for Anypoint Platform account and account config include::partial$acb-reusable-steps.adoc[tags="platform-account"] @@ -36,10 +36,10 @@ Use of Anypoint Code Builder in VS Code on your computer requires the Anypoint E [[install-pack]] === Install Anypoint Extension Pack -To install the Anypoint Extension Pack into the desktop IDE: +To install the Anypoint Extension Pack into VS Code: -. Open VS Code. -. Find *Anypoint Extension Pack* from the desktop IDE or from https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-extension-pack[Visual Studio Marketplace^]. +. Open VS Code. +. Find *Anypoint Extension Pack* from within VS Code or from https://marketplace.visualstudio.com/items?itemName=salesforce.mule-dx-extension-pack[Visual Studio Marketplace^]. + [NOTE] .To avoid installation errors: @@ -47,7 +47,7 @@ To install the Anypoint Extension Pack into the desktop IDE: Do not install the individual Anypoint Code Builder extensions that are also available separately from Anypoint Extension Pack in Visual Studio Marketplace. ==== -* To install from the desktop IDE, launch the Extensions menu by clicking the Extensions icon from the activity bar or pressing Cmd+Shift+x (Mac) or Ctrl+Shift+x (Windows), and search for the extension pack. +* To install from within VS Code, launch the Extensions menu by clicking the Extensions icon from the activity bar or pressing Cmd+Shift+x (Mac) or Ctrl+Shift+x (Windows), and search for the extension pack. + Select *Install Release Version*. @@ -83,15 +83,15 @@ Ensure this option is checked. [[acb-menu]] image::anypoint-code-builder-view.png["MuleSoft icon for Anypoint Code Builder in the activity bar"] -. Check that the IDE loads the <>. +. Confirm that the <> loads. . If you have an Anypoint Platform account running in the EU cloud, change the *Mule: Control Plane* setting to *EU cloud*. + -For guidance, see xref:anypoint-code-builder::start-acb.adoc#change-clouds[Set the Desktop IDE to the EU or US Cloud]. -. Follow the steps in xref:anypoint-code-builder::start-acb.adoc#login-ide[Log in to Anypoint Platform from the IDE]. +For guidance, see xref:anypoint-code-builder::start-acb.adoc#change-clouds[Set Anypoint Code Builder to the EU or US Cloud]. +. Follow the steps in xref:anypoint-code-builder::start-acb.adoc#login-ide[Log in to Anypoint Platform]. + NOTE:: -If an Anypoint Platform session is active in any of your browsers when you install Anypoint Extension Pack, the extension pack uses that session to sign in to Anypoint Platform from the IDE. You can xref:anypoint-code-builder::start-acb.adoc#logout-status-bar[log out] or xref:anypoint-code-builder::start-acb.adoc#logout-status-bar[sign in] from the status bar in the IDE. +If an Anypoint Platform session is active in any of your browsers when you install Anypoint Extension Pack, the extension pack uses that session to sign in to Anypoint Platform. You can xref:anypoint-code-builder::start-acb.adoc#logout-status-bar[log out] or xref:anypoint-code-builder::start-acb.adoc#logout-status-bar[sign in] from the status bar. [[install-other-ides]] === Install Anypoint Extension Pack in Cursor, Trae, or Devin @@ -151,7 +151,7 @@ https://marketplace.visualstudio.com/_apis/public/gallery [[update-pack]] === Update Anypoint Extension Pack -If Anypoint Extension Pack is installed on your desktop IDE, update to the latest version of the extension pack by following VS Code instructions in https://code.visualstudio.com/docs/configure/extensions/extension-marketplace#_update-an-extension-manually[Update an extension manually^]. +If Anypoint Extension Pack is installed, update to the latest version of the extension pack by following VS Code instructions in https://code.visualstudio.com/docs/configure/extensions/extension-marketplace#_update-an-extension-manually[Update an extension manually^]. [[uninstall-pack]] === Uninstall Anypoint Extension Pack diff --git a/code-builder-home/modules/ROOT/pages/acb-component-async.adoc b/code-builder-home/modules/ROOT/pages/acb-component-async.adoc index d8c9d1963..22d253437 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-async.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-async.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: async -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-choice.adoc b/code-builder-home/modules/ROOT/pages/acb-component-choice.adoc index d751e1ddc..cf48ef21b 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-choice.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-choice.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: choice -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-error-handler.adoc b/code-builder-home/modules/ROOT/pages/acb-component-error-handler.adoc index c37e84ef1..7b6c06347 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-error-handler.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-error-handler.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: error-handler -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-flow.adoc b/code-builder-home/modules/ROOT/pages/acb-component-flow.adoc index f74211793..aa568f5ba 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-flow.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-flow.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: flow -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-for-each.adoc b/code-builder-home/modules/ROOT/pages/acb-component-for-each.adoc index 03e4000c9..809024c1e 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-for-each.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-for-each.adoc @@ -1,6 +1,5 @@ // Filenames follow a syntax component-some-name.adoc :component-filename: for-each -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-logger.adoc b/code-builder-home/modules/ROOT/pages/acb-component-logger.adoc index 7d03faa13..64eb84c5d 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-logger.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-logger.adoc @@ -1,6 +1,5 @@ // Filenames follow a syntax component-some-name.adoc :component-filename: logger -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-parallel-for-each.adoc b/code-builder-home/modules/ROOT/pages/acb-component-parallel-for-each.adoc index 220b5ca24..2f112462d 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-parallel-for-each.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-parallel-for-each.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: parallel-for-each -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-raise-error.adoc b/code-builder-home/modules/ROOT/pages/acb-component-raise-error.adoc index 98d148373..37ddc37a0 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-raise-error.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-raise-error.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: raise-error -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-scatter-gather.adoc b/code-builder-home/modules/ROOT/pages/acb-component-scatter-gather.adoc index 685a764e6..75902fbdb 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-scatter-gather.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-scatter-gather.adoc @@ -1,6 +1,5 @@ // Filenames follow a syntax component-some-name.adoc :component-filename: scatter-gather -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-set-payload.adoc b/code-builder-home/modules/ROOT/pages/acb-component-set-payload.adoc index bf80086bf..80c5effae 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-set-payload.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-set-payload.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: set-payload -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-set-variable.adoc b/code-builder-home/modules/ROOT/pages/acb-component-set-variable.adoc index 249b34219..525abbb9b 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-set-variable.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-set-variable.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: set-variable -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-subflow.adoc b/code-builder-home/modules/ROOT/pages/acb-component-subflow.adoc index 88d8bb4d0..fb4df1be2 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-subflow.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-subflow.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: subflow -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-component-try.adoc b/code-builder-home/modules/ROOT/pages/acb-component-try.adoc index 86f01b3c9..1df3ed84a 100644 --- a/code-builder-home/modules/ROOT/pages/acb-component-try.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-component-try.adoc @@ -2,7 +2,6 @@ // So for component-scatter-gather.adocs, the confugration is // :component-filename: scatter-gather :component-filename: try -:page-deployment-options: cloud-ide, desktop-ide //TBD if this is needed for changing singular to plural :example: example diff --git a/code-builder-home/modules/ROOT/pages/acb-external-libraries.adoc b/code-builder-home/modules/ROOT/pages/acb-external-libraries.adoc index 9f9a8bd9f..9256ab0ec 100644 --- a/code-builder-home/modules/ROOT/pages/acb-external-libraries.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-external-libraries.adoc @@ -1,5 +1,4 @@ = Configure External Libraries for Mule Projects -:page-deployment-options: cloud-ide, desktop-ide External libraries are project-level dependencies that Mule applications require to support certain connectors and components, such as Database connectors or Spring-based components. Anypoint Code Builder provides a guided interface to add, edit, and delete external libraries, and automatically manages the corresponding entries in the project POM file. @@ -52,7 +51,7 @@ Some components provide recommended libraries that match the component requireme The interface shows the library to add to the project. . Click *Apply*. + -The IDE adds the recommended library to the project POM file and applies it to all components that require it. +Anypoint Code Builder adds the recommended library to the project POM file and applies it to all components that require it. === Add a Maven Dependency diff --git a/code-builder-home/modules/ROOT/pages/acb-reference.adoc b/code-builder-home/modules/ROOT/pages/acb-reference.adoc index 952af7b06..4177c11c0 100644 --- a/code-builder-home/modules/ROOT/pages/acb-reference.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-reference.adoc @@ -1,6 +1,5 @@ = Anypoint Code Builder Components and Commands Reference :page-aliases: acb-components.adoc -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -22,7 +21,7 @@ Configure Anypoint Code Builder proxy settings in Visual Studio Code (VS Code) t * xref:ref-proxy-settings.adoc[] -Meet hardware, storage performance, and antivirus exclusion guidance for the desktop IDE: +Meet hardware, storage performance, and antivirus exclusion guidance for Anypoint Code Builder: * xref:ref-hardware-storage-requirements.adoc[] diff --git a/code-builder-home/modules/ROOT/pages/acb-release-notes.adoc b/code-builder-home/modules/ROOT/pages/acb-release-notes.adoc index 97e96c3a9..713e20530 100644 --- a/code-builder-home/modules/ROOT/pages/acb-release-notes.adoc +++ b/code-builder-home/modules/ROOT/pages/acb-release-notes.adoc @@ -1,5 +1,4 @@ //= Anypoint Code Builder Release Notes -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: whats-new.adoc include::release-notes::partial$code-builder/acb-rn-landing-page.adoc[] \ No newline at end of file diff --git a/code-builder-home/modules/ROOT/pages/accept-terms-and-conditions.adoc b/code-builder-home/modules/ROOT/pages/accept-terms-and-conditions.adoc deleted file mode 100644 index 0f625cf83..000000000 --- a/code-builder-home/modules/ROOT/pages/accept-terms-and-conditions.adoc +++ /dev/null @@ -1,34 +0,0 @@ -= Accept Anypoint Code Builder Beta Terms and Conditions -:page-deployment-options: cloud-ide, desktop-ide - -include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] - -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] - -Anypoint Code Builder Cloud IDE is in Open Beta. Anypoint Code Builder Desktop is GA. - -== Before You Begin - -Use of Anypoint Code Builder Cloud IDE is subject to beta terms and conditions. - -* In the Cloud IDE for Anypoint Code Builder, an Organization Administrator must read and accept the beta terms and conditions. - -See xref:access-management::organization.adoc[] for information about organizations and Organization Administrators in Anypoint Platform. - -== Review and Accept Anypoint Platform Terms and Conditions - -. After you access the Anypoint Code Builder central page for the first time, you see a pop-up message titled *Get access to Anypoint Code Builder*. -. Read the terms and conditions. -. After you scroll through the terms and conditions, select *I accept the Anypoint Code Builder Beta Terms and Conditions*. -. Select *Get Access*. - -Your organization is now authorized to access Anypoint Code Builder. - -After accepting the terms and conditions, you must grant access to the rest of the users in your organization. For more information, see xref:configure-permissions.adoc[]. - -== See Also - -* xref:access-management::organization.adoc[] -* xref:load-acb-web-ide.adoc[] -* xref:manage-web-ide-instance.adoc[] diff --git a/code-builder-home/modules/ROOT/pages/ai-enabling-api-project-topic-center.adoc b/code-builder-home/modules/ROOT/pages/ai-enabling-api-project-topic-center.adoc index a04e996ac..7a136301d 100644 --- a/code-builder-home/modules/ROOT/pages/ai-enabling-api-project-topic-center.adoc +++ b/code-builder-home/modules/ROOT/pages/ai-enabling-api-project-topic-center.adoc @@ -29,7 +29,7 @@ NOTE: The MuleSoft for Agentforce Extension Pack (beta) must not be installed at *** *Delete applications* ** xref:access-management::permissions-by-product.adoc#design-center[Design Center Developer] permission so that users can view and create APIs. * In *Anypoint Platform -> API Governance*, make sure you xref:api-governance::get-started.adoc[opt in to govern APIs by version]. -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Understand the basics of designing API specs. + See the xref:tutorials.adoc[] for details. @@ -69,7 +69,7 @@ include::partial$acb-reusable-steps.adoc[tags="proj-directory-warn"] [NOTE] Only OAS 3.0 is supported for topics and actions. -| *Business Group* | Select the business group the API will belong to. The business group is required for API governance and syncing centralized rulesets. When you publish your API spec to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. +| *Business Group* | Select the business group the API will belong to. The business group is required for API governance and syncing centralized rulesets. When you publish your API spec to Exchange from Anypoint Code Builder, it requests the name of the business group. |=== . Click *Create Project*. + diff --git a/code-builder-home/modules/ROOT/pages/des-create-api-fragments.adoc b/code-builder-home/modules/ROOT/pages/des-create-api-fragments.adoc index f8fcb1317..022281eed 100644 --- a/code-builder-home/modules/ROOT/pages/des-create-api-fragments.adoc +++ b/code-builder-home/modules/ROOT/pages/des-create-api-fragments.adoc @@ -1,11 +1,8 @@ = Creating and Using API Spec Fragments -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: des-add-examples-to-specs.adoc, add-request-response-details.adoc, tut-af-design-api-add-request-response-details.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Using Anypoint Code Builder, you can create your own API fragments and publish them to Anypoint Exchange to share with other people, add fragments from Exchange to your API specification, @@ -36,13 +33,13 @@ Use these examples to explore the functionality of Anypoint Code Builder: Before adding fragments: -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Understand the basics of designing API specifications. + To see where adding fragments fits in the journey from API design through deployment, see xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment in Mule]. * Have some familiarity with xref:access-management::business-groups.adoc[business groups]. + -When you publish your API fragment to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. See xref:access-management::business-groups.adoc[]. +When you publish your API fragment to Exchange from Anypoint Code Builder, it requests the name of the business group. See xref:access-management::business-groups.adoc[]. == Create an API Fragment and Publish it to Exchange @@ -120,7 +117,7 @@ Your API specification appears as an API spec fragment type asset in your organi image::des-api-frag-exchange.png["API Spec Fragment in Exchange"] + -- -If your API spec appears on Exchange as a REST API rather than an API spec fragment, check that the `classifier` attribute in the `exchange.json` file in the project folder in your IDE is set to one of the following, depending on the language: +If your API spec appears on Exchange as a REST API rather than an API spec fragment, check that the `classifier` attribute in the `exchange.json` file in the project folder is set to one of the following, depending on the language: ** OAS: `oas-components` ** RAML: `raml-fragment` diff --git a/code-builder-home/modules/ROOT/pages/des-create-api-specs.adoc b/code-builder-home/modules/ROOT/pages/des-create-api-specs.adoc index 549b89ba9..db66bf602 100644 --- a/code-builder-home/modules/ROOT/pages/des-create-api-specs.adoc +++ b/code-builder-home/modules/ROOT/pages/des-create-api-specs.adoc @@ -1,14 +1,13 @@ = Creating and Importing API Specifications -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: des-test-api-specs.adoc, ui-tut-design.adoc, tut-af-design-api-specification-from-scratch.adoc, design-api-specification.adoc, test-api-specification.adoc, tut-af-design-am-flights-api.adoc, tut-af-design-api-test-specification.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Use Anypoint Code Builder to create, import, and test API specs before publishing to Anypoint Exchange. You can start a new spec from the IDE or import an existing spec from MuleSoft Version Control System (VCS). +Use Anypoint Code Builder to create, import, and test API specs before publishing to Anypoint Exchange. You can start a new spec or import an existing spec from MuleSoft Version Control System (VCS). -. Create a API spec project in Anypoint Code Builder from the IDE or by importing the spec from MuleSoft VCS: +. Create an API spec project in Anypoint Code Builder or import the spec from MuleSoft VCS: -* <> (example uses OAS 3.0 (YAML)) +* <> (example uses OAS 3.0 (YAML)) * <> * <> @@ -21,13 +20,13 @@ Use the <> API spec to explore the functiona == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Understand the basics of designing API specs. + See xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment] for a suggested order of topics. * Have some familiarity with xref:access-management::business-groups.adoc[business groups]. + -When you publish your API spec to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. See xref:access-management::business-groups.adoc[]. +When you publish your API spec to Exchange from Anypoint Code Builder, it requests the name of the business group. See xref:access-management::business-groups.adoc[]. [[design-new-api-spec]] == Create a New API Specification Project @@ -144,7 +143,7 @@ title: Example Items API [[import-spec]] == Import an API Specification from MuleSoft VCS -Import an API spec from MuleSoft VCS and use Git or another source-control management system compatible with VS Code in the desktop or cloud IDE to keep your project in sync. For more information, see xref:des-designing-api-specs.adoc#mulesoft-vcs[Source Control for API Design Projects]. +Import an API spec from MuleSoft VCS and use Git or another source-control management system compatible with VS Code to keep your project in sync. For more information, see xref:des-designing-api-specs.adoc#mulesoft-vcs[Source Control for API Design Projects]. [NOTE] Importing an API spec from MuleSoft VCS requires Git installed on your computer. If Git is not installed on your computer, follow the https://github.com/git-guides/install-git[Git installation instructions] for your machine. @@ -157,13 +156,13 @@ include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] ---- MuleSoft: Import API Specification from MuleSoft VCS ---- -. If prompted, log in to Anypoint Platform through the IDE. +. If prompted, log in to Anypoint Platform. . Complete the import process: .. Select your business group from the *Select a Business Group* popup. .. Search for the API spec in the *APIs from MuleSoft VCS* field. .. Navigate to or create a folder for the spec, and click *Select target folder*. + -If you receive an error that the import failed (*Importing project _a_project_name_ has failed*), check your target folder for a project with the same name. To address a duplicate naming issue before importing, you can import the design project to a different target folder or delete the project from your IDE (see xref:des-delete-api-projects.adoc[]). +If you receive an error that the import failed (*Importing project _a_project_name_ has failed*), check your target folder for a project with the same name. To address a duplicate naming issue before importing, you can import the design project to a different target folder or delete the project (see xref:des-delete-api-projects.adoc[]). . Edit or continue designing your spec, as needed. + As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (or press Ctrl+Space) to display available options within the context. diff --git a/code-builder-home/modules/ROOT/pages/des-create-asyncapi-api-specs.adoc b/code-builder-home/modules/ROOT/pages/des-create-asyncapi-api-specs.adoc index 0682e4f21..a902a6f43 100644 --- a/code-builder-home/modules/ROOT/pages/des-create-asyncapi-api-specs.adoc +++ b/code-builder-home/modules/ROOT/pages/des-create-asyncapi-api-specs.adoc @@ -1,13 +1,12 @@ = Creating and Importing AsyncAPI Specifications -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] Use Anypoint Code Builder to design, import, govern, and test AsyncAPI specs before publishing to Anypoint Exchange: -. Create and design an AsyncAPI spec project in Anypoint Code Builder from the IDE or by importing the spec from MuleSoft VCS: +. Create and design an AsyncAPI spec project in Anypoint Code Builder or import the spec from MuleSoft VCS: -* <> +* <> * <> . <>. @@ -17,11 +16,11 @@ Use the <> API spec to explore the == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Understand the basics of designing AsyncAPI specs. * Have some familiarity with xref:access-management::business-groups.adoc[business groups]. + -When you publish your API spec to Exchange from Anypoint Code Builder, the IDE requests the name of the business group. See xref:access-management::business-groups.adoc[]. +When you publish your API spec to Exchange from Anypoint Code Builder, it requests the name of the business group. See xref:access-management::business-groups.adoc[]. [[design-new-api-spec]] == Create and Design a New AsyncAPI Specification Project @@ -77,7 +76,7 @@ As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-comple [[import-spec]] == Import an AsyncAPI Specification from MuleSoft VCS -Import an AsyncAPI spec from MuleSoft VCS and use Git or another source-control management system compatible with VS Code in the desktop or cloud IDE to keep your project in sync. For more information, see xref:des-designing-api-specs.adoc#anypoint-scm[Source Control for API Design Projects]. +Import an AsyncAPI spec from MuleSoft VCS and use Git or another source-control management system compatible with VS Code to keep your project in sync. For more information, see xref:des-designing-api-specs.adoc#anypoint-scm[Source Control for API Design Projects]. [NOTE] Importing an API spec from MuleSoft VCS requires Git installed on your computer. If Git is not installed on your computer, follow the https://github.com/git-guides/install-git[Git installation instructions] for your machine. @@ -90,13 +89,13 @@ include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] ---- MuleSoft: Import API Specification from MuleSoft VCS ---- -. If prompted, log in to Anypoint Platform through the IDE. +. If prompted, log in to Anypoint Platform. . Complete the import process: .. Select your business group from the *Select a Business Group* popup. .. Search for the API spec in the *APIs from MuleSoft VCS* field. .. Navigate to or create a folder for the spec, and click *Select target folder*. + -If you receive an error that the import failed (*Importing project _a_project_name_ has failed*), check your target folder for a project with the same name. To address a duplicate naming issue before importing, you can import the design project to a different target folder or delete the project from your IDE (see xref:des-delete-api-projects.adoc[]). +If you receive an error that the import failed (*Importing project _a_project_name_ has failed*), check your target folder for a project with the same name. To address a duplicate naming issue before importing, you can import the design project to a different target folder or delete the project (see xref:des-delete-api-projects.adoc[]). . Edit or continue designing your spec, as needed. + As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (Ctrl+Space) to display available options within the context. diff --git a/code-builder-home/modules/ROOT/pages/des-delete-api-projects.adoc b/code-builder-home/modules/ROOT/pages/des-delete-api-projects.adoc index 9db5b533c..a659e3ed3 100644 --- a/code-builder-home/modules/ROOT/pages/des-delete-api-projects.adoc +++ b/code-builder-home/modules/ROOT/pages/des-delete-api-projects.adoc @@ -1,5 +1,4 @@ = Deleting API Specs and Fragments -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -15,7 +14,7 @@ You must delete the previous project to reuse the project name for a new design == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Create a xref:des-create-api-specs.adoc[spec] or xref:des-create-api-fragments.adoc[fragment]. [[delete-spec]] @@ -33,7 +32,7 @@ To delete an API project (API spec or API spec fragment) from Anypoint Code Buil // note on limited scope of this section: include::partial$acb-api-design.adoc[tags="api-dc-scm-scope"] -Design project names must be unique. To create a new design project with a name already used in Anypoint Code Builder, you must delete the existing project from the IDE. +Design project names must be unique. To create a new design project with a name already used in Anypoint Code Builder, you must delete the existing project. To delete an API project (API spec or API spec fragment) from Anypoint Code Builder: diff --git a/code-builder-home/modules/ROOT/pages/des-design-grpc-api-spec.adoc b/code-builder-home/modules/ROOT/pages/des-design-grpc-api-spec.adoc index 3111be141..550bd9bc0 100644 --- a/code-builder-home/modules/ROOT/pages/des-design-grpc-api-spec.adoc +++ b/code-builder-home/modules/ROOT/pages/des-design-grpc-api-spec.adoc @@ -1,5 +1,4 @@ = Designing a gRPC API Specification with Anypoint Code Builder -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -77,7 +76,7 @@ To publish a gRPC fragment to Exchange: . Ensure that you're logged in to Anypoint Platform. . Open the project that contains your reusable `.proto` files. -. From the IDE, select the publish action. +. Select the publish action. . When prompted: + * Select the business group. diff --git a/code-builder-home/modules/ROOT/pages/des-designing-api-specs.adoc b/code-builder-home/modules/ROOT/pages/des-designing-api-specs.adoc index a4e20622f..b081cc652 100644 --- a/code-builder-home/modules/ROOT/pages/des-designing-api-specs.adoc +++ b/code-builder-home/modules/ROOT/pages/des-designing-api-specs.adoc @@ -1,5 +1,4 @@ = Designing API Specs and Fragments -:page-deployment-options: cloud-ide, desktop-ide // :page-aliases: help-overview-design.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -62,9 +61,9 @@ See the RAML 1.0 specification for descriptions of these types: Reusable Protobuf definitions (for example, `message` or `enum` types) published as API fragment assets. See xref:des-design-grpc-api-spec.adoc#publish-a-grpc-fragment-to-exchange[Publish a gRPC Fragment to Exchange]. [[resource-reqs]] -== Minimum Resource Requirements for the Desktop IDE +== Minimum Resource Requirements for Anypoint Code Builder -When parsing an API specification, the desktop IDE depends on your computer's resources. To avoid issues, ensure that your computer has the following minimum resources available: +When parsing an API specification, Anypoint Code Builder depends on your computer's resources. To avoid issues, ensure that your computer has the following minimum resources available: include::anypoint-code-builder::partial$acb-api-design.adoc[tag="apid-resource-reqs"] @@ -74,8 +73,6 @@ include::anypoint-code-builder::partial$acb-api-design.adoc[tag="apid-resource-r To avoid common issues, follow these guidelines: include::anypoint-code-builder::partial$acb-api-design.adoc[tag="apid-best-practices"] -+ -This best practice applies to the cloud IDE only. * Before designing an OAS or RAML API specification, review <> or <> diff --git a/code-builder-home/modules/ROOT/pages/des-govern-api.adoc b/code-builder-home/modules/ROOT/pages/des-govern-api.adoc index fa287bae5..32e2d9852 100644 --- a/code-builder-home/modules/ROOT/pages/des-govern-api.adoc +++ b/code-builder-home/modules/ROOT/pages/des-govern-api.adoc @@ -1,5 +1,4 @@ = Validating API Specifications Against Governance Rulesets -:page-deployment-options: cloud-ide, desktop-ide // :page-aliases: include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -246,7 +245,7 @@ You can also use the command *MuleSoft: Remove Governance Ruleset...* from the c To examine the configuration of a ruleset's YAML file: . In the *Governance Ruleset* panel, hover over a ruleset to display its *More actions* (*...*) menu. -. Click *Show in Files* to open the YAML file in a *ruleset.yaml* tab in the IDE. +. Click *Show in Files* to open the YAML file in a *ruleset.yaml* tab. The following example shows version 1.6.1 of the HTTPS Enforcement YAML file: diff --git a/code-builder-home/modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc b/code-builder-home/modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc index 29cdbc83e..56b1afa37 100644 --- a/code-builder-home/modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc +++ b/code-builder-home/modules/ROOT/pages/des-publish-api-spec-to-exchange.adoc @@ -1,11 +1,8 @@ = Publishing API Projects to Exchange -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: publish-api-spec-to-exchange.adoc, tut-af-design-api-publish-api-spec-to-exchange.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Publish your API project to Anypoint Exchange so that other team members can find and use it. @@ -14,7 +11,7 @@ Publish your API project to Anypoint Exchange so that other team members can fin Before publishing an API project: -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:des-create-api-specs.adoc[Create your API specification] or xref:des-create-api-fragments.adoc[fragment]. // Prereq bullet on familiarity with biz groups include::partial$acb-reusable-steps.adoc[tags="prereq-business-groups"] @@ -41,8 +38,7 @@ Alternatively: * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== .. Enter `publish` and select the following command: + diff --git a/code-builder-home/modules/ROOT/pages/des-publish-grpc-api-to-exchange.adoc b/code-builder-home/modules/ROOT/pages/des-publish-grpc-api-to-exchange.adoc index 50fa78db1..21d2815ec 100644 --- a/code-builder-home/modules/ROOT/pages/des-publish-grpc-api-to-exchange.adoc +++ b/code-builder-home/modules/ROOT/pages/des-publish-grpc-api-to-exchange.adoc @@ -1,5 +1,4 @@ = Publishing Your gRPC API to Exchange -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -11,7 +10,7 @@ In Exchange, published gRPC API projects appear as assets of type *gRPC API*. Pu == Before You Begin * xref:des-design-grpc-api-spec.adoc[Design a gRPC API specification] in Anypoint Code Builder, or create a Protobuf library project for reusable types and services. -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. include::partial$acb-reusable-steps.adoc[tags="prereq-business-groups"] @@ -44,7 +43,7 @@ MuleSoft: Publish API Project to Exchange image::des-publish-api-project.png["Publish API Project to Exchange form with banner to sync centralized rulesets"] . Click *Publish*. + -The IDE builds the project and publishes the asset to Exchange. When publishing is complete, you see a message that the API specification (or fragment) successfully published to Exchange. +Anypoint Code Builder builds the project and publishes the asset to Exchange. When publishing is complete, you see a message that the API specification (or fragment) successfully published to Exchange. + If the project has validation or build errors, fix them before publishing. Check the *Problems* tab and the xref:start-open-output-panel.adoc[output panel] for details. . Click *View Asset* to open the published asset in Exchange. diff --git a/code-builder-home/modules/ROOT/pages/imp-asyncapi.adoc b/code-builder-home/modules/ROOT/pages/imp-asyncapi.adoc index 609724635..34b693fa3 100644 --- a/code-builder-home/modules/ROOT/pages/imp-asyncapi.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-asyncapi.adoc @@ -1,5 +1,4 @@ = Implementing AsyncAPI Specifications -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: imp-implement-apis.adoc :supported-spec-version: Only supported versions of the AsyncAPI specifications in Exchange are available for scaffolding. Unsupported versions don't appear in the search results. @@ -98,7 +97,7 @@ When you create the project, Anypoint Code Builder: + ** Scaffolds your API specification into the new Mule project that opens to a configuration XML file with scaffolded flows (`flows.xml`), for example: + -image::imp-asyncapi-project-ex.png["AsyncAPI implementation project in the IDE"] +image::imp-asyncapi-project-ex.png["AsyncAPI implementation project"] + The configuration XML file includes the interface for your implementation project, with flows that contain Message Listener (``) configurations for each `publish` operation in the specification. @@ -135,7 +134,7 @@ Scaffold or re-scaffold an AsyncAPI specification from Exchange into an existing . Meet the prerequisites in <>. + -Use of AsyncAPI features in the IDE requires enablement by an Anypoint Platform organization administrator. +Use of AsyncAPI features requires enablement by an Anypoint Platform organization administrator. . In Anypoint Code Builder, open your project. + // Pointer to Command Palette @@ -153,13 +152,13 @@ MuleSoft: Import Asset from Exchange ---- My AsyncAPI Spec ---- -. Wait for the IDE to load a list of matches to the name, and then select your AsyncAPI specification. +. Wait for Anypoint Code Builder to load a list of matches to the name, and then select your AsyncAPI specification. + {supported-spec-version} . When prompted for a version, select the version of the API to import, such as `_1.0.0_` or `_2.0.0_`. . Select *Yes* when prompted to scaffold the API dependency. + -When the scaffolding process is complete, the IDE opens to a configuration XML file that contains the scaffolded flows (`flows.xml`). If you re-scaffolded the specification, see the <> about which new configurations are scaffolded into your project. +When the scaffolding process is complete, Anypoint Code Builder opens to a configuration XML file that contains the scaffolded flows (`flows.xml`). If you re-scaffolded the specification, see the <> about which new configurations are scaffolded into your project. // Shared step on adding business logic include::partial$acb-reusable-steps.adoc[tags="implement-business-logic"] diff --git a/code-builder-home/modules/ROOT/pages/imp-filter-search-results.adoc b/code-builder-home/modules/ROOT/pages/imp-filter-search-results.adoc index 50c301b2b..0064c4407 100644 --- a/code-builder-home/modules/ROOT/pages/imp-filter-search-results.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-filter-search-results.adoc @@ -1,11 +1,8 @@ = Filtering Search Results -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: filter-search-results.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] When implementing an API, use the advanced search filters to find API specifications in Exchange. diff --git a/code-builder-home/modules/ROOT/pages/imp-implement-api-specs.adoc b/code-builder-home/modules/ROOT/pages/imp-implement-api-specs.adoc index 0be58894a..f6b8d5021 100644 --- a/code-builder-home/modules/ROOT/pages/imp-implement-api-specs.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-implement-api-specs.adoc @@ -1,5 +1,4 @@ = Implementing OAS, RAML, AsyncAPI, and GraphQL APIs -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: ui-tut-implement.adoc, implement-api-specification.adoc, implement-an-api-specification.adoc, tut-af-implement-am-flights-api.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -127,7 +126,7 @@ You can now implement the interface within the Mule app. [[re-scaffold-spec]] == Re-scaffold an API Specification into a Project -Re-scaffolding enables you to update a project in the IDE with the latest changes and version of an API spec in Anypoint Exchange. Re-scaffolding updates the configuration XML and `pom.xml` in your project. To re-scaffold a spec defined in a local API design project that is not published to Exchange, see xref:imp-implement-local-apis.adoc[], instead. +Re-scaffolding enables you to update a project with the latest changes and version of an API spec in Anypoint Exchange. Re-scaffolding updates the configuration XML and `pom.xml` in your project. To re-scaffold a spec defined in a local API design project that is not published to Exchange, see xref:imp-implement-local-apis.adoc[], instead. This procedure assumes that an updated version of the spec is available from Exchange, for example, a 2.0.0 version: diff --git a/code-builder-home/modules/ROOT/pages/imp-implement-grpc-api-spec.adoc b/code-builder-home/modules/ROOT/pages/imp-implement-grpc-api-spec.adoc index bef900e55..22418526d 100644 --- a/code-builder-home/modules/ROOT/pages/imp-implement-grpc-api-spec.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-implement-grpc-api-spec.adoc @@ -1,5 +1,4 @@ = Implementing a gRPC API Specification with Anypoint Code Builder -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -24,7 +23,7 @@ After scaffolding, implement the business logic in each flow, then run and deplo == Before You Begin * xref:des-design-grpc-api-spec.adoc[Design a gRPC API specification] in Anypoint Code Builder, then xref:des-publish-grpc-api-to-exchange.adoc[publish it to Exchange]. Scaffolding is supported only for gRPC API specs published to Anypoint Exchange as a *gRPC API* asset. The specification must be available in Exchange before you can scaffold it into a project. -* xref:start-acb.adoc[Set up and access the IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Verify that your Mule runtime supports gRPC. gRPC uses HTTP/2; Mule runtime 4.11 or later is required. See xref:int-versions.adoc[]. include::partial$acb-reusable-steps.adoc[tags="prereqs-implementation"] diff --git a/code-builder-home/modules/ROOT/pages/imp-implement-local-apis.adoc b/code-builder-home/modules/ROOT/pages/imp-implement-local-apis.adoc index 3edd7d82e..75ee6190e 100644 --- a/code-builder-home/modules/ROOT/pages/imp-implement-local-apis.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-implement-local-apis.adoc @@ -1,5 +1,4 @@ = Iteratively Design and Implement APIs -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -43,7 +42,7 @@ For more information, see https://code.visualstudio.com/docs/editing/workspaces/ == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:des-create-api-specs.adoc[Create and test your API specification]. [[scaffold-spec-into-project]] @@ -65,8 +64,7 @@ Alternatively, use the Command Palette. ** Use the keyboard shortcuts: *** Mac: Cmd+Shift+p *** Windows: Ctrl+Shift+p -** In the desktop IDE, select *View* > *Command Palette*. -** In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +** Select *View* > *Command Palette*. . Select the following command: + @@ -104,7 +102,7 @@ Anypoint Code Builder scaffolds your local API specification into a new Mule pro + image::imp-local-api-scaffolded.png["Scaffolding process ended message"] + -Both the API spec and the Mule project open in your IDE, for example: +Both the API spec and the Mule project open, for example: + image::imp-local-api-workspace.png["API spec and implementation project in Explorer view"] + diff --git a/code-builder-home/modules/ROOT/pages/imp-implementing-apis.adoc b/code-builder-home/modules/ROOT/pages/imp-implementing-apis.adoc index 9fdeb3b16..78e99bad1 100644 --- a/code-builder-home/modules/ROOT/pages/imp-implementing-apis.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-implementing-apis.adoc @@ -1,5 +1,4 @@ = Implementing APIs -:page-deployment-options: cloud-ide, desktop-ide // implement-api-specification diff --git a/code-builder-home/modules/ROOT/pages/imp-manage-api-spec-versions.adoc b/code-builder-home/modules/ROOT/pages/imp-manage-api-spec-versions.adoc index 1cf42a6a0..55c024bc6 100644 --- a/code-builder-home/modules/ROOT/pages/imp-manage-api-spec-versions.adoc +++ b/code-builder-home/modules/ROOT/pages/imp-manage-api-spec-versions.adoc @@ -1,5 +1,4 @@ = Managing API Spec Versions -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -9,7 +8,7 @@ You can also manage API spec versions using MuleSoft Vibes. See xref:vibes-manag == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. * Have an implementation or integration project that includes an API spec dependency published to Anypoint Exchange. diff --git a/code-builder-home/modules/ROOT/pages/import-dataweave-library.adoc b/code-builder-home/modules/ROOT/pages/import-dataweave-library.adoc index 092649c4d..3c23123ae 100644 --- a/code-builder-home/modules/ROOT/pages/import-dataweave-library.adoc +++ b/code-builder-home/modules/ROOT/pages/import-dataweave-library.adoc @@ -1,10 +1,7 @@ = Import a DataWeave Library -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Anypoint Code Builder enables you to import DataWeave libraries from Exchange into your Mule application. diff --git a/code-builder-home/modules/ROOT/pages/index.adoc b/code-builder-home/modules/ROOT/pages/index.adoc index e1c865e1a..4b28a31d2 100644 --- a/code-builder-home/modules/ROOT/pages/index.adoc +++ b/code-builder-home/modules/ROOT/pages/index.adoc @@ -1,20 +1,17 @@ = Anypoint Code Builder Overview -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: ui-help.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] //intro -Use the Anypoint Code Builder integrated development environment (IDE) for your API designs, implementations, and integration development. Work locally with Anypoint Code Builder for Desktop on Microsoft Visual Studio Code (VS Code) or from your browser with Anypoint Code Builder through Anypoint Platform. The IDEs support the development lifecycle: +Use Anypoint Code Builder for your API designs, implementations, and integration development. Work locally with Anypoint Code Builder on Microsoft Visual Studio Code (VS Code). Anypoint Code Builder supports the development lifecycle: * API specification design, a mocking service for testing, source control, and publication to Anypoint Exchange * API implementation features for importing supported API specifications (such as OAS, RAML, AsyncAPI, or GraphQL) and autogenerating interfaces (scaffolding) for flows and error handlers within a Mule application * Integration development to connect systems, transform data to required formats, and provide business logic to manage messages and events programmatically within a Mule application -The desktop and cloud IDEs offer the same Anypoint Code Builder functionality. Use the IDE that works better for your needs. You can share project snapshots between IDEs or with members of your team by using import and export features or by using a <> of your choice. +You can share project snapshots with members of your team by using import and export features or by using a <> of your choice. For an introduction to Anypoint Code Builder, see our Trailhead badge, https://trailhead.salesforce.com/content/learn/modules/mulesoft-anypoint-code-builder-quick-look[Anypoint Code Builder: Quick Look^] (login required). Sign up if you don't have a Trailhead account. @@ -22,12 +19,12 @@ For an introduction to Anypoint Code Builder, see our Trailhead badge, https://t [[extension-pack]] == Anypoint Extension Pack -Get the Anypoint Code Builder experience through the Anypoint Extension Pack for Visual Studio Code. The cloud-based extensions are preinstalled into a code-server implementation that makes VS Code accessible from a browser. The desktop extensions require installation to your VS Code IDE. See xref:start-acb.adoc[]. +Get the Anypoint Code Builder experience through the Anypoint Extension Pack for Visual Studio Code. The extensions require installation to VS Code. See xref:start-acb.adoc[]. [[us-eu-clouds]] == Cloud Hosts -Anypoint Code Builder is available through Anypoint Platform from US, EU, Canada (desktop IDE only), Japan (desktop IDE only), India (desktop IDE only), and Australia (desktop IDE only) cloud hosts. To help your organization meet emerging regulatory requirements that differ by region, Anypoint Platform does not share organization information, permissions, account data, or projects between hosts. +Anypoint Code Builder is available through Anypoint Platform from US, EU, Canada, Japan, India, and Australia cloud hosts. To help your organization meet emerging regulatory requirements that differ by region, Anypoint Platform does not share organization information, permissions, account data, or projects between hosts. [%header,cols="1,1,2"] |=== @@ -41,30 +38,30 @@ Anypoint Code Builder is available through Anypoint Platform from US, EU, Canada |https://eu1.anypoint.mulesoft.com/login[eu1.anypoint.mulesoft.com^] |EU-compliant host. MuleSoft hosts this control plane within EU (Frankfurt) data centers. -|Canada Cloud (desktop IDE only) +|Canada Cloud |https://ca1.platform.mulesoft.com/login/[ca1.platform.mulesoft.com^] |MuleSoft hosts this control plane within Canada (North America) data centers. -|Japan Cloud (desktop IDE only) +|Japan Cloud |https://jp1.platform.mulesoft.com/login/[jp1.platform.mulesoft.com^] |MuleSoft hosts this control plane within Japan (APAC) data centers. -|India Cloud (desktop IDE only) +|India Cloud |https://in1.platform.mulesoft.com/login/[in1.platform.mulesoft.com^] |MuleSoft hosts this control plane within India (APAC) data centers. -|Australia Cloud (desktop IDE only) +|Australia Cloud |https://au1.platform.mulesoft.com/login/[au1.platform.mulesoft.com^] |MuleSoft hosts this control plane within Australia (APAC) data centers. |=== Anypoint Platform hosts deployment targets for managed Mule runtime versions and related data, including data and metadata about your Mule implementations. -To change the host from the default (US), see xref:start-acb.adoc#change-clouds[Set the Desktop IDE to a Different Control Plane]. +To change the host from the default (US), see xref:start-acb.adoc#change-clouds[Set Anypoint Code Builder to a Different Control Plane]. -Use of Anypoint Code Builder in the desktop and cloud IDEs requires an Anypoint Platform user account. Access to the cloud IDE and use of some features in both IDEs require permissions set by an organization administrator (see xref:start-configure-permissions.adoc[]). +Use of Anypoint Code Builder requires an Anypoint Platform user account. Use of some features requires permissions set by an organization administrator (see xref:start-configure-permissions.adoc[]). -To open Anypoint Code Builder from Anypoint Platform, see xref:start-acb.adoc#set-up-web[Launch the Cloud IDE]. If you do not have an Anypoint Platform account through your organization, you can sign up in the US or EU cloud host for Anypoint Platform. +If you do not have an Anypoint Platform account through your organization, you can sign up in the US or EU cloud host for Anypoint Platform. See xref:hosting-home::index.adoc[] for more information. @@ -99,13 +96,13 @@ A flow reference enables you to trigger execution of a flow or subflow from anot == Anypoint Platform Product Integrations //relationships to our other products -Both the web and desktop Anypoint Code Builder IDEs integrate with key Anypoint Platform products and features: +Anypoint Code Builder integrates with key Anypoint Platform products and features: * Anypoint Exchange for publishing the API specifications that you create and importing API specifications and development resources (such as connectors, integration project templates and examples) into your projects * CloudHub and CloudHub 2.0 for deploying the implementations and integrations that you build * MuleSoft VCS for importing API specification projects into Anypoint Code Builder and optionally, synchronizing imported projects by using the Anypoint source control management (SCM) system -The use of features provided by Anypoint Platform products through the cloud and desktop IDEs requires a connection from the IDE to Anypoint Platform. You establish this connection by logging in to your Anypoint Platform account from the IDE. For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE]. +The use of features provided by Anypoint Platform products requires a connection. You establish this connection by logging in to your Anypoint Platform account from Anypoint Code Builder. For more information, see xref:start-acb.adoc#login-ide[Sign in to Anypoint Platform from Anypoint Code Builder]. [[scm]] == Source and Version Control diff --git a/code-builder-home/modules/ROOT/pages/int-ai-developing-integrations.adoc b/code-builder-home/modules/ROOT/pages/int-ai-developing-integrations.adoc index 58e4393ab..442a2b1f9 100644 --- a/code-builder-home/modules/ROOT/pages/int-ai-developing-integrations.adoc +++ b/code-builder-home/modules/ROOT/pages/int-ai-developing-integrations.adoc @@ -1,7 +1,6 @@ = Developing Integrations Using MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide -To develop, manage, or maintain your applications, use MuleSoft Vibes in Anypoint Code Builder. It is a purpose-built assistant for the development lifecycle, available directly in the IDE. It integrates with the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] and supports many capabilities, such as: +MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available with Anypoint Code Builder. Use it to develop, manage, or maintain your applications. MuleSoft Vibes integrates with the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] and supports many capabilities, such as: * Developing API specifications * Creating and configuring applications @@ -27,7 +26,7 @@ NOTE: MuleSoft Vibes is available on US, EU, Canada, and Japan cloud hosts. Before you start creating your API spec, make sure you meet the following prerequisites: -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. * Ensure you have the following permissions to use MuleSoft Vibes: ** *Mule Developer Generative AI User* diff --git a/code-builder-home/modules/ROOT/pages/int-autodiscovery-config.adoc b/code-builder-home/modules/ROOT/pages/int-autodiscovery-config.adoc index 643c69c3c..edfc16ecf 100644 --- a/code-builder-home/modules/ROOT/pages/int-autodiscovery-config.adoc +++ b/code-builder-home/modules/ROOT/pages/int-autodiscovery-config.adoc @@ -1,5 +1,4 @@ = Tracking Requests with Autodiscovery -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-api-autodiscovery-local.adoc b/code-builder-home/modules/ROOT/pages/int-configure-api-autodiscovery-local.adoc index d81d07045..b145b5ceb 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-api-autodiscovery-local.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-api-autodiscovery-local.adoc @@ -1,5 +1,4 @@ = Configure API Autodiscovery for Local Testing -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-components-add.adoc b/code-builder-home/modules/ROOT/pages/int-configure-components-add.adoc index fdf153bf4..90837e86d 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-components-add.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-components-add.adoc @@ -1,5 +1,4 @@ = Adding a Component to Your Project -:page-deployment-options: cloud-ide, desktop-ide :open-config-xml: In the Explorer, open the configuration XML file for your project: include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-components-check-connection.adoc b/code-builder-home/modules/ROOT/pages/int-configure-components-check-connection.adoc index c8e1f9cae..79964e338 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-components-check-connection.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-components-check-connection.adoc @@ -1,5 +1,4 @@ = Testing a Connection Configuration -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-components-import-connector-exchange.adoc b/code-builder-home/modules/ROOT/pages/int-configure-components-import-connector-exchange.adoc index 20c554d42..9e1c84cfe 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-components-import-connector-exchange.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-components-import-connector-exchange.adoc @@ -1,5 +1,4 @@ = Importing a Connector from Exchange -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-components-open-from-xml.adoc b/code-builder-home/modules/ROOT/pages/int-configure-components-open-from-xml.adoc index 25d22163e..79cbe38af 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-components-open-from-xml.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-components-open-from-xml.adoc @@ -1,5 +1,4 @@ = Opening a Component in the Canvas from the Code Editor -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-configure-components.adoc b/code-builder-home/modules/ROOT/pages/int-configure-components.adoc index 609b08dd0..fedf7c56b 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-components.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-components.adoc @@ -1,5 +1,4 @@ = Configuring Components -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: int-work-with-code-snippets.adoc, work-with-code-snippets.adoc, create-xml-snippets.adoc, connect-to-a-db.adoc, tut-af-integrate-connect-to-a-db.adoc :open-config-xml: In the Explorer, open the configuration XML file for your project: diff --git a/code-builder-home/modules/ROOT/pages/int-configure-dw-expressions.adoc b/code-builder-home/modules/ROOT/pages/int-configure-dw-expressions.adoc index 5c7b12859..e91b408bd 100644 --- a/code-builder-home/modules/ROOT/pages/int-configure-dw-expressions.adoc +++ b/code-builder-home/modules/ROOT/pages/int-configure-dw-expressions.adoc @@ -44,7 +44,7 @@ Anypoint Code Builder supports these transform mapping use cases: + For more information, see xref:dataweave::dw-functions.adoc[]. -* Review the built-in documentation for functions the IDE provides. For example, see <>. +* Review the built-in documentation for functions that Anypoint Code Builder provides. For example, see <>. ** xref:dataweave::dataweave-variables-context.adoc[Predefined Mule event variables] such as `payload`, `attributes`, `vars`. @@ -111,7 +111,7 @@ image:int-dw-fx-data-tab.png["Data tab for expression field"] image:int-dw-fx-data-tab-attributes.png["Data tab for expression field with mock attributes"] |=== -The IDE shows the automatically generated strings as mock values and uses them to generate output for previews, such as in the <> tab. The attribute metadata keys in the example come from the configuration of an `HTTP Listener` component in the flow. +Anypoint Code Builder shows the automatically generated strings as mock values and uses them to generate output for previews, such as in the <> tab. The attribute metadata keys in the example come from the configuration of an `HTTP Listener` component in the flow. [[set-component-custom-metadata-on-metadata-or-data-tab]] === Set Component Custom Metadata on the Metadata or Data Tab @@ -229,7 +229,7 @@ On *Transformation Builder*, select the option that best suits your needs: [[namespaces-in-generated-dataweave]] === Namespaces in Generated DataWeave Scripts -If your input or output metadata includes namespace URIs, Anypoint Code Builder updates the generated DataWeave script for visual mapping to XML and similar targets. The IDE adds `ns` directives to the script header for each URI that needs a declaration and maps fields using qualified names with a generated prefix. Prefixes are unique in the script (such as `ns0`, `ns1`), and Anypoint Code Builder reuses any existing `ns` line if it binds the same URI. +If your input or output metadata includes namespace URIs, Anypoint Code Builder updates the generated DataWeave script for visual mapping to XML and similar targets, adds `ns` directives to the script header for each URI that needs a declaration, and maps fields using qualified names with a generated prefix. Prefixes are unique in the script (such as `ns0`, `ns1`), and Anypoint Code Builder reuses any existing `ns` line if it binds the same URI. Namespace handling applies to AI-assisted mapping and manual drag mapping in *Transformation Builder*. It also applies to other flows that generate scripts from metadata, for MIME types where the type system exposes namespaces. Provide accurate xref:int-manage-custom-metadata.adoc[custom metadata] or sample data so element namespaces are present in the structure the builder uses. @@ -322,7 +322,7 @@ If you receive an authorization error: . Verify that you are logged in to Anypoint Platform from Anypoint Code Builder. + -For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE]. +For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform]. . Contact your Anypoint Platform organization administrator to verify: + * You have the *Mule Developer Generative AI User* permission assigned in Anypoint Platform access management. @@ -466,7 +466,7 @@ image::int-dw-sample-quick-fix-create.png["Quick Fix menu displaying 'Create sam + image::dw-issue-sample-data-formats.png["Sample data format selection menu showing options including JSON, XML, CSV, Java, Text, YAML, Avro, Excel, and other supported formats"] + -The IDE opens a tab for your sample data. +Anypoint Code Builder opens a tab for your sample data. . Add content in the selected format to the sample data file. For example, for JSON: + image::int-dw-sample-quick-fix-example-dir.png["Project Explorer showing sample data files like payload.json stored in src/test/resources directory structure"] diff --git a/code-builder-home/modules/ROOT/pages/int-create-integrations.adoc b/code-builder-home/modules/ROOT/pages/int-create-integrations.adoc index b604b03ba..8881a95d9 100644 --- a/code-builder-home/modules/ROOT/pages/int-create-integrations.adoc +++ b/code-builder-home/modules/ROOT/pages/int-create-integrations.adoc @@ -1,12 +1,9 @@ = Creating Integrations -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: int-create-basic-integrations.adoc, ui-tut-integrate.adoc, create-basic-integration.adoc, develop-integration.adoc, tut-af-integrate-am-flights.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] To process your data with business logic, create an integration with connectors and other components in a Mule application. @@ -26,7 +23,7 @@ You can create multiple configuration XML files in your project. See <` element with default namespaces: +The process automatically appends an `xml` extension to the file name and opens the new configuration XML file and its canvas. The new configuration XML file contains the `` element with default namespaces: + [source,xml] -- diff --git a/code-builder-home/modules/ROOT/pages/int-create-secure-configs.adoc b/code-builder-home/modules/ROOT/pages/int-create-secure-configs.adoc index f3cc4bc95..6032950c3 100644 --- a/code-builder-home/modules/ROOT/pages/int-create-secure-configs.adoc +++ b/code-builder-home/modules/ROOT/pages/int-create-secure-configs.adoc @@ -1,11 +1,8 @@ = Defining and Securing Properties for a Mule Application -:page-deployment-options: cloud-ide, desktop-ide // no corresponding Tutorial topic include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Define configuration properties to secure and customize your Mule application configuration for different deployment environments. @@ -20,7 +17,7 @@ For a guided, conversational approach to setting up secure properties, use MuleS == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:int-create-integrations.adoc[Create an integration]. [[get-familiar]] @@ -506,11 +503,11 @@ Changes you make in the editor automatically update the XML in `global-configs.x The editor manages the configuration element. To change the actual encrypted values in `.secure.properties` files, use the secure-properties-tool JAR, edit the file directly, or ask MuleSoft Vibes to re-encrypt values. See xref:vibes-secure-properties.adoc[]. [[test-deploy]] -== Test Encrypted Properties in Your IDE +== Test Encrypted Properties in Anypoint Code Builder -If your application uses encrypted properties, add arguments for the encryption key and value to the runtime command in your IDE. Adding these arguments to the setting enables the runtime to decrypt properties used in your application so that it deploys successfully to the local runtime in your IDE. +If your application uses encrypted properties, add arguments for the encryption key and value to the runtime command. Adding these arguments to the setting enables the runtime to decrypt properties used in your application so that it deploys successfully to the local runtime. -The setting avoids an error that causes the deployment to fail when you use *Run and Debug* in your IDE: +The setting avoids an error that causes the deployment to fail when you use *Run and Debug*: ---- Couldn't find configuration property value for key ${encryption.key} @@ -530,13 +527,13 @@ from properties provider environment properties provider In the example, `-M-D` is the required prefix, `encryption.key` is the default name of the encryption key, and `my-key-value` is the value used to encrypt the properties through the Secure Properties Tool. .. If you are using a variable such as `$\{env}` in `$\{env}.secure.yaml` to identify the properties file in ``, append a value for `$\{env}` to the *Runtime: Default Arguments* field. + -For example, for a file `dev.secure.yaml` that contains properties for the development environment within the IDE: +For example, for a file `dev.secure.yaml` that contains properties for the development environment: + [source,env-configuration] ---- -M-Denv=dev ---- -. Deploy the application locally within the IDE by pressing Cmd+shift+p (Mac) or Ctrl+shift+p (Windows), and entering *View: Show Run and Debug*, then clicking *Run and Debug*. +. Deploy the application locally by pressing Cmd+shift+p (Mac) or Ctrl+shift+p (Windows), and entering *View: Show Run and Debug*, then clicking *Run and Debug*. + A successful deployment produces the following message in the *OUTPUT* tab of the output panel: + @@ -567,8 +564,7 @@ IMPORTANT: This procedure configures the _name_ of your encryption key but not i Before you begin: -* Run and test encrypted properties used by your Mule application in your IDE. See <> for guidance. -* If you are using the cloud IDE, ensure that you have the required permission: *Anypoint Code Builder Developer*. See xref:configure-permissions.adoc[]. +* Run and test encrypted properties used by your Mule application. See <> for guidance. To hide sensitive values from the Runtime Manager UI when you deploy to CloudHub or CloudHub 2.0: @@ -584,7 +580,7 @@ To hide sensitive values from the Runtime Manager UI when you deploy to CloudHub } ---- + -The _name_ (not the _value_) of your encryption key goes into a comma-separated `secureProperties` array. Later in this procedure, when you deploy your application to CloudHub, the IDE prompts you to provide the _value_ of the encryption key that you provided through the Secure Configuration Tool when encrypting your sensitive properties. +The _name_ (not the _value_) of your encryption key goes into a comma-separated `secureProperties` array. Later in this procedure, when you deploy your application to CloudHub, Anypoint Code Builder prompts you to provide the _value_ of the encryption key that you provided through the Secure Configuration Tool when encrypting your sensitive properties. . Deploy your application to CloudHub or CloudHub 2.0 by pressing Cmd+shift+p (Mac) or Ctrl+shift+p (Windows) and providing this command: + [source, command] @@ -600,7 +596,7 @@ image::deploy-to-cloudhub-icon-with-detail.png["Deploy to CloudHub rocket icon"] If you do not enter the same value, the application is able to upload to CloudHub or CloudHub 2.0, but the deployment fails because the encryption key value does not work. . Select the *Sandbox* environment for your deployment. + -Other environments are not supported, and attempts to deploy to the *Design* environment fail with a `500` error code. While the deployment is in progress, the IDE provides the status of the process and prompts you to open the application in Runtime Manager when the deployment completes. +Other environments are not supported, and attempts to deploy to the *Design* environment fail with a `500` error code. While the deployment is in progress, Anypoint Code Builder provides the status of the process and prompts you to open the application in Runtime Manager when the deployment completes. + If you receive an error message that says the application `was not successfully deployed to "Sandbox" in CloudHub`, you can open Runtime Manager to check the logs and correct some issues. . Click *Open in Runtime Manager* to open the management options for the application in Runtime Manager. @@ -626,12 +622,12 @@ For more information, see xref:runtime-manager::index.adoc[]. For information ab Hosts, ports, directories, and other settings in the configuration XML often differ depending on the target environment for your deployment, such as the development, sandbox, or production environment. For example, on your desktop, the host name is typically `localhost`, the port something like `8081`, and the directory is a path on your local machine rather than a path to an external host. -When developing your application in the IDE, create separate properties files for each of the target environments that require different settings, and provide the appropriate settings in each file. +When developing your application, create separate properties files for each of the target environments that require different settings, and provide the appropriate settings in each file. [[filename-patterns]] Typical filenames follow patterns like these: -* `dev.properties.yaml` or `dev.secure.yaml` for your development environment in the IDE +* `dev.properties.yaml` or `dev.secure.yaml` for your development environment * `sandbox.properties.yaml` or `sandbox.secure.yaml` for a pre-production environment * `prod.properties.yaml` or `prod.secure.yaml` for the production environment @@ -661,14 +657,14 @@ Notice the value of the `file` attribute in this example: //---- //+ //After deploying to CloudHub or CloudHub 2.0, you can add a new value through the Runtime Manager UI that takes precedence over this setting. -. _Before deploying to CloudHub or CloudHub 2.0_, ensure that the application deploys locally your IDE: -.. In the IDE, press Cmd+shift+p (Mac) or Ctrl+shift+p (Windows), and provide this command: +. _Before deploying to CloudHub or CloudHub 2.0_, ensure that the application deploys locally: +.. Press Cmd+shift+p (Mac) or Ctrl+shift+p (Windows), and provide this command: + [source,command] ---- Open 'launch.json' ---- -.. In `launch.json`, append the value of the `env` variable to use when running the application from the IDE. +.. In `launch.json`, append the value of the `env` variable to use when running the application. + Notice the setting `-M-Denv=dev` in this `launch.json` example. For more information about launch configurations and alternative methods for passing properties, see xref:int-run-mule-apps-with-properties.adoc[]. + @@ -690,7 +686,7 @@ Notice the setting `-M-Denv=dev` in this `launch.json` example. For more informa ---- + `-M-Denv=dev` sets the `env` variable to `dev` as a Mule runtime argument (`"mule.runtime.args"`). -.. If your application defines encrypted properties in your properties file, configure the *Runtime: Default Arguments* command in the IDE with the encryption key and value so that the local deployment to your IDE can decrypt the properties when the application runs. +.. If your application defines encrypted properties in your properties file, configure the *Runtime: Default Arguments* command with the encryption key and value so that the local deployment can decrypt the properties when the application runs. + _Do not_ configure `launch.json` with sensitive property values. See <> for guidance with the recommended configuration. . Launch the `deploy.json` file for your application by pressing Cmd+shift+p (Mac) or Ctrl+shift+p (Windows) and providing this command: diff --git a/code-builder-home/modules/ROOT/pages/int-debug-mule-apps.adoc b/code-builder-home/modules/ROOT/pages/int-debug-mule-apps.adoc index f08ce9760..ba723ba71 100644 --- a/code-builder-home/modules/ROOT/pages/int-debug-mule-apps.adoc +++ b/code-builder-home/modules/ROOT/pages/int-debug-mule-apps.adoc @@ -1,12 +1,9 @@ = Debugging Mule Applications -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: debug-add-breakpoint.adoc, debug-add-components.adoc, debug-add-logger-set-variables.adoc, debug-run-debug-sessions.adoc, debug-a-mule-application.adoc, debugging-mule-apps.adoc, tut-af-debug-am-flights.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] In Anypoint Code Builder, the embedded debugger pauses Mule flows so you can inspect payloads and variables, evaluate DataWeave expressions, and step through processors in the XML editor or on the canvas. Set breakpoints in configuration files or on components, run in debug mode, step through execution with the debug toolbar, and hot deploy updates while the runtime stays up. @@ -29,7 +26,7 @@ For example, trigger an HTTP Listener, or trigger a Scheduler on demand instead == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:int-create-integrations.adoc[Create an integration]. [[debugger-view-overview]] @@ -209,7 +206,7 @@ At a *Flow Ref* component (``), *Step Over* doesn't enter the referen ==== . *Step Into* (F11) — Enters the next processor, including following a `` into the referenced flow. + -When you step into a flow reference, the IDE opens the Mule configuration file that declares that referenced flow, moves the canvas to that flow, and pauses on the first processor inside it. If the referenced flow is in an imported Mule project dependency, the dependency flow opens in a read-only canvas and XML view. You can step through its processors, and stepping continues in the caller flow where appropriate after you step through the referenced flow. +When you step into a flow reference, Anypoint Code Builder opens the Mule configuration file that declares that referenced flow, moves the canvas to that flow, and pauses on the first processor inside it. If the referenced flow is in an imported Mule project dependency, the dependency flow opens in a read-only canvas and XML view. You can step through its processors, and stepping continues in the caller flow where appropriate after you step through the referenced flow. + .Step Into Details [%collapsible] @@ -273,7 +270,7 @@ A hot deployment updates a running instance of your application but does not pac To perform a hot deploy: -. Ensure your Mule application is running in the IDE. +. Ensure your Mule application is running. . Make an update to your application. . In the editor toolbar for the running Mule application, click *Save and Hot-deploy to Mule Runtime* (lightning bolt icon) to push the change to the running runtime without a full stop and dependency resolution cycle. diff --git a/code-builder-home/modules/ROOT/pages/int-deploy-mule-apps.adoc b/code-builder-home/modules/ROOT/pages/int-deploy-mule-apps.adoc index 5e84f48a6..9ca0f17a0 100644 --- a/code-builder-home/modules/ROOT/pages/int-deploy-mule-apps.adoc +++ b/code-builder-home/modules/ROOT/pages/int-deploy-mule-apps.adoc @@ -1,5 +1,4 @@ = Deploying Mule Apps to CloudHub and CloudHub 2.0 -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: deploy-a-mule-application-to-cloudhub.adoc, tut-af-deploy-am-flights.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -8,7 +7,7 @@ You can use Anypoint Code Builder to deploy your Mule application to CloudHub. == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:int-create-integrations.adoc[Create an integration]. * Install a REST client, such as Postman or AdvancedRestClient. diff --git a/code-builder-home/modules/ROOT/pages/int-developing-integrations.adoc b/code-builder-home/modules/ROOT/pages/int-developing-integrations.adoc index bba22e608..f0bdc79ca 100644 --- a/code-builder-home/modules/ROOT/pages/int-developing-integrations.adoc +++ b/code-builder-home/modules/ROOT/pages/int-developing-integrations.adoc @@ -1,11 +1,8 @@ = Developing Integrations -:page-deployment-options: cloud-ide, desktop-ide // develop-integration include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Use Anypoint Code Builder to build integrations within a Mule application. Integrations with Anypoint Code Builder rely on a service-based framework that decouples your source from protocols and routing requirements. @@ -31,7 +28,7 @@ you can optionally: Other tasks you can do with your integration apps are: * xref:int-export-mule-project.adoc[Export Mule projects into a shareable or deployable JAR file]. -* xref:int-import-mule-project.adoc[Import project JAR files into a workspace in your IDE]. +* xref:int-import-mule-project.adoc[Import project JAR files into a workspace]. * xref:int-deploy-mule-apps.adoc[Deploy Mule apps to CloudHub]. == Source Control for Integration Projects diff --git a/code-builder-home/modules/ROOT/pages/int-export-mule-project.adoc b/code-builder-home/modules/ROOT/pages/int-export-mule-project.adoc index e8500a97a..aa9de4409 100644 --- a/code-builder-home/modules/ROOT/pages/int-export-mule-project.adoc +++ b/code-builder-home/modules/ROOT/pages/int-export-mule-project.adoc @@ -1,11 +1,8 @@ = Exporting Mule Projects -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: package-mule-application.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] A Mule application is an integration or implementation application that runs on Mule runtime engine. To share the application across different teams, or to deploy the application elsewhere, you can export and package a snapshot of Mule application resources. Additionally, you can publish a Mule project to Exchange as either a template or an example. @@ -20,11 +17,9 @@ The shareable JAR includes: * `mule-artifact.json` * `pom.xml` -The IDEs generate the dependencies automatically based on the settings in the POM file (`pom.xml`). You or your teammates can import the JAR file and continue developing in Anypoint Code Builder or Anypoint Studio (Studio). +Anypoint Code Builder generates the dependencies automatically based on the settings in the POM file (`pom.xml`). You or your teammates can import the JAR file and continue developing in Anypoint Code Builder or Anypoint Studio (Studio). -To import a shareable JAR, see xref:int-import-mule-project.adoc#desktop-project-package[Import a Shareable Project JAR File into the Desktop IDE] and xref:int-import-mule-project.adoc#web-project-package[Import a Shareable Project JAR File into the Cloud IDE]. - -If you are migrating from Cloud IDE to Desktop IDE, see xref:int-import-mule-project.adoc#migrate-cloud-to-desktop[Migrate a Project from Cloud IDE to Desktop IDE] for migration options and steps. +To import a shareable JAR, see xref:int-import-mule-project.adoc#desktop-project-package[Import a Shareable Project JAR File into Anypoint Code Builder]. [[deployable]] == Deployable JAR @@ -39,7 +34,7 @@ For more information on deployment options, see xref:hosting-home::index.adoc#ru == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:int-create-integrations.adoc[Create an integration]. [[export-mule-project]] @@ -66,26 +61,16 @@ MuleSoft: Export Mule Project . In *File Name*, enter a name for the exported file. . In *File Location*, enter or select the directory where you want to save the JAR file. . Click *Export*. -. The terminal window in the IDE opens automatically to provide the status of the packaging process, which includes execution of the export command, a scan for the project to export, and the packaging of the project snapshot into a JAR file. +. The terminal window opens automatically to provide the status of the packaging process, which includes execution of the export command, a scan for the project to export, and the packaging of the project snapshot into a JAR file. [[find-download-jar]] === Find or download the JAR -When packaging completes, find or download the JAR file by following the prompts that appear in the IDE: +When packaging completes, find the JAR file by following the prompts that appear: -* In the desktop IDE, click *Open Folder* to open the directory that contains the JAR file in the Explorer view. -* In the cloud IDE, click *Download File* to download the JAR file to a directory on your local machine: -+ --- -** For a JAR file that is 32 MB or smaller, the IDE automatically downloads the file to your Downloads folder. -** For a JAR file that is larger than 32 MB, the IDE disallows downloads to built-in folders that contain system files, such as the Downloads, Desktop, or Documents folder. -+ -... Select a folder for the download. -... At the prompt, click *View files* to allow the site to view the files in the folder you select. -... Click *Save Changes*. --- +* Click *Open Folder* to open the directory that contains the JAR file in the Explorer view. -The terminal window in the IDE also provides the path to the JAR, in the `/target` directory under your project folder. In the desktop IDE, you can find the JAR file in the Explorer, under Java Projects: +The terminal window also provides the path to the JAR, in the `/target` directory under your project folder. You can find the JAR file in the Explorer, under Java Projects: image::int-export-deployable.png["Deployable JAR file in the Java Projects folder"] diff --git a/code-builder-home/modules/ROOT/pages/int-global-config-elements.adoc b/code-builder-home/modules/ROOT/pages/int-global-config-elements.adoc index 8c1d20674..69033a595 100644 --- a/code-builder-home/modules/ROOT/pages/int-global-config-elements.adoc +++ b/code-builder-home/modules/ROOT/pages/int-global-config-elements.adoc @@ -1,5 +1,4 @@ = Managing Global Configuration Elements -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -17,7 +16,7 @@ Use the Global Configurations view to manage the configurations your Mule applic == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:int-create-integrations.adoc[Create an integration project]. [[open-global-elements-panel]] @@ -109,7 +108,7 @@ Use *Preview Mode* to switch the active environment and verify that property pla ACB supports the Mule Secure Properties module: -* Generate encrypted property values from the IDE. +* Generate encrypted property values from Anypoint Code Builder. * ACB warns you when a properties file contains unencrypted credentials. For information about encrypting values and referencing them in your Mule application, see xref:int-create-secure-configs.adoc[]. diff --git a/code-builder-home/modules/ROOT/pages/int-import-mule-project.adoc b/code-builder-home/modules/ROOT/pages/int-import-mule-project.adoc index b6b559f4b..412502eef 100644 --- a/code-builder-home/modules/ROOT/pages/int-import-mule-project.adoc +++ b/code-builder-home/modules/ROOT/pages/int-import-mule-project.adoc @@ -1,13 +1,10 @@ -= Importing Projects into the IDE -:page-deployment-options: cloud-ide, desktop-ide += Importing Projects into Anypoint Code Builder :page-aliases: upload-a-project.adoc[] include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] -Import a project JAR file or folder into a workspace in your IDE. +Import a project JAR file or folder into a workspace. A project directory contains a Mule application for an integration or implementation. You can also import a Maven multi-module project and apply the properties, dependencies, and versions from a Maven parent POM file to the `pom.xml` file of each child module. For more information about the Maven parent POM file, see https://maven.apache.org/pom/maven/index.html[Maven Project Parent POM]. @@ -16,49 +13,10 @@ If you encounter an import issue, check for workarounds in xref:acb-release-note To _export_ a JAR file that packages a project with resources from your application, see xref:int-export-mule-project.adoc[]. -[[migrate-cloud-to-desktop]] -== Migrate a Project from Cloud IDE to Desktop IDE - -Migrate your project from Cloud IDE to Desktop IDE by downloading the project folder directly or by exporting a JAR file from Cloud IDE. - -=== Download Your Project Folder - -. In Cloud IDE, select *File* > *Open Folder* and navigate to the folder that contains your project. -. In the Explorer view, right-click the project folder. -. Select *Download*. -+ -The Cloud IDE downloads the selected folder to your local file system. - -=== Export Your Project and Download a JAR - -. Open the Command Palette. -+ -.Show me how -[%collapsible] -==== -* Use the keyboard shortcuts: -** Mac: Cmd+Shift+p -** Windows: Ctrl+Shift+p -* Click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. -==== -. Search for and run this command: -+ -[source,command] ----- -MuleSoft: Export Mule Project ----- -+ A JAR file is created with the name of your project. -. Right-click the JAR file and select *Download*. -+ -The CloudIDE downloads the JAR file to your local file system. - -After you download either a project folder or JAR file from Cloud IDE, continue with <>. - - == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. -* Close any open project in your IDE. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. +* Close any open project. + -- // Pointer to Close Project @@ -69,9 +27,9 @@ IMPORTANT: Never open or unpack a project folder within another project folder. //H2: DESKTOP [[import-desktop]] -== Import and Open a Project in the Desktop IDE +== Import and Open a Project in Anypoint Code Builder -Use the desktop IDE to upload a project directory or shareable JAR file into a project workspace. +Use Anypoint Code Builder to upload a project directory or shareable JAR file into a project workspace. * <> * <> @@ -79,17 +37,17 @@ Use the desktop IDE to upload a project directory or shareable JAR file into a p [[desktop-project-package]] -=== Import a Shareable Project JAR File into the Desktop IDE +=== Import a Shareable Project JAR File into Anypoint Code Builder -Import a shareable JAR file for a snapshot of a Mule project into the desktop IDE. +Import a shareable JAR file for a snapshot of a Mule project into Anypoint Code Builder. To create a shareable JAR, see xref:int-export-mule-project.adoc#export-mule-project[Export Mule Project]. The contents are lightweight because they don't include dependencies. -The IDE generates the dependencies configured in the `pom.xml` for the project. +Anypoint Code Builder generates the dependencies configured in the `pom.xml` for the project. -To import a shareable JAR file in your desktop IDE: +To import a shareable JAR file in Anypoint Code Builder: -. Ensure that no project is open in the IDE. +. Ensure that no project is open. // include for this procedure include::partial$acb-open-packaged-sources.adoc[tags="open-command-palette-desktop"] include::partial$acb-open-packaged-sources.adoc[tags="load-shareable-jar"] @@ -101,15 +59,15 @@ include::partial$acb-open-packaged-sources.adoc[tags="test-project"] [[desktop-project-folder]] -=== Import a Project Folder into the Desktop IDE +=== Import a Project Folder into Anypoint Code Builder Although it is more common to import a shareable JAR file or to open a project workspace from file directory, you can also drag a Mule project folder into the Explorer view and open the project in a VS Code workspace. -Open any valid project folder, including a project from Anypoint Studio (Studio) that's stored on your desktop. Alternatively, use the procedure in <> to open the project from your file directory instead of dragging and dropping the folder into the IDE. +Open any valid project folder, including a project from Anypoint Studio (Studio) that's stored on your desktop. Alternatively, use the procedure in <> to open the project from your file directory instead of dragging and dropping the folder into Anypoint Code Builder. -To import a project folder to the desktop IDE: +To import a project folder into Anypoint Code Builder: -. Ensure that no project is open in the IDE. +. Ensure that no project is open. include::partial$acb-open-packaged-sources.adoc[tags="import-project-folder-desktop"] . If your Mule project folder is closed, <> for the project at the project's _root_ directory. + @@ -119,102 +77,10 @@ include::partial$acb-reusable-steps.adoc[tags="set-version-prompted"] //step: test project include::partial$acb-open-packaged-sources.adoc[tags="test-project"] -//H2: WEB -[[import-web]] -== Import and Open a Project in the Cloud IDE - -The cloud IDE enables you to upload a project directory or JAR file into a workspace. - -* <> -* <> -* <> - - -//WEB: PACKAGED PROJECT TO WORKSPACE -[[web-project-package]] -=== Import a Shareable Project JAR File into the Cloud IDE - -Import a JAR file for a Mule project and load the unpacked project into a workspace in the IDE. - -. Ensure that no project is open in the cloud IDE. -//includes first 2 steps, shared cloud steps -include::partial$acb-open-packaged-sources.adoc[tags="preliminary-cloud-import-steps"] -+ -If prompted, trust the authors of the files in the directory. -+ -Anypoint Code Builder loads your directory. -. Drag your shareable JAR file from your computer to the Explorer view in the cloud IDE, for example: -+ -image::int-drag-jar-cloud.png["Drag a JAR file to the Explorer view in the cloud IDE"] -+ -If prompted, trust the authors of your file or directory. -+ -IMPORTANT: Do not click *Open Anyway* in response to this warning in the IDE: `This file is not displayed in the text editor because it is either binary or uses an unsupported encoding.` -+ -If the imported folder is large, Anypoint Code Builder displays an upload progress bar that you can click to expand. -//last steps: -// include::partial$acb-open-packaged-sources.adoc[tags="load-shareable-jar"] -// Different in cloud. -. Open the Command Palette. -+ -.Show me how -[%collapsible] -==== -* Use the keyboard shortcuts: -** Mac: Cmd+Shift+p -** Windows: Ctrl+Shift+p -* Click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. -==== -. Select the following command: -+ -[source,command] ----- -MuleSoft: Import a Mule Project ----- -. Navigate to and select the shareable JAR file to import. -. Navigate to a destination folder for your unpacked project, such as your home directory or any folder _outside_ of a Mule project folder, and click *OK*. -+ -The IDE unpacks the shareable JAR file for your project into the selected folder. -. If your Mule project folder is closed, <> for the project at the project's _root_ directory. -+ -include::partial$acb-open-packaged-sources.adoc[tags="import-note"] -//step: if prompted, set version -include::partial$acb-reusable-steps.adoc[tags="set-version-prompted"] -//step: test project -include::partial$acb-open-packaged-sources.adoc[tags="test-project"] - -//WEB: PROJECT FOLDER TO WORKSPACE -[[web-project-folder]] -=== Import a Project Folder into the Cloud IDE - -. Ensure that no project is open in the cloud IDE. -//includes first 2 steps, shared cloud steps -include::partial$acb-open-packaged-sources.adoc[tags="preliminary-cloud-import-steps"] -+ -If prompted, trust the authors of the files in the directory. -+ -Anypoint Code Builder loads your directory. -. Drag your project folder from your computer to the Explorer view in the cloud IDE, for example: -+ -image::int-drag-folder-cloud.png["Drag a project folder to the Explorer view in the cloud IDE"] -+ -If prompted, trust the authors of your file or directory. -+ -If the imported folder is large, Anypoint Code Builder displays an upload progress bar that you can click to expand. -. If your Mule project folder is closed, <> for the project at the project's _root_ directory. -+ -include::partial$acb-open-packaged-sources.adoc[tags="import-note"] -//step: if prompted, set version -include::partial$acb-reusable-steps.adoc[tags="set-version-prompted"] -//step: test project -include::partial$acb-open-packaged-sources.adoc[tags="test-project"] - [[both-open-project-folder]] -== Open a Project Folder from the Desktop or Cloud IDE - -Open or reopen a project workspace folder for your application. This procedure works for projects built in Anypoint Code Builder and for projects stored on your desktop that are built in Anypoint Studio (Studio). +== Open a Project Folder -To import a project folder from Studio into your cloud IDE, use the procedure in <>. +Open or reopen a project workspace folder for your application. This procedure works for projects built in Anypoint Code Builder and for projects stored on your desktop that are built in Anypoint Studio (Studio). // include for this procedure include::partial$acb-open-packaged-sources.adoc[tags="open-workspace-root"] diff --git a/code-builder-home/modules/ROOT/pages/int-migrate-studio-to-acb.adoc b/code-builder-home/modules/ROOT/pages/int-migrate-studio-to-acb.adoc index 05ed10c97..d09bd608f 100644 --- a/code-builder-home/modules/ROOT/pages/int-migrate-studio-to-acb.adoc +++ b/code-builder-home/modules/ROOT/pages/int-migrate-studio-to-acb.adoc @@ -1,5 +1,4 @@ = Migrating Mule Projects from Anypoint Studio to Anypoint Code Builder -:page-deployment-options: cloud-ide, desktop-ide Migrate your Mule projects from Anypoint Studio to Anypoint Code Builder to unlock a modern development experience with advantages like faster startup times, streamlined collaboration, and the integration of MuleSoft for Agentforce: Topic Center to enable API specifications for topics and agents. @@ -20,7 +19,7 @@ Anypoint Code Builder provides three ways to bring your Studio projects over. | Package a single Mule project as a sharable JAR file in Studio and import it into Anypoint Code Builder by following the steps on this page. | Open the project folder directly -| Open an existing Studio project folder in Anypoint Code Builder without packaging it, which is the fastest path when the project is already on your machine. See xref:int-import-mule-project.adoc[Importing Projects into the IDE]. +| Open an existing Studio project folder in Anypoint Code Builder without packaging it, which is the fastest path when the project is already on your machine. See xref:int-import-mule-project.adoc[Importing Projects into Anypoint Code Builder]. |=== == Set Run and Debug Configurations diff --git a/code-builder-home/modules/ROOT/pages/int-run-mule-apps-with-properties.adoc b/code-builder-home/modules/ROOT/pages/int-run-mule-apps-with-properties.adoc index 893c3dc34..020a7953b 100644 --- a/code-builder-home/modules/ROOT/pages/int-run-mule-apps-with-properties.adoc +++ b/code-builder-home/modules/ROOT/pages/int-run-mule-apps-with-properties.adoc @@ -1,5 +1,4 @@ = Pass Runtime Properties and Arguments to Mule Applications -:page-deployment-options: desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-run-multiple-mule-apps.adoc b/code-builder-home/modules/ROOT/pages/int-run-multiple-mule-apps.adoc index 6ee44099b..6a012041c 100644 --- a/code-builder-home/modules/ROOT/pages/int-run-multiple-mule-apps.adoc +++ b/code-builder-home/modules/ROOT/pages/int-run-multiple-mule-apps.adoc @@ -1,5 +1,4 @@ = Running Multiple Mule Applications Concurrently -:page-deployment-options: desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/int-test-munit.adoc b/code-builder-home/modules/ROOT/pages/int-test-munit.adoc index 5efb76005..48aa95c5b 100644 --- a/code-builder-home/modules/ROOT/pages/int-test-munit.adoc +++ b/code-builder-home/modules/ROOT/pages/int-test-munit.adoc @@ -1,7 +1,6 @@ = Testing Projects with MUnit :page-aliases: //local shared variables/attributes: -:page-deployment-options: cloud-ide, desktop-ide :open-project: Open a project that contains an MUnit test suite. :check-for-tests: To check for test suites, see <>. :test-debug-options: Run tests with or without debugging features. If your XML contains breakpoints and you opt to debug, test execution stops at your breakpoints. For information about debugging, see <>. @@ -19,7 +18,7 @@ MUnit is a MuleSoft unit testing framework for creating and running unit tests o With MUnit, create MUnit tests and MUnit test suites. An MUnit test is an individual test case, defined by the `` element, which includes specific validations and assertions to test the functionality of a Mule application. An MUnit test suite is a container for multiple MUnit tests. It organizes tests in an XML file typically found in the `/src/test/munit` directory. -Anypoint Code Builder provides a *Testing* panel from which you can run tests. In the *Explorer*, test suites are also located within the project directory `{munit-src}`. The IDE also shows a canvas for creating and maintaining MUnit test suits, a Testing Results panel with the status of tests, and logs that identify the status of tests. +Anypoint Code Builder provides a *Testing* panel from which you can run tests. In the *Explorer*, test suites are also located within the project directory `{munit-src}`. Anypoint Code Builder also shows a canvas for creating and maintaining MUnit test suits, a Testing Results panel with the status of tests, and logs that identify the status of tests. Anypoint Code Builder - MUnit Extension, part of the Anypoint Extension Pack, supports MUnit functionality in Anypoint Code Builder. For information about extensions, see xref:index.adoc#extension-pack[Anypoint Extension Pack]. @@ -120,7 +119,7 @@ Generate the basic structure for an MUnit test designed to test a specific flow . Open an MUnit test suite file in the `src/test/munit/` folder. . Click *Add*, and then select *Test scope*. . In the panel that appears, select *Test*. -. The IDE creates an empty test in the currently open test suite. +. Anypoint Code Builder creates an empty test in the currently open test suite. [[create-test-from-xml]] ==== Create a Test from the Code Editor @@ -163,12 +162,12 @@ For guidance, see <>. == Open MUnit Tests Open the test suite XML from the *Testing* panel or the *Explorer*. + -After the February 2025 release, the IDE shows a canvas with the test components, or provides a link to build a new test. +After the February 2025 release, Anypoint Code Builder shows a canvas with the test components, or provides a link to build a new test. [NOTE] Anypoint Code Builder requires MUnit 3.4.0 or later to create MUnit test suites from the canvas. -* *Testing panel* - Open the *Testing* panel from the activity bar in the IDE: +* *Testing panel* - Open the *Testing* panel from the activity bar: //open project (with tests) step as local variable . {open-project} . Click image:anypoint-code-builder::icon-munit-testing.png["",18,18] (*Testing*) to open the *Testing* panel. @@ -202,7 +201,7 @@ Run MUnit tests using any of these options: If you run a test, a test build executes, and the Terminal displays the progress of the test. If all tests execute successfully, the build succeeds. Otherwise, the build fails. -The IDE displays the results of the tests in the *Testing* panel, the *Terminal*, and the *Test Results* panels. Time-stamped logs are also available from the *Test Results* panel. You can clear the results at any time. +Anypoint Code Builder displays the results of the tests in the *Testing* panel, the *Terminal*, and the *Test Results* panels. Time-stamped logs are also available from the *Test Results* panel. You can clear the results at any time. // //RUN: FROM TEST PANEL @@ -503,7 +502,7 @@ For more guidance, see <>. + image:anypoint-code-builder::munit-test-coverage-panel.png["Test coverage percentages after running tests with coverage"] -* In the activity bar, click (image:anypoint-code-builder::icon-explorer.png["",18,18]) (*Explorer*). The IDE shows Coverage for directories and files. +* In the activity bar, click (image:anypoint-code-builder::icon-explorer.png["",18,18]) (*Explorer*), which shows coverage for directories and files. Numeric and graphic percentages both show the percentage of event processors executed by the MUnit test. @@ -651,4 +650,3 @@ The following MUnit test example validates if the `payload` is the string `"Exam ---- For information about `munit:execution`, `munit:validation`, and other MUnit testing elements, see xref:munit::munit-test-concept.adoc[] and xref:munit::event-processors.adoc[]. - diff --git a/code-builder-home/modules/ROOT/pages/int-trigger-flows.adoc b/code-builder-home/modules/ROOT/pages/int-trigger-flows.adoc index cee334c76..96805db54 100644 --- a/code-builder-home/modules/ROOT/pages/int-trigger-flows.adoc +++ b/code-builder-home/modules/ROOT/pages/int-trigger-flows.adoc @@ -1,10 +1,9 @@ = Triggering Flows in Your Development Environment -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: ping-locally-deployed-app.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -When your integration or implementation builds successfully within the Anypoint Code Builder IDE, the application deploys to your local development environment, whether you use the desktop or cloud IDE. +When your integration or implementation builds successfully within Anypoint Code Builder, the application deploys to your local development environment. Configure the *HTTP Listener* from xref:http-connector::index.adoc[Anypoint Connector for HTTP] (HTTP Connector) to trigger the execution of a flow in a deployed application. Or trigger the flow locally from the built-in terminal in Anypoint Code Builder, or from a VS Code extension like Thunder Client. @@ -13,20 +12,20 @@ A *Scheduler*, a *Flow Ref*, or any connector trigger or message source can init [[before-you-begin]] == Before You Begin -* Complete xref:start-acb.adoc[] for your IDE. -* Make sure an integration or implementation project with an HTTP Listener (``) is available from the cloud or desktop IDE. +* Complete xref:start-acb.adoc[]. +* Make sure an integration or implementation project with an HTTP Listener (``) is available in Anypoint Code Builder. + To create a project, see xref:int-create-integrations.adoc[] or xref:imp-implementing-apis.adoc[], or follow xref:tutorials.adoc#modular-learning-paths[Take Your API Specification from Design Through Deployment]. [[trigger-urls]] == URLs for Triggering a Flow from an HTTP Listener -For integrations and implementations that you build and deploy within your IDE during the development process, the URL to use for triggering an HTTP Listener differs depending on whether the listener is within the configuration XML for a scaffolded interface that is generated from an API specification or within a configuration XML file that does not implement a scaffolded interface. +For integrations and implementations that you build and deploy during the development process, the URL to use for triggering an HTTP Listener differs depending on whether the listener is within the configuration XML for a scaffolded interface that is generated from an API specification or within a configuration XML file that does not implement a scaffolded interface. Typically, for apps that use an HTTP Listener, you configure the host to `0.0.0.0` and the port to `8081`. If port `8081` is in use by another application, you can use a similar port, such as `8082`. [[trigger-url-no-interface]] -* Trigger a flow within a configuration XML that _does not_ contain a scaffolded interface by using a URL similar to this one from your IDE's terminal: +* Trigger a flow within a configuration XML that _does not_ contain a scaffolded interface by using a URL similar to this one from the terminal: + ---- http://localhost:8081/mypath @@ -47,7 +46,7 @@ The port and host are defined in the `` element, and ---- [[trigger-url-interface]] -* Trigger a flow from the listener within a scaffolded interface by using a URL similar to this one from your IDE's terminal: +* Trigger a flow from the listener within a scaffolded interface by using a URL similar to this one from the terminal: + ---- http://localhost:8081/api/my-endpoint @@ -111,9 +110,9 @@ The URL adds `/api` before the `/flights` endpoint to make the request through t [[trigger-flow]] == Trigger a Flow -Use the terminal in Anypoint Code Builder to trigger a flow through an HTTP Listener in an integration or implementation project that is deployed locally, within your IDE. This procedure is for Mule apps within the desktop or cloud IDE. +Use the terminal in Anypoint Code Builder to trigger a flow through an HTTP Listener in an integration or implementation project that is deployed locally. -TIP: The examples in this procedure show how to trigger the flow with a `curl` command from the IDE's terminal. You can also use Thunder Client, a third-party extension for VS Code, to trigger a flow with the same URLs. For security reasons, external REST clients, such as Advanced REST Client and Postman, are not allowed to send requests to projects deployed in the cloud IDE. +TIP: The examples in this procedure show how to trigger the flow with a `curl` command from the terminal. You can also use Thunder Client, a third-party extension for VS Code, to trigger a flow with the same URLs. Before attempting to trigger a flow, review <>, and verify that you meet the prerequisites in <>. @@ -123,7 +122,7 @@ include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="open-run-d include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="deploy-locally"] //open terminal include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tag="open-terminal"] -. In the IDE's terminal, click the name of the shell to use, such as PowerShell (for Windows), Bash (`bash`), or Z shell (`zsh` for Mac). +. In the terminal, click the name of the shell to use, such as PowerShell (for Windows), Bash (`bash`), or Z shell (`zsh` for Mac). + Alternatively, click the *+* icon in the terminal to open a new command prompt. . At the command prompt, provide a `curl` command to trigger the flow. diff --git a/code-builder-home/modules/ROOT/pages/int-versions.adoc b/code-builder-home/modules/ROOT/pages/int-versions.adoc index 9b04dd78c..90181f8a2 100644 --- a/code-builder-home/modules/ROOT/pages/int-versions.adoc +++ b/code-builder-home/modules/ROOT/pages/int-versions.adoc @@ -2,7 +2,7 @@ Set Mule runtime engine (Mule), Java, and connector versions to use in your projects. -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. +Anypoint Code Builder includes bundled Mule runtime versions so you can open and design projects instantly without additional Mule runtime downloads. Anypoint Code Builder uses these bundled Mule runtime versions for editing and DataSense. Exact Mule runtime versions are only required when you run or debug your applications. * <>: Learn about the Mule runtime versions included with Anypoint Code Builder. @@ -23,7 +23,7 @@ Anypoint Code Builder includes two bundled Mule runtime versions that are availa * **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.0. 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. -The IDE automatically selects the appropriate bundled Mule runtime version based on your project's Java version: +Anypoint Code Builder automatically selects the appropriate bundled Mule runtime version based on your project's Java version: * Java 8 projects use the bundled 4.8 minimal Mule runtime version * Java 17 projects use the latest bundled Mule runtime version @@ -57,7 +57,7 @@ include::partial$acb-runtime-java.adoc[tags="runtime-java-version-selection"] 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. -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 Mule runtime downloads. +Anypoint Code Builder 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 Mule runtime downloads. 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. @@ -68,7 +68,7 @@ Version settings are important in several scenarios: * Selecting versions of Mule or Java that are compatible with each other * Specifying exact Mule runtime versions for run and debug operations -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: +When you run or debug an application, Anypoint Code Builder 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: * Continue with the latest compatible local version * Open *Project Properties* to select or download the required Mule runtime version @@ -76,7 +76,7 @@ When you run or debug an application, the IDE checks if the exact Mule runtime v [NOTE] 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. -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. +When a Mule or Java version isn't set for a project, the canvas and notifications provide a *Set version* button that opens the *Project Properties* tab. You can also navigate directly to the *Project Properties* tab. [[project-versions-from-properties]] To select Mule and Java versions for a project: @@ -135,10 +135,9 @@ MuleSoft: Install Runtime + . Select the Mule runtime version to install. + -The IDE downloads the selected Mule runtime version to `${user.home}/AnypointCodeBuilder/runtimes`. +Anypoint Code Builder downloads the selected Mule runtime version to `${user.home}/AnypointCodeBuilder/runtimes`. [NOTE] ==== 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. ==== - diff --git a/code-builder-home/modules/ROOT/pages/mock-data-using-dw-library.adoc b/code-builder-home/modules/ROOT/pages/mock-data-using-dw-library.adoc index 1847cd520..d231cadce 100644 --- a/code-builder-home/modules/ROOT/pages/mock-data-using-dw-library.adoc +++ b/code-builder-home/modules/ROOT/pages/mock-data-using-dw-library.adoc @@ -1,11 +1,8 @@ = Mock Data Using a DataWeave Library -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] The following tutorial shows you how to develop an integration, import the https://anypoint.mulesoft.com/exchange/68ef9520-24e9-4cf2-b2f5-620025690913/data-weave-mock-data-generators-library/minor/1.0/[Mock Data Generators Library^] from Exchange, and use the custom library to return a random value from the library. @@ -22,8 +19,6 @@ See xref:start-acb.adoc[] for more information. + . Select the command. + -// . In your cloud IDE instance, navigate to your Anypoint Code Builder view: -// . Select *Develop an Integration*. . Configure your integration using the following values: + image::int-create-integration-scratch.png["Develop an Integration form, with Empty Project selected"] diff --git a/code-builder-home/modules/ROOT/pages/mulesoft-vibes.adoc b/code-builder-home/modules/ROOT/pages/mulesoft-vibes.adoc index 73d3ab4e9..119356c13 100644 --- a/code-builder-home/modules/ROOT/pages/mulesoft-vibes.adoc +++ b/code-builder-home/modules/ROOT/pages/mulesoft-vibes.adoc @@ -1,6 +1,5 @@ = MuleSoft Vibes Overview :page-aliases: api-ai-design-spec.adoc, learn-about-mulesoft-vibes.adoc -:page-deployment-options: cloud-ide, desktop-ide MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available directly in Anypoint Code Builder. @@ -38,7 +37,7 @@ Models run within the Salesforce Shared Trust Boundary, and the assistant inheri The MuleSoft MCP Server supplies tools that connect MuleSoft Vibes to Exchange, Runtime Manager, and other services so prompts can search assets, inspect deployments, and perform other allowed operations. You enable or restrict that behavior by which servers and tools you install. -For product-level MCP documentation, see xref:mulesoft-mcp-server::index.adoc[]. When you are ready to add or tune servers inside the IDE, continue with xref:vibes-mcp-server.adoc[]. +For product-level MCP documentation, see xref:mulesoft-mcp-server::index.adoc[]. When you are ready to add or tune servers, continue with xref:vibes-mcp-server.adoc[]. [[related-ai]] == Related MuleSoft AI Resources @@ -50,14 +49,12 @@ MuleSoft Vibes is part of the broader MuleSoft AI story alongside experiences su To use MuleSoft Vibes, make sure that you meet these prerequisites: -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. -* Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. +* Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. * Install Node.js 20 LTS or later. * Install the latest version of `jq`. * On Windows, install *Git Bash* to use skills that run prepackaged shell-based steps. -* Ensure you have the following permissions: -** *Anypoint Code Builder Developer* (to use MuleSoft Vibes in the Cloud IDE) -** *Mule Developer Generative AI User* +* Ensure you have the *Mule Developer Generative AI User* and *Anypoint Code Builder Developer* permissions. * Make sure Einstein is enabled in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[]. * Connect your Anypoint Platform organization to a Salesforce organization that has generative AI enabled. For setup instructions, see xref:access-management::connecting-salesforce-orgs.adoc[] and xref:access-management::trusted-salesforce-org.adoc[]. + diff --git a/code-builder-home/modules/ROOT/pages/ref-acb-commands.adoc b/code-builder-home/modules/ROOT/pages/ref-acb-commands.adoc index f2610ef4f..22d1e1381 100644 --- a/code-builder-home/modules/ROOT/pages/ref-acb-commands.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-acb-commands.adoc @@ -28,14 +28,14 @@ MuleSoft: Export Troubleshooting Information MuleSoft: Import Studio Workspace ---- -* Log in to Anypoint Platform from the IDE. See xref:start-acb.adoc#login-ide[Log in from the IDE through the Command Palette]. +* Log in to Anypoint Platform from. See xref:start-acb.adoc#login-ide[Log in through the Command Palette]. + [source,command] ---- MuleSoft: Login to Anypoint Platform ---- -* Open the *Settings* page for Anypoint Code Builder settings, which include settings for the Anypoint Platform host (EU or US). For an example, see xref:start-acb.adoc#change-clouds[Set the Desktop IDE to the EU or US Cloud]. +* Open the *Settings* page for Anypoint Code Builder settings, which include settings for the Anypoint Platform host (EU or US). For an example, see xref:start-acb.adoc#change-clouds[Set Anypoint Code Builder to the EU or US Cloud]. + [source,command] ---- @@ -107,7 +107,7 @@ MuleSoft: Implement an API Specification MuleSoft: Import Asset from Exchange ---- -* Import a JAR file for a Mule project and load it into a workspace in the IDE. See xref:int-import-mule-project.adoc[]. +* Import a JAR file for a Mule project and load it into a workspace. See xref:int-import-mule-project.adoc[]. + [source,command] ---- @@ -186,7 +186,7 @@ MuleSoft: Show API Console MuleSoft: Design an API ---- -* Scaffold an API spec project located in the IDE into an implementation project. See xref:imp-implement-local-apis.adoc[Scaffold an API Spec into a New Implementation Project]. +* Scaffold a local API spec project into an implementation project. See xref:imp-implement-local-apis.adoc[Scaffold an API Spec into a New Implementation Project]. + [source,command] ---- @@ -327,7 +327,7 @@ Other helpful commands include the following: File: Open Folder ---- -* Open the Anypoint Code Builder panel from the IDE. The panel provides links to frequent actions. See an example in xref:start-discover-ui.adoc[]. +* Open the Anypoint Code Builder panel. The panel provides links to frequent actions. See an example in xref:start-discover-ui.adoc[]. + [source,command] ---- diff --git a/code-builder-home/modules/ROOT/pages/ref-acb-maven.adoc b/code-builder-home/modules/ROOT/pages/ref-acb-maven.adoc index 468272de4..cdee3bad3 100644 --- a/code-builder-home/modules/ROOT/pages/ref-acb-maven.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-acb-maven.adoc @@ -1,5 +1,4 @@ = Maven Settings in Anypoint Code Builder -:page-deployment-options: cloud-ide, desktop-ide Anypoint Code Builder uses Apache Maven to build and manage your Mule projects (implementation and integration projects) and API specifications in design projects. All Maven configurations, such as custom repositories, proxies, and server credentials, are managed through a central `settings.xml` file. diff --git a/code-builder-home/modules/ROOT/pages/ref-deployment.adoc b/code-builder-home/modules/ROOT/pages/ref-deployment.adoc index 317bfd81c..5ab327a17 100644 --- a/code-builder-home/modules/ROOT/pages/ref-deployment.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-deployment.adoc @@ -1,5 +1,4 @@ = Deployment Properties for Mule Applications -:page-deployment-options: cloud-ide, desktop-ide When deploying a Mule application to CloudHub, Anypoint Code Builder relies on a configuration in `deploy.json`. Mule applications are integration or implementation projects. diff --git a/code-builder-home/modules/ROOT/pages/ref-hardware-storage-requirements.adoc b/code-builder-home/modules/ROOT/pages/ref-hardware-storage-requirements.adoc index e7f959cca..d41af5421 100644 --- a/code-builder-home/modules/ROOT/pages/ref-hardware-storage-requirements.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-hardware-storage-requirements.adoc @@ -1,5 +1,4 @@ = Hardware and Storage Requirements -:page-deployment-options: desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/ref-launch-json-properties.adoc b/code-builder-home/modules/ROOT/pages/ref-launch-json-properties.adoc index 491a4c8c1..c7776bc56 100644 --- a/code-builder-home/modules/ROOT/pages/ref-launch-json-properties.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-launch-json-properties.adoc @@ -1,5 +1,4 @@ = Launch Configuration Properties Reference -:page-deployment-options: desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/ref-mule-settings.adoc b/code-builder-home/modules/ROOT/pages/ref-mule-settings.adoc index 24d5cb416..882f2c7a0 100644 --- a/code-builder-home/modules/ROOT/pages/ref-mule-settings.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-mule-settings.adoc @@ -1,12 +1,9 @@ = MuleSoft Settings -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] -Anypoint Code Builder provides configurable settings that apply at the IDE level, across all your Anypoint Code Builder projects. Many of the default settings are suitable for most users. However, if you use the EU cloud, it is important to change the default US cloud setting. Some settings are configurable in the desktop IDE only. +Anypoint Code Builder provides configurable settings that apply across all your Anypoint Code Builder projects. Many of the default settings are suitable for most users. However, if you use the EU cloud, it is important to change the default US cloud setting. To open the settings: @@ -21,7 +18,7 @@ HIDING EINSTEIN SECTION: NOT FOR FEB RELEASE [[setting-einstein]] == Mule > Application: Einstein -If an organization administrator set permissions for you to access and use Einstein AI features, you can disable or enable (default) the feature in your IDE. When you disable Einstein, the UI no longer displays AI features. +If an organization administrator set permissions for you to access and use Einstein AI features, you can disable or enable (default) the feature. When you disable Einstein, the UI no longer displays AI features. For access to Einstein, see start-configure-permissions.adoc[]. //// @@ -35,7 +32,7 @@ Set a default Mule runtime engine and Java version for new Mule projects (integr [[setting-group-id]] == Mule › Application: Group ID -Set the Maven group ID value for the IDE to use when you create a Mule integration or implementation project. This setting populates the `pom.xml` file for each Mule project. The default is `com.mycompany`, for example, `com.mycompany` in the `pom.xml`. You can change the setting within your project, as needed. +Set the Maven group ID value for Anypoint Code Builder to use when you create a Mule integration or implementation project. This setting populates the `pom.xml` file for each Mule project. The default is `com.mycompany`, for example, `com.mycompany` in the `pom.xml`. You can change the setting within your project, as needed. For information about Maven group IDs, see https://maven.apache.org/guides/introduction/introduction-to-the-pom.html[Introduction to the POM^] in the Apache Maven Project documentation. @@ -96,29 +93,23 @@ For information about secure configuration properties, see xref:int-create-secur Metaspace is an area for non-heap memory used to store class metadata, constant pool information, and method bytecode. -Typically, the default of *1g* (1 GB) is sufficient. However, you can change the metaspace size when installing Mule Runtime engine (Mule). +Typically, the default of *1g* (1 GB) is sufficient. However, you can change the metaspace size when installing Mule Runtime engine (Mule). //TODO: WHEN INSTALLING MULE FOR THE FIRST TIME ONLY, OR WHAT ABOUT WHEN UPDATING? -If you are using the cloud IDE, be aware of the memory available to the container before changing this value. -//TODO: HOW WOULD THEY KNOW - - [[setting-region]] == Mule: Control Plane -Select a control plane for your desktop IDE: +Select a control plane for Anypoint Code Builder: * *US Cloud* (default) * *EU Cloud* -In the cloud IDE, this setting is not configurable because it is set automatically based on the region where your Anypoint Platform account resides. - For more information, see xref:index.adoc#us-eu-clouds[US and EU Cloud Hosts]. [[setting-telemetry]] == Mule > Telemetry -You can enable or disable telemetry services in the US cloud. By default, this setting is disabled and not used for the EU cloud. When telemetry services are enabled, the IDE sends anonymous usage data to the MuleSoft team. The data helps identify important usage trends. +You can enable or disable telemetry services in the US cloud. By default, this setting is disabled and not used for the EU cloud. When telemetry services are enabled, Anypoint Code Builder sends anonymous usage data to the MuleSoft team. The data helps identify important usage trends. [[setting-home-dir]] == Mule: Home Directory @@ -136,7 +127,7 @@ Enable auto-completion suggestions in the API design editor in Anypoint Code Bui Set the time in milliseconds to wait before displaying auto-completion options. This setting defaults to 1500 milliseconds. See also <>. -Avoid setting a long delay. If you activate the auto-completion menu but initiate other actions in your project before the delay period ends, the IDE automatically returns focus to the editor and opens the menu where you activated auto-completion. Such actions include opening the command palette or using the command terminal after activating the menu. +Avoid setting a long delay. If you activate the auto-completion menu but initiate other actions in your project before the delay period ends, Anypoint Code Builder automatically returns focus to the editor and opens the menu where you activated auto-completion. Such actions include opening the command palette or using the command terminal after activating the menu. If you move your cursor to a new location or use the up or down arrow keys in the editor before the trigger delay expires, the request to open the auto-completion menu is cancelled. diff --git a/code-builder-home/modules/ROOT/pages/ref-proxy-settings.adoc b/code-builder-home/modules/ROOT/pages/ref-proxy-settings.adoc index b2f55a3f1..de89f12ed 100644 --- a/code-builder-home/modules/ROOT/pages/ref-proxy-settings.adoc +++ b/code-builder-home/modules/ROOT/pages/ref-proxy-settings.adoc @@ -1,13 +1,9 @@ = Using a Proxy in Anypoint Code Builder -:page-deployment-options: desktop-ide -:restart-ide: Restart the IDE to load all your changes. +:restart-ide: Restart Anypoint Code Builder to load all your changes. include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Execute network-dependent functions in Anypoint Code Builder, such as publishing to Exchange, logging into Anypoint Platform, and running or debugging applications, by configuring your proxy settings in Visual Studio Code (VS Code). - -[NOTE] -Proxy settings doesn’t work on the cloud IDE +Execute network-dependent functions in Anypoint Code Builder, such as publishing to Exchange, logging into Anypoint Platform, and running or debugging applications, by configuring your proxy settings in Visual Studio Code (VS Code). == Before You Begin Configuring Your Proxy diff --git a/code-builder-home/modules/ROOT/pages/start-acb-cloud.adoc b/code-builder-home/modules/ROOT/pages/start-acb-cloud.adoc deleted file mode 100644 index 1e9e62c17..000000000 --- a/code-builder-home/modules/ROOT/pages/start-acb-cloud.adoc +++ /dev/null @@ -1,22 +0,0 @@ -= Launching the Cloud IDE -:page-deployment-options: cloud-ide - -include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] - -//intro: launch cloud IDE -include::partial$acb-start-cloud.adoc[tag="start-cloud-intro"] - - -//heading: before you begin -[[before-you-begin]] -include::partial$acb-start-cloud.adoc[tag="heading-before-you-begin",leveloffset=+1] - -//content: before you begin -include::partial$acb-start-cloud.adoc[tag="before-you-begin"] - -//heading: launch cloud IDE -[[login-cloud]] -include::partial$acb-start-cloud.adoc[tag="heading-launch-cloud",leveloffset=+1] - -//content: launch cloud IDE -include::partial$acb-start-cloud.adoc[tag=launch-cloud] \ No newline at end of file diff --git a/code-builder-home/modules/ROOT/pages/start-acb-desktop.adoc b/code-builder-home/modules/ROOT/pages/start-acb-desktop.adoc index 213fa3f08..5420ea5fa 100644 --- a/code-builder-home/modules/ROOT/pages/start-acb-desktop.adoc +++ b/code-builder-home/modules/ROOT/pages/start-acb-desktop.adoc @@ -1,5 +1,4 @@ -= Setting Up the Desktop IDE -:page-deployment-options: desktop-ide += Setting Up Anypoint Code Builder include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/start-acb.adoc b/code-builder-home/modules/ROOT/pages/start-acb.adoc index 8e28e1040..d5e098a1f 100644 --- a/code-builder-home/modules/ROOT/pages/start-acb.adoc +++ b/code-builder-home/modules/ROOT/pages/start-acb.adoc @@ -1,54 +1,27 @@ = Getting Started with Anypoint Code Builder -:page-deployment-options: cloud-ide, desktop-ide -:page-aliases: setup.adoc, connect-eu-cloud.adoc, load-acb-web-ide.adoc, log-in-anypoint-platform.adoc, get-started.adoc -:restart-ide: Restart the IDE to load all your changes. +:page-aliases: setup.adoc, connect-eu-cloud.adoc, load-acb-web-ide.adoc, log-in-anypoint-platform.adoc, get-started.adoc, start-acb-cloud.adoc +:restart-ide: Restart Anypoint Code Builder to load all your changes. include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] -Anypoint Code Builder is built from the Anypoint Extension Pack for Visual Studio Code. Both the desktop and cloud IDEs for Anypoint Code Builder share these extensions. The cloud IDE provides built-in extensions to the code-server implementation of Visual Studio Code for the web. - -* <>: For the desktop IDE, you must load the extension pack to your local Visual Studio Code IDE. -* <>: For the cloud IDE, you must sign in to Anypoint Platform and acquire the permission to use Anypoint Code Builder. +Anypoint Code Builder is built from the Anypoint Extension Pack for Visual Studio Code. You must load the extension pack to your local Visual Studio Code installation. [[set-up-desktop]] -== Set up the Desktop IDE +== Set up Anypoint Code Builder //start desktop IDE include::anypoint-code-builder::partial$acb-start-desktop.adoc[] -[[set-up-web]] -== Launch the Cloud IDE - -//intro: launch cloud IDE -include::partial$acb-start-cloud.adoc[tag="start-cloud-intro"] - - -//heading: before you begin -[[prereqs-cloud]] -include::partial$acb-start-cloud.adoc[tag="heading-before-you-begin",leveloffset=+2] - -//content: before you begin -include::partial$acb-start-cloud.adoc[tag="before-you-begin"] - -//heading: launch cloud IDE -[[login-cloud]] -include::partial$acb-start-cloud.adoc[tag="heading-launch-cloud",leveloffset=+2] - -//content: launch cloud IDE -include::partial$acb-start-cloud.adoc[tag=launch-cloud] - [[login-ide]] -== Sign in to Anypoint Platform from the IDE +== Sign in to Anypoint Platform from Anypoint Code Builder -Some Anypoint Code Builder features require you to sign in directly from the IDE to Anypoint Platform. The IDE prompts you when login is necessary and guides you through the login process. However, it is a good practice to sign in from the IDE after opening MuleSoft features in the IDE. +Some Anypoint Code Builder features require you to sign in directly to Anypoint Platform. Anypoint Code Builder prompts you when login is necessary and guides you through the login process. However, it is a good practice to sign in after opening MuleSoft features. //Requirements for Anypoint Platform account and account config include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="platform-account"] -From the IDE, you can sign in from the status bar or through a command, and you can log out from the status bar: +You can sign in from the status bar or through a command, and you can log out from the status bar: * <> * <> @@ -58,7 +31,7 @@ From the IDE, you can sign in from the status bar or through a command, and you [[login-status-bar]] === Sign in to Anypoint Platform from the Status Bar -The status bar in the desktop and cloud IDEs shows your login status: +The status bar shows your login status: * *Not logged in to Anypoint Platform* indicates that you must sign in to perform tasks that require a connection to Anypoint Platform. + @@ -72,9 +45,9 @@ You can log out by clicking your user name and following the prompts. [[login-command]] === Sign in to Anypoint Platform from the Command Palette -You can use the Command Palette to sign in to Anypoint Platform from the IDE. +You can use the Command Palette to sign in to Anypoint Platform. -To sign in from the IDE from the Command Palette: +To sign in from the Command Palette: // Pointer to Command Palette include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="open-command-palette"] @@ -100,20 +73,20 @@ After logging you in, Anypoint Platform displays a *You can close this page now* . To verify your login, ensure that ** replaces *Not logged in to Anypoint Platform*. [[logout-status-bar]] -=== Log Out from Anypoint Platform from the IDE +=== Log Out from Anypoint Platform from Anypoint Code Builder -Log out from the IDE by: +Log out by: . Clicking your username in the status bar . Clicking *Yes* when asked *Logout from Anypoint?* [[change-user-account]] -=== Sign In to a Different Anypoint Platform Account from the IDE +=== Sign in to a Different Anypoint Platform Account from Anypoint Code Builder To use a different Anypoint Platform user account: -. Log out from the status bar in the IDE. +. Log out from the status bar. + For guidance, see <>. . Sign in from the status bar. @@ -121,9 +94,9 @@ For guidance, see <>. For more guidance, see <>. [[change-clouds]] -== Set the Desktop IDE to a Different Control Plane +== Set Anypoint Code Builder to a Different Control Plane -In the desktop IDE, you can change your Anypoint Platform control plane to one of these clouds: +In Anypoint Code Builder, you can change your Anypoint Platform control plane to one of these clouds: * US Cloud (default) * EU Cloud @@ -140,4 +113,4 @@ include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="mule-setti . Scroll to *Mule: Control Plane*. . Select the desired cloud. . {restart-ide} -. Follow the steps in xref:anypoint-code-builder::start-acb.adoc#login-ide[Sign in to Anypoint Platform from the IDE]. +. Follow the steps in xref:anypoint-code-builder::start-acb.adoc#login-ide[Sign in to Anypoint Platform from Anypoint Code Builder]. diff --git a/code-builder-home/modules/ROOT/pages/start-add-folders.adoc b/code-builder-home/modules/ROOT/pages/start-add-folders.adoc index e32f3035b..310fd0138 100644 --- a/code-builder-home/modules/ROOT/pages/start-add-folders.adoc +++ b/code-builder-home/modules/ROOT/pages/start-add-folders.adoc @@ -1,50 +1,16 @@ = Adding Folders to Your Home Directory -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: work-on-home-directory.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] -When you create a project, Anypoint Code Builder stores it in your home directory by default. You can create other folders for your projects in the IDE. +When you create a project, Anypoint Code Builder stores it in your home directory by default. You can create other folders for your projects. include::partial$acb-reusable-steps.adoc[tags="proj-directory-warn"] -== Create Project Folders in the Cloud IDE +== Create a Project Folder -To a folder for storing your Mule projects under your home directory: - -// Pointer to Command Palette -include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] -. Select the following command: -+ -[source, command] ----- -File: Open Folder... ----- -+ -image::file-open-folder-command.png["Finding the command in the Command Palette"] -. Select your Anypoint Code Builder home directory: -+ -image::select-home-directory.png["Adding a home directory to the Open Folder field"] -+ -If prompted, trust the authors of the files in the directory: -+ -image::trust-home-directory.png["Trusting authors of the files in the folder"] -. After Anypoint Code Builder loads your home directory, right-click your Explorer view, and select *New Folder*. -+ -image::new-folder-home-directory.png["Selecting New Folder from the Explorer"] -. Name your new directory and press Enter. -. Close your home directory by clicking the image:icon-menu.png["",18,18] (menu) icon and selecting *File* > *Close Folder*. -+ -image::close-working-directory.png["Closing the folder from the File menu"] - -//TODO: HOW DO YOU MAKE IT STORE YOUR PROJECTS (WHICH SEEMED TO BE THE POINT OF THIS ARTICLE)? - -== Create a Project Folder in the Desktop IDE - -To create a local folder for your projects from the desktop IDE: +To create a local folder for your projects: // Pointer to Command Palette include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] @@ -56,11 +22,11 @@ include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] ---- + image::file-open-folder-command.png[Opening a folder from the Command Palette] -. Use your local directory to create a new folder. +. Use your local directory to create a new folder. -== Create a Project Folder from the Desktop or Cloud IDE +== Create a Project Folder from the Terminal -Use the terminal in the IDE to create folders. +Use the terminal to create folders. . Ensure that no projects are open. //open terminal: diff --git a/code-builder-home/modules/ROOT/pages/start-configure-permissions.adoc b/code-builder-home/modules/ROOT/pages/start-configure-permissions.adoc index ca817ce16..689af1693 100644 --- a/code-builder-home/modules/ROOT/pages/start-configure-permissions.adoc +++ b/code-builder-home/modules/ROOT/pages/start-configure-permissions.adoc @@ -1,31 +1,24 @@ = Configuring Permissions -:page-deployment-options: cloud-ide, desktop-ide -:page-aliases: configure-permissions.adoc +:page-aliases: configure-permissions.adoc, accept-terms-and-conditions.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Manage user access to Anypoint Code Builder and Anypoint Platform features used by the cloud and desktop IDEs. Use Access Management to grant permissions directly to individual users or assign permissions to teams to which the users belong. +Manage user access to Anypoint Code Builder and Anypoint Platform features. Use Access Management to grant permissions directly to individual users or assign permissions to teams to which the users belong. [[permissions]] -== Required Permissions +== Required Permissions -These permissions are required: +These permissions are required: -* Cloud IDE users only: -+ -*Anypoint Code Builder Developer* allows a user to launch Anypoint Code Builder from Anypoint Platform. - -* Cloud and desktop IDE users: - -** Set these xref:access-management::permissions-by-product.adoc#exchange[Anypoint Exchange permissions] so that users can download and publish assets: -*** *Viewer* -*** *Creator* -** Set these xref:access-management::permissions-by-product.adoc#runtime-manager[Runtime Manager permissions] to enable services related to CloudHub and CloudHub 2.0, such as deploying applications: -*** *Read applications* -*** *Create applications* -*** *Delete applications* -** Set the xref:access-management::permissions-by-product.adoc#design-center[Design Center Developer] permission so that users can view and create APIs. +* Set these xref:access-management::permissions-by-product.adoc#exchange[Anypoint Exchange permissions] so that users can download and publish assets: +** *Viewer* +** *Creator* +* Set these xref:access-management::permissions-by-product.adoc#runtime-manager[Runtime Manager permissions] to enable services related to CloudHub and CloudHub 2.0, such as deploying applications: +** *Read applications* +** *Create applications* +** *Delete applications* +* Set the xref:access-management::permissions-by-product.adoc#design-center[Design Center Developer] permission so that users can view and create APIs. For a complete list of permissions, see xref:access-management::permissions-by-product.adoc[]. @@ -75,5 +68,4 @@ The members of the team can now develop using Anypoint Code Builder. == See Also -* xref:load-acb-web-ide.adoc[] * xref:access-management::business-groups.adoc[] \ No newline at end of file diff --git a/code-builder-home/modules/ROOT/pages/start-discover-ui.adoc b/code-builder-home/modules/ROOT/pages/start-discover-ui.adoc index 778930777..4f70b6526 100644 --- a/code-builder-home/modules/ROOT/pages/start-discover-ui.adoc +++ b/code-builder-home/modules/ROOT/pages/start-discover-ui.adoc @@ -1,15 +1,12 @@ = Discovering the UI -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: learn-ui-elements.adoc, customize-look-and-feel.adoc, include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Get familiar with the Anypoint Code Builder UI and elements to design, develop, and deploy APIs and integrations. -image::welcome-mat-reference.png["Welcome mat in the Anypoint Code Builder IDE"] +image::welcome-mat-reference.png["Welcome mat in Anypoint Code Builder"] [calloutlist] . *Activity Bar*: Use VS Code Activity Bar items as you work on your projects. Mouse over the items to find their names: @@ -21,17 +18,15 @@ In addition to Anypoint Code Builder (MuleSoft icon), commonly used items in the * *Explorer*: Open project files and folders. * *Source Control*: Store your project files. * *Run and Debug*: Run and debug integrations and implementations. -* *Extensions*: Open for installations and updates in the desktop IDE. +* *Extensions*: Open for installations and updates. + You can change the order of the items in your activity bar. . *Anypoint Code Builder* (MuleSoft icon): Open the *Anypoint Code Builder* panel to start a project. Follow the tutorials to get started with API specification design, implementation, and integration development in Anypoint Code Builder. . *Create*: Start an API specification, implementation, or integration project. -. *Settings*: Set Anypoint Code Builder configurations, including the xref:index.adoc#us-eu-clouds[US or EU cloud] for your IDE. Select the cloud where your Anypoint Platform user account resides. +. *Settings*: Set Anypoint Code Builder configurations, including the xref:index.adoc#us-eu-clouds[US or EU cloud]. Select the cloud where your Anypoint Platform user account resides. -== Compare Project UIs in the IDE - -The UIs of the web and desktop IDEs share the same structure. +== Project UIs in Anypoint Code Builder Integration and implementation projects are Mule applications with similar UIs: @@ -56,7 +51,7 @@ See xref:des-designing-api-specs.adoc[] for more detail. [[use-autocomplete]] == Use Auto-Completion Menus -The IDE supports auto-completion through the Anypoint Code Builder extensions and through IntelliSense, a built-in code-completion feature of VS Code, to provide auto-completion in Editor views. +Auto-completion is supported through the Anypoint Code Builder extensions and through IntelliSense, a built-in code-completion feature of VS Code, to provide auto-completion in Editor views. . Open auto-completion options from the Editor view using one of the following options: @@ -86,14 +81,14 @@ Auto-complete adds the element to the code and places the cursor for you to add For more information, see https://code.visualstudio.com/docs/editing/intellisense[IntelliSense^] in the VS Code documentation. -== Change the Look and Feel of the IDE +== Change the Look and Feel of Anypoint Code Builder -Select a theme to change the look and feel of the desktop or cloud IDE. +Select a theme to change the look and feel. . Select the *Manage* (gear) icon from the activity bar. . Select *Themes* > *Color Themes*, and select a theme, for example, *Dark Modern*: + -image::acb-ui-dark-theme.png["IDE using the dark theme"] +image::acb-ui-dark-theme.png["Anypoint Code Builder using the dark theme"] == Explore the Canvas View diff --git a/code-builder-home/modules/ROOT/pages/start-fips-compliance.adoc b/code-builder-home/modules/ROOT/pages/start-fips-compliance.adoc index 704c03b71..0eb139ae1 100644 --- a/code-builder-home/modules/ROOT/pages/start-fips-compliance.adoc +++ b/code-builder-home/modules/ROOT/pages/start-fips-compliance.adoc @@ -1,5 +1,4 @@ = Configuring FIPS Compliance in Anypoint Code Builder -:page-deployment-options: desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -9,7 +8,7 @@ FIPS support in Anypoint Code Builder is functionally equivalent to FIPS support == Before You Begin -* xref:start-acb-desktop.adoc[Install and set up the Anypoint Code Builder desktop IDE]. +* xref:start-acb-desktop.adoc[Install and set up Anypoint Code Builder]. * Make sure the Mule runtime you use is FIPS 140-3 compliant. Mule runtime 4.9 (LTS) or 4.10 and later supports FIPS 140-3 compliance. * Use Java 17 when running Mule runtime 4.9. diff --git a/code-builder-home/modules/ROOT/pages/start-open-output-panel.adoc b/code-builder-home/modules/ROOT/pages/start-open-output-panel.adoc index b944819a5..7616e929a 100644 --- a/code-builder-home/modules/ROOT/pages/start-open-output-panel.adoc +++ b/code-builder-home/modules/ROOT/pages/start-open-output-panel.adoc @@ -1,11 +1,8 @@ = Viewing Logs and Errors -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: configure-mulesoft-environment.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Anypoint Code Builder provides two ways to view logs and errors: @@ -75,8 +72,7 @@ To open and configure the Output panel: . Open the Output panel using one of these methods: + * Use the keyboard shortcuts: Cmd+Shift+u (Mac) or Ctrl+Shift+u (Windows) -* In the desktop IDE, select *View* > *Output*. -* In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Output*: +* Select *View* > *Output*: + image::select-specific-output-view.png["The View and Output options are displayed in a list of menu choices"] . In the Output panel, select an output channel from the dropdown list: diff --git a/code-builder-home/modules/ROOT/pages/start-scm.adoc b/code-builder-home/modules/ROOT/pages/start-scm.adoc index c444e273d..78b8b9b67 100644 --- a/code-builder-home/modules/ROOT/pages/start-scm.adoc +++ b/code-builder-home/modules/ROOT/pages/start-scm.adoc @@ -1,10 +1,9 @@ = Controlling Source Files -:page-deployment-options: cloud-ide, desktop-ide -:no-repo-yet: If you have a project in Anypoint Code Builder but do not have a repo for that project, you can use the IDE to generate a repo in GitHub and publish your project files to that remote repo. The process also implicitly initializes a local repo in the IDE. -:init-local: Initializing and committing your project files into a local repo in the IDE is a prerequisite to publishing and syncing files into a remote repo in GitHub. -:repo-in-github: If you have an empty repo in GitHub, you can publish your project files to the repo from the IDE. -:extra-repo: If your project is already configured to sync with a remote repo, you can configure the IDE to publish your project files to a different repo. -:extra-repo-continued: This feature is helpful, for example, if you want to use your own repo for an API spec project that you imported from MuleSoft VCS or if you created your design project from the IDE before the February 2024 release. Both types of projects automatically add a connection to a remote Git repo in MuleSoft VCS. +:no-repo-yet: If you have a project in Anypoint Code Builder but do not have a repo for that project, you can generate a repo in GitHub and publish your project files to that remote repo. The process also implicitly initializes a local repo. +:init-local: Initializing and committing your project files into a local repo is a prerequisite to publishing and syncing files into a remote repo in GitHub. +:repo-in-github: If you have an empty repo in GitHub, you can publish your project files to the repo. +:extra-repo: If your project is already configured to sync with a remote repo, you can configure Anypoint Code Builder to publish your project files to a different repo. +:extra-repo-continued: This feature is helpful, for example, if you want to use your own repo for an API spec project that you imported from MuleSoft VCS or if you created your design project before the February 2024 release. Both types of projects automatically add a connection to a remote Git repo in MuleSoft VCS. include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -12,7 +11,7 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tag="scm-intro-best-practice"] A useful SCM provides change history of each file and a branching methodology to maintain project quality, full traceability, the ability to restore earlier versions of your files, and a way to recover source code if your Anypoint Code Builder environment is lost or removed. -GitHub and the Git command line interface (CLI) are widely used in the industry and supported by VS Code out-of-the-box, with minimal configuration, in the desktop and cloud IDE. The procedures on this page show how to set up and use GitHub for source control. VS Code extensions for other SCM systems are also available for you to set up and use. For information, see https://code.visualstudio.com/docs/sourcecontrol/overview#_scm-providers[SCM Providers^]. +GitHub and the Git command line interface (CLI) are widely used in the industry and supported by VS Code out-of-the-box, with minimal configuration. The procedures on this page show how to set up and use GitHub for source control. VS Code extensions for other SCM systems are also available for you to set up and use. For information, see https://code.visualstudio.com/docs/sourcecontrol/overview#_scm-providers[SCM Providers^]. For more information, see https://code.visualstudio.com/docs/sourcecontrol/overview[Using Git source control in VS Code^] in the VS Code documentation. For detailed information about Git, see the https://git-scm.com/book[Git documentation^]. @@ -29,7 +28,7 @@ If you do not have an account, create one from the https://github.com/signup[Joi + If Git is not installed on your computer, follow the https://github.com/git-guides/install-git[Git installation instructions^] for your machine. -* Access to Anypoint Code Builder from the desktop or cloud IDE +* Access to Anypoint Code Builder + For setup and installation information, see xref:start-acb.adoc[], and be sure to meet all prerequisites. @@ -67,17 +66,17 @@ git config –-global user.email "your@email.com" + If two-factor authentication is enabled on your GitHub account and you are prompted for a password, enter your personal access token instead of your GitHub login password. For more information, see GitHub documentation https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication[Access GitHub with 2FA^]. -* If your GitHub `user.name` and `user.email` are listed, you are ready to use Git to control your project files from the IDE. For guidance with common source control tasks in VS Code, see: +* If your GitHub `user.name` and `user.email` are listed, you are ready to use Git to control your project files. For guidance with common source control tasks in VS Code, see: ** <> ** <> [[set-up-repo]] -== Set Up a Repository from the IDE +== Set Up a Repository from Anypoint Code Builder -Set up a repo for your design, integration, or implementation project from the IDE. If your project is already set up to sync from the IDE with a repo in an SCM that you want to use, no additional setup is required. You can sync your changes without further setup. For an example, see <>. +Set up a repo for your design, integration, or implementation project. If your project is already set up to sync with a repo in an SCM that you want to use, no additional setup is required. You can sync your changes without further setup. For an example, see <>. -To set up a remote GitHub repo from the IDE for your projects, the following scenarios are common: +To set up a remote GitHub repo for your projects, the following scenarios are common: * <> + @@ -99,14 +98,14 @@ To set up a remote GitHub repo from the IDE for your projects, the following sce {extra-repo-continued} * <> + -If a design, implementation, or integration project is already stored in a repo on GitHub, you can clone it into the cloud or desktop IDE. +If a design, implementation, or integration project is already stored in a repo on GitHub, you can clone it into Anypoint Code Builder. [[create-repo]] === Generate and Publish to a Repository in GitHub //shared info about this procedure: {no-repo-yet} -If you already have an empty repo in GitHub that you intend to use for a project in Anypoint Code Builder, see <> to add and publish to the repo from the IDE. +If you already have an empty repo in GitHub that you intend to use for a project in Anypoint Code Builder, see <> to add and publish to the repo. . Meet the prerequisites in <>. //step: open the project folder @@ -115,9 +114,9 @@ include::anypoint-code-builder::partial$acb-open-packaged-sources.adoc[tag="open include::partial$acb-reusable-steps.adoc[tags="open-source-control-no-edits"] . In the Source Control panel, click *Publish to GitHub*. + -image::start-scm-repo.png["Publish repo to GitHub from the IDE"] +image::start-scm-repo.png["Publish repo to GitHub"] + -When no repo is associated with your project, the IDE provides options for initializing a _local_ repo (*Initialize Repository*) on your IDE or directly publishing your project to a new remote repo in GitHub (*Publish to GitHub*). Publishing to GitHub also implicitly initializes your local repo for the project. +When no repo is associated with your project, Anypoint Code Builder provides options for initializing a _local_ repo (*Initialize Repository*) or directly publishing your project to a new remote repo in GitHub (*Publish to GitHub*). Publishing to GitHub also implicitly initializes your local repo for the project. . Provide a name for your repo in the field that opens, or use the default name that appears. + image::start-scm-repo-name.png["Name of new repo"] @@ -151,12 +150,12 @@ include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="scm-sync-c include::anypoint-code-builder::partial$acb-open-packaged-sources.adoc[tag="open-workspace-root"] // Pointer to Source Control Panel include::partial$acb-reusable-steps.adoc[tags="open-source-control-no-edits"] -. From the Source Control panel for your project, initialize and commit your project files to a local repo in the IDE for your project: +. From the Source Control panel for your project, initialize and commit your project files to a local repo for your project: .. In the Source Control panel, click *Initialize Repository* to generate a local repo for your project. + image::start-scm-repo-initialize.png["Initializing a local repo for a project"] + -When no repo is associated with your project, the IDE provides options for initializing a _local_ repo (*Initialize Repository*) for your project or directly publishing your project to a new remote repo in GitHub (*Publish to GitHub*). +When no repo is associated with your project, Anypoint Code Builder provides options for initializing a _local_ repo (*Initialize Repository*) for your project or directly publishing your project to a new remote repo in GitHub (*Publish to GitHub*). // Shared substep to stage files include::partial$acb-reusable-steps.adoc[tags="scm-stage-files-substep"] // Shared substeps to commit files @@ -180,10 +179,10 @@ include::partial$acb-reusable-steps.adoc[tags="scm-commit-message-substep"] This procedure assumes that the project files are ready to stage and publish to the repo. . Meet the prerequisites in <>. -. If you have not yet initialized a local repo for your project in the IDE, see <>. +. If you have not yet initialized a local repo for your project, see <>. // Pointer to Command Palette include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] -. Configure a connection from the project in the IDE to your empty remote repo in GitHub: +. Configure a connection from the project to your empty remote repo in GitHub: .. Provide the following command to add the remote repo on GitHub: + [source, command] @@ -196,13 +195,13 @@ image::start-scm-oas-add-remote.png["Adding an remote repo from GitHub"] .. Provide the URL to your git repo, for example: + image::start-scm-repo-add-remote-uri.png["Adding a remote repo URL from GitHub"] -.. Provide a name for the remote in the IDE, for example: +.. Provide a name for the remote, for example: + ---- my-acb-project-repo ---- + -The name for the repo in the IDE can match or differ from the repo name in GitHub. +The name for the repo can match or differ from the repo name in GitHub. . Click *Publish Branch*. + image::start-scm-repo-publish-branch.png["Publish branch files in a repo on GitHub"] @@ -236,7 +235,7 @@ include::partial$acb-reusable-steps.adoc[tags="open-source-control"] image::start-scm-oas-anypoint.png["Project source control using MuleSoft VCS"] // Pointer to Command Palette include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] -. Configure a connection from the project in the IDE to your repo in GitHub: +. Configure a connection from the project to your repo in GitHub: .. Provide the following command to add the remote repo on GitHub: + [source, command] @@ -251,13 +250,13 @@ image::start-scm-oas-add-remote.png["Adding an extra remote repo from GitHub"] ---- https://github.com/me/my-extra-repo.git ---- -.. Provide a name for the remote in the IDE, for example: +.. Provide a name for the remote, for example: + ---- my-extra-repo ---- + -This name for the repo in the IDE can match or differ from the repo name in GitHub. +This name for the repo can match or differ from the repo name in GitHub. . Publish your project to your extra remote repo: .. In the command palette, provide the following command: + @@ -267,7 +266,7 @@ Git: Push to... ---- .. Select *Git: Push to...* from the popup menu. + -image::start-scm-oas-push-to.png["Selecting 'Push to... from the IDE'"] +image::start-scm-oas-push-to.png["Selecting 'Push to...'"] .. Select the extra remote repo that you added, for example: + image::start-scm-oas-publish-to-private-repo.png["Selecting the extra remote repo"] @@ -275,14 +274,14 @@ image::start-scm-oas-publish-to-private-repo.png["Selecting the extra remote rep + image::start-scm-oas-in-github.png["Viewing project files in the extra remote repo"] -You can now clone this project repo in your IDE to easily modify and sync your changes from the IDE's UI. See <>. +You can now clone this project repo to easily modify and sync your changes from the UI. See <>. [[sync-changes]] == Sync Project Changes with Your Repository -After your project is connected and published to a remote repo in GitHub, you can use the IDE to sync your changes with that repo. If your repo is not set up yet, see <>. +After your project is connected and published to a remote repo in GitHub, you can sync your changes with that repo. If your repo is not set up yet, see <>. -Use the IDE's UI or its built-in terminal to sync your changes: +Use the UI or the built-in terminal to sync your changes: * <> * <> @@ -290,7 +289,7 @@ Use the IDE's UI or its built-in terminal to sync your changes: [[sync-from-ui]] === Sync Changes from the Source Control Panel -To sync changes to your files from your project's Source Control panel in the IDE: +To sync changes to your files from your project's Source Control panel: //step: open the project folder include::anypoint-code-builder::partial$acb-open-packaged-sources.adoc[tag="open-workspace-root"] @@ -307,7 +306,7 @@ include::partial$acb-reusable-steps.adoc[tags="scm-commit-message-substep"] [[sync-from-terminal]] === Sync Changes from the Command Terminal -To sync changes to your files from your project's command terminal in the IDE: +To sync changes to your files from your project's command terminal: //step: open the project folder include::anypoint-code-builder::partial$acb-open-packaged-sources.adoc[tag="open-workspace-root"] @@ -348,9 +347,9 @@ To https://github.com/me/my-repo.git For common Git commands, see https://docs.github.com/en/get-started/using-git/about-git[About Git^] in the GitHub documentation, or find all commands in the https://git-scm.com/docs[Git command reference^]. [[clone-repo]] -== Clone a Project Repository into the IDE +== Clone a Project Repository into Anypoint Code Builder -If your design, implementation, or integration project is already stored in a repo on GitHub, you and your team members can clone it into Anypoint Code Builder desktop or cloud IDEs. Cloning is helpful for sharing your project with another IDE, for enabling you to edit source and sync changes from the IDE, and for retrieving a backup of a deleted project. For example, you can work on the same project in the desktop and cloud IDE if your project is stored in a repo to which you and your team have access. +If your design, implementation, or integration project is already stored in a repo on GitHub, you and your team members can clone it into Anypoint Code Builder. Cloning is helpful for sharing your project, for enabling you to edit source and sync changes, and for retrieving a backup of a deleted project. For example, you can work on the same project on different computers if your project is stored in a repo to which you and your team have access. //open ACB terminal: include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tag="open-terminal"] @@ -382,7 +381,7 @@ include::anypoint-code-builder::partial$acb-reusable-steps.adoc[tags="scm-sync-c [[check-remote]] == Check for a Remote Repository URL -To determine whether a remote GitHub repo for your project is configured in the IDE, check for a URL to the repo: +To determine whether a remote GitHub repo for your project is configured, check for a URL to the repo: //step: open the project folder include::anypoint-code-builder::partial$acb-open-packaged-sources.adoc[tag="open-workspace-root"] @@ -425,7 +424,7 @@ Git: Remove Remote... ---- .. In the popup, select the remote repo that you want to remove. + -In the IDE, your local Git repo remains because it was initialized before syncing with the remote. +Your local Git repo remains because it was initialized before syncing with the remote. == See Also diff --git a/code-builder-home/modules/ROOT/pages/start-use-command-palette.adoc b/code-builder-home/modules/ROOT/pages/start-use-command-palette.adoc index d0900b5c5..cf698944f 100644 --- a/code-builder-home/modules/ROOT/pages/start-use-command-palette.adoc +++ b/code-builder-home/modules/ROOT/pages/start-use-command-palette.adoc @@ -1,11 +1,8 @@ = Using the Command Palette -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: use-the-command-palette.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] The Command Palette in Anypoint Code Builder is the control center for all commands you use to perform tasks. Knowing how to open it is important for your productivity. @@ -14,8 +11,7 @@ The Command Palette in Anypoint Code Builder is the control center for all comma * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*: +* Select *View* > *Command Palette*: + image::open-command-palette.png["The View and Command Palette options are displayed in a list of menu choices"] diff --git a/code-builder-home/modules/ROOT/pages/start-workspaces.adoc b/code-builder-home/modules/ROOT/pages/start-workspaces.adoc index b9bdafb7c..73cfa673e 100644 --- a/code-builder-home/modules/ROOT/pages/start-workspaces.adoc +++ b/code-builder-home/modules/ROOT/pages/start-workspaces.adoc @@ -1,5 +1,4 @@ = Working with Workspaces -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-authentication-errors.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-authentication-errors.adoc index 481d325ba..1f6d48ffd 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-authentication-errors.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-authentication-errors.adoc @@ -1,12 +1,9 @@ = Authentication Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] -In Anypoint Code Builder, authentication errors sometimes occur when you attempt to perform actions that require a connection to Anypoint Platform or to services that the cloud and desktop IDEs rely on. +Authentication errors sometimes occur when you attempt to perform actions that require a connection to Anypoint Platform or to services that Anypoint Code Builder relies on. == Failed to Authenticate to Git @@ -16,7 +13,7 @@ All commands that involve `git` actions, such as publishing to Exchange and comm Failed to authenticate to git remote ---- -To address this issue, cancel the error notification, and ensure that your IDE is set to the correct region for your project and that you are logged in to Anypoint Platform. +To address this issue, cancel the error notification, and ensure that Anypoint Code Builder is set to the correct region for your project and that you are logged in to Anypoint Platform. == See Also diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-cloud-ide-disk.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-cloud-ide-disk.adoc deleted file mode 100644 index 2d427f437..000000000 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-cloud-ide-disk.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= Disk Space Issues in Cloud IDE -:page-deployment-options: cloud-ide - -include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] - -When the Cloud IDE runs out of disk space, the devcontainer can present issues. Use this recovery sequence to restore access and prevent repeated startup failures. - -Cloud IDE disk space issues can manifest as: - -* The IDE remains in an indefinite *Connecting* state. -* Project creation fails, or new projects don't load. -* Terminal or log output shows `ENOENT: no such file or directory`, indicating a file or directory is missing. - -In such cases, follow the recovery sequence to restore access and prevent repeated startup failures. - -== Reboot the Cloud IDE - -Reboot the Cloud IDE first to recover from transient startup issues. - -. Open Anypoint Code Builder Cloud IDE. -. Select *Manage your IDE*. -. Select *Reboot*. -. Wait 5 to 6 minutes for the reboot to complete. -. Select *Launch*, and verify that you can access the Cloud IDE. - -== Free Up Space - -If the reboot doesn't resolve the issue, remove content you no longer need from the workspace. - -* Delete unused Mule project folders from the Cloud IDE workspace. -* Remove files and folders that are no longer required for active development. - -== Delete and Recreate the Cloud IDE - -If the issue persists, as a last resort, recreate the Cloud IDE instance from the Anypoint Code Builder launch page. - -[IMPORTANT] --- -Deleting the Cloud IDE instance permanently removes local project files. Back up or download important project folders before you continue. --- - -. Go to the Anypoint Code Builder launch page. -. Delete the Cloud IDE instance. -. Wait 1 minute. -. Click *Launch* to create a new Cloud IDE instance. - -== See Also - -include::release-notes::partial$release-notes/rn-known-issues.adoc[tag=knownIssuesSeeAlsoLink] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-dataweave.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-dataweave.adoc index e263c8341..f27ea4fcf 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-dataweave.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-dataweave.adoc @@ -1,9 +1,8 @@ = DataWeave Issues and Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -When Anypoint Code Builder can't process a value, the IDE provides a visual indicator to identify an issue with the value. Issues include: +When Anypoint Code Builder can't process a value, it provides a visual indicator to identify an issue with the value. Issues include: * <> * <> @@ -13,11 +12,11 @@ When Anypoint Code Builder can't process a value, the IDE provides a visual indi [[sample-input]] == Unable to Find Sample Input -The DataWeave error `Unable to find sample input` applies to a Mule event variable, such as `payload`. In this case, the IDE places a wavy blue line under the value in the configuration XML file. +The DataWeave error `Unable to find sample input` applies to a Mule event variable, such as `payload`. In this case, Anypoint Code Builder places a wavy blue line under the value in the configuration XML file. image::dw-issue-sample-data.png["'Unable to find sample input' error"] -If your application isn't running, the IDE can't provide any information about Mule variables unless you provide sample data. +If your application isn't running, Anypoint Code Builder can't provide any information about Mule variables unless you provide sample data. Use xref:int-configure-dw-expressions.adoc#sample-data[Quick Fix] to provide sample data in the format and data structure that you expect to be present when the application runs. For more information about Mule event variables, see xref:dataweave::dataweave-variables-context.adoc[]. diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-deploy-errors.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-deploy-errors.adoc index 0b0f32adc..e883973bc 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-deploy-errors.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-deploy-errors.adoc @@ -1,5 +1,4 @@ = Deployment Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-generative-ai.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-generative-ai.adoc index c3d83d503..0a07fbcf3 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-generative-ai.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-generative-ai.adoc @@ -12,7 +12,7 @@ If results are still inconsistent, verify that your project context and Mulesoft If you can't open MuleSoft Vibes, verify the following: -* You are logged in to Anypoint Platform from the IDE. For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE]. +* You are logged in to Anypoint Platform. For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform]. * You have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions], including: ** *Mule Developer Generative AI User* * You have the required permissions for the tools in the MuleSoft MCP Server that MuleSoft Vibes uses to generate accurate responses. @@ -120,7 +120,7 @@ java -version == See Also -* xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE] +* xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform] * xref:start-configure-permissions.adoc#permissions[Anypoint Code Builder Permissions] * xref:vibes-create-integrations.adoc[] include::release-notes::partial$release-notes/rn-known-issues.adoc[tag=knownIssuesSeeAlsoLink] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-implementation-errors.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-implementation-errors.adoc index 047d6b4b9..8008f5692 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-implementation-errors.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-implementation-errors.adoc @@ -1,5 +1,4 @@ = Implementation Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-loading-errors.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-loading-errors.adoc index fe469db50..25942fa5d 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-loading-errors.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-loading-errors.adoc @@ -1,10 +1,7 @@ = Project Loading Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Errors sometimes occur when you open or start a project in Anypoint Code Builder. @@ -68,7 +65,7 @@ See also xref:int-import-mule-project.adoc[] and xref:start-workspaces.adoc[]. [[mule-dx]] == Mule DX API Component Was Not Installed -The error indicates that some Anypoint Code Builder dependencies have not finished loading. This issue typically occurs when you click *Design an API* and is often accompanied by the notification *Extracting Mule runtime: This operation may take a while...*. The extraction process can take several minutes, particularly after you install or update Anypoint Extension Pack on the desktop IDE. +The error indicates that some Anypoint Code Builder dependencies have not finished loading. This issue typically occurs when you click *Design an API* and is often accompanied by the notification *Extracting Mule runtime: This operation may take a while...*. The extraction process can take several minutes, particularly after you install or update Anypoint Extension Pack. . Wait for the error *Mule DX API Component was not installed* to disappear. . Retry your action. @@ -83,7 +80,7 @@ include::partial$acb-reusable-steps.adoc[tags="open-output-panel"] The error `There was an issue solving the dependencies for the asset` occurs when a dependency is missing. Usually, the appears after you import or open an integration or implementation project that is missing one or more dependencies for a connector operation. -To address this issue and avoid other errors, try logging in to Anypoint Platform from the IDE, and wait for the project to finish loading before attempting to resolve any missing dependencies that remain. +To address this issue and avoid other errors, try logging in to Anypoint Platform, and wait for the project to finish loading before attempting to resolve any missing dependencies that remain. == See Also diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-mcp-server.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-mcp-server.adoc index 6acf1e8de..f52be62b0 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-mcp-server.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-mcp-server.adoc @@ -1,5 +1,4 @@ = MCP Server Issues -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-missing-features.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-missing-features.adoc index 0cb4d5d84..eb52b153e 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-missing-features.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-missing-features.adoc @@ -1,9 +1,8 @@ = Missing or Disabled Features -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Some Anypoint Code Builder features can be disabled or hidden based on settings in the IDE. +Some Anypoint Code Builder features can be disabled or hidden based on your settings. For any features that aren't working as expected, first xref:troubleshooting.adoc#check-logs[check for problems and issues]. @@ -19,9 +18,9 @@ If the MuleSoft icon (see xref:start-discover-ui.adoc[]) is missing from the Act [[enable-icon]] === Enable Anypoint Code Builder in the Activity Bar -The Activity Bar allows you to enable or disable icons. +Use the Activity Bar to enable or disable icons. -. In the IDE, right-click the Activity Bar. +. Right-click the Activity Bar. . Check for *Anypoint Code Builder*: * If *Anypoint Code Builder* is disabled, click *Anypoint Code Builder* to add the icon to the Activity Bar. @@ -48,12 +47,12 @@ If the *Workspace Trust* tab says *You are in Restricted Mode*, you can click *T image:acb-restricted-mode.png["VS Code indicating that a project or workspace is in restricted mode"] . After trusting, check for the MuleSoft icon in the Activity Bar. -For more information about trust settings in the IDE, see https://code.visualstudio.com/docs/editing/workspaces/workspace-trust[Trusting a workspace^] in the VS Code documentation. +For more information about trust settings, see https://code.visualstudio.com/docs/editing/workspaces/workspace-trust[Trusting a workspace^] in the VS Code documentation. [[modify-trust-settings]] === Modify Trust Settings -To modify your trust settings in the IDE: +To modify your trust settings: . Provide the following command to launch the *Workspace Trust* tab: + diff --git a/code-builder-home/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc b/code-builder-home/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc index cde05bb4d..ac036e2e0 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc @@ -1,9 +1,8 @@ = Mule Runtime Issues and Errors -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -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. +Anypoint Code Builder includes bundled Mule runtime versions that enable instant project opening and design. When you run or debug applications, Anypoint Code Builder 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. 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. @@ -140,7 +139,7 @@ If your Mule runtime installation becomes corrupted, you can force a reinstallat . Open Anypoint Code Builder. . Select the Mule runtime version from *Project Properties*. + -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]. +Anypoint Code Builder 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]. [NOTE] Your projects and other installed Mule runtime versions are not affected. diff --git a/code-builder-home/modules/ROOT/pages/troubleshooting.adoc b/code-builder-home/modules/ROOT/pages/troubleshooting.adoc index 50f64ee17..5336042f5 100644 --- a/code-builder-home/modules/ROOT/pages/troubleshooting.adoc +++ b/code-builder-home/modules/ROOT/pages/troubleshooting.adoc @@ -1,11 +1,8 @@ = Troubleshooting -:page-deployment-options: cloud-ide, desktop-ide -:page-aliases: manage-web-ide-instance.adoc +:page-aliases: manage-web-ide-instance.adoc, troubleshoot-cloud-ide-disk.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Troubleshoot errors and warnings you encounter when using Anypoint Code Builder. @@ -15,7 +12,6 @@ Troubleshoot errors and warnings you encounter when using Anypoint Code Builder. * xref:troubleshoot-implementation-errors.adoc[] * xref:troubleshoot-mule-runtime-errors.adoc[] * xref:troubleshoot-loading-errors.adoc[] -* xref:troubleshoot-cloud-ide-disk.adoc[] * xref:troubleshoot-mcp-server.adoc[] + For other issues and workarounds, see xref:acb-release-notes.adoc#known-issues[Known Issues] in the Anypoint Code Builder Release Notes. @@ -25,14 +21,6 @@ For tasks that support the troubleshooting process, see: * <> * <> * <> -* <> - -[[cloud-ide-environment]] -== About the Cloud IDE Environment - -The Anypoint Code Builder cloud IDE is a managed, hosted environment. Your workspace is a dedicated directory assigned to you at `/home/_your-user-name_/`, and you have full control to create, edit, and manage files within it. - -Unlike a local development environment, you don't have access to underlying server system folders, and you don't need to. All troubleshooting steps provide solutions you can perform directly from the IDE without requiring server access or file system permission changes. [[check-logs]] == Check for Problems and Issues @@ -46,7 +34,7 @@ When you don't know how to resolve an issue, the first step is to check for and [[check-console-logs]] == Check Console Logs for Extension Issues -If you encounter an issue with an Anypoint Code Builder extension, capture the console logs from the IDE's developer tools and share them with the MuleSoft support team. +If you encounter an issue with an Anypoint Code Builder extension, capture the console logs from the developer tools and share them with the MuleSoft support team. . Open the Developer Tools: + @@ -81,7 +69,7 @@ MuleSoft: Export Troubleshooting Information ---- . When you receive a notification about the information that the command extracts, click *Continue*. + -When the process is complete, the IDE shows this message: +When the process is complete, Anypoint Code Builder shows this message: + ---- Collecting information...: Generating compressed file @@ -91,41 +79,17 @@ Collecting information...: Generating compressed file The command places the file in your home directory. The filename has the prefix `acb-troubleshooting`, for example, `/Users/me/acb-troubleshooting-w9ffppmq.tar.gz`. . Provide a copy of the file to the support team. -[[manage-cloud]] -== Manage Your Cloud IDE Instance - -Manage your cloud IDE instance directly from the Anypoint Code Builder in Anypoint Platform. - -image::web-ide-management-central-page.png["Cloud IDE management page"] - -[calloutlist] -. *Version and IDE Details*: -+ -Shows the version of your Anypoint Code Builder cloud IDE instance. You can hover over *View IDE Details* to view some internal details about your cloud IDE instance: - -* *Image*: The ID of the image of your cloud IDE instance. -* *URL*: The URL to directly access your cloud IDE instance. + -This URL is necessary to ping your locally deployed Mule application when debugging. -* *Created at*: Date and time of the creation of the cloud IDE instance. -. *Reboot*: Button for rebooting your cloud IDE instance. -. *Delete*: Button for deleting your cloud IDE instance. -+ -[WARNING] --- -Deletion is permanent and cannot be undone. The process removes all the projects hosted on the IDE instance. --- - [[check-extension-pack]] == Check for Anypoint Extension Pack Installation -To determine whether Anypoint Code Builder extensions are installed in the desktop IDE, check for the *Anypoint Extension Pack* in the *Extensions: Marketplace* panel of the IDE: +To determine whether Anypoint Code Builder extensions are installed, check for the *Anypoint Extension Pack* in the *Extensions: Marketplace* panel: . In the Activity Bar, click the Extensions icon to open the *Extensions: Marketplace* panel. + To find this icon, see xref:start-discover-ui.adoc[]. . In the panel's search field, type _Anypoint_ to locate *Anypoint Extension Pack* in the list of installed extensions. -* If the extension pack is _not_ installed, follow the installation steps at xref:start-acb.adoc#set-up-desktop[Set up the Desktop IDE]. +* If the extension pack is _not_ installed, follow the installation steps at xref:start-acb.adoc#set-up-desktop[Set up Anypoint Code Builder]. * If the extension pack is installed but the MuleSoft icon is not present in the Activity Bar, see xref:troubleshoot-missing-features.adoc#missing-mulesoft-icon[MuleSoft Icon Missing from Activity Bar] to display the icon. [[maven-401-error]] @@ -135,18 +99,6 @@ If Maven fails to download dependencies with a 401 Unauthorized error when openi See xref:ref-acb-maven.adoc#authenticating-to-mulesoft-repositories[Authenticating to MuleSoft Repositories] for instructions on configuring your credentials. -[[folder-permission]] -== Folder Permission Error - -Error: ----- -EACCES: permission denied, mkdir '/home/XXXX/.vscode' ----- - -Cause: In the Anypoint Code Builder cloud IDE, you must save your work in your designated workspace folder to keep your projects secure and accessible. This error occurs when you attempt to create or save a project outside of that workspace, in a system-level folder such as `/home`, `/`, or `.config`. - -Solution: Create and import your projects within your `/home/_your-user-name_/` folder or a subdirectory under it. The cloud IDE automatically provides this folder with your username. Also avoid `/home/AnypointCodeBuilder`, which is reserved for Mule and Java downloads. - [[settings-sync-home-directory]] == Settings Sync Overwrites Home Directory on a New Computer diff --git a/code-builder-home/modules/ROOT/pages/tut-graphql-configure-flow-responses.adoc b/code-builder-home/modules/ROOT/pages/tut-graphql-configure-flow-responses.adoc index c96d6e098..a53cbcee5 100644 --- a/code-builder-home/modules/ROOT/pages/tut-graphql-configure-flow-responses.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-graphql-configure-flow-responses.adoc @@ -1,5 +1,4 @@ = Configure Responses for Your GraphQL Implementation -:page-deployment-options: cloud-ide, desktop-ide :page-pagination: prev include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/tut-graphql-implement-api.adoc b/code-builder-home/modules/ROOT/pages/tut-graphql-implement-api.adoc index 0fc2be2ad..3b7f00cbc 100644 --- a/code-builder-home/modules/ROOT/pages/tut-graphql-implement-api.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-graphql-implement-api.adoc @@ -1,5 +1,4 @@ = Implement a GraphQL API -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: next @@ -73,7 +72,7 @@ image::upload-graphql-api-exchange-method-select.png["A form for publishing a Gr == Implement the GraphQL API Schema -Use Anypoint Code Builder to retrieve the schema from Anypoint Exchange and scaffold the schema into an interface that you can implement from the desktop or cloud IDE. +Use Anypoint Code Builder to retrieve the schema from Anypoint Exchange and scaffold the schema into an interface that you can implement. . Open Anypoint Code Builder. // Pointer to Command Palette @@ -100,7 +99,7 @@ image::select-books-graphql-api.png["A table of available API specifications wit . Click *Create Project*. . If prompted, trust the authors of the API specification. + -Trusting is required before you can work on the project from the IDE. +Trusting is required before you can work on the project. + After you trust the authors, Anypoint Code Builder scaffolds your GraphQL API and creates a project with an empty flow for each type in your Books API GraphQL schema. + diff --git a/code-builder-home/modules/ROOT/pages/tut-graphql-test-first-implementation.adoc b/code-builder-home/modules/ROOT/pages/tut-graphql-test-first-implementation.adoc index af274e172..98fb3fd81 100644 --- a/code-builder-home/modules/ROOT/pages/tut-graphql-test-first-implementation.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-graphql-test-first-implementation.adoc @@ -1,11 +1,10 @@ = Test Your GraphQL Project -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Before making changes to your GraphQL project, run the application locally within the IDE to test the endpoints. +Before making changes to your GraphQL project, run the application locally to test the endpoints. == Before You Begin @@ -13,7 +12,7 @@ Complete xref:tut-graphql-implement-api.adoc[]. == Run Your Application -To deploy your Mule Application locally, within the IDE, run a debug session in Anypoint Code Builder: +To deploy your Mule Application locally, run a debug session in Anypoint Code Builder: . In Anypoint Code Builder, open the *Books Implementation* project. . Click the image:icon-run-debug.png["",15,15] (*Run and Debug*) icon in the activity bar, then click the *Start Debugging (F5)* icon. diff --git a/code-builder-home/modules/ROOT/pages/tut-local-api-specification.adoc b/code-builder-home/modules/ROOT/pages/tut-local-api-specification.adoc index 640dfce51..3dd55c6de 100644 --- a/code-builder-home/modules/ROOT/pages/tut-local-api-specification.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-local-api-specification.adoc @@ -1,18 +1,15 @@ = Iteratively Design and Implement an API Specification -:page-deployment-options: desktop-ide :imagesdir: ../assets/images :page-aliases: local-api-specification-tutorial.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Scaffold a REST API specification into an implementation project within your IDE, and sync changes to the specification with the interface without first publishing to Anypoint Exchange. For example, after adding a new endpoint to your API specification, you can re-scaffold the change into the interface to add a flow for that endpoint to the interface's configuration XML file. +Scaffold a REST API specification into an implementation project, and sync changes to the specification with the interface without first publishing to Anypoint Exchange. For example, after adding a new endpoint to your API specification, you can re-scaffold the change into the interface to add a flow for that endpoint to the interface's configuration XML file. The interface XML is automatically created in a Mule project during the scaffolding process. You define an API in a specification file within an API Design project. -Iterative API design and implementation within the IDE takes place in a _multi-root workspace_ in VS Code. To map project folders for your API specification and implementation projects into a multi-root workspace, VS Code uses a file with the extension `.code-workspace`. For your projects to work properly, this file _must not reside within_ either project folder. In addition, Anypoint Code Builder permits only one pair of iterative design and implementation project folders per multi-root workspace. The procedures for creating the specification and implementation projects are designed to meet these requirements. For information in the VS Code documentation, see https://code.visualstudio.com/docs/editing/workspaces/multi-root-workspaces[Multi-root Workspaces^]. - -NOTE: The procedures are currently written for the desktop IDE only. +Iterative API design and implementation takes place in a _multi-root workspace_ in VS Code. To map project folders for your API specification and implementation projects into a multi-root workspace, VS Code uses a file with the extension `.code-workspace`. For your projects to work properly, this file _must not reside within_ either project folder. In addition, Anypoint Code Builder permits only one pair of iterative design and implementation project folders per multi-root workspace. The procedures for creating the specification and implementation projects are designed to meet these requirements. For information in the VS Code documentation, see https://code.visualstudio.com/docs/editing/workspaces/multi-root-workspaces[Multi-root Workspaces^]. [[prereqs]] == Before You Begin @@ -24,10 +21,10 @@ include::partial$acb-reusable-steps.adoc[tags="prereq-business-groups"] [[create]] == Create an API Specification -. In the desktop IDE, open a new window in VS Code by pressing Cmd+Shift+n (Mac) or Ctrl+Shift+n (Windows). +. Open a new window in VS Code by pressing Cmd+Shift+n (Mac) or Ctrl+Shift+n (Windows). + This step helps prevent the possibility of creating an API specification in a multi-root workspace that already contains iterative design and implementation projects and ensures that the command required in the next procedure, <>, is available. -. In the activity bar of the desktop IDE, click the image:icon-ms-logo.png["",20,20] (*Anypoint Code Builder*) icon to open Anypoint Code Builder. +. In the activity bar, click the image:icon-ms-logo.png["",20,20] (*Anypoint Code Builder*) icon to open Anypoint Code Builder. . Start an API specification by clicking the quick action *Design an API*. + Alternatively, open the Command Palette by pressing Ctrl+Shift+p (Mac) or Cmd+Shift+p (Windows), and provide this command: @@ -36,7 +33,7 @@ Alternatively, open the Command Palette by pressing Ctrl+Shift+p (Mac) or Cmd+Sh ---- MuleSoft: Design an API ---- -. If prompted, sign in to Anypoint Platform, and follow all the prompts to reopen the IDE. +. If prompted, sign in to Anypoint Platform, and follow all the prompts to reopen Anypoint Code Builder. . Complete the *API Specification* form: + [%header,cols="20a,60a"] @@ -113,11 +110,11 @@ version: 1.0.development Scaffold your local REST API specification into a local implementation project. The scaffolding process creates a configuration XML for your implementation. -Local projects reside in the Anypoint Code Builder IDE, whether the projects are in your desktop IDE or in the cloud IDE associated with your user account in Anypoint Platform. +Local projects reside in Anypoint Code Builder. To scaffold your local API specification: -. With `retrieve-users-api.raml` open in your IDE, prepare to scaffold the specification into a Mule project: +. With `retrieve-users-api.raml` open, prepare to scaffold the specification into a Mule project: + .. Click the image:icon-implement-api.png["",15,15] (*Implement this local API*) icon in the activity bar: + @@ -155,7 +152,7 @@ The UI provides updates while the scaffolding process takes place: * *Executing scaffolding operation, please wait* * *Scaffolding process ended. You can now start iterating over your local API and implementation project* -. From your multi-root workspace in the Explorer, the IDE opens the scaffolded specification in your new Mule project. +. From your multi-root workspace in the Explorer, Anypoint Code Builder opens the scaffolded specification in your new Mule project. + The configuration XML file for the implementation (`retrieve-users-implementation.xml`) is located in an implementation project directory similar to this one: + @@ -364,7 +361,7 @@ image::tut-api-publish.png["Publish Retrieve Users API"] . Confirm the asset version: *1.0.0*. . Confirm the API version: *v1*. + -The status bar provides progress-related messages before the IDE updates your Mule project POM file to point to `v1.0.0` of your API specification: +The status bar provides progress-related messages before Anypoint Code Builder updates your Mule project POM file to point to `v1.0.0` of your API specification: ** *Publishing API Specification to Exchange* ** _Project_ *has been successfully published to Exchange* @@ -387,8 +384,7 @@ Team members in your business group can import your API specification from Excha * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== .. Provide this command: @@ -402,7 +398,7 @@ MuleSoft: Implement an API Specification *** Select or create a new project location. *** Find your API specification on Anypoint Exchange, and click *Add* to insert the API name into the field. .. Click *Create Project* to start scaffolding the specification into a new implementation. -. Implement the scaffolded specification in your IDE. +. Implement the scaffolded specification. //// //TODO: ON HOLD. RETEST THIS PROCEDURE. CREATE STORY. FIX ANY ISSUES. @@ -430,8 +426,7 @@ To remove your project from a multi-root workspace: * Use the keyboard shortcuts: ** Mac: Cmd+Shift+p ** Windows: Ctrl+Shift+p -* In the desktop IDE, select *View* > *Command Palette*. -* In the cloud IDE, click the image:anypoint-code-builder::icon-menu.png["",18,18] (menu) icon, and select *View* > *Command Palette*. +* Select *View* > *Command Palette*. ==== .. Provide this command: diff --git a/code-builder-home/modules/ROOT/pages/tut-slack-add-condition-to-your-flow.adoc b/code-builder-home/modules/ROOT/pages/tut-slack-add-condition-to-your-flow.adoc index f01a0dd01..bb73d3862 100644 --- a/code-builder-home/modules/ROOT/pages/tut-slack-add-condition-to-your-flow.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-slack-add-condition-to-your-flow.adoc @@ -1,5 +1,4 @@ = Add a Condition to Your Flow Logic -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: diff --git a/code-builder-home/modules/ROOT/pages/tut-slack-configure-integration.adoc b/code-builder-home/modules/ROOT/pages/tut-slack-configure-integration.adoc index 3b23f2c44..8688fe580 100644 --- a/code-builder-home/modules/ROOT/pages/tut-slack-configure-integration.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-slack-configure-integration.adoc @@ -1,5 +1,4 @@ = Configure Slack Integration -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: prev diff --git a/code-builder-home/modules/ROOT/pages/tut-slack-create-config-files-sfdc.adoc b/code-builder-home/modules/ROOT/pages/tut-slack-create-config-files-sfdc.adoc index 5c503f64c..75a164e9e 100644 --- a/code-builder-home/modules/ROOT/pages/tut-slack-create-config-files-sfdc.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-slack-create-config-files-sfdc.adoc @@ -1,5 +1,4 @@ = Create a Configuration File for Slack and Salesforce -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: diff --git a/code-builder-home/modules/ROOT/pages/tut-slack-create-escalation-api.adoc b/code-builder-home/modules/ROOT/pages/tut-slack-create-escalation-api.adoc index dceba8ca6..b532700a2 100644 --- a/code-builder-home/modules/ROOT/pages/tut-slack-create-escalation-api.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-slack-create-escalation-api.adoc @@ -1,5 +1,4 @@ = Integrate Salesforce Data into Slack and Email Notifications -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: next diff --git a/code-builder-home/modules/ROOT/pages/tut-slack-extract-payload-information.adoc b/code-builder-home/modules/ROOT/pages/tut-slack-extract-payload-information.adoc index 3769f8098..70c435d6a 100644 --- a/code-builder-home/modules/ROOT/pages/tut-slack-extract-payload-information.adoc +++ b/code-builder-home/modules/ROOT/pages/tut-slack-extract-payload-information.adoc @@ -1,5 +1,4 @@ = Extract Payload Information to Variables -:page-deployment-options: cloud-ide, desktop-ide :imagesdir: ../assets/images :page-pagination: diff --git a/code-builder-home/modules/ROOT/pages/tutorials.adoc b/code-builder-home/modules/ROOT/pages/tutorials.adoc index ed622be0b..11f3606e7 100644 --- a/code-builder-home/modules/ROOT/pages/tutorials.adoc +++ b/code-builder-home/modules/ROOT/pages/tutorials.adoc @@ -1,18 +1,15 @@ = Tutorials -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: user-guide.adoc, tut-af-amflights-overview.adoc include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -//LOGO (web, desktop, or both) -// include::partial$acb-ide-logos.adoc[tags="both-ides"] Learn how to design, implement, integrate, and deploy APIs with Anypoint Code Builder. Work through these numbered product topics to move from API specification design to a deployed Mule application. For end-to-end walkthroughs that focus on one scenario each, see <>. [[modular-learning-paths]] == Take Your API Specification from Design Through Deployment -The following topics guide you step by step from API specification design in the IDE to publishing the contract on Anypoint Exchange, building and configuring integration flows, importing and scaffolding the API into a Mule interface, and deploying the application to CloudHub or CloudHub 2.0. +The following topics guide you step by step from API specification design to publishing the contract on Anypoint Exchange, building and configuring integration flows, importing and scaffolding the API into a Mule interface, and deploying the application to CloudHub or CloudHub 2.0. . xref:des-designing-api-specs.adoc[Designing API Specs and Fragments] for supported languages and the overall design workflow. . xref:des-create-api-specs.adoc[Creating and Importing API Specifications], including the API Console and mocking service. @@ -32,7 +29,7 @@ Each linked tutorial is a self-contained walkthrough that applies Anypoint Code * xref:tut-local-api-specification.adoc[]: + -Scaffold an API specification into an interface to implement within your IDE, and sync changes to the specification with the interface without first publishing to Anypoint Exchange. For example, after adding a new endpoint to your API specification, you can re-scaffold the change into the interface to add a flow for that endpoint to the interface's configuration XML file. +Scaffold an API specification into an interface to implement, and sync changes to the specification with the interface without first publishing to Anypoint Exchange. For example, after adding a new endpoint to your API specification, you can re-scaffold the change into the interface to add a flow for that endpoint to the interface's configuration XML file. * xref:tut-graphql-implement-api.adoc[]: + diff --git a/code-builder-home/modules/ROOT/pages/urls-to-allow.adoc b/code-builder-home/modules/ROOT/pages/urls-to-allow.adoc index eb90c2686..f7a745a09 100644 --- a/code-builder-home/modules/ROOT/pages/urls-to-allow.adoc +++ b/code-builder-home/modules/ROOT/pages/urls-to-allow.adoc @@ -1,6 +1,6 @@ = Allow URLs for Anypoint Code Builder -Configure your firewall, antivirus, and proxy settings to allow Anypoint Code Builder URLs. Allowing these URLs ensures Anypoint Code Builder can connect to Anypoint Platform services, download dependencies, and access Maven repositories. This configuration prevents connection issues and improves performance if working with external hosts and Anypoint Platform services. These URLs apply to both the Desktop IDE and Cloud IDE versions of Anypoint Code Builder. +Configure your firewall, antivirus, and proxy settings to allow Anypoint Code Builder URLs. Allowing these URLs ensures Anypoint Code Builder can connect to Anypoint Platform services, download dependencies, and access Maven repositories. This configuration prevents connection issues and improves performance if working with external hosts and Anypoint Platform services. == Allow Anypoint Code Builder URLs @@ -72,7 +72,7 @@ Some entries use a wildcard (*) to indicate that all subdomains must be allowed. * MuleSoft Maven repositories and connectors update site ** \https://repository.mulesoft.org ** \https://*.repository.mulesoft.org -* Anypoint Code Builder update sites (Desktop IDE and Cloud IDE) +* Anypoint Code Builder update sites ** \https://anypoint.code-builder.platform.salesforce.com ** \https://*.anypoint.code-builder.platform.salesforce.com * Anypoint Platform services: CloudHub, Exchange, Core Services [Commcloud / Hyperforce] diff --git a/code-builder-home/modules/ROOT/pages/vibes-api-ai-create-spec.adoc b/code-builder-home/modules/ROOT/pages/vibes-api-ai-create-spec.adoc index 2f6f54dda..3550729ff 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-api-ai-create-spec.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-api-ai-create-spec.adoc @@ -1,5 +1,4 @@ = Creating API Specs with MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: api-ai-create-spec.adoc MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available directly in Anypoint Code Builder. It provides a unified panel that lets you interact with AI features using natural language prompts. Mulesoft Vibes works with the embedded MuleSoft MCP Servers (see xref:mulesoft-mcp-server::index.adoc[Mulesoft MCP Servers]) to support capabilities such as deploying applications, managing instances, and creating new projects. @@ -11,12 +10,10 @@ One of these capabilities is AI-powered API specification generation. With Mules Before you start creating your API spec, make sure you meet the following prerequisites: -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. -* Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. -* Ensure you have the following permissions to use Mulesoft Vibes: -** *Anypoint Code Builder Developer* (to use Mulesoft Vibes in the Cloud IDE) -** *Mule Developer Generative AI User* -* Make sure Einstein is enabled in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. +* Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. +* Ensure you have the *Mule Developer Generative AI User* and *Anypoint Code Builder Developer* permissions to use Mulesoft Vibes. +* Make sure Einstein is enabled in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. NOTE: Authentication happens through the user logged into Anypoint Code Builder. Mulesoft Vibes inherits the same permissions as that user and can only execute actions that the user is authorized to perform in Anypoint Platform. @@ -171,7 +168,7 @@ Governance isn't included in the validation. . After the API project is generated, you can also: ** Ask Mulesoft Vibes to publish the API asset to Exchange. ** Add governance rulesets to validate your specification. -** Mock requests to the API directly from the IDE. +** Mock requests to the API directly. [[rules-workflows]] == Define Rules and Workflows diff --git a/code-builder-home/modules/ROOT/pages/vibes-create-integrations.adoc b/code-builder-home/modules/ROOT/pages/vibes-create-integrations.adoc index 5305d8c14..89ee8f429 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-create-integrations.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-create-integrations.adoc @@ -1,5 +1,4 @@ = Creating Integrations with MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide :page-aliases: int-ai-enable-einstein.adoc int-ai-create-integrations.adoc MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available right in Anypoint Code Builder. MuleSoft Vibes supports many capabilities through the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Servers], such as deploying applications, managing instances, and more. One such capability is transforming your business logic into a Mule application. diff --git a/code-builder-home/modules/ROOT/pages/vibes-manage-api-spec-versions.adoc b/code-builder-home/modules/ROOT/pages/vibes-manage-api-spec-versions.adoc index ca6ada0d3..4755d7c66 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-manage-api-spec-versions.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-manage-api-spec-versions.adoc @@ -1,5 +1,4 @@ = Managing API Spec Versions with MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] @@ -9,10 +8,10 @@ To manage API spec versions using the *Project Properties* UI instead, see xref: == Before You Begin -* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* xref:start-acb.adoc[Set up and access Anypoint Code Builder]. * xref:mulesoft-vibes.adoc[Set up MuleSoft Vibes] and confirm you have the required permissions. * Have an implementation or integration project that includes an API spec dependency published to Anypoint Exchange. -* Open the project folder in the IDE so that the `pom.xml` file is accessible. +* Open the project folder so that the `pom.xml` file is accessible. [[change-version-vibes]] == Change an API Spec Version diff --git a/code-builder-home/modules/ROOT/pages/vibes-run-multiple-integration-projects-locally.adoc b/code-builder-home/modules/ROOT/pages/vibes-run-multiple-integration-projects-locally.adoc index 8bdb3624f..e6e849aac 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-run-multiple-integration-projects-locally.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-run-multiple-integration-projects-locally.adoc @@ -1,5 +1,4 @@ = Running Multiple Local Integration Projects with MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide Run multiple integration projects locally in one runtime to validate service-to-service behavior before deployment. Use MuleSoft Vibes to create a reusable run configuration automatically, start related projects together, and test end-to-end behavior. Update and reuse the same configuration as your local integration scope changes. @@ -11,7 +10,7 @@ When MuleSoft Vibes creates a multi-project configuration, it uses the default r * xref:start-workspaces.adoc[Work in a multi-root workspace] that contains the related Mule projects. * xref:mulesoft-vibes.adoc[Set up MuleSoft Vibes] and confirm you have required permissions. -* Verify that each project can run locally in your IDE environment. +* Verify that each project can run locally in your environment. == Run Related Projects Together Locally @@ -29,9 +28,9 @@ Example prompts: . Wait for MuleSoft Vibes to create the run configuration and start the selected projects. . Confirm that the projects are running in the same local runtime instance. -== Run Saved Configurations from the IDE +== Run Saved Configurations from Anypoint Code Builder -After MuleSoft Vibes creates a multi-project configuration, you can reuse it through standard IDE execution paths. +After MuleSoft Vibes creates a multi-project configuration, you can reuse it through standard execution paths. . Open the *Run and Debug* panel. . Select the saved multi-project configuration from the launch configuration list. @@ -153,7 +152,7 @@ To customize runtime arguments for a specific configuration, add the `mule.runti Alternatively, update the global default: -. Open *Settings* in your IDE. +. Open *Settings*. . Search for `Mule > Runtime: Default Arguments`. . Add or update your arguments, for example `-M-Dencryption.key=my-key` or `-M-Denv=dev`. @@ -169,7 +168,7 @@ For common runtime argument use cases, see xref:ref-mule-settings.adoc#setting-m |Edit `noDebug` in the `.code-workspace` file, or ask MuleSoft Vibes to update the configuration. |Runtime arguments -|Add `mule.runtime.args` to the launch configuration in your `.code-workspace` file, or update `Mule > Runtime: Default Arguments` in IDE settings. +|Add `mule.runtime.args` to the launch configuration in your `.code-workspace` file, or update `Mule > Runtime: Default Arguments` in *Settings*. |Mule runtime or JDK version |Edit `mule.runtime.version` or `mule.jdk.version` in the `.code-workspace` file. See <>. diff --git a/code-builder-home/modules/ROOT/pages/vibes-secure-properties.adoc b/code-builder-home/modules/ROOT/pages/vibes-secure-properties.adoc index 6335e9725..cbf3c8c09 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-secure-properties.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-secure-properties.adoc @@ -1,5 +1,4 @@ = Working with Secure Properties Using MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] diff --git a/code-builder-home/modules/ROOT/pages/vibes-skills.adoc b/code-builder-home/modules/ROOT/pages/vibes-skills.adoc index 0764f5c83..143244a79 100644 --- a/code-builder-home/modules/ROOT/pages/vibes-skills.adoc +++ b/code-builder-home/modules/ROOT/pages/vibes-skills.adoc @@ -1,5 +1,4 @@ = Using Skills with MuleSoft Vibes -:page-deployment-options: cloud-ide, desktop-ide Skills are reusable instruction sets that MuleSoft Vibes activates only when they apply to your task. Each skill packages guidance and optional resources so MuleSoft Vibes can follow a consistent workflow without loading that material for unrelated messages. @@ -105,7 +104,7 @@ The default MuleSoft skills set includes: // You can also install skills manually by copying a skill folder to one of these locations: // // * Claude Code: `~/.claude/skills/` -// * MuleSoft Vibes in Anypoint Code Builder desktop IDE: `/Users/{your-user-name}/Library/Application Support/Code/User/globalStorage/salesforce.mule-dx-vscode/Skills-MuleSoft/` +// * MuleSoft Vibes in Anypoint Code Builder: `/Users/{your-user-name}/Library/Application Support/Code/User/globalStorage/salesforce.mule-dx-vscode/Skills-MuleSoft/` == Skills and MCP Tools