Developing Applications

Table of Contents

Creating a New Fuse Integration Project
Creating a New Camel XML file
Editing a routing context in the route editor
The Source Tab
Creating a new Apache Camel JUnit test case
Running routes inside Red Hat JBoss Fuse Tooling
Getting Started with Fuse Integration Services
Using the JBoss Fuse SAP Tool Suite
Getting Started with Data Transformation
Developing extensions for Ignite integrations
Changing the Camel version
[Note]Note

You can also develop Fuse projects using Maven. For details, see Getting Started with Developing.

Creating a New Fuse Integration Project

Overview

Creating a new Fuse Integration project involves three steps.

Once the project has been configured, the tooling configures all of the required Maven dependencies and creates the POM file needed to run and publish the project. Configured templates, based on common use cases, also provide sample code and data to get you started quickly.

Configuring project basics

  1. Select File > New > Project > JBoss Fuse > Fuse Integration Project to open the New Fuse Integration Project wizard:

    nfpProjectName1

    The wizard opens with the Use default workspace location option selected in the Location pane.

  2. In Project Name, enter a name for the new project.
  3. Specify the workspace location where the data for the project will be stored.

    1. To use the default workspace leave Use default workspace location enabled.
    2. To use an alternative location clear Use default workspace location and specify a new location in the Path field.

      Click Browse button to quickly find and select the alternate workspace.

  4. Click Next to open the Select a Target Runtime page:

    NFPcamelVersion

    You can base your new Fuse Integration project on a target runtime or on a specific version of Camel.

    • Target Runtime — Specify the runtime to which you want to publish the new project.

      You can either select an existing configured runtime from the drop-down menu, or create a new one.

      In either case, the Camel Version pane displays the Camel version associated with the runtime once it is selected.

    • Camel Version — You can specify the Camel version on which to base the new project, without creating or selecting a target runtime. The tooling supports the productised options available from the drop-down list, but allows you to type a different Camel version, if you want to experiment with non productised versions (which are not supported).

      [Important]Important

      Camel versions 2.18.1.redhat-000012 and 2.18.1.redhat-000015 work only with Fuse Integration Services projects (for details, see Getting Started with Fuse Integration Services). For Fuse Integration projects, select one of the other available productised Camel versions or type in a non productised version.

