diff --git a/block-api/framework/analyticsbuilder-framework.cdp b/block-api/framework/analyticsbuilder-framework.cdp index 246b0ab..70b7778 100644 Binary files a/block-api/framework/analyticsbuilder-framework.cdp and b/block-api/framework/analyticsbuilder-framework.cdp differ diff --git a/doc/apamadoc/alltypes-frame.html b/doc/apamadoc/alltypes-frame.html index 0c7f8a2..015c63e 100644 --- a/doc/apamadoc/alltypes-frame.html +++ b/doc/apamadoc/alltypes-frame.html @@ -20,6 +20,16 @@ InventoryLookupResult
L10N
LngLat
+ModelCreateRequest
+ModelCreateResponse
+ModelDeleteRequest
+ModelDeleteResponse
+ModelFailed
+ModelFailedInternal
+ModelLifecycleManager
+ModelStatus
+ModelStatusRequest
+ModelStatusResponse
NameValue
OutputHandler
OutputParams
@@ -31,7 +41,11 @@ PromiseJoiner
PromiseReturner
RequestForwarding
+RunModelInternalRequest
+RunModelInternalResponse
SlowSystemWarning
+StopModelInternalRequest
+StopModelInternalResponse
TemplateParameterDefinition
TemplateReference
TimerHandle
diff --git a/doc/apamadoc/alltypes-noframe.html b/doc/apamadoc/alltypes-noframe.html index dbde4ac..30045c8 100644 --- a/doc/apamadoc/alltypes-noframe.html +++ b/doc/apamadoc/alltypes-noframe.html @@ -20,6 +20,16 @@ InventoryLookupResult
L10N
LngLat
+ModelCreateRequest
+ModelCreateResponse
+ModelDeleteRequest
+ModelDeleteResponse
+ModelFailed
+ModelFailedInternal
+ModelLifecycleManager
+ModelStatus
+ModelStatusRequest
+ModelStatusResponse
NameValue
OutputHandler
OutputParams
@@ -31,7 +41,11 @@ PromiseJoiner
PromiseReturner
RequestForwarding
+RunModelInternalRequest
+RunModelInternalResponse
SlowSystemWarning
+StopModelInternalRequest
+StopModelInternalResponse
TemplateParameterDefinition
TemplateReference
TimerHandle
diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateRequest.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateRequest.html new file mode 100644 index 0000000..eaca66e --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateRequest.html @@ -0,0 +1,32 @@ + + +ModelCreateRequest
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelCreateRequest

+Request for creating (deploying) a model.

A ModelCreateResponse event is sent back with the same reqId with the result.
Constant summary
 constant stringSEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event must be sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance being deployed.
 dictionary<string, string>params
+
Other parameters for the models. Following parameters are supported: - name - name of the model. In case of template model instance, it is the name of the parent template model. - builderModel - the details of the model (blocks and its connection) - mode - mode of model deployment - modeProperties - mode specific properties - templateParameters - definition of the template parameters in case of template model instance. Missing in case of static model. - templateParameterValues - value of template parameters in case of template model instance. Missing in case of static model. - parentModelId - the ID of the parent model if it is a template instance. Currently unused.
 
Constant detail
+

SEND_CHANNEL

constant string SEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event must be sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance being deployed.

In case of a static model deployment, this will be the ID of the model. In case of deployment of an instance of a template model, this will be the ID of the instance.

This is the ID which is used for all lifecycle operations and tracking the model.
+

params

dictionary<string, string> params
+Other parameters for the models. Following parameters are supported: - name - name of the model. In case of template model instance, it is the name of the parent template model. - builderModel - the details of the model (blocks and its connection) - mode - mode of model deployment - modeProperties - mode specific properties - templateParameters - definition of the template parameters in case of template model instance. Missing in case of static model. - templateParameterValues - value of template parameters in case of template model instance. Missing in case of static model. - parentModelId - the ID of the parent model if it is a template instance. Currently unused.
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateResponse.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateResponse.html new file mode 100644 index 0000000..05e8ce9 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelCreateResponse.html @@ -0,0 +1,47 @@ + + +ModelCreateResponse
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelCreateResponse

+Response to the ModelCreateRequest.
Constant summary
 constant stringSUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event is sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 stringmodelName
+
Name of the model.
 stringstatus
+
State of the model. RUNNING if creation is successful, else FAILED.
 stringruntimeError
+
The model creation error in English. Empty if the creation is successful.
 sequence<any>runtimeErrorLocalized
+
The localized error details. Empty if the creation is successful.
 dictionary<string, dictionary<string, sequence<dictionary<string, any>>>>modelInputDetails
+
Details of model inputs.
 dictionary<string, dictionary<string, sequence<dictionary<string, any>>>>modelOutputDetails
+
Details of model outputs.
 
Constant detail
+

SUBSCRIBE_CHANNEL

constant string SUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event is sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

modelInputDetails

dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> modelInputDetails
+Details of model inputs.
+

modelName

string modelName
+Name of the model.

This is the name of the model in case of static model deployment. In case of template model instance deployment, this is the name of the parent template model.
+

modelOutputDetails

dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> modelOutputDetails
+Details of model outputs.
+

reqId

integer reqId
+The request ID.
+

runtimeError

string runtimeError
+The model creation error in English. Empty if the creation is successful.
+

runtimeErrorLocalized

sequence<any> runtimeErrorLocalized
+The localized error details. Empty if the creation is successful.
+

status

string status
+State of the model. RUNNING if creation is successful, else FAILED.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteRequest.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteRequest.html new file mode 100644 index 0000000..8fcbb59 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteRequest.html @@ -0,0 +1,29 @@ + + +ModelDeleteRequest
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelDeleteRequest

+Request for deleting a model.

A ModelDeleteResponse event is sent back with the same reqId with the result.
Constant summary
 constant stringSEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event must be sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 
Constant detail
+

SEND_CHANNEL

constant string SEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event must be sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteResponse.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteResponse.html new file mode 100644 index 0000000..93a049d --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelDeleteResponse.html @@ -0,0 +1,32 @@ + + +ModelDeleteResponse
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelDeleteResponse

+Response to the ModelDeleteRequest.
Constant summary
 constant stringSUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event is sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 booleanmodelExisted
+
True if the model was actually deployed previously, otherwise false.
 
Constant detail
+

SUBSCRIBE_CHANNEL

constant string SUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event is sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

modelExisted

boolean modelExisted
+True if the model was actually deployed previously, otherwise false.
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailed.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailed.html new file mode 100644 index 0000000..15158ec --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailed.html @@ -0,0 +1,35 @@ + + +ModelFailed
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelFailed

+Event sent if a running model fails.
Constant summary
 constant stringSUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event is sent.
 
Field summary
 stringmId
+
The ID of the model or the template instance.
 stringmodelName
+
Name of the model. If it is a template instance, then it is the name of the parent template model.
 stringruntimeError
+
The model creation error in English. Empty if the creation is successful.
 sequence<any>runtimeErrorLocalized
+
The localized error details. Empty if the creation is successful.
 
Constant detail
+

SUBSCRIBE_CHANNEL

constant string SUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event is sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

modelName

string modelName
+Name of the model. If it is a template instance, then it is the name of the parent template model.
+

runtimeError

string runtimeError
+The model creation error in English. Empty if the creation is successful.
+

runtimeErrorLocalized

sequence<any> runtimeErrorLocalized
+The localized error details. Empty if the creation is successful.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailedInternal.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailedInternal.html new file mode 100644 index 0000000..2da1233 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelFailedInternal.html @@ -0,0 +1,26 @@ + + +ModelFailedInternal
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelFailedInternal

+Routed by the Framework.mon when a running model has failed.
Field summary
 stringmId
+
The ID of the model or the template instance.
 com.apama.exceptions.Exceptionex
+
The failure exception.
 
Field detail
+

ex

com.apama.exceptions.Exception ex
+The failure exception.
+

mId

string mId
+The ID of the model or the template instance.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelLifecycleManager.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelLifecycleManager.html new file mode 100644 index 0000000..3cdd873 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelLifecycleManager.html @@ -0,0 +1,49 @@ + + +ModelLifecycleManager
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelLifecycleManager

+The event to manage requests for model lifecycle.

It makes sure that only one lifecycle request is handled at a time.
Routes:
apama.analyticsbuilder.framework.RunModelInternalRequest - 
apama.analyticsbuilder.framework.RunModelInternalResponse - 
apama.analyticsbuilder.framework.StopModelInternalRequest - 
Sends:
apama.analyticsbuilder.framework.ModelCreateResponse - 
apama.analyticsbuilder.framework.ModelDeleteResponse - 
apama.analyticsbuilder.framework.ModelFailed - 
apama.analyticsbuilder.framework.ModelStatusResponse - 
Listens:
apama.analyticsbuilder.framework.RunModelInternalResponse - 
apama.analyticsbuilder.framework.StopModelInternalResponse - 
any - 
Constant summary
 constant stringCHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel on which it listens for the requests.
 
Field summary
 com.apama.cumulocity.TenantDetailstenant
+
The current tenant.
 dictionary<string, apama.analyticsbuilder.framework.ModelStatus>_models
+
Status of currently deployed models.
 sequence<any>_pendingRequests
+
Currently pending request. It includes the request currently being processed.
 float_currentRequestStartTime
+
The start time of current request.
 listener_currentRequestWaitListener
+
A wait listener for logging warning for current request.
 sequence<listener>_requestListeners
+
The listeners created for all supported request types. Used for cleanup for testing.
  + +
Action summary
 apama.analyticsbuilder.framework.ModelLifecycleManagerstatic init(com.apama.cumulocity.TenantDetails tenant)
+
Create a new instance.
 voidqueueRequest(any req)
+
Queue a request.
 
Constant detail
+

CHANNEL

constant string CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel on which it listens for the requests.
Field detail
+

_currentRequestStartTime

float _currentRequestStartTime
+The start time of current request.
+

_currentRequestWaitListener

listener _currentRequestWaitListener
+A wait listener for logging warning for current request.
+

_models

dictionary<string, apama.analyticsbuilder.framework.ModelStatus> _models
+Status of currently deployed models.
+

_pendingRequests

sequence<any> _pendingRequests
+Currently pending request. It includes the request currently being processed.
+

_requestListeners

sequence<listener> _requestListeners
+The listeners created for all supported request types. Used for cleanup for testing.
+

tenant

com.apama.cumulocity.TenantDetails tenant
+The current tenant.
Action detail
+

init

apama.analyticsbuilder.framework.ModelLifecycleManager static init(com.apama.cumulocity.TenantDetails tenant)
+Create a new instance.
Parameters:
tenant
+

queueRequest

void queueRequest(any req)
+Queue a request.
Parameters:
req
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatus.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatus.html new file mode 100644 index 0000000..516a4ea --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatus.html @@ -0,0 +1,43 @@ + + +ModelStatus
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelStatus

+Current model status.
Field summary
 stringmId
+
The ID of the model or the template instance.
 stringmodelName
+
The name of the static model or the parent template model.
 stringstatus
+
Current status of the model - RUNNING / FAILED.
 stringruntimeError
+
The model failure error in English. Empty if model is running.
 sequence<any>runtimeErrorLocalized
+
The localized error details. Empty if the model is running.
  + +
Action summary
 apama.analyticsbuilder.framework.ModelStatusstatic create(string mId, string modelName)
+
Create an instance.
 apama.analyticsbuilder.framework.ModelStatusfailed(com.apama.exceptions.Exception e)
+
Update failure status.
 
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

modelName

string modelName
+The name of the static model or the parent template model.
+

runtimeError

string runtimeError
+The model failure error in English. Empty if model is running.
+

runtimeErrorLocalized

sequence<any> runtimeErrorLocalized
+The localized error details. Empty if the model is running.
+

status

string status
+Current status of the model - RUNNING / FAILED.
Action detail
+

create

apama.analyticsbuilder.framework.ModelStatus static create(string mId, string modelName)
+Create an instance.
Parameters:
mId
modelName
+

failed

apama.analyticsbuilder.framework.ModelStatus failed(com.apama.exceptions.Exception e)
+Update failure status.
Parameters:
e
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusRequest.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusRequest.html new file mode 100644 index 0000000..b22abf8 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusRequest.html @@ -0,0 +1,29 @@ + + +ModelStatusRequest
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelStatusRequest

+Request for getting the current status of a model or a template instance. A ModelStatusResponse event is sent back with the same reqId with the result.
Constant summary
 constant stringSEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event must be sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 
