Difference between revisions of "Extensions.ExternalServiceProvider.IsServiceRunning"
Jump to navigation
Jump to search
(Created by Ngoc Tran.) |
(Edited by Ngoc Tran.) |
||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | BooleanTerm ExternalServiceProvider.IsServiceRunning(ServiceTerm serviceHandle); | + | otx:BooleanTerm ExternalServiceProvider.IsServiceRunning(esp:ServiceTerm serviceHandle); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 11: | ||
The [[Extensions.ExternalServiceProvider.IsServiceRunning|IsServiceRunning]] term is a otx:[[Boolean]][[Term]], which checks if a service is still running. This check can be performed while a synchronous or asynchronous service is running. For a synchronous ExcecuteService call this term can be called in parallel lane. | The [[Extensions.ExternalServiceProvider.IsServiceRunning|IsServiceRunning]] term is a otx:[[Boolean]][[Term]], which checks if a service is still running. This check can be performed while a synchronous or asynchronous service is running. For a synchronous ExcecuteService call this term can be called in parallel lane. | ||
| − | {{TermReturnValue| [[Boolean]] | Checks if a service is still running }} | + | {{TermReturnValue| [[Boolean|otx:Boolean]] | Checks if a service is still running }} |
== Properties == | == Properties == | ||
Latest revision as of 11:04, 14 November 2019
Contents
Classification
| Name | IsServiceRunning |
| Short Description | Checks if a service is still running |
| Class | Term |
| Extension | OTX ExternalServiceProvider extension |
| Group | ExternalServiceProvider related terms |
| Exceptions | |
| Checker Rules | |
| Standard Compliant | Yes |
OTL Syntax
otx:BooleanTerm ExternalServiceProvider.IsServiceRunning(esp:ServiceTerm serviceHandle);Description
The IsServiceRunning term is a otx:BooleanTerm, which checks if a service is still running. This check can be performed while a synchronous or asynchronous service is running. For a synchronous ExcecuteService call this term can be called in parallel lane.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| otx:Boolean | Checks if a service is still running |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| serviceHandle | esp:Service | Term | - | [1..1] | With serviceHandle of a CreateProvider action, a check can be performed to determine if the service is still running. Specifies the service to test. |
OTL 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 READ-WRITE;
ExternalServiceProvider.ServiceSignature ServiceSignature1(in ByteField ExternalInParameterDeclaration1, ref Float ExternalInOutParameterDeclaration1, out Integer ExternalOutParameterDeclaration1) throws ExternalServiceProvider.ConfigurationException, ExternalServiceProvider.ExecuteException, ExternalServiceProvider.ProviderServiceException;
}
package HMI.ScreenSignature ScreenSignature1();
/// Global Declarations
public procedure main()
{
/// Local Declarations
ExternalServiceProvider.ServiceProvider ServiceProvider1;
String String1 = "Abc";
String String2 = "Def";
String String3 = "Ghi";
Integer Integer1 = 5678;
ExternalServiceProvider.Service Service1;
Boolean Boolean1 = false;
ByteField ByteField1;
Float Float1;
/// Flow
ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, {ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String2, ConstructorExternalInParameter3 = String3});
ExternalServiceProvider.ExecuteService(ServiceProvider1, ServiceProviderSignature1, ServiceSignature1, {ExternalInParameterDeclaration1 = ByteField1, ExternalInOutParameterDeclaration1 = Float1, ExternalOutParameterDeclaration1 = Integer1}, Service1, false);
Boolean1 = ExternalServiceProvider.IsServiceRunning(Service1);
ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}