OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService Class Reference

Execute a service provided by an external service provider More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService:

Classes
class	ServiceArguments
	Represents the list of arguments for a service More...

Public Attributes
ServiceArguments	arguments
	This simple container element represents the list of arguments for a service More...
System.Boolean	executeAsync
	This option tells the communication backend to make this service execution non-blocking More...
OtxLink	providerType
	This attribute identifies the external provider to execute the service on. The link shall point to the corresponding ServiceProviderSignature More...
OtxName	service
	This attribute identifies the service that shall be executed. The service name shall be defined within the corresponding service declaration within the ServiceProviderSignature More...
ServiceVariable	serviceHandle
	For every started service a serviceHandle is returned. With this handle the running service can be stopped (if possible). It is also possible to check if the service is already running. More...
ServiceProviderTerm	serviceProvider
	A service of this ServiceProvider will be executed More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Validity of ActionRealisation. More...

Detailed Description

Execute a service provided by an external service provider

The ExecuteService activity shall execute a service provided by an external service provider. The action executes externally implemented functionality of the provider. The required parameters of the service are defined in the ServiceSignature.

Exceptions

Exceptions.ProviderDisposedException
Exceptions.ProviderServiceException
Core.Exceptions.TypeMismatchException

Checker rules

CheckerRule.ExternalServiceProvider_Chk001 - Correct target for service provider
CheckerRule.ExternalServiceProvider_Chk005 - Correct ExecuteService service reference
CheckerRule.ExternalServiceProvider_Chk006 - Correct ExecuteService arguments

Syntax

ExternalServiceProvider.ExecuteService(OtxLink providerType, OtxName service, Boolean executeAsync, ServiceProviderTerm serviceProvider, ServiceArguments arguments, ServiceVariable serviceHandle);

Examples

// Signatures
 
package ExternalServiceProvider.ServiceProviderSignature ServiceProviderSignature1
{
    ExternalServiceProvider.ConstructorSignature ConstructorSignature1(String ConstructorExternalInParameter1, String ConstructorExternalInParameter2, String ConstructorExternalInParameter3);
    ExternalServiceProvider.EventSignature EventSignature1(String EventValueParameterDeclaration1);
    ExternalServiceProvider.PropertySignature PropertySignature1(String PropertyValueDeclaration1) accessType WRITE-ONLY;
    ExternalServiceProvider.ServiceSignature ServiceSignature1(in ByteField ExternalInParameterDeclaration1, ref Float ExternalInOutParameterDeclaration1, out Integer ExternalOutParameterDeclaration1) throws ExternalServiceProvider.ConfigurationException, ExternalServiceProvider.ExecuteException, ExternalServiceProvider.ProviderServiceException;
}
 
// Global Declarations
 
public procedure main()
{
    // Local Declarations
 
    ExternalServiceProvider.ServiceProvider ServiceProvider1;
    String String1 = "Abc";
    String String2 = "Def";
    String String3 = "Ghi";
    ExternalServiceProvider.Service Service1;
    ByteField ByteField1 = &1234;
    Integer Integer1 = 5678;
    Float Float1 = 9.9;
 
    // Flow
    ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, { ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String1, ConstructorExternalInParameter3 = String3});
    ExternalServiceProvider.ExecuteService(ServiceProvider1, ServiceProviderSignature1, ServiceSignature1, {ExternalInParameterDeclaration1 = ByteField1, ExternalInOutParameterDeclaration1 = Float1, ExternalOutParameterDeclaration1 = Integer1}, Service1, false);
    ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}

Member Data Documentation

arguments

ServiceArguments OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.arguments

This simple container element represents the list of arguments for a service

executeAsync

System.Boolean OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.executeAsync

This option tells the communication backend to make this service execution non-blocking

This means that if executeAsync is set to true, the OTX execution flow will immediately move on to the next Action, without waiting for the result of the ExecuteService action. An OTX sequence can make use of the ServiceExecutionFinishedEventSource term to be notified when the service has finished.

providerType

OtxLink OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.providerType

This attribute identifies the external provider to execute the service on. The link shall point to the corresponding ServiceProviderSignature

service

OtxName OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.service

This attribute identifies the service that shall be executed. The service name shall be defined within the corresponding service declaration within the ServiceProviderSignature

serviceHandle

ServiceVariable OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.serviceHandle

For every started service a serviceHandle is returned. With this handle the running service can be stopped (if possible). It is also possible to check if the service is already running.

serviceProvider

ServiceProviderTerm OpenTestSystem.Otx.Extensions.ExternalServiceProvider.Actions.ExecuteService.serviceProvider

A service of this ServiceProvider will be executed