Class Result

Read only.

Read only.

Summary text also displays on the status line while the Composition is playing.

If the summary text is not set by a Script, it will contain the text of the first error that occured during the Composition. If the summary text is set by a Script, the text set by the Script takes precedence over any error text that would ordinarily display.

Example of setting the summary text to a custom value:

$context.result.summary = "I got to here.";

Example of posting a custom informational event to the Result:

$context.result.postMessage($context.result.LEVEL_INFO, "Hello, world!");

Example of posting a custom error event with multi-line details to the Result:

var details = "The error happened at:\n" + Date.now() + "\nAnd the value of i was:\n" + i;
$context.result.postMessage($context.result.LEVEL_ERROR, "An error happened.", details);

This method does not actually cause any Message sending or receiving, it is used to record such activity when it is done in some other way other than via a standard Message.

Typically the Script would make one or more calls to Java in one or more Custom Modules. Those calls would return information and statistics about what happened, and then this this function would be called one or more times by the Script to record in the Composition's Result what happened.

This function has two required parameters. Both parameters can be any type of JavaScript object, although usually they would just be plain Objects. Each object is expected to have certain properties with certain pre-defined names.

The target object is expected to have property values that describe the target of the action. This takes the place of the Target object that a standard Message would have. It is expected to have the following property values:

The action object is expected to have property values that describe the action that was taken. This takes the place of the standard Message object. It is expected to have the following property values:

Here is an example Script. It is assumed that there is a Custom Module that contains a Java class named "org.example.ExampleSender" that implements the sending in a method called "sendSomething" and returns the result of the send in a Java class named "ExampleSenderOutput" that contains public members for each of the values being returned.

importPackage(org.example);

// Invoke the Java code in the Custom Module to do the actual sending.
var exampleSender = new ExampleSender();
var exampleSenderOutput = exampleSender.sendSomething("Some text to send");

// Create the JS object to represent the simulated Target.
var pretendTarget = new Object();
pretendTarget.name = "My Target";
pretendTarget.repositoryPath = "/Some folder name";
pretendTarget.repositoryName = "My pretend Repository Target";

// Create the JS object to represent the action that was just executed.
var pretendAction = new Object();
pretendAction.name = "My action";
pretendAction.repeatIndex = -1;
pretendAction.operation = exampleSenderOutput.m_operation;
pretendAction.url = exampleSenderOutput.m_url;
pretendAction.failureText = exampleSenderOutput.m_failureText;
pretendAction.validationPassed = exampleSenderOutput.m_validationPasses;
pretendAction.textSent = exampleSenderOutput.m_textSent;
pretendAction.textReceived = exampleSenderOutput.m_textReceived;
pretendAction.duration = exampleSenderOutput.m_duration;
pretendAction.completionType = exampleSenderOutput.m_completionType;
pretendAction.deltaFromScheduledStart = exampleSenderOutput.m_deltaFromScheduledStart;
pretendAction.bytesSent = exampleSenderOutput.m_bytesSent;
pretendAction.bytesReceived = exampleSenderOutput.m_bytesReceived;
pretendAction.totalPortRetryCount = exampleSenderOutput.m_totalPortRetryCount;
pretendAction.connectionEstablishTime = exampleSenderOutput.m_connectionEstablishTime;
pretendAction.sendTime = exampleSenderOutput.m_sendTime;
pretendAction.receiveTime = exampleSenderOutput.m_receiveTime;
pretendAction.totalTime = exampleSenderOutput.m_totalTime;
pretendAction.ttfb = exampleSenderOutput.m_ttfb;
pretendAction.ttlb = exampleSenderOutput.m_ttlb;
pretendAction.dnsLookupDuration = exampleSenderOutput.m_dnsLookupDuration;
pretendAction.waitForConnectionPoolTime = exampleSenderOutput.m_waitForConnectionPoolTime;

// Record the action in the Result.
$context.result.recordActionCompletion(pretendTarget, pretendAction);

Note that the above approach was used for illustrative purposes, but another approach might be to have the Java code return a Java object that contains exactly all of the members expected for the "action" parameter, and then that object could be passed directly to the recordActionCompletion call. In that case, the Script would look as follows:

importPackage(org.example);

// Invoke the Java code in the Custom Module to do the actual sending.
// In this case, the Java code is expected to return an object that contains
// exactly all of the members expected by "recordActionCompletion".
var exampleSender = new ExampleSender();
var exampleSenderOutput = exampleSender.sendSomething("Some text to send");

// Create the JS object to represent the simulated Target.
var pretendTarget = new Object();
pretendTarget.name = "My Target";
pretendTarget.repositoryPath = "/Some folder name";
pretendTarget.repositoryName = "My pretend Repository Target";

// Record the action in the Result.
$context.result.recordActionCompletion(pretendTarget, exampleSenderOutput);

When the Composition Result is viewed in the Results Viewer, the Clip in which the Script resides will show a Target named "My Target" and the container in which the Script resides will show a Message named "My action", along with events showing the information shown for any Message, such as what was sent and what was received. In addition, the statistics for the action will be added to the various widget displays and charts as appropriate.

This function has one required parameter. It can be any type of JavaScript object, although usually it would just be a plain Object. The object is expected to have certain properties with certain pre-defined names.

The object is expected to have property values that describe the Transaction to be completed. It is expected to have the following property values:

The Transaction will be empty unless simulated actions are recorded inside of it using the recordActionCompletion method, and/or nested Transactions are created inside of it using this method.

Code that is adding simulated actions to the Result can also create Transactions and place the actions inside of those Transactions, to control how things appear and how statistics are computed in the Result.

This function has one required parameter. It can be any type of JavaScript object, although usually it would just be a plain Object. The object is expected to have certain properties with certain pre-defined names.

The object is expected to have property values that describe the Transaction to be started. It is expected to have the following property values: