Scriptor

This Scriptor component, which can be used in any stage of a pipeline, executes a script written in a Microsoft® ActiveX® scripting language such as JavaScript™ or Microsoft® Visual Basic® Scripting Edition (VBScript).

You can run the Scriptor component in any stage of a pipeline.

• υScripting Engine. Specifies the scripting language in which the script is written.
• υSource. Specifies whether the script is stored internally or externally.
  • υInternal. Indicates that the script is stored internally in the .pcf file. In the Win32 Pipeline Editor, click the Edit button to display the script for editing.
  • υExternal. Indicates that the script is stored in a file on disk. The script’s path and file name are displayed in the Filename box. You can import an external script and convert it to an internal script (see Configuring a Scriptor Component).
• υConfig. Specifies the parameters that are passed to the script in the form name=value.

Remarks

Note

The MSCSExecute function must return a success code. If you write a Scriptor component in VBScript, the MSCSExecute routine must be a function, not a subroutine (see the following examples). This is because MSCSExecute must return a success value of 1, a warning value of 2, or a failure value of 3. Subroutines cannot return 1. If you write the function in JavaScript, be sure to return a value.

The script that is executed by the Scriptor component consists of a group of entry points. These include the following:

The MSCSOpen handler. This function is invoked first when the Scritpor component is run.

The MSCSExecute handler. This is the main Scriptor entry point. This handler is passed the OrderForm, the pipe context, and optional configuration parameters.

The MSCSClose handler. This handler is invoked after the MSCSExecute handler has returned.

If you include the Scriptor component in a pipeline that you run using the MtsTxPipeline, you should not call the ObjectContext object’s methods from within the MSCSOpen or MSCSClose handlers. Calls to ObjectContext methods can only occur from within the Scriptor’s MSCSExecute handler.

Note

The Microsoft Transaction Server (MTS) context is not available to a Scriptor component or to any components called by a Scriptor (that is, context.SetComplete() and context.SetAbort() are not available to scripts hosted by Scriptor).

Related Topics

υUsing the Scriptor Component

υThe Scriptor Methods

υConfiguring a Scriptor Component