Constant detail
+

SEND_CHANNEL

constant string SEND_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event must be sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusResponse.html b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusResponse.html new file mode 100644 index 0000000..ff49387 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/ModelStatusResponse.html @@ -0,0 +1,42 @@ + + +ModelStatusResponse
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event ModelStatusResponse

+Response to the ModelStatusRequest.
Constant summary
 constant stringSUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+
The channel to which this event is sent.
 
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 stringstatus
+
Current state of the model - RUNNING / FAILED / INACTIVE.
 stringruntimeError
+
The model failure error in English. Empty if model is running or missing.
 sequence<any>runtimeErrorLocalized
+
The localized error details. Empty if the model is running of missing.
  +
Action summary
 booleanisMissing()
+
 
Constant detail
+

SUBSCRIBE_CHANNEL

constant string SUBSCRIBE_CHANNEL := "AnalyticsBuilder.ModelLifecycleManager"
+The channel to which this event is sent.
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

reqId

integer reqId
+The request ID.
+

runtimeError

string runtimeError
+The model failure error in English. Empty if model is running or missing.
+

runtimeErrorLocalized

sequence<any> runtimeErrorLocalized
+The localized error details. Empty if the model is running of missing.
+

status

string status
+Current state of the model - RUNNING / FAILED / INACTIVE.
Action detail
+

isMissing

boolean isMissing()
+
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalRequest.html b/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalRequest.html new file mode 100644 index 0000000..d618b6a --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalRequest.html @@ -0,0 +1,23 @@ + + +RunModelInternalRequest
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event RunModelInternalRequest

+Internal events used for requesting starting a model. Handled by Framework.mon *
Field summary
 apama.analyticsbuilder.framework.ModelCreateRequestrequest
+
The actual ModelCreateRequest request.
 
Field detail
+

request

apama.analyticsbuilder.framework.ModelCreateRequest request
+The actual ModelCreateRequest request.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalResponse.html b/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalResponse.html new file mode 100644 index 0000000..a115131 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/RunModelInternalResponse.html @@ -0,0 +1,38 @@ + + +RunModelInternalResponse
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event RunModelInternalResponse

+Response for RunModelInternalRequest. Routed from Framework.mon
Field summary
 integerreqId
+
The request ID.
 apama.analyticsbuilder.framework.ModelCreateResponseresp
+
The actual ModelCreateResponse.
  + + +
Action summary
 apama.analyticsbuilder.framework.RunModelInternalResponsestatic create(integer reqId, string mId, string modelName)
+
Create a new instance.
 apama.analyticsbuilder.framework.RunModelInternalResponsedone(dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> inputDetails, dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> outputDetails)
+
Request to run model completed successfully.
 apama.analyticsbuilder.framework.RunModelInternalResponsefailed(com.apama.exceptions.Exception ex)
+
Request to run model failed.
 
Field detail
+

reqId

integer reqId
+The request ID.
+

resp

apama.analyticsbuilder.framework.ModelCreateResponse resp
+The actual ModelCreateResponse.
Action detail
+

create

apama.analyticsbuilder.framework.RunModelInternalResponse static create(integer reqId, string mId, string modelName)
+Create a new instance.
Parameters:
reqId
mId
modelName
+

done

apama.analyticsbuilder.framework.RunModelInternalResponse done(dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> inputDetails, dictionary<string, dictionary<string, sequence<dictionary<string, any>>>> outputDetails)
+Request to run model completed successfully.
Parameters:
inputDetails
outputDetails
+

failed

apama.analyticsbuilder.framework.RunModelInternalResponse failed(com.apama.exceptions.Exception ex)
+Request to run model failed.
Parameters:
ex
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalRequest.html b/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalRequest.html new file mode 100644 index 0000000..92e6b18 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalRequest.html @@ -0,0 +1,29 @@ + + +StopModelInternalRequest
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event StopModelInternalRequest

+Internal events used for stopping all monitor instances of a model. Handled by Framework.mon *
Field summary
 integerreqId
+
The request ID.
 stringmId
+
The ID of the model or the template instance.
 booleanmodelFailed
+
True iff we are stopping the model (cleanup) if the model failed and not due to user deletion request.
 
Field detail
+

mId

string mId
+The ID of the model or the template instance.
+

modelFailed