If you select an existing, configured target runtime or a specific Camel version on which to base your new Fuse Integration project, you need only set the project’s advanced options (See Setting advanced project options. Otherwise, you need to create a new target runtime before you set the project’s advanced options (see Creating a new target runtime).

When you enter a non productised Camel version, you can click the Verify button to check whether the tooling can access the specified version. If not, a notification appears in the Select a Target Runtime header:

nfpCamVerVerify

After you create, configure and save a project, it is possible to change the Camel version. See Changing the Camel version.

Creating a new target runtime

With the Select a Target Runtime page open:

  1. In the Target Runtime pane, click New to open the New server runtime environment page:

    New Server Runtime Environment
  2. Expand the Red Hat JBoss Middleware folder, and then select a JBoss Fuse runtime environment (for example JBoss Fuse 6.3).

    Leave the Create a new local server option disabled. You can create the local server later when you are ready to publish your project to it (for details, seeAdding a Server).

    [Note]Note

    If you click the Create a new local server option, the New Fuse Integration Project wizard walks you through additional steps to define and configure the new JBoss Fuse 6.3 server runtime (as described in Adding a Server). Then, when it builds the project, it also adds the server runtime to the Servers view in the Fuse Integration perspective.

  3. Click Next to open the server’s Runtime Definition page:

    nfpRuntimeDefJBF1
  4. Specify the Name, Home Directory, and Execution Environment of the server runtime:

    • Name — accept the default, or enter a new name for the runtime environment
    • Home Directory — click the Browse button to locate and select the server runtime’s installation directory

      [Note]Note

      If the server is not already installed on your machine, you can install it now by clicking the link Download and install runtime…​ and following the site’s download instructions. Depending on the site, you may be required to provide valid credentials before you can continue the download process.

    • Execution Environment — accept the default, or select another JavaSE version from the drop-down menu

      If the version you want does not appear on the list, click the Environments button and select the version from that list. The JRE version you select must be installed on your machine.

      [Note]Note

      JBoss Fuse 6.3 requires either JRE version 1.8 (recommended) or 1.7.

    • Alternate JRE — Leave as is

      [Important]Important

      If you need to modify the configuration of an existing target runtime, you do so by selecting, from the menu bar, JBoss Developer Studio > Preferences > JBoss Fuse > Server > Runtime Environments to open the Server Runtime Environments page. (On Linux and Windows machines, you access Preferences through the Windows menu.) In the Name pane, select the runtime you want to modify, and click Edit to open the server’s Runtime Definition page. You can change the Name of the target runtime, its Home Directory, and its Execution Environment.

  5. Click Finish to return to the Select a Target Runtime page:

    Target Runtime

    The newly configured target runtime appears in the Target Runtime pane’s drop-down menu, and the Camel version supported by the runtime appears in the Camel Version pane, grayed out.

    To finish, set the advanced project options as described in Setting advanced project options.

After you create and save a target runtime, it is possible to change the Camel version. See Changing the Camel version.

Setting advanced project options

With the completed Select a Target Runtime page open:

  1. Click Next to open the Advanced Project Setup page.

    You can create an empty project, which creates a skeleton Camel context routing file based on one of the three supported Domain Specific Languages (DSLs), or you can use a predefined template, each of which is based on a common use case. Individual templates may not support all DSL options.

    [Note]Note

    For Java DSL, the tooling generates a CamelRoute.java file that you can edit in the tooling’s Java editor, but it does not generate a graphical representation of it in the Diagram View.

    • Start with an empty project:

      Empty Project

      For an empty project, all DSL options are available.

    • Use a predefined template:

      Templates

      The options are:

      • ActiveMQ — Provides a sample Camel route that reads files from a specific location and routes them to a message queue. Another route, implementing a content-based router, pulls the messages off the queue and routes each to its target destination, according to message content.

        [Note]Note

        Before you can deploy this project, you must create, in your Red Hat JBoss Fuse installation, a pid file that configures the ActiveMQ connection properties. For details, open the ReadMe.txt file, listed under the project root in the Project Explorer view.

        This template creates a project that runs on Red Hat JBoss Fuse servers, and it supports the Blueprint and Spring DSLs only.

      • Content Based Router — Provides a sample Camel route that reads files from a specific location and routes them to different output folders according to message content.

        This template creates a project that runs on Red Hat JBoss Fuse servers, and it supports all three of the DSLs.

      • CXF code first — Provides a sample Camel route that is started by a CXF web service call.

        This template creates a project that runs on Red Hat JBoss Fuse servers, and it supports the Spring and Java DSLs only.

      • Spring on EAP — Provides a sample Camel route that calls into a bean service to say Hello.

        This template creates a project that runs on Red Hat EAP 6.4 servers, and it supports the Spring DSL only.

      • SpringBoot on OpenShift — Demonstrates how to configure Camel routes in Spring Boot using a Spring XML configuration file. This template creates a Fuse Integration Services project and requires Camel version 2.18.1.redhat-000012 or 2.18.1.redhat-000015.

        This template creates a project that runs on OpenShift servers, and it supports the Spring DSL only. For details on using this template, see Getting Started with Fuse Integration Services

  2. Select one of the project setup options and a DSL (as available), and then click Finish.

    The tooling starts building the project, adding it to the Project Explorer view.

    If you are not already in the Fuse Integration perspective, the tooling asks whether you want to switch to it now:

    OpenAssociatedPerspective
  3. Click Yes to open the new project in the Fuse Integration perspective:

    nfpTemplateProjectOpen

    In this example, the CBRroute project appears in the Project Explorer view. CBRroute would have been the name entered in the Project Name field in [cnfigProjectName].

  4. Click the Source tab at the bottom of the canvas to see the generated Camel context file:

    nfpTemplateCBRsource

Resolving Maven dependency errors

You may encounter Maven dependency errors after you create a new Fuse Integration project.

Though it can happen at other times, it more typically occurs when a project build is canceled before the process has finished. Interrupting the process in this way often prevents all of the project’s dependencies from downloading from the Maven repositories, which can take some time.

You can often resolve these dependency errors by updating Maven dependencies this way:

  1. In the Project Explorer view, select the root project just created.
  2. Right-click it to open the context menu.
  3. Select Maven > Update Project
  4. In the Update Maven Project wizard:

    • Select the project you want to update, if more than one appears in the wizard’s list.
    • Click the Force Update of Snapshots/Releases option to enable it.
  5. Click OK.

    In the bottom, right corner of the workbench, you may see the progress status bar churning as missing dependencies are downloaded from the Maven repositories.

Creating a New Camel XML file

Overview

Apache Camel stores routes in an XML file that contains a camelContext element. The tooling includes a wizard that simplifies adding an Apache Camel context file to your project. It creates a new XML file that has all of the required namespaces preconfigured and a template camelContext element.

Procedure

To add a new Apache Camel context file to your project:

  1. Select File > New > Other > JBoss Fuse > Camel XML File from the main menu to open the Camel XML File wizard, as shown in Figure 8, “Camel XML File wizard”.

    Figure 8. Camel XML File wizard

    Camel XML file wizard

  2. In RouteContainer, enter the location for the new file, or accept the default.

    You can click Browse…​ button to search for an appropriate location.

    [Important]Important

    The Spring framework and the OSGi Blueprint framework require that all Apache Camel files be placed in specific locations under the project’s META-INF or OSGI-INF folder:

    • Spring - projectName/src/main/resources/META-INF/spring/
    • OSGi Blueprint - projectName/src/main/resources/OSGI-INF/blueprint/
  3. In File Name, enter a name for the new context file, or accept the default (camelContext.xml).

    The file’s name cannot contain spaces or special characters, and it must be unique within the JVM.

  4. In Framework, accept the default, or select which framework the routes will use:

    • Spring — [default] for routes that will be deployed in Spring containers, non-OSGi containers, or as standalone applications
    • OSGi Blueprint — for routes that will be deployed in OSGi containers
    • Routes — for routes that you can load and add into existing camelContexts
  5. Click Finish.

    The new context file is added to the project and opened in the route editor.

Editing a routing context in the route editor

Developing an Apache Camel application typically consists of the following tasks:

  1. Adding routes to the routing context one or more routes to the routing context.
  2. Adding patterns to a route a starting point pattern to a route.
  3. Adding patterns to a route one or more endpoint patterns to a route.
  4. Adding patterns to a route one or more processor patterns that represent how messages will be transformed and routed between the starting point and endpoints.
  5. Connecting patterns to make a route the patterns (referred to as nodes once they are placed on the canvas).
  6. Configuring a pattern the details for each of the endpoints and processors that make up the route.
  7. Manually adding beans and configuration any configuration beans or shared global components/data formats to the context.

Adding routes to the routing context

Overview

The camelContext element within an XML context file creates a routing context. The camelContext element can contain one or more routes, and each route, displayed on the canvas as a Route container node, maps to a route element in the generated camelContext element.

When you create a new Fuse Integration Project, the tooling creates an example camelContext.xml (Spring) or blueprint.xml (Blueprint) routing context file. You can view and edit the contents of the routing context file in the route editor’s Source tab. In the Design tab, the route editor displays a Route container node, which represents the empty route element. You can drag patterns from the Palette and drop them into the Route container node on the canvas to create a route. The Camel tooling updates the empty route element with XML code generated from the patterns you dropped into the Route container node on the canvas.

The tooling provides two methods for adding a new route:

  • In the Design tab, by dragging a Route pattern from the Palette's Routing drawer and dropping it onto the canvas
  • In the Source tab, by adding a <route/> element to the existing list within the camelContext element

Procedure

To add another route to the camelContext: element

  1. Select one of the methods for adding a route.

    With the Design tab selected, notice that the Properties view displays the list of the new route’s properties for you to edit.

  2. In the Properties view, enter :

    • An ID (for example, Route2) for the new route in the route’s Id field

      [Note]Note

      The tooling automatically assigns an ID to EIP and component patterns dropped on the canvas. You can replace these autogenerated IDs with your own to distinguish the routes in your project.

    • A description of the route in the Description field
    • A value for any other property as needed
  3. On the menu bar, select File > Save to save the changes you made to the routing context file.
[Note]Note

To switch between multiple routes, select the route you want to display on the canvas by clicking its entry under the project’s Camel Contexts folder in the Project Explorer view.

routeEntriesProjectExplorer

When you click the context file entry in the Project Explorer view, the canvas displays all routes in the context, as space allows.

Adding patterns to a route

Routes consist of a sequence of connected patterns, referred to as nodes once they are placed on the canvas inside a Route container node. To add a pattern to a route you drag it from the Palette and drop it into a Route container on the canvas.

When patterns are dropped into a Route container on the canvas, they take on a color that indicates the type of node they are:

  • Blue — Route containers, which correspond to route elements in the context file, and other container nodes, such as when and otherwise EIPs that contain other EIPs that complete their logic
  • Green — Consumer endpoints that input data entering routes
  • Orange — EIPs that route, transform, process, or control the flow of data transiting routes
  • Purple — Producer endpoints that output the data exiting routes

Procedure

To drag a pattern onto a route:

  1. In the Palette, locate the pattern you want to add to the route.
  2. Drag the pattern over the target Route container and drop it.

    Alternatively, you can drop a pattern on an existing node that has no outgoing connection, or on a connection existing between two nodes, to have the tooling automatically wire the connections between all nodes involved.

    The tooling checks whether the resulting connection is valid and then either allows or prevents you from dropping the pattern on the drop target. For valid connections, the tooling:

    • existing node — adds the new node to the target node’s outgoing side (beneath or to the right of it depending on how the editor preferences are set) and automatically wires the connection between them
    • existing connection — inserts the new node between the two connected nodes and automatically rewires the connections between the three nodes

The new pattern appears on the canvas in the Route container and becomes the selected node. The Properties view displays a list of the new node’s properties for you to edit.

[Note]Note

After you drop a pattern inside a Route container, you can drag it to different location inside the route container or to another route container on the canvas, as long as it can establish a valid connection. You can also relocate existing nodes that are already connected, as long as the move can establish another valid connection.

[Note]Note

When you connect one node to another, the tooling updates the layout according to the route editor’s layout preference. The default is Down.

To access the route editor 's layout preference:

  • On Linux and Windows machines, Windows > Preferences > Fuse Tooling > Editor > Choose the layout direction for the diagram editor
  • On OS X, JBoss Developer Studio > Preferences > Fuse Tooling > Editor > Choose the layout direction for the diagram editor

Connecting patterns to make a route

Overview

A complete route typically consists of a starting endpoint, a string of processing nodes, and one or more destination endpoints. The tooling saves routes in the context file regardless of whether they are complete.

[Important]Important

The tooling appends every new node added in the Design tab to its route element in the context file, and any that are not connected manually, using the connector arrows, are auto-connected when the context file is reopened, or when a route is reloaded in the route editor, by switching from the Source tab to the Design tab.

[Note]Note

Not all nodes can be connected. When you try to connect a source node to an invalid target node, the tooling displays the unconfigured co gray symbol attached to the mouse cursor, and the connector fails to stick to the target node.

Manually connecting nodes

Connecting two nodes in a Route container on the canvas is as simple as dragging a line from one to the other. Each node in a route has a connector arrow. Selecting a node and dragging its connector arrow to a target node establishes a connection between the two nodes.

To connect two nodes:

  1. In the Route container on the canvas, select the source node to display its connector arrow.
  2. Drag the source node’s connector arrow ( ConnectorArrow) to the target node.

    The direction of the connection represents the direction messages flow between the nodes in the route.

  3. While hovering over the target node, release the mouse button to drop the connector on it.

    The route editor updates the <route> element in the routing context file with the xml generated from the connection. You can view the xml in the Source tab.

  4. When you are done, save your work by selecting File > Save from the menu bar.

Configuring a pattern

Overview

Most patterns require some explicit configuration. For example, an endpoint requires an explicitly entered URI.

The tooling’s Properties view provides a form that lists all of the configuration details a particular pattern supports. The Properties view also provides the following convenience features:

  • validating that all required properties have values
  • validating that supplied values are the correct data type for the property
  • drop-down lists for properties that have a fixed set of values
  • drop-down lists that are populated with the available bean references from the Apache Camel Spring configuration

Procedure

To configure a pattern:

  1. On the canvas, select the node you want to configure.

    The Properties view lists all of the selected node’s properties for you to edit. For EIPs, the Details tab lists all of a pattern’s properties. For components from the Components drawer, the Details tab lists the general properties and those that require a value, and the Advanced tab lists additional properties grouped according to function.

    The Documentation tab describes the pattern and each of its properties.

  2. Edit the fields in the Properties view to configure the node.
  3. When done, save your work by selecting File > Save from the menu bar.

Removing patterns from a route

Overview

As you develop and update a route, you may need to remove one or more of the route’s nodes. The node’s garbageIcon icon makes this easy to do. When you delete a node from the canvas, all of its connections with other nodes in the route are also deleted, and the node is removed from the corresponding route element in the context file.

[Note]Note

You can also remove a node by opening its context menu and selecting Remove.

Procedure

To remove a node from a route:

  1. Select the node you want to delete.
  2. Click its garbageIcon icon.
  3. Click Yes when asked if you are sure you want to delete this element.

The node and all of its connections are deleted from the canvas, and the node is removed from its corresponding route element in the context file.

Deleting a route

Overview

In some cases you made need to delete an entire route from your routing context. The Route container’s garbageIcon icon makes this easy to do. When you delete a route, all of the nodes inside the Route container are also deleted, and the corresponding route element in the context file is removed.

[Note]Note

You can also remove a route using the Route container’s context menu and selecting Remove.

[Important]Important

You cannot undo this operation.

Procedure

To delete a route:

  1. If the routing context contains more than one route, first select the route you want to delete in the Project Explorer view.

    routeEntriesProjectExplorer
  2. On the canvas, click the Route container’s garbageIcon icon.

    routeDelete
  3. Click Yes when asked if you are sure you want to delete this element.

The route is removed from the canvas, from the context file, and from the Project Explorer view.

Manually adding beans and configuration

Overview

Many routing patterns rely on references to Java objects (beans) for configuration or for implementation details. You manually add the beans into the routing context file by using the route editor’s Source tab. However, this approach is not recommended because it is error prone. The recommendation is to use the Configurations tab. See Adding global endpoints, data formats or beans.

Procedure

To add beans to your routing context file:

  1. Open your routing context file in the route editor.
  2. Click the Source tab at the bottom of the route editor’s canvas so you can edit the XML that defines the route.
  3. Enter the bean elements needed by your route before the camelContext element.

    [Note]Note

    Use the id attribute to identify the bean, not the name attribute.

    For example:

    <!-- Configure the Inbound SAP Connections -->
     <bean id="sap-configuration" class="org.fusesource.camel.component.sap.SapConnectionConfiguration" activation="eager">
         <property name="destinationDataStore">
             <map>
                 <entry key="quickstartDest" value-ref="quickstartDestinationData" />
             </map>
         </property>
         <property name="serverDataStore">
             <map>
                 <entry key="quickstartServer" value-ref="quickstartServerData" />
             </map
         </property>
     </bean>
    
    ...
    
     <camelContext trace="false" id="sap-srfc-destination-fuse-context" xmlns="http://camel.apache.org/schema/blueprint">
    	 <route id="sap-srfc-destination-fuse-route">
    	     <from uri="file:work/camel-sap/input"/>
    	     <convertBodyTo type="java.lang.String"/>
    	     <log message="${body}" loggingLevel="INFO"/>
    	     <to uri="sap-srfc-destination:quickstartDest:BAPI_FLCUST_GETLIST"/>
    	     <log message="${body}" loggingLevel="INFO"/>
          </route>
     </camelContext>
  4. Save your changes by selecting File > Save on the menu bar.
  5. Click the Design tab at the bottom of the route editor’s canvas to return to the graphic display and the route diagram.

Adding global endpoints, data formats or beans

Overview

Some routes rely on shared configuration provided by global endpoints, global data formats or global beans. You can add global elements to the project’s routing context file by using the route editor’s Configurations tab.

To add global elements to your routing context file:

  1. Open your routing context file in the route editor.
  2. At the bottom of the route editor, click the Configurations tab to display global configurations, if there are any.

    ConfigurationsView
  3. Click Add to open the Create a new global element dialog.

    CnfigsVAddButton

    The options are:

Adding a global endpoint

  1. In the Create a new global element dialog, select Endpoint and click OK to open the Select component dialog.

    CnfigsVSelectCamComponent1
    [Note]Note

    By default, the Select component dialog opens with the Show only palette components option enabled. To see all available components, disable this option.

    [Note]Note

    The Grouped by categories option groups components by type.

    CnfigsVSelectCamComponentGrouped
  2. In the Select component dialog, scroll through the list of Camel components to find and select the component you want to add to the context file, and then enter an ID for it in the Id field.

    CnfigsVCamComponentSelected

    In this example, the JMS component is selected and myJMS is the Id value.

  3. Click Finish.

    CnfigsVmyEndptAdded2

    You can now set properties in the Properties view as needed.

    The tooling autofills Id with the value you entered in the component’s Id field in [globalEndptSelect]. In this example, Camel builds the uri (required field) starting with the component’s schema (in this case, jms:), but you must specify the destinationName and the destinationType to complete the component’s uri.

    [Note]Note

    For the JMS component, the destination type defaults to queue. This default value does not appear in the uri field on the Details page until you have entered a value in Destination Name (required field).

  4. To complete the component’s uri, click Advanced > Path.
  5. In the Destination Name field, enter the name of the destination endpoint (for example, FOO.BAR). In the Destination Type field, enter the endpoint destination’s type (for example, queue, topic), temp:queue, or temp:topic).

    JMSCompAdvanPathProp

    The Properties view’s Details and Advanced tabs provide access to all properties available for configuring a particular component.

  6. For example, click the Consumer (advanced) tab.

    JMSCompConsumerAdvanProps2

    Enable the properties Eager Loading Of Properties and Expose Listener Session.

  7. In the route editor, switch to the Source tab to see the code that the tooling added to the context file (in this example, a configured JMS endpoint), before the first route element.

    CnfigsEndptSourceView
  8. When done, save your changes by selecting File > Save on the menu bar.

