W-15669357 share component docs duke

.vscode/settings.json

@@ -15,4 +15,4 @@
         "**/.exchange_modules_tmp": true,
         ".mule": true
     }
-}
+}

modules/ROOT/pages/_partials/nav-app-dev.adoc

@@ -2,55 +2,68 @@
 ** xref:mule-app-dev-hellomule.adoc[Tutorial: Create a "Hello World" Mule app]
 ** xref:mule-app-tutorial.adoc[Tutorial: Create a Mule app that uses the Database Connector and DataWeave]
 ** xref:about-components.adoc[Core Components]
- *** xref:async-scope-reference.adoc[Async Scope]
- *** xref:batch-processing-concept.adoc[]
+*** xref:component-async.adoc[]
+// REMOVED: EXTRACTED DIFF TO NEW FILE
+// *** xref:async-scope-reference.adoc[Async Scope OLD]
+ //NOTE: shareable batch doc not available yet
+ *** xref:batch-processing-concept.adoc[Batch (<batch:/>)]
  **** xref:batch-phases.adoc[]
  **** xref:batch-filters-and-batch-aggregator.adoc[]
  **** xref:batch-job-instance-id.adoc[]
  **** xref:batch-error-handling-faq.adoc[]
  **** xref:batch-reference.adoc[]
