The following sections are ordered according the steps needed to create a component diagram and describe each creation step in detail.
- Assigning the Diagram Name
- Defining the Composite
- Defining the Frontend Service
- Defining the SOAP Service Interface
- Defining Backend Aliases
- Finishing the Components Wizard
Step 1: 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 default name suggested 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. |
Step 2: Defining the Composite
With the next step, you define the service composite. The service composite represents the repository of the Web service and will contain all necessary configuration information.
Clicking Next after having assigned 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). | Info |
|---|
Special characters and blanks are not allowed for composite names. |
|
| In case you accidentally clicked the Cancel button, 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 advanced composite settings as tagged values to the composite. | Tagged Value | Description |
|---|
| wsdlPerService | | Multiexcerpt include |
|---|
| MultiExcerptName | wsdlPerService |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | WSDL Namespace | | Multiexcerpt include |
|---|
| MultiExcerptName | wsdlNamespace |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | Category | | Multiexcerpt include |
|---|
| MultiExcerptName | category |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | resolveInheritance | | Multiexcerpt include |
|---|
| MultiExcerptName | resolveInheritance |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | Version | | Multiexcerpt include |
|---|
| MultiExcerptName | version |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | Soap Version | | Multiexcerpt include |
|---|
| MultiExcerptName | soapVersion |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
| | Class To XML Default Root Name | | Multiexcerpt include |
|---|
| MultiExcerptName | classToXMLDefaultRootName |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
Refer to XML - UML Class Mapping for more information on the topic of XML serialization. | | Startup Shutdown Trace Port | | Multiexcerpt include |
|---|
| MultiExcerptName | startupShutdownTracePort |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Frontend Components |
|---|
|
|
For more information on these tagged values refer to Frontend Components . |
| Specify the test settings here. | Tagged Value | Description |
|---|
generateTestService | | Multiexcerpt include |
|---|
| MultiExcerptName | generateTestService |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| Test Service Name | | Multiexcerpt include |
|---|
| MultiExcerptName | testServiceName |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| | Test Port | | Multiexcerpt include |
|---|
| MultiExcerptName | testPort |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| Test Encoding | | Multiexcerpt include |
|---|
| MultiExcerptName | testEncoding |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| Test Proxy Host | | Multiexcerpt include |
|---|
| MultiExcerptName | testProxyHost |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| | Test Proxy Port | | Multiexcerpt include |
|---|
| MultiExcerptName | testProxyPort |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| | Test Proxy Protocol | | Multiexcerpt include |
|---|
| MultiExcerptName | testProxyProtocol |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| | Test Proxy Path | | Multiexcerpt include |
|---|
| MultiExcerptName | testProxyPath |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using Testable Classes |
|---|
|
| | External Test Proxy Host | | Multiexcerpt include |
|---|
| MultiExcerptName | externalTestProxyHost |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Using 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, and configure the persistent state engine. | Tagged Value | Description |
|---|
| Workers | | Multiexcerpt include |
|---|
| MultiExcerptName | workers |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | Storage Medium | | Multiexcerpt include |
|---|
| MultiExcerptName | storageMedium |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | Internal State Database Sync | | Multiexcerpt include |
|---|
| MultiExcerptName | state_db_synch |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | External Database Alias | | Multiexcerpt include |
|---|
| MultiExcerptName | externalStateDBAlias |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | Owner | 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. | | Switch Over Enabled | | Multiexcerpt include |
|---|
| MultiExcerptName | switchOverRetryTimeout |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | Switch Over Retry Timeout | | Multiexcerpt include |
|---|
| MultiExcerptName | switchOverEnabled |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | Event Selection Algorithm | | Multiexcerpt include |
|---|
| MultiExcerptName | event_selection_algorithm |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
| | External Properties State DB Alias | | Multiexcerpt include |
|---|
| MultiExcerptName | externalPropertiesStateDBAlias |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Persistent State Components |
|---|
|
|
For more information Persistent State Components. |
| Using Java services in the xUML service, you can specify the JVM options here. | Tagged Value | Description |
|---|
JVM Options | | Multiexcerpt include |
|---|
| MultiExcerptName | jvmOptions |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Modeling the Java Components |
|---|
|
| | killJVMThreadsOnShutdown | | Multiexcerpt include |
|---|
| MultiExcerptName | killJVMThreadsOnShutdown |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Modeling the Java Components |
|---|
|
| | Parallel JVM Operations | | Multiexcerpt include |
|---|
| MultiExcerptName | parallelJVMOperations |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | Modeling 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 can find the new xUML service component (e.g. EducationLesson3) in the list of added composites on the right side. | Info |
|---|
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.
Step 3: 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
| |
| This example shows how to define a Web service. Select the service stereotype E2ESOAPService. Proceed with OK. |
| Now, customize the service artifact. | Tagged Value | Description |
|---|
Name | Assign a Name. | Port | Assign a Port, to which the SOAP service is listening (the value needs to be between 10'000 and 19'999). | | Encoding | Select an encoding. See Encoding of SOAP Operations for more information on SOAP encoding of xUML services. | Timezone | | Multiexcerpt include |
|---|
| MultiExcerptName | timezone |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Date Format String | | Multiexcerpt include |
|---|
| MultiExcerptName | dateFormatString |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Max Request Body Size | | Multiexcerpt include |
|---|
| SpaceWithExcerpt | INTERNAL |
|---|
| MultiExcerptName | max_request_body_size |
|---|
| PageWithExcerpt | INTERNAL:_bridge_excerpts |
|---|
|
| | Max Parallel Connections | Maximum number of requests that can be processed in parallel. | | resolveHostnames | Automatically resolve IP addresses to domain names. |
|
The Create New SOAP Service dialog contains two more tabs.
| On the Advanced tab, you can specify the following settings: | Tagged Value | Description |
|---|
| Wsdl Namespace | | Multiexcerpt include |
|---|
| MultiExcerptName | wsdlNamespace |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Authentication Mode | | Multiexcerpt include |
|---|
| MultiExcerptName | authenticationMode |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP 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. |
| On the Proxy tab, you can specify the proxy details. | Tagged Value | Description |
|---|
| External Proxy Host | | Multiexcerpt include |
|---|
| MultiExcerptName | externalProxyHost |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Proxy Host | | Multiexcerpt include |
|---|
| MultiExcerptName | proxyHost |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| Proxy Path | | Multiexcerpt include |
|---|
| MultiExcerptName | proxyPath |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Proxy Port | | Multiexcerpt include |
|---|
| MultiExcerptName | proxyPort |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP Service Reference |
|---|
|
| | Proxy Protocol | | Multiexcerpt include |
|---|
| MultiExcerptName | proxyProtocol |
|---|
| nopanel | true |
|---|
| PageWithExcerpt | SOAP 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.
Step 4: 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 Add 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. | Info |
|---|
| 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. | Info |
|---|
| 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. |
Step 5: 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 Add 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. FileAlias 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. |
Step 6: Finishing the Components Wizard
This is the final step of the Components Wizard where you confirm to draw the component diagram. If the definitions are not complete yet, you can 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.