boolean modelFailed
+True iff we are stopping the model (cleanup) if the model failed and not due to user deletion request.
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalResponse.html b/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalResponse.html new file mode 100644 index 0000000..0035936 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/StopModelInternalResponse.html @@ -0,0 +1,23 @@ + + +StopModelInternalResponse
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION

apama.analyticsbuilder.framework
Event StopModelInternalResponse

+Response for StopModelInternalRequest. Routed from Framework.mon when all monitor instances related to the model are stopped.
Field summary
 integerreqId
+
The request ID.
 
Field detail
+

reqId

integer reqId
+The request ID.
FRAMES   + +  NO FRAMES   +  
Overview  + PackageDeprecated  + Help  + Apama Analytics Builder
SUMMARY: IMPORT | CONSTANT | FIELD | ACTIONDETAIL: IMPORT | CONSTANT | FIELD | ACTION
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/package-frame.html b/doc/apamadoc/apama/analyticsbuilder/framework/package-frame.html new file mode 100644 index 0000000..71b60c9 --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/package-frame.html @@ -0,0 +1,6 @@ + + +apama.analyticsbuilder.frameworkapama.analyticsbuilder.framework
+ Events +   +
ModelCreateRequest
ModelCreateResponse
ModelDeleteRequest
ModelDeleteResponse
ModelFailed
ModelFailedInternal
ModelLifecycleManager
ModelStatus
ModelStatusRequest
ModelStatusResponse
RunModelInternalRequest
RunModelInternalResponse
StopModelInternalRequest
StopModelInternalResponse
\ No newline at end of file diff --git a/doc/apamadoc/apama/analyticsbuilder/framework/package-summary.html b/doc/apamadoc/apama/analyticsbuilder/framework/package-summary.html new file mode 100644 index 0000000..82251af --- /dev/null +++ b/doc/apamadoc/apama/analyticsbuilder/framework/package-summary.html @@ -0,0 +1,26 @@ + + +apama.analyticsbuilder.framework
Overview  + Package  + Deprecated  + Help  + Apama Analytics Builder
FRAMES   + +  NO FRAMES   +  

Package apama.analyticsbuilder.framework

Event summary
ModelCreateRequestRequest for creating (deploying) a model.
ModelCreateResponseResponse to the ModelCreateRequest.
ModelDeleteRequestRequest for deleting a model.
ModelDeleteResponseResponse to the ModelDeleteRequest.
ModelFailedEvent sent if a running model fails.
ModelFailedInternalRouted by the Framework.mon when a running model has failed.
ModelLifecycleManagerThe event to manage requests for model lifecycle.
ModelStatusCurrent model status.
ModelStatusRequestRequest for getting the current status of a model or a template instance. A ModelStatusResponse event is sent back with the same reqId with the result.
ModelStatusResponseResponse to the ModelStatusRequest.
RunModelInternalRequestInternal events used for requesting starting a model. Handled by Framework.mon *
RunModelInternalResponseResponse for RunModelInternalRequest. Routed from Framework.mon
StopModelInternalRequestInternal events used for stopping all monitor instances of a model. Handled by Framework.mon *
StopModelInternalResponseResponse for StopModelInternalRequest. Routed from Framework.mon when all monitor instances related to the model are stopped.

+   +

+   +
Overview  + Package  + Deprecated  + Help  + Apama Analytics Builder
FRAMES   + +  NO FRAMES   +  
\ No newline at end of file diff --git a/doc/apamadoc/element-list b/doc/apamadoc/element-list index 847b634..9c0a946 100644 --- a/doc/apamadoc/element-list +++ b/doc/apamadoc/element-list @@ -1,3 +1,4 @@ apama.analyticsbuilder.cumulocity.inventory apama.analyticsbuilder.cumulocity apama.analyticsbuilder +apama.analyticsbuilder.framework diff --git a/doc/apamadoc/overview-frame.html b/doc/apamadoc/overview-frame.html index 217945f..4ff4a54 100644 --- a/doc/apamadoc/overview-frame.html +++ b/doc/apamadoc/overview-frame.html @@ -2,5 +2,5 @@ Overview (Apama API Documentation) -
All Types

Packages
apama.analyticsbuilder
apama.analyticsbuilder.cumulocity
apama.analyticsbuilder.cumulocity.inventory

  +