Adding a global data format

  1. In the Create a new global element dialog, select Data Format and click OK to open the Create a global Data Format dialog.

    CnfigsVCreateGlobalDF1

    The data format defaults to avro, the format at the top of the list of those available.

  2. Open the Data Format drop-down menu, and select the format you want, for example, xmljson.
  3. In the Id field, enter a name for the format, for example, myDataFormat).

    CnfigsVCreateGlobalDF2
  4. Click Finish.

    CnfigsVEditGlobalDFprops1
  5. In the Properties view, set property values as appropriate for your project, for example:

    CnfigsVEditGlobalDFprops2
  6. In the route editor, click the Source tab to see the code that the tooling added to the context file. In this example, a configured xmljson data format is before the first route element.

    CnfigsVGlobalDFSourceV
  7. When done, save your changes by selecting File > Save on the menu bar.

Adding a global bean

A global bean enables out-of-route bean definitions that can be referenced from anywhere in the route. When you copy a Bean component from the palette to the route, you can find defined global beans in the Properties view’s Ref dropdown. Select the global bean that you want the Bean component to reference.

To add a global bean element:

  1. In the Create a new global element window, select Bean and click OK to open the Bean Definition dialog.

    CnfigsVCreateGlobalBean1
  2. In the Id field, enter an ID for the global bean, for example, TransformBean. The ID must be unique in the configuration.
  3. Identify a bean class or a factory bean.

    To specify a factory bean, you must have already added another global bean with a factory class specified. You can then select that global bean to declare it as a global bean factory. One instance of the bean factory class will be in the runtime. Other global beans can call factory methods on that class to create their own instances of other classes.

    To fill the Class field, do one of the following:

    • Enter the name of a class that is in the project or in a referenced project.
    • Click …​ (Browse) to navigate to and select a class that is in the project or in a referenced project.
    • Click + to define a new bean class and add it as a global bean.
  4. If the bean you are adding requires one or more arguments, in the Constructor Arguments section, for each argument:

    1. Click Add.
    2. Optionally, in the Type field, enter the type of the argument. The default is java.lang.String.
    3. In the Value field, enter the value of the argument.
    4. Click OK.
  5. Optionally specify one or more properties that are accessible to the global bean. In the Bean Properties section, do the following for each property:

    1. Click Add.
    2. In the Name field, enter the name of the property.
    3. In the Value field, enter the value of the property.
    4. Click OK.
  6. Click Finish to add the global bean to the configuration. The global bean ID you specified appears in the Configurations tab, for example:

    CnfigsBeanInList
  7. Switch to the Source tab to see the bean element that the tooling added to the context file. For example:

    CnfigsBeanSourceV
  8. Click the Configurations tab to return to the list of global elements and select a global bean to display its standard properties in the Properties view, for example:

    CnfigsBeanProperties
    [Note]Note

    To view or edit a property that you specified when you added a global bean, select the bean in the Configurations tab and then click Edit.

  9. Set global bean properties as needed:

    • Depends-on is a string that you can use to identify a bean that must be created before this global bean. Specify the ID (name) of the depended on bean. For example, if you are adding the TransformBean and you set Depends-on to ChangeCaseBean then ChangeCaseBean must be created and then TransformBean can be created. When the beans are being destroyed then TransformBean is destroyed first.
    • Factory-method is useful only when the global bean is a factory class. In this situation, specify or select a static factory method to be called when the bean is referenced.
    • Scope is singleton or prototype. The default, singleton, indicates that Camel uses the same instance of the bean each time the bean is called. Specify prototype when you want Camel to create a new instance of the bean each time the bean is called.
    • Init-method lets you specify or select which of the bean’s init() methods to call when the bean is referenced.
    • Destroy-method lets you specify or select which of the bean’s destory methods to call when the processing performed by the bean is done.
  10. When done, save your changes by selecting File > Save on the menu bar.

Deleting a global element

The procedure is the same whether removing an endpoint, data format or bean that was previously added to the routing context.

  1. In the Configurations tab, select the global element that you want to delete.

    For example, suppose you want to delete the data format myDataFormat that was added in Adding a global data format:

    CnfigsVDFSelectDelete
  2. Click Delete.

    The global element myDataFormat disappears from the Configurations tab.

  3. Switch to the Source tab to check that the tooling removed the XML code from the routing context.

    CnfigsDelDFSourceV
  4. When done, save your changes by selecting File > Save on the menu bar.

You cannot perform an undo operation for deletion of a global element. If you inadvertently delete a global element that you want to keep in the configuration you might be able to undo the deletion by closing the context file without saving it. If this is not feasible then re-add the inadvertently deleted global element.

Editing a global element

The procedure is the same whether modifying the properties of an endpoint, data format or bean that you added to the routing context.

Typically, you do not want to change the ID of a global element. If the global element is already in use in a running route, changing the ID can break references to the global element.

  1. In the Configurations tab, select the global element that you want to edit.

    For example, to edit the endpoint myJMS that was added in Adding a global endpoint:

    CnfigsVEndptEditSelect
  2. Click Edit.

    CnfigsVEndptClickEdit

    In the Properties view, modify the element’s properties as needed.

  3. For example, open the Advanced > Consumer tab, and change the value of Concurrent Consumers to 2:

    CnfigsEditEndpntConcurConsume2
  4. In the route editor, click the Source tab and check that the tooling added the property concurrentConsumers=2 to the routing context:

    CnfigsVEndptEditSourceV
  5. When done, save your changes by selecting File > Save on the menu bar.

Related topics

[Note]Note

Manually adding a global element is possible but not recommended because doing so is error prone. The recommendation is to use the Configurations tab in the route editor.

Configuring the route editor

Overview

Using JBoss Developer Studio preferences, you can specify aspects of the route editor’s behavior when configuring Enterprise Integration Patterns:

  • The default language to use for expressions in EIPs
  • The method for labeling nodes on the canvas
  • The direction in which patterns flow on the canvas when creating routes
  • Whether the canvas displays a grid overlay

Procedure

To configure the route editor:

  1. Click Windows > Preferences > Fuse Tooling > Editor on Linux and Windows machines, but JBoss Developer Studio > Preferences > Fuse Tooling > Editor on OS X, to open the Editor preferences dialog.
  2. Select, from the drop-down list, the default language you want to use for expressions in EIP nodes. The default is Simple.
  3. Click the checkbox next to If enabled the ID values will be use for labels if existing to enable or disable using node IDs as labels. The default is enabled.
  4. Select, from the drop-down list, the direction in which you want the route editor to align the patterns in a route. The default is Down.
  5. Click the checkbox next to Show diagram grid in Routes Editor to enable or disable displaying the grid overlay on the canvas. The default is enabled.
  6. Click Apply to apply the changes to the Editor preferences.
  7. When done, click OK to close the Preferences dialog.

    You can restore the route editor’s original defaults at any time by returning to the Editor preferences dialog and clicking Restore Defaults.

Related topics

The Source Tab

The tooling’s Source tab displays the contents of a routing context .xml file.

Figure 9. Source tab

route editor’s Source tab

The Source tab is useful for editing and adding any configuration, comments, or beans to the routing context file. The content assist feature helps you when working with configuration files. In the Source tab, press Ctrl+Space to see a list of possible values that can be inserted into your project.

Creating a new Apache Camel JUnit test case

Overview

A common way of testing routes is to use JUnit. The design time tooling includes a wizard that simplifies creating a JUnit test case for your routes. The wizard uses the endpoints you specify to generate the starting point code and configuration for the test.

[Note]Note

After you create the boilerplate JUnit test case, you need to modify it to add expectations and assertions specific to the route that you’ve created or modified, so the test is valid for the route.

Prerequisites

Before you create a new JUnit test case, you need to perform a preliminary task:

Deleting and existing JUnit test case

  1. In the Project Explorer view, expand the project’s root node to expose the <root_project>/src/test/java folder.
  2. Locate the JUnit test case file in the /src/test/java folder.

    Depending on which DSL the project is based on, the JUnit test case file is named BlueprintXmlTest.java or CamelContextXmlTest.java.

  3. Right-click the JUnit test case .java file to open the context menu, and then select Delete.

    The JUnit test case .java file disappears from the Project Explorer view.

    You can now create a new JUnit test case.

Creating and adding the src/test/java folder to the build path

  1. In the Project Explorer view, right-click the project’s root to open the context menu.
  2. Select New > Folder to open the Create a new folder resource wizard.
  3. In the wizard’s project tree pane, expand the project’s root node and select the src folder.

    Make sure <project_root>/src appears in the Enter or select the parent folder field.

  4. In Folder name, enter /test/java. This folder will store the new JUnit test case you create.
  5. Click Finish.

    In the Project Explorer view, the new src/test/java folder appears under the src/main/resources folder. You can verify that this folder is on the class path by opening its context menu and selecting Build Path. If Remove from Build Path is a menu option, you know the src/test/java folder is on the class path.

    You can now create a new JUnit test case.

Creating a JUnit test case