- *** xref:cache-scope.adoc[Cache Scope]
-  **** xref:cache-scope-to-configure.adoc[Configure the Cache Scope]
-  **** xref:cache-scope-strategy.adoc[Set Up a Caching Strategy]
-  **** xref:cache-scope-invalidate.adoc[Invalidate Cache Entries]
- *** xref:choice-router-concept.adoc[Choice Router]
- *** xref:business-events-custom.adoc[Custom Business Event Component]
- *** xref:dynamic-evaluate-component-reference.adoc[Dynamic Evaluate Component]
- *** xref:first-successful.adoc[First Successful Router]
- *** xref:flow-component.adoc[Flow and Subflow Scopes]
- *** xref:flowref-about.adoc[Flow Reference Component]
- *** xref:for-each-scope-concept.adoc[For Each Scope]
- *** xref:idempotent-message-validator.adoc[Idempotent Message Validator]
- *** xref:logger-component-reference.adoc[Logger Component]
- *** xref:on-error-scope-concept.adoc[On-Error Components]
- *** xref:parallel-foreach-scope.adoc[Parallel For Each Scope]
- *** xref:parse-template-reference.adoc[Parse Template Component]
- *** xref:raise-error-component-reference.adoc[Raise Error Component]
- *** xref:round-robin.adoc[Round Robin Router]
- *** xref:remove-variable.adoc[Remove Variable Transformer]
- *** xref:scheduler-concept.adoc[Scheduler Endpoint (Trigger)]
- *** xref:scatter-gather-concept.adoc[Scatter-Gather Router]
- *** xref:set-payload-transformer-reference.adoc[Set Payload Transformer]
- *** xref:set-transaction-id.adoc[Set Transaction Id Component]
- *** xref:variable-transformer-reference.adoc[Set Variable Transformer]
- *** xref:transform-component-about.adoc[Transform Message Component]
-  **** xref:transform-workflow-create-mapping-ui-studio.adoc[Workflow: Create a Mapping in Anypoint Studio]
-   ***** xref:transform-input-output-structure-transformation-studio-task.adoc[Define Input and Output Structure of a Transformation]
-   ***** xref:transform-graphically-construct-mapping-studio-task.adoc[Graphically Construct a Mapping]
-   ***** xref:transform-preview-transformation-output-studio-task.adoc[Preview the Output of a Transformation]
-   ***** xref:transform-tips-transform-message-ui-studio.adoc[Tips: Transform Message Component UI]
-   ***** xref:transform-change-target-output-transformation-studio-task.adoc[Change the Target Output of a Transformation]
-   ***** xref:transform-add-another-output-transform-studio-task.adoc[Add Another Output Target]
-   ***** xref:transform-move-transformations-separate-file-studio-task.adoc[Move Transformations to Separate Files]
-  **** xref:transform-workflow-create-mapping-ui-design-center.adoc[Workflow: Create a Mapping in Design Center]
-   ***** xref:transform-input-output-structure-transformation-design-center-task.adoc[Define Input and Output Structure of a Transformation]
-   ***** xref:transform-graphically-construct-mapping-design-center-task.adoc[Graphically Construct a Mapping]
-   ***** xref:transform-preview-transformation-output-design-center-task.adoc[Preview the Output of a Transformation]
-  **** xref:transform-to-change-target-output-design-center.adoc[Output a Transformation to an Attribute or Variable]
-  **** xref:transform-dataweave-xml-reference.adoc[Transform XML Reference]
- *** xref:try-scope-concept.adoc[Try Scope]
-  **** xref:try-scope-xml-reference.adoc[Try Scope XML Reference]
- *** xref:until-successful-scope.adoc[Until Successful Scope]
+*** xref:component-cache.adoc[]
+ *** xref:cache-scope.adoc[Cache Scope OLD]
+  **** xref:cache-scope-to-configure.adoc[Configure the Cache Scope OLD]
+  **** xref:cache-scope-strategy.adoc[Set Up a Caching Strategy OLD]
+//MOVED LOWER
+//  **** xref:cache-scope-invalidate.adoc[Invalidate Cache Entries OLD]
+*** xref:component-choice.adoc[]
+ *** xref:choice-router-concept.adoc[Choice Router OLD]
+*** xref:component-custom-event.adoc[] 
+ *** xref:business-events-custom.adoc[Custom Business Event Component OLD]
+*** xref:component-dynamic-evaluate.adoc[]
+ *** xref:dynamic-evaluate-component-reference.adoc[Dynamic Evaluate Component OLD]
+*** xref:component-error-handler.adoc[]
++
+Includes On-Error Continue (`<on-error-continue/>`) and On-Error Propagate (`<on-error-propagate/>`)
+ *** xref:on-error-scope-concept.adoc[On-Error Components OLD]
+*** xref:component-first-successful.adoc[]
+ *** xref:first-successful.adoc[First Successful Router OLD]
+*** xref:component-flow.adoc[]
+ *** xref:flow-component.adoc[Flow and Subflow Scopes OLD]
+*** xref:component-flow-ref.adoc[]
+ *** xref:flowref-about.adoc[Flow Reference Component OLD]
+*** xref:component-for-each.adoc[] 
+ *** xref:for-each-scope-concept.adoc[For Each Scope OLD]
+*** xref:component-idempotent-message-validator.adoc[]
+ *** xref:idempotent-message-validator.adoc[Idempotent Message Validator OLD]
+*** xref:component-invalidate-cache.adoc[]
+*** xref:cache-scope-invalidate.adoc[Invalidate Cache Entries OLD]
+*** xref:component-invalidate-key.adoc[]
+// MOVED UP *** xref:on-error-scope-concept.adoc[On-Error Components OLD]
+*** xref:component-logger.adoc[]
+ *** xref:logger-component-reference.adoc[Logger Component OLD]
+*** xref:component-parallel-for-each.adoc[]
+ *** xref:parallel-foreach-scope.adoc[Parallel For Each Scope OLD]
+*** xref:component-parse-template.adoc[] 
+ *** xref:parse-template-reference.adoc[Parse Template Component OLD]
+*** xref:component-raise-error.adoc[]
+ *** xref:raise-error-component-reference.adoc[Raise Error Component OLD]
+*** xref:component-round-robin.adoc[]
+ *** xref:round-robin.adoc[Round Robin Router OLD]
+*** xref:component-remove-variable.adoc[]  
+ *** xref:remove-variable.adoc[Remove Variable Transformer OLD]
+*** xref:component-scatter-gather.adoc[] 
+ *** xref:scatter-gather-concept.adoc[Scatter-Gather Router OLD]
+*** xref:component-scheduler.adoc[] 
+*** xref:component-set-payload.adoc[]
+*** xref:component-transaction.adoc[]
+*** xref:component-set-variable.adoc[]
+*** xref:component-subflow.adoc[]
+*** xref:component-transform.adoc[]
+*** xref:component-try.adoc[]
+*** xref:component-until-successful.adoc[]
 ** xref:build-application-from-api.adoc[Build an Application from an API]
 ** xref:build-an-https-service.adoc[Build an HTTPS Service]
 ** xref:global-elements.adoc[Configure Global Elements]

modules/ROOT/pages/_partials/set-transaction-id.adoc

@@ -5,37 +5,13 @@ The transaction ID supports DataWeave expressions, which enables you to create a
 //end::transactionIdIntro[]
 
 [[customize-transaction-id]]
-== Customize the Transaction ID
+== Customize the Transaction ID in Studio
 //tag::transactionIdConfigure[]
-Follow these steps to set a transaction ID either in Anypoint Studio or by editing the configuration XML:
+Follow these steps to set a transaction ID from the Anypoint Studio UI:
 
-* In the Studio UI:
-+
 . Drag the *Set Transaction Id* component to your flow.
 . In the *Set Transaction ID* configuration screen, set an ID value for the  *Transaction ID* field:
 +
 image::mruntime-custom-transaction-id.png["Configuration for setting a transaction ID in a Mule flow"]
 