All Types

Packages
apama.analyticsbuilder
apama.analyticsbuilder.cumulocity
apama.analyticsbuilder.cumulocity.inventory
apama.analyticsbuilder.framework

  \ No newline at end of file diff --git a/doc/apamadoc/overview-summary.html b/doc/apamadoc/overview-summary.html index 9242e14..2878d60 100644 --- a/doc/apamadoc/overview-summary.html +++ b/doc/apamadoc/overview-summary.html @@ -15,7 +15,7 @@ Apama Analytics BuilderFRAMES    NO FRAMES   -  
Packages
apama.analyticsbuilder 
apama.analyticsbuilder.cumulocity 
apama.analyticsbuilder.cumulocity.inventory 

  +  
Packages
apama.analyticsbuilder 
apama.analyticsbuilder.cumulocity 
apama.analyticsbuilder.cumulocity.inventory 
apama.analyticsbuilder.framework 

 
 Overview  Package  diff --git a/doc/apamadoc/structure.xml b/doc/apamadoc/structure.xml index 815fac4..b6e1a1b 100644 --- a/doc/apamadoc/structure.xml +++ b/doc/apamadoc/structure.xml @@ -284,4 +284,32 @@ action tagOutput(MyEvent e) { This should typically be a string, float or boolean. A value wire can be connected to a simple input, and only this value will be used.]]>value.]]>value.]]> \ No newline at end of file + Stores a copy of all block information as it is registered, and responds to get requests either from HTTP connectivity or internal apps.]]>MinHeap.]]>MinHeap.]]>MinHeap.]]>TimersManager should be created via TimersManager.create action which takes an callback action. The callback action is called when a timer is triggered, model/chain should be evaluated when it is called. Once the evaluation is completed for the time, the resume() action of the TimersManager should be called. + + It uses MinHeap data structure to maintain current set of pending timers and schedule the minimum timers from the heap by creating a wait listener. It maintains at max one active wait listener at a time. + + If a schedule timer request is received for a time which is less than the currently scheduled time, it cancels the active listener and create new wait listener for the new time. + + Once a timer is triggered, the TimerManager goes into the paused state and accumulates timers without processing them. Timer processing is only resumed when resume() action is called. This is done to make sure that all timer requests are accumulated during a model or chain execution before picking of the next minimum timer time. + + It also supports setting up a maxEvalTime - timers are executed as long as ther are less than or equal to the maxEvalTime. Timers greater than the maxEvalTime are accumulated and only processed when maxEvalTime is cleared.]]> \ No newline at end of file diff --git a/samples/tests/Percentile/run.py b/samples/tests/Percentile/run.py index 6e6edd0..9c1a200 100755 --- a/samples/tests/Percentile/run.py +++ b/samples/tests/Percentile/run.py @@ -17,7 +17,7 @@ def execute(self): modelId_failed = self.createTestModel('apamax.analyticsbuilder.samples.Percentile', {'percentile':500.0}) # Checking that the model failed to load. - self.assertGrep('all.evt', expr="Created.*must be in the range 0 to 100 inclusive") + self.assertGrep('all.evt', expr="must be in the range 0 to 100 inclusive") # Deploying a new model with correct parameter. self.m5 = self.createTestModel('apamax.analyticsbuilder.samples.Percentile', {'percentile':5.0}) diff --git a/samples/tests/TimeDelayBlock/run.py b/samples/tests/TimeDelayBlock/run.py index 4409722..e85f129 100755 --- a/samples/tests/TimeDelayBlock/run.py +++ b/samples/tests/TimeDelayBlock/run.py @@ -17,7 +17,7 @@ def execute(self): modelId_failed = self.createTestModel('apamax.analyticsbuilder.samples.TimeDelay') # Checking that the model failed to load. - self.assertGrep('all.evt', expr="Created.*No value provided for required parameter 'Delay .secs.'") + self.assertGrep('all.evt', expr="No value provided for required parameter 'Delay .secs.'") # Deploying a new model with correct parameter. self.modelId = self.createTestModel('apamax.analyticsbuilder.samples.TimeDelay', {'delaySecs':1.9}) diff --git a/samples/tests/TimeWindow/run.py b/samples/tests/TimeWindow/run.py index 655f520..693b56c 100755 --- a/samples/tests/TimeWindow/run.py +++ b/samples/tests/TimeWindow/run.py @@ -17,7 +17,7 @@ def execute(self): modelId_failed = self.createTestModel('apamax.analyticsbuilder.samples.TimeWindow') # Checking that the model failed to load. - self.assertGrep('all.evt', expr="Created.*No value provided for required parameter 'Duration.*'") + self.assertGrep('all.evt', expr="No value provided for required parameter 'Duration.*'") # Deploying a new model with correct parameter. self.modelId = self.createTestModel('apamax.analyticsbuilder.samples.TimeWindow', {'durationSecs':10.0}) diff --git a/scripts/buildExtension.py b/scripts/buildExtension.py index a47db11..bed2064 100755 --- a/scripts/buildExtension.py +++ b/scripts/buildExtension.py @@ -16,7 +16,7 @@ BLOCK_REGISTRY_CHANNEL = 'analyticsbuilder.metadata.requests' UNSUPPORTED_FILE_TYPES = ('.log','.classpath','.dependencies','.project','.deploy','.launch','.out','.o') # Files with these extensions are to be excluded EXCLUDE_FOLDERS = ['.git', '.github'] # The folders to be excluded, .git and .github folders should be excluded as they are unnecessary and can lead to build issues -LOCALES = 'EN,DE,PL,PT_BR,ZH_CN,ZH_TW,NL,FR,JA_JP,KO,RU,ES' +LOCALES = 'EN,DE,PL,PT_BR,ZH_CN,ZH_TW,NL,FR,JA_JP,KO,ES' def add_arguments(parser): """ Add parser arguments. """ diff --git a/scripts/jsonHelper.py b/scripts/jsonHelper.py index 2966480..e380298 100755 --- a/scripts/jsonHelper.py +++ b/scripts/jsonHelper.py @@ -11,7 +11,7 @@ BLOCK_METADATA_EVENT = buildExtension.BLOCK_METADATA_EVENT BLOCK_MESSAGES_EVENT = buildExtension.BLOCK_MESSAGES_EVENT BLOCK_REGISTRY_CHANNEL = buildExtension.BLOCK_REGISTRY_CHANNEL -LOCALES = 'EN,DE,PL,PT_BR,ZH_CN,ZH_TW,NL,FR,JA_JP,KO,RU,ES' +LOCALES = 'EN,DE,PL,PT_BR,ZH_CN,ZH_TW,NL,FR,JA_JP,KO,ES' def add_arguments_extract(parser): parser.add_argument('--input', metavar='INPUT', type=str, required=True, help='the input directory (should contain _messages.evt and _metadata.evt)') diff --git a/testframework/apamax/analyticsbuilder/basetest.py b/testframework/apamax/analyticsbuilder/basetest.py index f0aa505..31df35b 100755 --- a/testframework/apamax/analyticsbuilder/basetest.py +++ b/testframework/apamax/analyticsbuilder/basetest.py @@ -24,7 +24,8 @@ def __init__(self, parent, corr, channels=[]): self.parent = parent self.corr = corr self.stdouterr = self.parent.allocateUniqueStdOutErr('waiter') - + if channels: + channels = channels + ['AnalyticsBuilder.ModelLifecycleManager'] corr.receive(self.stdouterr[0], channels=channels, utf8=True) def waitFor(self, expr, count=5, errorExpr=None): self.corr.flush(count=count) @@ -192,7 +193,7 @@ def createTestModel(self, blockUnderTest, parameters={}, id=None, corr=None, inp blockUnderTest=[blockUnderTest] testParams=', '.join([json.dumps(blockUnderTest), json.dumps(id), json.dumps(json.dumps(parameters)), json.dumps(json.dumps(inputs)), json.dumps(json.dumps(outputs)), json.dumps(wiring), '{"isDeviceOrGroup":any(string, "%s")}'%isDeviceOrGroup]) corr.sendEventStrings(f'apamax.analyticsbuilder.test.Test({testParams})') - waiter.waitFor(expr='com.apama.scenario.Created', errorExpr='CreateFailed') + waiter.waitFor(expr=f'apama.analyticsbuilder.framework.ModelCreateResponse\(.*{id}', errorExpr='CreateFailed') return id