MD Link Jython code interacts with the MD Link engine through an object called engine. Below are the fields and functions available on that object from within a Web Service Event. To call any of these from your script, you must preceed the name of the field or function with a reference to engine - for example:
print engine.solnId
or:my_id = 'key_'+engine.transId
An engine object will be available to Jython scripts in all of a Web Service Event's scripts - 'Load', 'Run', and 'Unload'. However, some of the fields and functions described below are only available from within certain scripts - for example from the 'Run' script, but not the 'Load' or 'Unload' scripts. For each field or function which has such limited availability, this is documented below. If an attempt is made by your Jython code to access a field or function that is not available in the current context, then an exception will be raised. This exception will by default appear in the logs, and will interrupt the control flow of your script. The exception will contain an error message noting the cause.
Read-only property. This is the version of MD Link that is currently running (major and minor version numbers only) encoded as an integer such that, for example:
4.3.14.2 becomes 4030000
5.12.5 becomes 5120000
Read-only property. This is the ID of the enclosing Web Service Event- for example, E20.
logdebug (type: python file-like object)
Read-only property. This is a Jython output file stream that is redirected to MD Link's debug-level logs. You can use it as part of a print statement like this:
print >> engine.logdebug, 'Some debug info.'
loginfo (type: python file-like object)
Read-only property. This is a Jython output file stream that is redirected to MD Link's info-level logs. You can use it as part of a print statement like this:
print >> engine.loginfo, 'Some info-level info.'
A simple print statement like this:
print 'Some info-level info'
will accomplish the same thing. This field is just provided for convenience in some programming scenarios.
logwarn (type: python file-like object)
Read-only property. This is a Jython output file stream that is redirected to MD Link's warning-level logs. You can use it as part of a print statement like this:
print >> engine.logwarn, 'Some warning info.'
logerror (type: python file-like object)
Read-only property. This is a Jython output file stream that is redirected to MD Link's error-level logs. You can use it as part of a print statement like this:
print >> engine.logerror, 'Some error info.'
requestBodyDom (type: Java DOM object - i.e. org.w3c.dom.Document)
Available from the 'Run' script only. This is the body of the request message that the remote client sent to this Web Service Event. It is a DOM (Document Object Model) document object, so familiarity with that API is necessary to work with it. Please see the documentation for the Java DOM implementation.
The document tree provided by this field is read-only.
requestHeaderDom (type: Java DOM object - i.e. org.w3c.dom.Document)
Available from the 'Run' script only. This is the header of the request message that the remote client sent to this Web Service Event, or None if no headers section is present in the request. It is a DOM (Document Object Model) document object, so familiarity with that API is necessary to work with it. Please see the documentation for the Java DOM implementation.
The document tree provided by this field is read-only.
responseBodyDom (type: Java DOM object - i.e. org.w3c.dom.Document)
Available from the 'Run' script only. This is the body of the response message that the Web Service Event will send back to the remote client. This is a DOM object, like requestBodyDom. Unlike requestBodyDom, the value of this field will be None by default; it is the responsibility of the Web Service Event implementer to create a document object conforming to the WSDL's response body schema and point this field at that document. One way to do that is to write code such as:
engine.responseBodyDom = util.makeXMLDocument('SubmitMessageResponse')
responseHeaderDom (type: Java DOM object - i.e. org.w3c.dom.Document)
Available from the 'Run' script only. This is the header of the response message that the Web Service Event will send back to the remote client. This is a DOM object, like requestBodyDom. Unlike requestBodyDom, the value of this field will be None by default; it is the responsibility of the Web Service Event implementer to create a document object conforming to the WSDL's response header schema and point this field at that document - but only if headers need to be part of the response. One way to create this object is to write code such as:
engine.responseHeaderDom = util.makeXMLDocument('SubmitMessageResponseHeaders')
Read-only property. This is the ID of the solution of which this Web Service Event is a part, as assigned by the engine. eg. SOLN3.
solutionFilename (type: string)
Read-only property. This is the absolute filename of the solution file of which this Web Service Event is a part.
void fail(string message)
An error message will be logged. Control will not return to the calling Jython code.
If this is called from the 'Load' script, then the solution will refuse to load. If it is called from the 'Run' script, then the current Web Service Event execution will fail. If it is called from the 'Unload' script, nothing will happen except for the error message logged.
message - optional. This message string will show up in the log message that results from this call.
void ret()
This method causes the Jython script to exit immediately. If this is called from the 'Run' script, then the event's run thread will exit.
string getVarVal(string variablename)
Gets the value of a variable. This could be a solution or global variable. If there are both solution and global variables defined with the name supplied, then the value of the solution variable will be returned.
Do not include $ or ${} to reference the variable name, as you would when referencing variables in elsewhere in the product.
If the given variable name does not exist, an exception will be raised.
Example:
engine.getVarVal('sender')
might return "LAB".
Given a string containing references to variables, this function substitutes the variable names with their values. Each variable name can be either a solution or global variable. If there are both solution and global variables defined with the name supplied, then the value of the solution variable will be returned.
Unlike getVarVal(), for this function you will need to include $ or ${} to reference the variable names, as you would when referencing variables in elsewhere in the product.
Also unlike getVarVal(), if the given variable name does not exist, then the original variable reference will appear in the return value unmodified. No exception will be raised by this case.
Example:
engine.subVarVals('sender: ${sender}, receiver: ${receiver}')
might return "sender: LAB, receiver: DATABASE"