Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 21.1a
Div
Classe2e-refDiv

Otp
Floatingfalse

Rp

The following sections are ordered according the steps needed to create a component diagram and describe each creation step in detail.

  1. Assigning the Diagram Name
  2. Defining the Composite
  3. Defining the Frontend Service
  4. Defining the SOAP Service Interface
  5. Defining Backend Aliases
  6. Finishing the Components Wizard

Assigning the Diagram Name

After starting the Components Wizard, the first dialog opens and you are prompted to enter the name of the component diagram.

You may use the suggested default name or enter a descriptive name. Changing the name will change the name of the top most tree node (marked in blue) in the navigation panel.

Click Next to proceed or Cancel to abort.

The Components Wizard can be canceled any time.

After clicking cancel, the Components Wizard prompts for confirmation.

Defining the Composite

In the next step, you will define the service composite. The service composite represents the repository of the Web service and will contain all necessary configuration information.

Clicking Next after assigning the diagram name will bring you directly to the following dialog. Create the service composite here.

Assign a name to the composite. In the field Control Port, enter an unused port number (the value needs to be between 20'000 and 29'999).

Note
iconfalse

Special characters and blanks are not allowed for composite names.

In case the Cancel button was accidentally pressed, the Create new Composite window can be re-opened by clicking the New button.

The Create New Composite dialog contains four more tabs.

On the Advanced tab of this dialog you can

  • configure the compiler as to create a WSDL per service
  • define the WSDL namespace
  • assign a category to the xUML service
  • select whether you want the compiler to resolve class inheritances when generating the WSDL file
    Bridge 7 Using this option is deprecated.
  • Bridge 7 specify a service version
    This service version will be visible in service context on the Bridge.
  • select the SOAP version of the service
  • specify a startup shutdown trace port

For more information on these tagged values refer to Frontend Components .

Specify the test settings here.

  • generateTestService
    Multiexcerpt include
    MultiExcerptNamegenerateTestService
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Service Name:
    Multiexcerpt include
    MultiExcerptNametestServiceName
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Port:
    Multiexcerpt include
    MultiExcerptNametestPort
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Encoding:
    Multiexcerpt include
    MultiExcerptNametestEncoding
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Proxy Host:
    Multiexcerpt include
    MultiExcerptNametestProxyHost
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Proxy Port:
    Multiexcerpt include
    MultiExcerptNametestProxyPort
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Proxy Protocol:
    Multiexcerpt include
    MultiExcerptNametestProxyProtocol
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • Test Proxy Path:
    Multiexcerpt include
    MultiExcerptNametestProxyPath
    nopaneltrue
    PageWithExcerptUsing Testable Classes
  • External Test Proxy Host:
    Multiexcerpt include
    MultiExcerptNameexternalTestProxyHost
    nopaneltrue
    PageWithExcerptUsing Testable Classes

For more information on testing in general refer to QA Concepts.

Using Persistent State features in the xUML service, you can make corresponding adjustments on the Persistent State tab configuring the persistent state engine.

  • Multiexcerpt include
    MultiExcerptNameworkers
    nopaneltrue
    PageWithExcerptPersistent State Components
  • Multiexcerpt include
    MultiExcerptNamestorageMedium
    nopaneltrue
    PageWithExcerptPersistent State Components
  • Multiexcerpt include
    MultiExcerptNameexternalStateDBAlias
    nopaneltrue
    PageWithExcerptPersistent State Components
  • Owner specifies the owner of the persistent state objects. Default owner (used when no divergent owner is specified) is the xUML service name, which is unique on each node instance.
  • Multiexcerpt include
    MultiExcerptNameswitchOverEnabled
    nopaneltrue
    PageWithExcerptPersistent State Components
  • Multiexcerpt include
    MultiExcerptNameswitchOverRetryTimeout
    nopaneltrue
    PageWithExcerptPersistent State Components

For more information Persistent State Components.

Using Java services in the xUML service, you can specify the JVM options here.

  • JVM Options:
    Multiexcerpt include
    MultiExcerptNamejvmOptions
    nopaneltrue
    PageWithExcerptModeling the Java Components
  • killJVMThreadsOnShutdown:
    Multiexcerpt include
    MultiExcerptNamekillJVMThreadsOnShutdown
    nopaneltrue
    PageWithExcerptModeling the Java Components
  • Parallel JVM Operations:
    Multiexcerpt include
    MultiExcerptNameparallelJVMOperations
    nopaneltrue
    PageWithExcerptModeling the Java Components

For more information on Java Components refer to Modeling the Java Components.

Click OK to proceed.

Up to this point, you have defined the xUML service component EducationLesson3.

In the customization panel, you will find the new xUML service component (e.g. EducationLesson3) in the list of added composites on the right side.

Info
iconfalse

The left side of the customization panel contains available components, classes, or interfaces. The right side always contains the used components.

Click Next to proceed.

Defining the Frontend Service

In the next step, you define the frontend service that will be part of the xUML service.

Clicking Next after having defined the composite will bring you directly to the following dialog. Add a frontend service here.

Select a service type from the list.

In other cases, e.g. if you want to add additional services, you can open the above dialog by clicking New on Services level of the tree.