To create a new JUnit test case for your route:

  1. In the Project Explorer view, select the routing context .xml file in your project.
  2. Right-click it to open the context menu, and then select New > Camel Test Case to open the New Camel JUnit Test Case wizard, as shown in Figure 10, “New Camel JUnit Test Case wizard”.

    Figure 10. New Camel JUnit Test Case wizard

    Entry page of the New Camel JUnit Test Case wizard

    Alternatively, you can open the wizard by selecting File > New > Other > JBoss Fuse > Camel Test Case from the menu bar.

  3. In Source folder, accept the default location of the source code for the test case, or enter another location.

    You can click Browse button to search for a location.

  4. In Package, accept the default package name for the generated test code, or enter another package name.

    You can click Browse button to search for a package.

  5. In Camel XML file under test, accept the default pathname of the routing context file that contains the route you want to test, or enter another pathname.

    You can click Browse button to search for a context file.

  6. In Name, accept the default name for the generated test class, or enter another name.
  7. Select the method stubs you want to include in the generated code.
  8. If you want to include the default generated comments in the generated code, check the Generate comments box.
  9. Click Next button to open the Test Endpoints page. For example, Figure 11, “New Camel JUnit Test Case page” shows a route’s input and output file endpoints selected.

    Figure 11. New Camel JUnit Test Case page

    Example Test Endpoints page

  10. Under Available endpoints, select the endpoints you want to test. Click the checkbox next to any selected endpoint to deselect it.
  11. Click Finish button.

    [Note]Note

    If prompted, add JUnit to the build path.

The artifacts for the test are added to your project and appear in the Project Explorer view under src/test/java. The class implementing the test case opens in the Java editor.

Running routes inside Red Hat JBoss Fuse Tooling

There are two ways to run your routes using the tooling:

Running routes as a local Camel context

Overview

The simplest way to run an Apache Camel route is as a Local Camel Context. This method enables you to launch the route directly from the Project Explorer view’s context menu. When you run a route from the context menu, the tooling automatically creates a runtime profile for you. You can also create a custom runtime profile for running your route.

Your route runs as if it were invoked directly from the command line and uses Apache Camel’s embedded Spring container. You can configure a number of the runtime parameters by editing the runtime profile.

Procedure

To run a route as a local Camel context:

  1. In the Project Explorer view, select a routing context file.
  2. Right-click it to open the context menu, and then select Run As > Local Camel Context.

    [Note]Note

    Selecting Local Camel Context (without tests) directs the tooling to run the project without performing validation tests, which may be faster.

Result

The Console view displays the output generated from running the route.

Running routes using Maven

Overview

If the project containing your route is a Maven project, you can use the m2e plug-in to run your route. Using this option, you can execute any Maven goals, before the route runs.

Procedure

To run a route using Maven:

  1. In the Project Explorer view, select the root of the project .
  2. Right-click it to open the context menu, and then select Run As > Maven build.

    1. The first time you run the project using Maven, the Edit Configuration and launch editor opens, so you can create a Maven runtime profile.

      To create the runtime profile, on the Maven tab:

      1. Make sure the route directory of your Apache Camel project appears in the Base directory: field.

        For example, on Linux the root of your project is similar to ~/workspace/simple-router.

      2. In the Goals: field, enter camel:run.

        [Important]Important

        If you created your project using the Java DSL, enter exec:java in the Goals: field.

      3. Click Apply and then Run.
    2. Subsequent Maven runs use this profile, unless you modify it between runs.

Results

The Console view displays the output from the Maven run.

Working with runtime profiles

Red Hat JBoss Fuse Tooling stores information about the runtime environments for each project in runtime profiles. The runtime profiles keep track of such information as which Maven goals to call, the Java runtime environment to use, any system variables that need to be set, and so on. A project can have more than one runtime profile.

Editing a Local Camel Context runtime profile

Overview

A Local Camel Context runtime profile configures how Apache Camel is invoked to execute a route. A Local Camel Context runtime profile stores the name of the context file in which your routes are defined, the name of the main to invoke, the command line options passed into the JVM, the JRE to use, the classpath to use, any environment variables that need to be set, and a few other pieces of information.

The runtime configuration editor for a Local Camel Context runtime profile contains the following tabs:

  • Camel Context File — specifies the name of the new configuration and the full path of the routing context file that contains your routes.
  • JMX — specifies JMX connection details, including the JMX URI and the user name and password (optional) to use to access it.
  • Main — specifies the fully qualified name of the project’s base directory, a few options for locating the base directory, any goals required to execute before running the route, and the version of the Maven runtime to use.
  • JRE — specifies the JRE and command line arguments to use when starting the JVM.
  • Refresh — specifies how Maven refreshes the project’s resource files after a run terminates.
  • Environment — specifies any environment variables that need to be set.
  • Common — specifies how the profile is stored and the output displayed.

The first time an Apache Camel route is run as a Local Camel Context, Red Hat JBoss Fuse Tooling creates for the routing context file a default runtime profile, which should not require editing.

Accessing the Local Camel Context’s runtime configuration editor
  1. In the Project Explorer view, select the Camel context file for which you want to edit or create a custom runtime profile.
  2. Right-click it to open the context menu, and then select Run As > Run Configurations to open the Run Configurations dialog.
  3. In the context selection pane, select Local Camel Context, and then click New profile icon at the top, left of the context selection pane.
  4. In the Name field, enter a new name for your runtime profile.

Figure 12. Runtime configuration editor for Local Camel Context

Local camel context runtime configuration editor

Setting the camel context file

The Camel Context File tab has one field, Select Camel Context file…​. Enter the full path to the routing context file that contains your route definitions.

The Browse…​ button accesses the Open Resource dialog, which facilitates locating the target routing context file. This dialog is preconfigured to search for files that contain Apache Camel routes.

Changing the command line options

By default the only command line option passed to the JVM is:

-fa context-file

If you are using a custom main class you may need to pass in different options. To do so, on the Main tab, click the Add button to enter a parameter’s name and value. You can click the Add Parameter dialog’s Variables…​ button to display a list of variables that you can select.

To add or modify JVM-specific arguments, edit the VM arguments field on the JRE tab.

Changing where output is sent

By default, the output generated from running the route is sent to the Console view. But you can redirect it to a file instead.

To redirect output to a file:

  1. Select the Common tab.
  2. In the Standard Input and Output pane, click the checkbox next to the Output File: field, and then enter the path to the file where you want to send the output.

    The Workspace…​, File System…​, and Variables…​ buttons facilitate building the path to the output file.

Editing a Maven runtime profile

Overview

A Maven runtime profile configures how Maven invokes Apache Camel. A Maven runtime profile stores the Maven goals to execute, any Maven profiles to use, the version of Maven to use, the JRE to use, the classpath to use, any environment variables that need to be set, and a few other pieces of information.

[Important]Important

The first time an Apache Camel route is run using Maven, you must create a default runtime profile for it.

The runtime configuration editor for a Fuse runtime profile contains the following tabs:

  • Main — specifies the name of the new configuration, the fully qualified name of the project’s base directory, a few options for locating the base directory, any goals required to execute before running the route, and the version of the Maven runtime to use.
  • JRE — specifies the JRE and command line arguments to use when starting the JVM.
  • Refresh — specifies how Maven refreshes the project’s resource files after a run terminates.
  • Source — specifies the location of any additional sources that the project requires.
  • Environment — specifies any environment variables that need to be set.
  • Common — specifies how the profile is stored and the output displayed.
Accessing the Maven runtime configuration editor
  1. In the Project Explorer view, select the root of the project for which you want to edit or create a custom runtime profile.
  2. Right-click it to open the context menu, and then select Run As > Run Configurations to open the Run Configurations dialog.
  3. In the context selection pane, select Maven Build, and then click New profile icon at the top, left of the context selection pane.

Figure 13. Runtime configuration editor for Maven

Maven runtime configuration editor

Changing the Maven goal

The most commonly used goal when running a route is camel:run. It loads the routes into a Spring container running in its own JVM.

The Apache Camel plug-in also supports a camel:embedded goal that loads the Spring container into the same JVM used by Maven. The advantage of this is that the routes should bootstrap faster.

Projects based on Java DSL use the exec:java goal.

If your POM contains other goals, you can change the Maven goal used by clicking the Configure…​ button next to the Maven Runtime field on the Main tab. On the Installations dialog, you edit the Global settings for <selected_runtime> installation field.

Changing the version of Maven

By default, Red Hat JBoss Fuse Tooling for Eclipse uses m2e, which is embedded in Eclipse. If you want to use a different version of Maven or have a newer version installed on your development machine, you can select it from the Maven Runtime drop-down menu on the Main tab.

Changing where the output is sent

By default, the output from the route execution is sent to the Console view. But you can redirect it to a file instead.

To redirect output to a file:

  1. Select the Common tab.
  2. Click the checkbox next to the Output File: field, and then enter the path to the file where you want to send the output.

    The Workspace…​, File System…​, and Variables…​ buttons facilitate building the path to the output file.

Getting Started with Fuse Integration Services

Overview

Fuse Integration Services (FIS) provides a set of tools and containerized xPaaS images for developing, deploying, and managing microservices on OpenShift.

[Important]Important

For FIS projects, JBoss Fuse Tooling requires installation of the Red Hat Container Development Kit (CDK) v3.x. See Getting Started Guide: Container Development Kit for instructions. In addition to the prerequisites specified in this guide, you need to establish a Red Hat account if you do not have one. Your Red Hat user name and password are required to start the virtual OpenShift instance provided in the Red Hat Container Development Kit.

You can easily get an account by registering on the Red Hat Customer Portal. Click Account in the upper right corner of the white banner, and then click RH acctRegBut on the Login to Your Red Hat Account page.

JBoss Fuse Tooling enables you to develop and deploy FIS 2.0 projects using the s2i binary workflow. In this workflow, the tooling builds your project locally, assembles it into an image stream, then pushes the image stream to OpenShift, where it is used to build the Docker container. Once the Docker container is built, OpenShift deploys it in a pod.

[Important]Important

JBoss Fuse Tooling works only with the S2I binary workflow and only with projects based on the Spring Boot framework.

[Note]Note

Although JBoss Fuse Tooling can deploy FIS projects created using the tooling to remote OpenShift servers, this chapter describes creating and deploying FIS projects to a virtual OpenShift instance, installed locally using the Red Hat Container Development Kit (CDK) v3.x.

Creating and deploying your first Fuse FIS project involves:

[Note]Note

You can also run a Fuse FIS project as a local Camel context, see Running routes as a local Camel context, and then connect to it in the JMX Navigator view, where you can monitor and test the routing context. You can also run the Camel debugger on a Fuse FIS project (Debugging Routing Contexts) to expose and fix any logic errors in the routing context.

Adding the Red Hat Container Development Kit server

