T4EA  AIG_19.2 C8891 A24697
Teamcenter Gateway for Enterprise Applications API Reference
PIPELINE_CLASS Class Reference

Public Member Functions

 addStep name description command args
 This method adds a step binding a TCL command. More...
 
 CheckCommand cmd
 This method checks if the target TCL command exists. More...
 
 defineRestEndpoint name method ?inputDataFormat? ?outputDataFormat? ?modeAsync?
 This method defines a pipeline specific rest endpoint. More...
 
 enableMonitor
 
 enableTransactionLogger
 
 getEndpoints
 This method returns information of all created pipeline specific endpoints. More...
 
 getName
 This method returns the pipeline name. More...
 
 getSteps
 This method returns information of all steps. More...
 
 getSummary
 
 NormalizeResult input
 This method normalizes a step engine result. More...
 
 ResponseError errMsg expectedOutputDataFormat
 
 run input
 This method triggers the pipeline with given input data (script way) More...
 
 runAsync input
 
 trigger name args
 This method triggers a pipeline (webservice way) More...
 
 triggerAsync name args
 

Detailed Description

Member Function Documentation

◆ addStep()

addStep   name description command args  

This method adds a step binding a TCL command.

Parameters
nameStep name
descriptionStep description
commandTarget TCL command
args(Optional) Additional properties
Warning
The target TCL command must exist prior to calling this method
Given property must be supported (see documentation). An error will be thrown if the property is unknown
Returns
none

◆ CheckCommand()

CheckCommand   cmd  

This method checks if the target TCL command exists.

Returns
1 if it exists. Otherwise 0

◆ defineRestEndpoint()

defineRestEndpoint   name method ?inputDataFormat? ?outputDataFormat? ?modeAsync?  

This method defines a pipeline specific rest endpoint.

Parameters
nameidentifier of the rest endpoint <host>:<port>/pxml/<name>
methodExpected HTTP method
inputDataFormat(Optional) The HTTP payload format. Default value := JSON
outputDataFormat(Optional) The HTTP response format. Default value := JSON
Warning
The rest endpoint name must be unique per pipeline object
Returns
none

◆ enableMonitor()

enableMonitor

◆ enableTransactionLogger()

enableTransactionLogger

◆ getEndpoints()

getEndpoints

This method returns information of all created pipeline specific endpoints.

Returns
List of Endpoint descriptions

◆ getName()

getName

This method returns the pipeline name.

Returns
Name of the pipeline

◆ getSteps()

getSteps

This method returns information of all steps.

Returns
List of step descriptions

◆ getSummary()

getSummary

◆ NormalizeResult()

NormalizeResult   input  

This method normalizes a step engine result.

Parameters
inputStep engine result: Ok|Error ...
Warning
An error will be thrown if the ERROR key exists
Returns
Normalized result

◆ ResponseError()

ResponseError   errMsg expectedOutputDataFormat  

◆ run()

run   input  

This method triggers the pipeline with given input data (script way)

Parameters
inputInput data (can be empty string)
Warning
The pipeline must have at least one step.
In case of critical error, the pipeline will only execute the error resistant steps prior to throwing an error
Returns
The pipeline result

◆ runAsync()

runAsync   input  

◆ trigger()

trigger   name args  

This method triggers a pipeline (webservice way)

Parameters
namePipeline name
argsPayload from rest endpoint call
Returns
HTTP Request result

◆ triggerAsync()

triggerAsync   name args