Page tree
Skip to end of metadata
Go to start of metadata

xUML services normally are deployed via the Builder for MagicDraw. In the component diagram of a UML model in MagicDraw™, you define the control port number and the Bridge node instance, to which the composite of the service will be deployed. Then, you can compile and deploy the service to the defined node instance with the xUML Model Compiler.

You can also directly deploy the repository of a compiled composite to a node instance via the Bridge.

How to manage service repositories for different environments like Development, Test, or Production is explained in detail in Configuration Management.

The control port is defined in the component diagram and is used for the communication between the console and the server component. If a compiled composite is deployed to a server, the Bridge will check whether the xUML service is already existing on the Bridge. If you have chosen the option to overwrite the xUML service, and existing (old) xUML service will be overwritten. If the control port has changed, the new control port will be used. The old control port will be released.
If you have not chosen to overwrite the composite, the Bridge will report an error, because composite names of a node instance must be unique.

It is possible to deploy two different xUML services with the same control port. However, if the control port is already used by one composite, the other composite cannot be started unless the first composite is stopped.

Bridge 7.0.0 Please note that repositories that have been compiled with a Bridge 7 compiler cannot be deployed to Bridges older than 6.0.55.2.

Deploying an xUML Service via the Bridge

Only users who are member of a group, to which the role ADMIN or MODELER has been assigned, are allowed to deploy xUML services. Users, who have only MODELER access rights, may only replace an xUML service, if they themselves or a member of the same group deployed it.

If a composite has already been compiled in the Builder, you can select and deploy the generated REP file that contains the repository files and the WSDL file.
Select the navigation item Deployment in the Domain section of the navigation on the left to deploy a new xUML service or overwrite an existing one.

Locate and select the REP file by clicking Browse….

The REP file is located in the repository directory as defined in the Builder project settings. Start the Builder, open the Builder project settings, and switch to the tab General to look up this directory.

Click Upload ... to proceed with uploading the repository and setting the deployment options.

Two tables show an overview on the details of the service to be deployed:

NameDescription
xUML RepositoryFile name of the service repository.
Service NameName of the service component.
Service VersionService version as specified on the service component (see Frontend Components).
Compiler VersionVersion of the compiler the service has been compiled with.
Build TimeBuild time of the service repository.

If the service has been deployed to this node instance before, you can compare the details of the new and the existing service here.

Furthermore, you can set the following deployment options:

OptionDescription
Deploy Settings and Preferences from Repository

This option is enabled only, if the repository to be uploaded comes from a service export and contains exported settings and preferences.

Check this option, if you want to also deploy the exported settings and preference. If you are overwriting an existing xUML service, settings and preferences will be added from the repository – all locally changed settings and preferences will get overwritten.
Startup ServiceTo run, the xUML service has to be started. Select this option, if you want the xUML service to be started automatically right after its deployment.

After you have set all options, deploy the composite by clicking Deploy. If the service already exists, the button will read Overwrite.

If you have deployed a new xUML service, it will be displayed in the navigation, below the node instance, to which it has been deployed. The target node instance, to which the xUML service will be deployed, is specified in the component diagram of the UML model in the Builder and is stored in the deployment descriptor of the repository files.

Additionally, a backup copy of the deployed service will be made to <your Bridge data directory>/backup. This backup includes the service settings as present on the Bridge after deployment - depending on what you specified for option Deploy Settings and Preferences from Repository.

Deployment of xUML Services on Bridge 6

 Bridge 6

If a composite has already been compiled in the Builder, you can select and deploy the generated REP file that contains the repository files and the WSDL file.
Select the navigation item Deployment in the Domain section of the navigation on the left to deploy a new xUML service or overwrite an existing one.

Locate and select the REP file by clicking Browse….

The REP file is located in the repository directory as defined in the Builder project settings. Start the Builder, open the Builder project settings, and switch to the tab General to look up this directory.

Click Select ... to proceed with uploading the repository and set the deployment options.

>


OptionDescription
Overwrite ServiceIf the xUML service you want to deploy already exists, check this option, if you want to overwrite it.
Overwrite Settings and Preferences

Check this option, if you want to overwrite the local settings and preferences of an existing xUML service on deployment.

If you are overwriting an existing xUML service, settings and preferences will be added from the repository – all locally changed settings will get overwritten. This can be either default settings defined in the xUML service model, or settings coming from an xUML service export (see xUML Service Details).


Overwrite = NoOverwrite = Yes

Builder RepositoryExported RepositoryBuilder RepositoryExported Repository

Settings

  • no change of locally changed settings

  • changed default values from the model will be applied to the settings (this will affect unchanged settings only)
no change of locally changed settingsall settings (including locally changed) will get overwritten with the default settings coming from the modelall settings (including locally changed) will get overwritten with the settings coming from the exported repository
Preferencesno changeno changeno changeexported preferences applied
Startup ServiceTo run, the xUML service has to be started. Select this option, if you want the xUML service to be started automatically right after its deployment.

After you have set all options, deploy the composite by clicking Upload.
If you have deployed a new xUML service, it will be displayed in the navigation, below the node instance, to which it has been deployed.

The target node instance, to which the xUML service will be deployed, is specified in the component diagram of the UML model in the Builder and is stored in the deployment descriptor of the repository files.

  • No labels