All possible frontend service stereotypes are listed:

  • E2EEventObserverService
  • E2EHTTPService
  • E2EJavaService
  • E2ESAPRFCService
  • E2ESchedulerService
  • E2ESOAPService
  • E2ETimerService
  • several ActiveMQ versions
  • GlassFishMQ-4.4
  • Weblogic-10.3
  • WebshpereMQ-6-NoJNDI
  • WebshpereMQ-7
  • XSLTProcessor
  • ApacheFOP
  • Saxon6 and 8
  • Xalan2
  • XalanTrax2
  • UIRepository

This example shows how to define a Web service. Select the service stereotype E2ESOAPService.

Proceed with OK.

Now, customize the service artifact.

  • Assign a Name.
  • Assign a Port, to which the SOAP service is listening (the value needs to be between 10'000 and 19'999).
  • Select an encoding. See Encoding of SOAP Operations for more information on SOAP encoding and the E2E Bridge.
  • Timezone:
    Multiexcerpt include
    MultiExcerptNametimezone
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • Date Format String:
    Multiexcerpt include
    MultiExcerptNamedateFormatString
    nopaneltrue
    PageWithExcerptSOAP Service Reference

The Create New SOAP Service dialog contains two more tabs.

On the Advanced tab, you can specify the following settings:

  • Wsdl Namespace:
    Multiexcerpt include
    MultiExcerptNamewsdlNamespace
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • Authentication Mode:
    Multiexcerpt include
    MultiExcerptNameauthenticationMode
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • User: Specifies user and password for the use of HTTP Basic authentication.

For detailed information on these tagged values refer to SOAP Service Reference.

Anchor
proxy_tab
proxy_tab

On the Proxy tab, you can specify the proxy details.

  • Proxy Host:
    Multiexcerpt include
    MultiExcerptNameproxyHost
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • Proxy Path:
    Multiexcerpt include
    MultiExcerptNameproxyPath
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • Proxy Protocol:
    Multiexcerpt include
    MultiExcerptNameproxyProtocol
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • Proxy Port:
    Multiexcerpt include
    MultiExcerptNameproxyPort
    nopaneltrue
    PageWithExcerptSOAP Service Reference
  • External Proxy Host:
    Multiexcerpt include
    MultiExcerptNameexternalProxyHost
    nopaneltrue
    PageWithExcerptSOAP Service Reference

For detailed information on these tagged values refer to SOAP Service Reference.

Proceed with OK.

Now, in the component diagram the service component is placed within the service composite component.

In the customization panel on the right, you will find the new service (e.g. QueryProductsService).

Click Next to proceed.

Defining the SOAP Service Interface

In the next step, you will define the interface of the SOAP service. Through this interface, the Web service is accessible from the outside world.

The Components Wizard lists all port type classes on the left. Select a port type and click the button  >  to add the port type to the composite.

In the following dialog, assign a name to the port type or use the default name suggested.

Note
iconfalse

Special characters and blanks are not allowed for component names.

  • Provide a Namespace if necessary.
  • Provide a path, if you want to make this component independent of the package structure. Without a given path, port types are identified by port type name and package URL.

Proceed with OK.


In the artifact part oft the customization panel, you will find the added port type QueryProductsPortType.

As an interface can only be used once in a composite, the port type QueryProductsPortType is not displayed anymore in the SOAP Port Types list on the left.

Note
iconfalse

Each port type class (representing the interface of the SOAP service) can only be used once in a composite.

Click Next to proceed.


In the Customized Artifacts part of the tree panel, the xUML service is selected again, to give you the option to define further frontend services (see Defining the Frontend Service).

If you do not need any further elements, click Skip.

For definition of Backend Services (Aliases/Resources) see below (Defining Backend Aliases).

For Finishing the Components Wizard see Finishing the Components Wizard.

Defining Backend Aliases

In this step, backend aliases are defined. The Components Wizard provides predefined Backend Components.

Click New to create a new backend alias ...

...or select an existing alias and click > to add it to the component diagram.

Anchor
components_wizard_creating_a_com_6198
components_wizard_creating_a_com_6198
For adding a new alias, choose one of the following possible backend service stereotypes:

Backend Aliases
  • FileSystemAlias
  • Anchor
    components_wizard_JMSProvider
    components_wizard_JMSProvider
    JMSAlias
  • POP3Alias
  • SAPAlias
  • SMTPAlias
  • SOAPAlias
  • SQLAlias
  • URLAlias

Choose a backend alias stereotype from the list of available stereotypes, e.g. FileSystemAlias and click OK.

Assign a name to the alias or leave the default name suggested.

Specify File Name and Path, or, if you wanted to read data from an imported resource, select the resource from the Resource drop-down box instead.

Click OK.

In right part oft the customization panel, you will find the new file system alias (e.g. ProductCatalog).

Click Next.

Finishing the Components Wizard

This is the final step of the Components Wizard. You need to confirm to draw the component diagram. If the definitions are not complete yet, you may select an element node in the tree panel and add further UML elements to the diagram.

The Components Wizard generates the component diagram. If no errors occurred, it is necessary to save the model. On saving, the deployment data of the Model Compiler gets refreshed and you can proceed with e.g. compiling the model.