Add the Red Hat Container Development Kit to the Servers view:

  1. If necessary, switch to the Fuse Integration perspective.

    [Note]Note

    If, in this or any other section in this chapter, a view described in a procedure is not open, you can open it by clicking Window > Show View > Other > view_name .

  2. In the Servers view, click the link No servers are available. Click this link to create a new server…​ to open the Define a New Server wizard. This link appears only when the Servers view contains no server entry.

    Otherwise, right-click in the view to open the context menu, and then select New > Server to open the Define a New Server wizard.

    DefNewSrvCDK
  3. Select Red Hat JBoss Middleware > Red Hat Container Development Kit 3.

    Accept the defaults for:

    • Server’s host name — localhost
    • Server name — Container Development Environment
  4. Click Next to open the Red Hat Container Development Environment page.
  5. Next to Folder, click Browse, navigate to the location where you installed the Red Hat Container Development Kit 3.x and click Open.
  6. Next to Username, click Add to open the Add a Credential page.
  7. Set the credentials this way:

    • Username — Enter the name you use to log into your Red Hat account.
    • Always prompt for password — Leave as is (disabled).
    • Password — Enter the password you use to log into your Red Hat account.
  8. Click OK to return to the Red Hat Container Development Environment page, which is now populated. For example:

    CDEdefUserFolder3
  9. Click Finish. Container Development Environment 3 [Stopped, Synchronized] appears in the Servers view. Container Development Environment 3 is the default server name when you add a CDK 3.x server.

    CDEsrvStoppedSyncd

Starting the Container Development Environment (CDE) and virtual OpenShift server

Starting the Container Development Environment (CDE) also starts the virtual OpenShift server. Stopping the CDE also stops the virtual OpenShift server.

  1. In the Servers view, select Container Development Environment 3 [stopped, Synchronized], and then click run exec on the Servers menu bar.

    Console view opens and displays the status of the startup process:

    CDEstartTerminal
    [Note]Note

    On initial startup, the CDE asks whether you accept the untrusted SSL certificate. Click Yes.

    When the startup process has finished, the Servers view displays:

    CDEsrvStartedSyncd
  2. Switch to the OpenShift Explorer view.

    The virtual OpenShift server instance, developer, is also running:

    OSEopenshift devAutostart

    https://192.168.99.100:8443 is an example of a URL for the OpenShift developer web console. Your installation displays the URL for your instance. For more details, see Accessing the OpenShift Web Console.

Creating a new OpenShift project

When you deploy your Fuse FIS project to OpenShift, it is published to the OpenShift project you create here.

  1. In the OpenShift Explorer view, right-click the developer entry, to open the context menu.
  2. Select New > Project to open the New OpenShift Project wizard.
  3. Set the new project’s properties this way:

    • In the Project Name field, enter the name for the project’s namespace on the virtual OpenShift server.

      Only lower case letters, numbers, and dashes are valid.

    • In the Display Name field, enter the name to display on the virtual OpenShift web console’s Overview page.
    • Leave the Description field as is.

      For example:

      New Project Name
  4. Click Finish.

    The new OpenShift project (in this example, New FIS Test newtest) appears in the OpenShift Explorer tab, under, in this example, developer https://192.168.99.100:8443:

    OSEnewFISprojCreated
    [Note]Note

    MyProject myproject is an initial example project included with OpenShift.

    With New FIS Test newtest selected in the OpenShift Explorer view, the Properties view displays the project’s details. For example:

    OSEnewFISprojProps
    [Note]Note

    When you deploy the project to OpenShift, the Properties view gathers and displays the same information about the project that the OpenShift web console does.

Creating a new Fuse FIS project

Before you create a new Fuse FIS project, you should enable staging repositories. This is needed because some Maven artifacts are not in default Maven repositories. To enable staging repositories, select Window > Preferences > Fuse Tooling > Staging Repositories.

To create a FIS project, use the Spring Boot on OpenShift template:

  1. In the Project Explorer view, right-click to open the context menu and then select New > Fuse Integration Project to open the wizard’s Choose a project name page:

    nfpProjectName1
  2. In the Project Name field, enter a name that is unique to the workspace you are using, for example, myFISproject.

    Accept the defaults for the other options.

  3. Click Next to open the Select a Target Runtime page:

    New Project Camel Version

    Leave the defaults for Target Runtime (No Runtime selected) and Camel Version (2.18.1.redhat-000015).

  4. Click Next to open the Advanced Project Setup page:

    Advanced Project Setup
  5. Click Use a predefined template, and then expand the Fuse on OpenShift option:

    Advanced Project Templates
  6. Select SpringBoot on OpenShift, and then click Finish.

    [Note]Note

    Because of the number of dependencies that are downloaded for a first-time Fuse FIS project, building it can take some time.

    If the Fuse Integration perspective is not already open, Developer Studio prompts you to indicate whether you want to open it now. Click Yes.

When the build is done the *Fuse Integration * perspective displays the project, for example:

FIS ProjCreatedFIP

At this point, you can:

Deploying the Fuse FIS project to OpenShift

  1. In the Project Explorer view, right-click the project’s root (in this example, myFISproject) to open the context menu.
  2. Select Run As > Run Configurations to open the Run Configurations wizard.
  3. In the sidebar menu, select Maven Build > Deploy <projectname > on OpenShift (in this example, Deploy myFISproject on OpenShift) to open the project’s default run configuration:

    FIS RunCnfgMain

    Leave the default settings as they are on the Main tab.

  4. Open the JRE tab to access the VM arguments:

    FIS RunCfgJRE
  5. In the VM arguments pane, change the value of the -Dkubernetes.namespace=test argument to match the Project name you used for the OpenShift project when you created it (OpenShift project name in Creating a new OpenShift project.

    In this example, change the default value test to newtest:

    FIS RunCfgVMargsChg

    Depending on your OpenShift configuration, you may need to modify other`VM arguments to support it:

    • -Dkubernetes.master=https://192.168.99.1:8443

      When running multiple OpenShift instances or using a remote instance, you need to specify the URL of the OpenShift instance targeted for the deployment. The URL above is an example.

    • -Dkubernetes.trust.certificates=true

      • When using the CDK, this argument is required. Leave it set to true.
      • If you are using an OpenShift instance that has a valid SSL certificate, change the value of this argument to false.
  6. Click Apply and then click Run.

    Because of the number of dependencies to download, first-time deployment can take some time. The speed of your computer and your internet connection are contributing factors. Typically, it takes 25 to 35 minutes to complete a first-time deployment.

    In the Console view, you can track the progress of the deploy process. In the following output, the entry *Pushing image 172.30.1 …​.. * indicates that the project built successfully and the application images are being pushed to OpenShift, where they will be used to build the Docker container.

    FIS ConLogSuccess1

    The Console view displays BUILD SUCCESS when deployment completes successfully:

    FIS ConLogSuccess2
  7. Switch to the OpenShift Explorer view and select New FIS Test newtest:

    OSE NewFISTestDeploy1

    In the Properties view, the Details page displays all of the project’s property values.

    OSEnewFISprojProps

    Open the other tabs (Builds, Build Configs, Deployments,…​) to view other properties of the project. The Properties view provides the same information as the OpenShift Web Console.

  8. In the OpenShift Explorer view, select camel-ose-springboot-xml to view its details in the Properties view:

    NFT camxmlPropsDetails

    Scroll through the other tabs to view other properties of the deployment configuration.

  9. In the OpenShift Explorer view, select camel-ose-springboot-xml-1-mdmtd Pod Running, and then view the details of the running instance in the Properties view:

    NFT ImageStreamPropsDetails
  10. In the OpenShift Explorer view, right-click camel-ose-springboot-xml-1-mdmtd Pod Running, and then select Pod Logs…​.

    [Note]Note

    If prompted, enter the path to the installed oc executable. It is required to retrieve pod logs.

    The Console view automatically opens, displaying the logs from the running pod:

    OSE podLogsDisplayed

    Click Close in the Console view’s menu bar to terminate the session and clear console output.

Accessing the OpenShift Web Console

[Note]Note

This information applies to Red Hat Container Development Kit installations only.

To access the OpenShift Web Console, open a browser and enter the OpenShift server’s URL, which is specific to your instance and your machine. For example, enter https://192.168.99.100:8443, in the browser’s address field.

You can log into the web console either as a developer or as an administrator, using the default credentials:

  • Default developer role

    Developer users can view only their own projects and the supplied OpenShift sample project, which demonstrates OpenShift v3 features. Developer users can create, edit and delete any project that they own that is deployed on OpenShift.

    • Username developer
    • Password developer
  • Default administrator role

    An administrator user can view and access all projects on OpenShift (CDK). Administrator users can create, edit and delete, any project deployed on OpenShift.

    • Username admin
    • Password admin

For more information on using the OpenShift web console, see Getting Started Guide: Container Development Kit.

Using the JBoss Fuse SAP Tool Suite

The JBoss Fuse SAP Tool Suite makes it possible to integrate your Camel routes with a remote SAP Application Server. A variety of SAP components are provided to support Remote Function Calls (RFC) and the sending and receiving of Intermediate Documents (IDocs). The SAP Tool Suite depends on the JCo and IDoc client libraries from SAP. To install and use these libraries, you must have an SAP Service Marketplace Account.

Installing the JBoss Fuse SAP Tool Suite

Overview

The JBoss Fuse SAP Tool Suite provides the Edit SAP Connection Configuration dialog, which helps you to create and manage the SAP Application Server and Destination connections. The suite is not installed by default, because it requires third-party JCo and IDoc client libraries, which are licensed separately by SAP.

Platform restrictions for SAP tooling

Because the SAP tool suite depends on the third-party JCo 3.0 and IDoc 3.0 libraries, it can only be installed on the platforms that these libraries support. For more details about the platform restrictions for SAP tooling, see Red Hat JBoss Fuse Supported Configurations.

Prerequisites

Before you can install the JBoss Fuse SAP Tool Suite, you must download the JCo and IDoc libraries from the following location:

To download these libraries, you must have an SAP Service Marketplace Account. Be sure to choose the appropriate JCo and IDoc libraries for your operationg system. Also:

  • Only version 3.0.11 or greater of the JCo library is supported.
  • Only version 3.0.10 or greater of the IDoc library is supported.

For this installation procedure, you can leave the downloaded files in archive format. There is no need to extract the contents.

Procedure

To install the JBoss Fuse SAP Tool Suite into JBoss Developer Studio, perform the following steps:

  1. In JBoss Developer Studio, select menu:[File > Import] to open the Import wizard.
  2. In the Select screen of the Import wizard, select menu:[JBoss Fuse > Install JBoss Fuse SAP Tool Suite], and click Next.
  3. The Install the JBoss Fuse SAP Tool Suite screen opens, which displays the instructions for downloading the JCo and IDoc libraries from the SAP Service Marketplace. Click Next.
  4. The Select JCo3 and IDoc3 Archive to Import screen opens. Next to the JCo Archive File field, use the Browse button to select the JCo archive that you downloaded from the SAP Service Marketplace. After selecting the JCo archive, the Archive Version and Archive OS Platform fields are automatically filled in, so that you can check whether the library you are installing has the correct version and OS platform.

    Next to the IDoc3 Archive File field, use the Browse button to select the IDoc archive that you downloaded from the SAP Service Marketplace.

    After selecting both archive files, click Finish.

  5. A new Install wizard (for installing Eclipse plug-ins) opens automatically. This wizard displays the following to plug-ins to be installed:

    • JBoss Fuse SAP Tool Suite
    • SAP JCo3 and IDoc3 Libraries

      Make sure that both of these plug-ins are selected. Click Next.

      [Note]Note

      The SAP JCo3 and IDoc3 Libraries plug-in is dynamically constructed from the selected JCo and IDoc libraries.

  6. The Install Details screen allows you to review the plug-ins to be installed. Click Next.
  7. The Review Licenses dialog opens. Select the I accept radiobutton option, and then click Finish.
  8. If you encounter a Security Warning dialog (warning of unsigned content), click OK to ignore the warning and continue installing.
  9. The Restart Eclipse dialog opens. Click OK to restart Eclipse.

Create and Test SAP Destination Connection

Overview

In JBoss Fuse SAP Tool suite, the Edit SAP Connection Configuration dialog helps you to create and manage the SAP Application Destination connections. This section describes how to create and test the SAP destination connection.

Procedure

To create and test an SAP destination connection, perform the following steps:

  1. Navigate to the global Configurations tab of the route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the type of connection you would like to create. Choose the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. To create a new Destination Data Store, click the Add Destination tab.

    The Create Destination dialog appears.

  4. Enter a name for the destination in the Destination Name field and click Ok.
  5. In the Properties dialog,

    1. Click the Basic tab to configure the basic properties required to connect to an SAP destination. In this tab, fill in the following property fields to configure the connection:

      • SAP Application Server
      • SAP System Number
      • SAP Client
      • Logon User
      • Logon Password
      • Logon Language
    2. Click the Connection tab to add values required to connect to an SAP destination. Fill in the following property fields to configure the connection:

      • SAP System Number
      • SAP Router String
      • SAP Application Server
      • SAP Message Server
      • SAP Message Server Port
      • Gateway Host
      • Gateway Port
      • SAP System ID
      • SAP Application Server Group
    3. Click the Authenticate tab to add values required to validate an SAP destination. Fill in the following property fields to configure the connection.

      • SAP Authentication type
      • SAP Client
      • Logon User
      • Logon User Alias
      • Logon Password
      • SAP SSO Logon Ticket
      • SAP X509 Login Ticket
      • Logon Language
    4. Click the Special tab. In this tab, fill in the following property fields to configure the connection:

      • Select CPIC Trace
      • Initial Codepage
    5. Click the Pool tab and fill in the following property fields to configure the connection:

      • Connection Pool Peak Limit
      • Connection Pool Capacity
      • Connection Pool Expiration Time
      • Connection Pool Expire Check Period
      • Connection Pool Max Get Client Time
    6. Click the SNC tab and fill in the following property fields to configure the connection:

      • SNC Partner Name
      • SNC Level of Security
      • SNC Name
      • SNC Library Path
    7. Click the Repository tab and fill in the following property fields to configure the connection:

      • Repository Destination
      • Repository Logon User
      • Repository Logon Password

        [Note]Note

        If you need more information about these settings, refer the SAP documentation.

  6. You are now ready to test the destination connection. In the Edit SAP Connection Configuration dialog, right-click on the destination name and select Test.

    The Test Destination Connection dialog opens.

  7. The dialog uses the current destination configuration settings to connect to the SAP Destination Data Store. If the test is successful, you will see the following message in the status area:

    Connection test for destination 'YourDestination' succeeded.

    Otherwise, an error report appears in the status area.

  8. Click Close to close the Test Destination Connection dialog.
  9. Click Finish. The newly created SAP Destination Connection appears under SAP.

Create and Test SAP Server Connection

Overview

In JBoss Fuse SAP Tool suite, the Edit SAP Connection Configuration dialog helps you to create and manage the SAP Application Server connections. This section describes how to create and test the SAP Server connection.

Procedure

To create and test the SAP Server connection, perform the following steps:

  1. Navigate to the global Configurations tab of route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the type of connection you would like to create. Choose the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. To create a new Server Data Store, click the Add Server tab.

    The Create Server dialog appears.

  4. Enter a name for the Server in the Server Name field and click Ok.
  5. In the Properties dialog,

    1. Click the Mandatory tab to configure the basic properties required to connect to an SAP server. In this tab, fill in the following property fields to configure the connection:

      • Gateway Host
      • Gateway Port
      • Program ID
      • Repository Destination
      • Connection Count
    2. Click the Optional tab and fill in the following property fields to configure the connection:

      • SAP Router String
      • Worker Thread Count
      • Minimum Worker Thread Count
      • Maximum Startup Delay
      • Repository Map
    3. Click the SNC tab and fill in the following property fields to configure the connection.

      • SNC Level of Security
      • SNC Name
      • SNC Library Path

        [Note]Note

        For more information about the settings, refer the SAP documentation.

  6. You are now ready to test the server connection. In the Edit SAP Connection Configuration dialog, right-click on the server name and select Test.

    The Test Server Connection dialog opens.

  7. The dialog uses the current server configuration settings to connect to the SAP Server Data Store. If the test is successful, you will see the following message in the status area:

    Server state: STARTED
    Server state: ALIVE

    If the test fails, the server status is reported as DEAD.

  8. Click Stop to shut down the Test Sever.
  9. Click Close to close the Test Server Connection dialog.
  10. Click Finish. The newly created SAP Server Connection appears under SAP.

Deleting Destination and Server Connections

Overview

This following section describes how to delete the SAP Destination and Server connections in the Edit SAP Connection Configuration dialog.

Procedure

If you want to delete the Destination and Server connections, perform the following steps:

  1. Navigate to the global Configurations tab of route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. In the Edit SAP Connection Configuration dialog, select the Destination and Server Data Stores which you want to delete.
  4. Click Delete. It will delete the selected connections.

    Atlast, click Finish. It will save all the changes.

Create a New SAP Endpoint

Overview

You can use the Components palette in the route editor to add SAP components to a route with the help of the Edit SAP Connection Configuration dialog.

[Note]Note

If you are using the SAP Connection view, remember to paste the requisite SAP connection configuration data into your Blueprint XML or Spring XML code.

Prerequisites

You must already have created some SAP destination connections and/or server connections with the help of the Edit SAP Connection Configuration dialog.

[Note]Note

If you are using the SAP Connection view, export this configuration to a file of the appropriate type (Blueprint XML or Spring XML).

Procedure

To create a new SAP endpoint, perform the following steps:

  1. It is assumed that you already have a Fuse project and a Camel XML file to work with (which could either be in Blueprint XML or Spring XML format).
  2. Open your Camel XML file in the route editor. If you have already installed the JBoss Fuse SAP Tool Suite, you should be able to see the SAP components under the Components palette in the route editor. The following SAP components are provided by the tool suite:

    • SAP IDoc Destination
    • SAP IDoc List Destination
    • SAP IDoc List Server
    • SAP qRFC Destination
    • SAP Queued IDoc Destination
    • SAP Queued IDoc List Destination
    • SAP sRFC Destination
    • SAP sRFC Server
    • SAP tRFC Destination
    • SAP tRFC Server

      In the Design tab of the route editor, drag one of these components onto the canvas to create a new SAP endpoint in the current camelContext.

      [Note]Note

      The SAP Netweaver component does not belong to the JBoss Fuse SAP Tool Suite. It is hosted in the Apache Camel project.

  3. Switch to the Source tab of the route editor, by clicking the Source tab at the bottom of the canvas. You can see the XML source of the routes.
  4. When specifying an SAP endpoint URI, you must embed either a destination name or a server connection name in the URI format. For example, the sap-srfc-destination component has the following URI format:

    sap-srfc-destination:destinationName:rfcName

    To reference a particular destination, use the value of the relevant entry element’s key attribute as the destinationName in this URI.

Getting Started with Data Transformation

Fuse Transformation Tooling

One of the challenges that comes with system and data integration is that the component systems often work with different data formats. You cannot simply send messages from one system to another without translating it into a format (or language) recognized by the receiving system. Data transformation is the term given to this translation.

Data Transformation Tutorial

In this tutorial you will learn how to use the data transformation tooling to include data transformation in a predefined Camel route. The Camel route directs messages from a source endpoint that produces XML data to a target endpoint that consumes JSON data. You will add and define a data transformation component that maps the source’s XML data format to the target’s JSON data format.

Prerequisites

Importing the starter quickstart application

  1. Right-click in the Project Explorer view to open the context menu.
  2. Select menu:[Import > Import].
  3. Expand the Maven folder, and select Existing Maven Projects.
  4. Click Next to open the Maven Projects wizard.

    Description
  5. Click Browse to find and select the root directory of the starter quickstart application.

    If the browse operation finds multiple projects, make sure you select the starter quickstart application. The full path to the starter quickstart application appears in the Projects pane.

  6. Click Finish.

    After the import operation finishes, the starter project appears in the Project Explorer view.

  7. In the Project Explorer view, expand the starter project.
  8. Double-click starter/src/main/resources/META-INF/spring/camel-context.xml to open the route in the route editor’s Design tab.

    Description
  9. Click the Source tab to view the underlying XML.

    You can see that an XML file is produced from a source endpoint and a JSON file is consumed by a target endpoint.

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:camel="http://camel.apache.org/schema/spring"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd        http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">
    
        <camelContext id="camelContext-272d04f8-e498-466d-b34b-3c24d01a4e10" xmlns="http://camel.apache.org/schema/spring"
            <route id="_route1">
                <from id="_from1" uri="file:src/data?fileName=abc-order.xml&noop=true"/>
                <to id="_to1" uri="file:target/messages?fileName=xyz-order.json"/>
            </route>
        </camelContext>
    </beans>
  10. Click the Design tab to return to the graphical display of the route.
  11. Remove the arrow that connects the source and target endpoints.
  12. If the Console view is not already open, open it now by selecting Window > Show View > Console.
[Note]Note

Although the following mini tutorials are written to be run in consecutive order, you can run them in any order. If you change the order then the console output for a tutorial will differ from that shown here.

Adding a data transformation node to the Camel route

  1. In the Palette, expand the Transformation drawer.
  2. Drag a Data Transformation pattern over the canvas and drop it on the Route_route1 container.

    The New Transformation wizard opens with the Project, Dozer File Path, and Camel File Path fields auto filled.

    Description
  3. Fill in the remaining fields:

    • In the Transformation ID field, enter xml2json.
    • For Source Type, select XML from the drop-down menu.
    • For Target Type, select JSON from the drop-down menu.
  4. Click Next.

    The Source Type (XML) definition page opens, where you specify either an XML Schema (default) or an example XML Instance Document to provide the type definition of the source data:

    Description
  5. Leave XML Schema enabled.
  6. For Source file, browse to the location of the XML schema file or the XML instance file to use for the type definition of the source data, and select it (in this case, abc-order.xsd).

    The XML Structure Preview pane displays a preview of the XML structure.

  7. In the Element root field, enter ABCOrder.

    The tooling uses this text to label the pane that displays the source data items to map.

    The Source Type (XML) definition page should now look like this:

    Description
  8. Click Next to open the Target Type (JSON) definition page. This is where you specify the type definition for the target data.

    Description
  9. Click JSON Instance Document.

    In the Target File field, enter the path to the xyz-order.json instance document, or browse to it. The JSON Structure Preview pane displays a preview of the JSON data structure:

    Description
  10. Click Finish.

The transformation editor opens. This is where you can map data items in your XML source to data items in your JSON target.

Description

The transformation editor is composed of three panels:

  • Source — lists the available data items of the source
  • Mappings — displays the mappings between the source and target data items
  • Target — lists the available data items of the target

In addition, the editor’s details pane, located just below the editor’s three panels (once the first mapping has been made), graphically displays the hierarchical ancestors for both the mapped source and target data items currently selected. For example:

Details pane with source property customerNum mapped to target property role="italic">custId

Using the details pane, you can customize the mapping for the selected source and target data items:

Mapping source data items to target data items

  1. Expand all items in the Source and Target panels located on left and right sides of the Mappings panel.

    Description
  2. Drag a data item from the Source panel and drop it on its corresponding data item in the Target panel.

    For example, drag the customerNum data item from the Source panel and drop it on the custId data item in the Target panel.

    Description

    The mapping appears in the Mappings panel, and the details of both the Source and Target data items appear below in the details pane.

  3. Continue dragging and dropping source data items onto their corresponding target data items until you have completed all basic mappings.

    In the starter example, the remaining data items to map are:

    SourceTarget +

    orderNum

    orderId

    +

    status

    priority

    +

    id

    itemId

    +

    price

    cost

    +

    quantity

    amount

    +

    [Note]Note

    You can map collections (data items containing lists or sets) to noncollection data items and vice versa, but you cannot map collections to other collections.

  4. Click Hide mapped fields icon on both the Source and Target panels to quickly determine whether all data items have been mapped.

    Description

    Only data items that have not been mapped are listed in the Source and Target panels.

    In the starter example, the remaining unmapped Target attributes are approvalCode and origin.

  5. Click the camel-context.xml tab to return to the graphical display of the route.
  6. Hover your cursor over each endpoint to reveal its connecter arrow.

    Description
  7. Selecting the file:src/data?fil…​ node, drag and drop its connector arrow onto the ref:xml2json node. Likewise drag and drop the connector arrow from the ref:xml2json node onto the file:target/messa…​ node.

    Description

    Connecting the nodes on the canvas creates a valid Camel route, which you can now save.

  8. Click File > Save.

You can run a JUnit test on your transformation file after you create the transformation test. For details, see Creating the transformation test file and running the JUnit test. If you do so at this point, you will see this output in the Console view:

<?xml version="1.0" encoding="UTF-8"?>
<ABCOrder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:java="http://java.sun.com">
    <header>
        <status>GOLD</status>
        <customer-num>ACME-123</customer-num>
        <order-num>ORDER1</order-num>
    </header>
    <order-items>
        <item id="PICKLE">
            <price>2.25</price>
            <quantity>1000</quantity>
        </item>
        <item id="BANANA">
            <price>1.25</price>
            <quantity>400</quantity>
        </item>
    </order-items>
</ABCOrder>

for the source XML data, and

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","lineItems":[{"itemId":"PICKLE",
"amount":1000,"cost":2.25},{"itemId":"BANANA","amount":400,"cost":1.25

for the target JSON data.

Creating the transformation test file and running the JUnit test

  1. Right-click the starter project in the Project Explorer view, and select menu:[New > Other > Fuse Tooling > Fuse Transformation Test].
  2. Select Next to open the New Transformation Test wizard.
  3. In the New Transformation Test wizard, set the following values:

    FieldValue +

    Package

    example

    +

    Transformation ID

    xml2json

    +

  4. Click Finish.
  5. In the Project Explorer view, navigate to starter/src/test/java/example, and open the TransformationTest.java file.
  6. Add the following code to the transform method:

    startEndpoint.sendBodyAndHeader(readFile("src/data/abc-order.xml"), "approvalID", "AUTO_OK");
  7. Click File > Save.

    You can now run a JUnit test on your transformation file at any point in these tutorials.

  8. In the Project Explorer view, expand the starter project to expose the /src/test/java/example/TransformationTest.java file.
  9. Right click it to open the context menu, and select Run as JUnit Test.

    The JUnit Test pane opens to display the status of the test. To avoid cluttering your workspace, drag and drop the pane in the bottom panel near the Console view.

    Description
  10. Open the Console view to see the log output.

Mapping a constant variable to a data item

When a source/target data item has no corresponding target/source data item, you can map a constant variable to the existing data item.

In the starter example, the target data item origin does not have a corresponding source data item. To map the origin attribute to a constant variable:

  1. In the Source panel, click the Variables view.

    Description
  2. In the Variables view, click Add a new variable icon to open the Enter a new variable name dialog.

    Description
  3. Enter a name for the variable you want to create.

    For the starter example, enter ORIGIN.

  4. Click OK.

    The newly created variable ORIGIN appears in the Variables view in the Name column and the default value ORIGIN in the Value column.

  5. Click the default value to edit it, and change the value to Web.
  6. Press Enter.
  7. Drag and drop the new variable ORIGIN onto the origin data item in the Target panel.

    Description

    The new mapping of the variable $(ORIGIN) appears in the Mappings panel and in the details pane.

  8. Run a JUnit test on your TransformationTest.java file. For details, see Creating the transformation test file and running the JUnit test.

    The Console view displays the JSON-formatted output data:

    {"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
    "approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
    {"itemId":"BANANA","amount":400,"cost":1.25}]}

Mapping an expression to a data item

This feature enables you, for example, to map a target data item to the dynamic evaluation of a Camel language expression.

Use the target approvalCode data item, which lacks a corresponding source data item:

  1. Click Add a new mapping icon to add an empty transformation map to the Mappings panel.

    Description
  2. From the Target panel, drag and drop the approvalCode data item to the target field of the newly created mapping in the Mappings panel.

    Description

    The approvalCode data item also appears in the details pane’s target box.

  3. In the details pane, click drop-down menu access on the ABCOrder source box to open the drop-down menu.

    Description

    Menu options depend on the selected data item’s data type. The available options are bolded.

  4. Select Set expression to open the Expression dialog.

    Description
  5. In Language, select the expression language to use from the list of those available. Available options depend on the data item’s data type.

    For the starter example, select Header.

  6. In the details pane, select the source of the expression to use.

    The options are Value and Script.

    For the starter example, click Value, and then enter ApprovalID.

  7. Click OK.

    Description

    Both the Mappings panel and the details pane display the new mapping for the target data item approvalCode.

  8. Run a JUnit test on your TransformationTest.java file. For details, see Creating the transformation test file and running the JUnit test.

    The Console view displays the JSON-formatted output data:

    {"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
    "approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
    {"itemId":"BANANA","amount":400,"cost":1.25}]}

Adding a custom transformation to a mapped data item

You may need to modify the formatting of source data items when they do not satisfy the requirements of the target system.

For example, to satisfy the target system’s requirement that all customer IDs be enclosed in brackets:

  1. In the Mappings panel, select the customerNum mapping to populate the details pane.

    Description
  2. In the details pane, click drop-down menu access on the ABCOrder source box to open the drop-down menu.

    Description
  3. Select Add custom transformation to open the Add Custom Transformation page.

    Description
  4. Click create new function button next to the Class field to open the Create a New Java Class wizard.

    Description
  5. Modify the following fields:

    • Package — Enter example.
    • Name — Enter MyCustomMapper.
    • Method Name — Change map to brackets.

      Leave all other fields as is.

  6. Click Finish.

    The Add Custom Transformation page opens with the Class and Method fields auto filled:

    Description
  7. Click OK to open the MyCustomMapper.java file in the Java editor:

    Description
  8. Edit the brackets method to change the last line return null; to this:

    return "[" + input + "]";
  9. Click the transformation.xml tab to switch back to the transformation editor.

    Description

    The details pane shows that the brackets method has been associated with the customerNum data item.

    The brackets method is executed on the source input before it is sent to the target system.

  10. Run a JUnit test on your TransformationTest.java file. For details, see Creating the transformation test file and running the JUnit test.

    The Console view displays the JSON-formatted output data:

    {"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
    "approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
    {"itemId":"BANANA","amount":400,"cost":1.25}]}

Mapping a simple data item to a data item in a collection

In this tutorial, you will modify an existing mapping that maps all ids in the Source to the itemIds in the Target. The new mapping will map the customerNum data item in the Source to the itemId of the second item in the lineItems collection in the Target.

With this change, no ids in the Source will be mapped to itemIds in the Target.

  1. In the Mappings panel, select the mapping id  — > itemId to display the mapping in the details pane.

    Description
  2. On the Source box, click drop-down menu access to open the drop-down menu, and select Set property.

    Description
  3. In the Select a property page, expand the header node and select customerNum. Click OK to save the changes.

    select a property
  4. The details pane now shows that XyzOrder has a lineItems field. Click the toggle button next to lineItems to increase its value to 1.

    [Note]Note

    Indexes are zero-based, so a value of 1 selects the second instance of itemId in the collection.

    Description

    Notice that the details pane shows customerNum mapped to the itemId of the second item in the lineItems collection.

  5. Run a JUnit test on your TransformationTest.java file. For details, see Creating the transformation test file and running the JUnit test.

    The Console view displays the JSON-formatted output data:

    {"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
    "approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},
    {"itemId":"ACME-123","amount":400,"cost":1.25}]}

Adding a built-in function to a mapped data item

You can use the built-in string-related functions to apply transformations to mapped data items.

  1. In the Transformations panel, select the status to priority mapping to populate the details pane.

    Description
  2. In the Source box, click drop-down menu access to open the drop-down menu, and select Add transformation.

    Description
  3. In the Transformations pane, select append, and in the Arguments pane, enter -level for the value of suffix.

    This append function adds the specified suffix to the end of the status string before mapping it to the target priority data item.

    Description
  4. Click OK.

    Description

    By default, the details pane displays the results of adding the append function to the status data item in a user-friendly format. You can change this formatting by clicking the right-most drop-down menu access on the Source box, and selecting Show standard formatting.

    Description
  5. Run a JUnit test on your TransformationTest.java file. For details, see Creating the transformation test file and running the JUnit test.

    The Console view displays the JSON-formatted output data:

    {"custId":"[ACME-123]","priority":"GOLD-level","orderId":"ORDER1","origin":"Web",
    "approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},{"itemId":"ACME-123",
    "amount":400,"cost":1.25}]}

Publishing a Fuse Integration project with data transformation to a Red Hat JBoss Fuse

server

Before you publish your data transformation project to a JBoss Fuse server (see Publishing Fuse Integration Projects to a Server), you need to install the following features in the JBoss Fuse runtime:

  • camel-dozer
  • camel-jackson
  • camel-jaxb

To install the required features on the JBoss Fuse runtime:

  1. If not already there, switch to the Fuse Integration perspective.
  2. If necessary, add the JBoss Fuse server to the Servers list (see Adding a Server).
  3. Start the JBoss Fuse Server (see Starting a Server), and wait for the JBoss Fuse shell to appear in the Terminal view:

    UGservrStrtShellV
  4. For each of the required camel- features, at the JBossFuse:admin@root> prompt type:

    features:install camel-<featureName>

    Where featureName is one of dozer, jackson, or jaxb.

  5. To verify that each of the features was successfully installed, at the JBossFuse:admin@root> prompt type:

    features:list --ordered --installed

    You should see the camel features you just installed in the output listing:

    DTCamFeatsInstalled

Developing extensions for Ignite integrations

Ignite is a Red Hat JBoss Fuse feature that provides a web interface for integrating applications. Without writing code, a business expert can use Ignite to connect to applications and optionally operate on data between connections to different applications. In Ignite, a data operation is referred to as a step in an integration.

Ignite provides steps for operations such as filtering and mapping data. To operate on data in ways that are not provided by Ignite built-in steps, you can develop an Ignite extension to define one or more custom steps.

Here is an overview of the tasks for developing an Ignite extension:

  1. In Red Hat JBoss Developer Studio, create an Ignite extension project.
  2. Add routes, define actions, and specify any dependencies.
  3. Build a .jar file.
  4. Provide the .jar file to the Ignite user.

The Ignite user uploads the .jar file to Ignite and can then add the custom step(s) defined in the extension to an integration. For information about Ignite and how to build integrations, see Integrating Applications with Ignite.

Prerequisites

Before you begin, you need the following information and knowledge:

  • A description of the required functionality for the Ignite custom step (from the Ignite user).
  • The version of each of the following components for the extension:

    • Spring Boot
    • Camel
    • Ignite
  • You should be familiar with :

    • Spring Boot XML or Java
    • Apache Camel routes
    • Ignite

Creating an Ignite Extension project

To use the Fuse tooling to create an extension project, follow these steps.

  1. In Red Hat JBoss Developer Studio, select File > New > Project > JBoss Fuse > Fuse Ignite Extension Project.

    The New Fuse Ignite Extension Project wizard opens.

  2. Enter the name for the project, then click Next.
  3. Specify the versions of the extension dependencies:

    • Spring Boot Version
    • Camel Version
    • Fuse Ignite Version
  4. (Optional) Click Verify to confirm that the specified Camel version is available to the project.
  5. Click Next.
  6. Specify the following extension details:

    • Extension id - A value that you define and that is unique in the Ignite environment. This value will be visible in Ignite when the user imports the extension .jar file.
    • Version - The version of the extension. For example, if this is the initial version, you could enter 1.0. If you are updating a version, you could enter 1.1 or 2.0.
    • Name - The name of the extension. This value will be visible in Ignite as the extension’s name. In Ignite, on the Extensions tab, the user can see a list of the names and descriptions of extensions that have been uploaded to Ignite.
    • Description - An optional description of the custom steps that the extension defines.
    • Tags - An optional comma-separated list of values. Note that these tags are ignored in this release. They are reserved for future use.
  7. Click Finish.

The new project appears in the Red Hat JBoss Developer Studio Project Explorer view. It includes the following files:

  • A descriptor file: META-INF/syndesis/syndesis-extension-definition.json

    This is the file that you edit to add actions and their properties. An action in the .json file becomes a custom step in Ignite. A property becomes an action parameter in Ignite.

  • A Camel context file: extension.xml

    This file contains a sample route with a log component. You customize the Camel routes in this file.

  • A Maven Project Object Model file: pom.xml

    This file contains information about the project and configuration details used by Maven to build the project, including default extension dependencies. You edit this file to add custom dependencies or to edit the Extension Id, Name, Version, Tags, or Description values.

Developing the steps for the Ignite extension

To write the code that implements a custom step for Ignite:

  1. In the extension.xml file, create routes that address the purpose of the extension. The entrypoint of each route must match the entrypoint that you define in the syndesis-extension-definition.json file, as described in Step 2.
  2. In the syndesis-extension-definition.json file, write the code that defines the actions and their properties. You need a new action for each entrypoint. Each property corresponds to an action parameter. In Ignite, when the user selects a custom step, Ignite prompts for values for action properties. For example, a custom log step might have a level property that indicates how much information to sent to the log.

    Each action that you create corresponds to a custom step in Ignite. You can use different types of code for each action. That is, you can use XML for one action and Spring Boot routes and beans for another action.

    Here is the template for the .json file that contains the extension metadata, including properties that will be filled in by the user in Ignite after uploading the extension and adding its custom step to an integration:

    {
      "actions": [
        {
          "actionType": "extension",
          "id": "${actionId}",
          "name": "Action Name",
          "description": "Action Description",
          "tags": [
               "xml"
          ],
          "descriptor": {
            "kind": "ENDPOINT|BEAN|STEP",
            "entrypoint": "direct:${actionId}",
            "inputDataShape": {
              "kind": "any"
            },
            "outputDataShape": {
              "kind": "any"
            },
            "propertyDefinitionSteps": []
          }
        }
      ],
      "tags": [
        "feature",
        "experimental"
      ]
    }

    Note: The tags are ignored in this release. They are reserved for future use.

  3. To edit the extension dependencies, open the pom.xml file in the editor. If you add a dependency, you must define its scope. The scope for any dependency that Red Hat ships is provided, for example:

    <dependency>
          <groupId>io.syndesis.integration-runtime</groupId>
          <artifactId>runtime-api</artifactId>
          <version>${syndesis.version}</version>
          <scope>provided</scope>
    </dependency>
        <dependency>
          <groupId>org.apache.camel</groupId>
          <artifactId>camel-core</artifactId>
          <scope>provided</scope>
    </dependency>
    <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
          <scope>provided</scope>
    </dependency>

    Note: You can optionally edit the Extension Id, Name, Version, Tags, or Description values.

Building the Ignite extension JAR file

To build the .jar file for the extension:

  1. In the Project Explorer view, right-click the project.
  2. From the popup menu, select Run As > Maven clean verify.
  3. In the Console view, you can monitor the progress of the build.
  4. When the build is complete, refresh the target folder in the Project Explorer view (select and press F5).
  5. In the Project Explorer view, open the target folder to see the generated .jar file:

    The name of the .jar file follows Maven defaults: ${artifactId}-$6.3.jar

    For example: ignite-extension-1.0.0-SNAPSHOT

    This .jar file defines the extension steps, its required dependencies, and its metadata: Extension Id, Name, Version, Tags, and Description. For example:

    {
      "name" : "Syndesis Extension (XML)",
      "description" : "A simple Syndesis Extension (XML)",
      "extensionId" : "com.mycompany:syndesis-extension-example-xml",
      "version" : "1.0.0-SNAPSHOT",
      "tags" : [ "experimental", "feature" ],
      "actions" : [ {
        "id" : "log-body",
        "name" : "simple-log-body",
        "description" : "A simple xml based logging extension",
        "descriptor" : {
          "kind" : "ENDPOINT",
          "entrypoint" : "direct:log-body",
          "inputDataShape" : {
            "kind" : "any"
          },
          "outputDataShape" : {
            "kind" : "any"
          },
          "propertyDefinitionSteps" : [ ]
        },
        "tags" : [ "xml" ],
        "actionType" : "extension"
      } ],
      "dependencies" : [ {
        "type" : "MAVEN",
        "id" : "io.syndesis.integration-runtime:runtime-api:jar:1.2.1"
      }, {
        "type" : "MAVEN",
        "id" : "org.apache.camel:camel-core:jar:2.20.1"
      }, {
        "type" : "MAVEN",
        "id" : "org.springframework.boot:spring-boot-starter:jar:1.5.8.RELEASE"
      } ],
      "properties" : { }
    }

Next steps

Provide the following to the Ignite user:

  • The .jar file
  • A document that describes the extension, including information about data shapes that each action in the extension requires as input or provides as output (for data mapping)

In Ignite, the user uploads the .jar file as described in Integrating Applications with Ignite.

Changing the Camel version

As you work with a Fuse tooling project, you might want to change the Camel version that it uses. This can be helpful, for example, if you want to use a feature supported in a more recent Camel version or if you want to use a community version.

To change the Camel version that a project uses:

  1. In Project Explorer, right-click the project for which you want to change the Camel version and select Configure > Change Camel Version.
  2. In the Change Camel Version window, to the right of the Camel Version field, click the down caret to display available Camel versions.

    To use a community version of Apache Camel, you enter its version number, for example, 2.19.2.

  3. Select or enter the version you want and click Finish.

Fuse Tooling checks whether the version you selected is available and supported by Fuse Tooling. If it is then Fuse Tooling changes the Camel version and saves the project’s updated pom.xml file. You receive an error message if the Camel version you select is not available or not supported.

You can check the project’s Camel version in its pom.xml file, in the <camel.version> element.