-* In the XML editor:
-+
-** Add a child element to the `flow` element:
-+
-[source,xml,linenums]
-----
-<flow name="flow">
-...
-  <tracking:transaction id="#[payload.orderId]" />
-...
-</flow>
-----
-//end::transactionIdConfigure[]
-
-//tag::transactionIdReference[]
-== Set Transaction ID Reference
-
-[%header,cols="1,4"]
-|===
-| Field | Description
-| Transaction ID (`id`) a| Defines the value of the identifier. It can be an expression or a literal. By default, the component assigns a numeric value.
-|===
-//end::transactionIdReference[]
+//end::transactionIdReference[]

modules/ROOT/pages/batch-processing-concept.adoc

@@ -1,4 +1,4 @@
-= Batch Processing
+= Batch Processors (<batch:/>)
 ifndef::env-site,env-github[]
 include::_attributes.adoc[]
 endif::[]

modules/ROOT/pages/component-async.adoc

@@ -0,0 +1,82 @@
+// Filenames follow a syntax component-some-name.adoc
+// So for component-scatter-gather.adocs, the confugration is
+// :component-filename: scatter-gather
+:component-filename: async
+:page-aliases: async-scope-reference.adoc
+//:page-deployment-options: cloud-ide, desktop-ide
+
+//TBD if this is needed for changing singular to plural 
+:example: example
+
+//
+//title of this page
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-title]
+//
+
+//INTRODUCTION
+//short description
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-short-description]
+//
+//long description, if needed
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-long-description]
+//
+
+//NOTE: in docs-mule-runtime only
+image::async-scope-schematic.png[Async+scope+schematic]
+
+//
+//COMPONENT XML AND SNIPPET SECTION
+//component XML title
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-title]
+//
+//component XML
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml]
+//
+//component XML variant, as needed
+//TODO_INTRO_AS NEEDED
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml2]
+//
+//
+
+//
+//Component element and attribute descriptions
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-attributes-root]
+//
+// component SNIPPET JSON, if available:
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-snippet-json]
+//
+
+//Child Element (if needed, repeating as necessary): 
+//Component element and attribute descriptions
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-attributes-child1]
+//
+//Grandchild/Descendant Element (if needed, repeating as necessary): 
+//Component element and attribute descriptions
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-attributes-descendant1]
+//
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=async-vs-subflow]
+// 
+//EXAMPLES SECTION
+//example: title (Examples)
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-examples-title]
+//
+//example: generic intro
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-examples-intro]
+//
+//XML example
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-ex1]
+//
+//
+//XML example 2, if needed
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-xml-ex2]
+//
+
+//
+//ERROR HANDLING SECTION, if available
+//include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=component-error-handling]
+//
+
+//
+//SEE ALSO SECTION, if needed
+include::anypoint-code-builder::partial$mule-components/4.x/component-{component-filename}.adoc[tag=see-also]
+//

modules/ROOT/pages/component-cache.adoc

@@ -0,0 +1,79 @@
+// Filenames follow a syntax component-some-name.adoc
+// So for component-scatter-gather.adocs, the confugration is
+// :component-filename: scatter-gather
+:component-filename: cache
+:version: 4.4
+
+//TBD if this is needed for changing singular to plural 
+:example: example
+
+//
+//title of this page
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-title]
+//
+
+//INTRODUCTION
+//short description
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-short-description]
+//
+//long description, if needed
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-long-description]
+//
+//Caching process
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=caching-process]
+//Caching strategy
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=caching-strategy]
+//
+//COMPONENT XML AND SNIPPET SECTION
+//component XML title
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml-title]
+//
+//component XML
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml]
+//
+//component XML variant, as needed
+//TODO_INTRO_AS NEEDED
+//include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml2]
+//
+//
+
+//
+//Component element and attribute descriptions
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml-attributes-root]
+//
+//component XML global config
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml-global-config]
+//
+// component SNIPPET JSON, if available:
+//include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-snippet-json]
+//
+
+// 
+//EXAMPLES SECTION
+//example: title (Examples)
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-examples-title]
+//
+//example: generic intro
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-examples-intro]
+//
+//XML example
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml-ex1]
+//
+//
+//XML example 2, if needed
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-xml-ex2]
+//
+//
+//XML example 3, if needed
+//N/A for ACB (studio only)
+//
+
+//
+//ERROR HANDLING SECTION, if available
+//include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=component-error-handling]
+//
+
+//
+//SEE ALSO SECTION, if needed
+include::anypoint-code-builder::partial$mule-components/{version}/component-{component-filename}.adoc[tag=see-also]
+//