Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions modules/ROOT/pages/_partials/acb-component-info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ For reference documentation on specific connector and component configurations,

//
// tag::note-component-add-config[]
When adding components, you can start from the canvas or the configuration XML for your app.
You can configure components from their configuration panels in the canvas or from the XML.
When adding components, you can start from the canvas or the code editor for your app.
You can configure components from their configuration panels in the canvas or from the code editor.
// end::note-component-add-config[]
//

Expand All @@ -64,7 +64,7 @@ In Anypoint Code Builder, both integrations and implementations are Mule applica

include::reuse::partial$connectors/connectors-mule-apps.adoc[]

Built-in Anypoint connectors are available from the canvas and configuration XML for integration and implementation projects. These connectors include:
Built-in Anypoint connectors are available from the canvas and code editor for integration and implementation projects. These connectors include:

* xref:a2a-connector::index.adoc[Anypoint Connector for Agent2Agent (A2A) (Beta) (<a2a:/>)] (A2A Connector)
* xref:agentforce-connector::index.adoc[Anypoint Connector for Agentforce (<ms-agentforce:/>)] (Agentforce Connector)
Expand Down Expand Up @@ -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 XML view.
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.

To open the configuration panel:

Expand All @@ -117,7 +117,7 @@ You can select a previously saved connection in the *Connection* field and the f
+
NOTE: Changes impact all components using this connection.

* Update connection details without manually editing the XML code.
* Update connection details without manually editing the XML in the code editor.

