|
Service Name and Purpose
|
Input Parameters
|
Result
|
||
|---|---|---|---|---|
|
Parameter Name
|
Base Type
|
Description
|
||
|
ModelMgmtPublishModel — Sets the Model Object in the Model Data Table to published if not already published or a client.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
modelName
|
String
|
Specifies the name of the model.
|
||
|
isPublished
|
Boolean
|
Set this parameter totrue if model is already published.
|
||
|
EventMgmtEnableTriggeringConfiguration — Toggle Enabled/Disabled the selected Analysis service trigger configuration.
|
selected
|
Infotable
|
List of analytic services which are to be enabled or disabled.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
enabled
|
Boolean
|
If the value is set to true then selected services will be enabled otherwise disabled.
|
||
|
MappingGetDataShapeFields — Get the fields from the Data Shape.
|
mappedFields
|
Infotable
|
List of fields to be mapped with specific data shape.
|
Returns the mapping fields from the datashape. This is an infotable in the same format as the TW.AnalysisServices.ParamFieldDataShape data shape.
|
|
dataShapeName
|
String
|
Specifies the name of the data shape.
|
||
|
EventMgmtAddTriggeringConfiguration — Add an Analysis service trigger configuration.
|
entityName
|
ThingName
|
Specifies the name of the entity.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
eventName
|
String
|
Specifies the name of the event on which the analysis is triggered.
|
||
|
ServiceName
|
String
|
Specifies the name of the service to be implemented on the thing.
|
||
|
resourceName
|
String
|
Specifies the name of the resource.
|
||
|
StoreJobs
|
String
|
Specifies which sort of jobs needs to be stored Either all jobs or only the jobs executed with warnings would be stored.
|
||
|
eventProperty
|
String
|
Specifies the name of the property if the event specified by eventName is a property event. Otherwise, it can be set to null.
|
||
|
alertName
|
String
|
Specifies the name of the alert. This allows you to customize the cloned event according to alert type. This parameter is optional.
|
||
|
isContinuous
|
Boolean
|
Specifies if trigger service creation is to be continuous. Set the value of this parameter to true to store all the jobs. Job history will not be retained.
|
||
|
isPropApplicable
|
Boolean
|
Specifies if the event property is applicable. Set it to false in case eventProperty is null.
|
||
|
errorMode
|
Boolean
|
Specifies output message of the services. Set the value to true to get the operation code as an output.
0 indicates Success and -1 indicates the failure
|
||
|
runOnSameHost
|
Boolean
|
Specifies if the cascaded event must run on the same host as the event that triggered it.
|
||
|
matchExecutionRate
|
Boolean
|
The value of this parameter is set to true only if below two conditions are met:
• If the value of the isSimulation parameter is set to true
• Execute the analysis only if the interval between executions exceeds the average execution time
|
||
|
retainJobHistory
|
String
|
Specifies if the job details will be stored for the discrete analysis event. The following are the possible values:
• None
• Failed
• All
.The default value is None.
|
||
|
agentName
|
String
|
Specifies the name of the agent where the event must be executed. This parameter is optional.
|
||
|
isTimeSeries
|
Boolean
|
Specifies whether the analysis event is instance-based or time series-based. Set to true to configure the event as time-series based. This parameter is optional.
|
||
|
trailingWindowDuration
|
Long
|
If the value of the isTimeSeries parameter is set to true, the time for trailing data collection is specified in this parameter in milliseconds.
|
||
|
lookBackCount
|
Integer
|
If the value of the isTimeSeries parameter is set to false, this parameter specifies the number of mapped entries’ rows for which trailing data is to be collected.
|
||
|
samplingFrequency
|
Long
|
Specifies the frequency in milliseconds at which trailing data is to be collected for the specified values of the trailingWindowDuration parameter or the lookBackCount parameter.
|
||
|
entityType
|
String
|
Specifies the type of entity that the event is to be created on as one of the following:
• Thing
• Thing template
This parameter is optional.
|
||