* Test the connection directly within the panel to verify it's correctly configured.
+
Expand Down Expand Up @@ -182,17 +182,17 @@ Includes On-Error Continue (`<on-error-continue/>`) and On-Error Propagate (`<on
//
// tag::add-components[]

These examples illustrate basic configurations for adding components to your project from the canvas, and the configuration XML. The examples assume you are beginning with an empty integration project.
These examples illustrate basic configurations for adding components to your project from the canvas, and the code editor. The examples assume you are beginning with an empty integration project.

. {open-config-xml}, such as `my-project-name.xml`.
+
image::anypoint-code-builder::int-empty-canvas.png["Canvas showing visual representation of Mule flow and the Mule configuration file"]
+
[calloutlist]
.. The canvas provides space for a visual representation of your Mule flows or subflows.
.. The configuration XML editor displays the configuration file for your Mule application.
.. The code editor displays the configuration file for your Mule application.
. Select *Build a Flow* from the canvas to create an empty flow within a Mule integration application.
. Change the default name of the flow from the canvas or from the configuration XML.
. Change the default name of the flow from the canvas or from the code editor.
+
[tabs]
====
Expand All @@ -203,7 +203,7 @@ Click *Flow name1* to open the configuration panel for the Flow component, chang

image::anypoint-code-builder::int-flow-name-ui.png["Change name of flow through canvas."]
--
From the configuration XML::
From the code editor::
+
--
Replace the default name of the flow (`name1`) with your flow name, such as `getFlights`, for example:
Expand Down Expand Up @@ -234,11 +234,11 @@ The configuration XML file now includes the XML for the HTTP Listener within the

</flow>
----
. Add another component, this time using the configuration XML.
. Add another component, this time using the code editor.
+
In the configuration XML, place your cursor before the opening `<flow>` tag. Ensure that the cursor is not inside the `<flow/>` element. Add the following code:
In the code editor, place your cursor before the opening `<flow>` tag. Ensure that the cursor is not inside the `<flow/>` element. Add the following code:
+
// image::anypoint-code-builder::add-http-config-snippet.png["http:listener-config highlighted in the configuration XML menu"]
// image::anypoint-code-builder::add-http-config-snippet.png["http:listener-config highlighted in the code editor"]
+
[source,xml]
----
Expand All @@ -252,7 +252,7 @@ image::anypoint-code-builder::int-canvas-error.png["Listener error in the canvas
+
.. To determine where the error is, select the processor in the canvas.
+
Anypoint Code Builder highlights its location within the configuration XML, and you can mouse over the issue for more information, for example:
Anypoint Code Builder highlights its location in the code editor, and you can mouse over the issue for more information, for example:
+
image::anypoint-code-builder::int-select-listener-config.png["Selecting configuration reference from configuration panel"]
.. To fix the error, change the value of the `name` attribute in `http:listener-config` to match the name of the `config-ref` value in your `http:listener` configuration:
Expand Down Expand Up @@ -423,11 +423,11 @@ The status bar shows the progress:
* *Invalid Connection Got status code: 500 when trying to resolve a Mule Runtime operation* indicates a connection error.


== Test Connection from the Configuration XML
== Test Connection from the Code Editor

You can test the connection from the configuration XML. For example, to test an HTTP Listener connection, click *Test Connection* in the configuration XML:
You can test the connection from the code editor. For example, to test an HTTP Listener connection, click *Test Connection* in the code editor:

image::http-listener-test-connection.png["HTTP Listener Test Connection link in the configuration XML"]
image::http-listener-test-connection.png["HTTP Listener Test Connection link in the code editor"]

The status bar shows the progress:

Expand Down Expand Up @@ -522,14 +522,14 @@ xref:exchange::index.adoc[].
//
// tag::open-component-from-xml[]

You can open a component and its configuration panel in the canvas from the XML editor. This feature is helpful, for example, if you want to configure the component from the UI, if a component is in another flow than the flow currently displayed in the canvas, or if the canvas is not open.
You can open a component and its configuration panel in the canvas from the code editor. This feature is helpful, for example, if you want to configure the component from the UI, if a component is in another flow than the flow currently displayed in the canvas, or if the canvas is not open.

. From the configuration XML, place your cursor within the component's XML.
. From the code editor, place your cursor within the component's XML.
. Right-click and select *Configure Component in UI*.
+
This action displays the component in the canvas and opens its configuration panel, for example:
+
image::anypoint-code-builder::acb-open-component-ui-from-xml.png["Opening a component in the canvas from the XML"]
image::anypoint-code-builder::acb-open-component-ui-from-xml.png["Opening a component in the canvas from the code editor"]

// end::open-component-from-xml[]
//
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ The root of a project is the top-level folder that Anypoint Code Builder generat
// step to test the project after opening
// tag::test-project[]
. Test your project:
.. In the open project, check for errors and make sure that the configuration XML and canvas load correctly, which indicates that component dependencies resolved.
.. In the open project, check for errors and make sure that the canvas and code editor load correctly, which indicates that component dependencies resolved.
.. Check for any configurations to modify, such as ports or file paths in the configuration XML.
.. Run and debug your project:
+
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/_partials/acb-reusable-steps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
// tag::check-connection-http[]
. Before starting your Mule app, confirm that the connection to the listener is successful:
+
From the configuration XML, above the HTTP Listener configuration (`<http:listener-config/>`), click *Test Connection*.
From the code editor, above the HTTP Listener configuration (`<http:listener-config/>`), click *Test Connection*.
* If the test succeeds, you see a *Connection is valid* message.
* If the connection fails, an error message indicates that the connection was unsuccessful. If the app is running when you click *Test Connection*, this error message appears: `Invalid Connection Got status code: 500 when trying to resolve a Mule Runtime operation. Reason: 'Internal Server Error.`
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/imp-implement-api-specs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ For example, if the updated spec adds a new endpoint, the configuration XML for

== Tour the Interface File

After you scaffold your API spec into an interface, examine the scaffolded flows and error handlers for your interface in the UI canvas and configuration XML.
After you scaffold your API spec into an interface, examine the scaffolded flows and error handlers for your interface in the UI canvas and code editor.

image::imp-scaffolded-flow-canvas.png["Scaffolded flows in the Canvas"]

Expand All @@ -175,7 +175,7 @@ image::imp-scaffolded-flow-canvas.png["Scaffolded flows in the Canvas"]
+
image::int-flow-list.png["Flow List example"]

. In the configuration XML, locate the flows created for the endpoints in your API spec.
. In the code editor, locate the flows created for the endpoints in your API spec.
+
.Example Flow
[%collapsible]
Expand Down Expand Up @@ -261,7 +261,7 @@ and add a Flow Ref component (`<flow-ref/>`) to a flow in your interface file.
. Open `implementation.xml`.
+
image::get-flights-select-listener.png["HTTP listener highlighted in the implementation.xml file"]
. Delete the *HTTP /flights* listener XML from the configuration XML:
. In the code editor, delete the *HTTP /flights* listener XML:
+
[source,xml]
--
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/int-ai-gen-flow-examples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ After reviewing and inserting the generated flow into your project:
----
+
This example flow is configured to poll for new cases every 5000 milliseconds.
. Add the required configurations for your Salesforce instance and email inbox in your configuration XML.
. Add the required configurations for your Salesforce instance and email inbox in the code editor.

The following is an example of the completed flow:

Expand Down Expand Up @@ -165,7 +165,7 @@ The `type` attribute is set to `Account` to specify the object type to update.

=== Complete the Flow

To run this flow, add the required configurations for your Salesforce instance in your configuration XML.
To run this flow, add the required configurations for your Salesforce instance in the code editor.

The following is an example of the completed flow:

Expand Down Expand Up @@ -265,7 +265,7 @@ output application/java
After reviewing and inserting the generated flow into your project:

. Update the name of the database table and fields to match what is configured in your MySQL database.
. To run this flow, add the required configurations for your Salesforce instance in your configuration XML.
. To run this flow, add the required configurations for your Salesforce instance in the code editor.

The following is an example of a completed flow:

Expand Down Expand Up @@ -372,7 +372,7 @@ After reviewing and inserting the generated flow into your project:
. Update the `watermarkColumn` in the Database *Listener* to whichever database column is used to indicate new records.
+
The values that are taken from this column are used to filter the contents of the next poll, so that only rows with a greater watermark value are processed.
. To run this flow, add the required configurations for your database and email inbox in your configuration XML.
. To run this flow, add the required configurations for your database and email inbox in the code editor.

The following is an example of the completed flow:

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/int-autodiscovery-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ You'll need the instance ID when configuring your Mule app for autodiscovery.
====
--
. In your Mule app in Anypoint Code Builder, use your API instance ID to pair your app to the API instance:
.. In the XML editor for your Mule app, add the `<api-gateway:autodiscovery/>` element above `<flow/>` elements in the app, for example:
.. In the code editor for your Mule app, add the `<api-gateway:autodiscovery/>` element above `<flow/>` elements in the app, for example:
+
[source,xml]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Opening a Component in the Canvas from the XML Editor
= 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"]
Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/int-configure-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

Configure connectors and processors within your implementation and integration projects from the canvas or configuration XML.
Configure connectors and processors within your implementation and integration projects from the canvas or the code editor.

Common tasks include the following:

Expand Down Expand Up @@ -122,14 +122,14 @@ To copy a component:
Some components, like an HTTP Listener, can't be pasted to certain locations. An error message shows if a component can't be pasted to the location.

== Disable Components
You can temporarily remove components from your flow without deleting them by disabling them directly from the canvas. This action is equivalent to commenting out code in the XML editor.
You can temporarily remove components from your flow without deleting them by disabling them directly from the canvas. This action is equivalent to commenting out code in the code editor.

To disable a component:

. Right-click a component in the canvas.
. Select *Disable Component*.

Disabled components appear with a dashed outline and a disabled icon. In the XML editor, the component is wrapped in an XML comment (<!-- ... -->), preserving the code but preventing it from executing.
Disabled components appear with a dashed outline and a disabled icon. In the code editor, the component is wrapped in an XML comment (<!-- ... -->), preserving the code but preventing it from executing.
Disabled components appear greyed out in the canvas and are ignored at runtime.

=== Re-enable a Disabled Component
Expand All @@ -138,7 +138,7 @@ To restore a component:
. Right-click the disabled component.
. Select *Enable Component*.

This also removes the comment from the XML view.
This also removes the comment from the code editor.

If you previously set a breakpoint on a component and then disable it, the breakpoint remains associated with the component but is inactive. +
You can't add new breakpoints to a disabled component until it's re-enabled.
Expand Down Expand Up @@ -173,7 +173,7 @@ include::partial$acb-component-info.adoc[tags="import-connector-exchange"]
include::partial$acb-component-info.adoc[tags="check-connection"]

[[open-component-from-xml]]
== Open a Component in the Canvas from the XML Editor
== Open a Component in the Canvas from the Code Editor

//open from xml
include::partial$acb-component-info.adoc[tags="open-component-from-xml"]
Expand Down
Loading