Create a Scripted Rule

You can write a customized script inside a rule in the data model.

In this topic:

Create a new scripted rule

In the Data Model Editor, click New Rule > Scripted Rule and select an option:

• JavaScript
• C#

Then select a scope for the rule. For details, see Rule scope.

Back to top

Edit a script

Select one of the following:

Back to top

Script guidelines

Write the script content according to the following guidelines:

• JavaScript: Use any JavaScript expression from ECMAScript 5 strict mode along with Service Virtualization exposed objects.

• C#: You can code any algorithmic implementation designed to process messages that are received by Service Virtualization.

  To include code in the script that will act on external elements, such as files in the file system, windows configuration, printers, network, database checks, or other programs, you must specify these rules in the Service Virtualization security policy file. For details on configuring the security policy file, see Configure C# Security.

• You can insert the path to a Service Virtualization object, instead of entering it manually. Select a scripted rule, and from the Data Model Editor Script menu, select Insert Path. Select a data element to add to the script.

In addition, the following Service Virtualization objects are available:

For manipulating messages:

For stateful behavior, define a context for the script:

To search the content of contexts:

It can be helpful to search the contexts of your script, to check for possible memory leaks, for example.

To take advantage of this functionality, use the property 'Keys' from any context.

foreach(string key in listOfExistingKeys) {
      sv.Contexts.Server.Remove(key);    
}

For information on the current environment:

You may want to enable the script to identify the environment in which the virtual service is running, so the script can execute differently in different environments based on that information.

To take advantage of this functionality, use the property 'Environment' from the root HpsvObject in your scripts, together with the following fields:

For information on the current service:

Additional endpoint properties:

The endpoints property represents a collection of endpoints. You need to provide an integer (indexed from 0) to access one of the items within the collection. For example:

var myAgentId = sv.serviceInfo.endpoints[0].virtualOutputAgentId;

Back to top

Configure logging for scripted rules

Configure logging using one or more of the following methods:

• Log messages to the Service Virtualization log file
• Send messages to the Designer Problem List

Log messages to the Service Virtualization log file

1. Prerequisite: Enable logging

   To enable your scripts to write to the log file, add the following entry to the log4net section of the configuration file for the Designer or Service Virtualization Server.

   <logger name="JavascriptLogger"> OR <logger name="CsharpRuleFileLogger">

   <level value="XXX" />

   </logger>

   where XXX is one of the following log levels: DEBUG, INFO, WARNING, ERROR.

   By default, only log level WARNING is set.

   For more information, consult the log4net documentation.

   Note:  

   • Service Virtualization Server configuration file: HP.SV.StandaloneServer.exe.config, located on the Service Virtualization Server machine in the server installation folder. By default, C:\Program Files\Micro Focus\Service Virtualization Server\Server\bin.

   • Designer configuration file: VirtualServiceDesigner.exe.config, located on the Designer machine in the installation folder. By default, C:\Program Files\Micro Focus\Service Virtualization Designer\Designer\bin\.
   • For details on log file locations, see Virtual Service Editor.

2. Configure a logging level in the script.

   Log level	JavaScript	C#
   Error	hpsv.logger.error	sv.Logger.Error
   Warning	hpsv.logger.warn	sv.Logger.Warn
   Information	hpsv.logger.info	sv.Logger.Info
   Debug	hpsv.logger.debug	sv.Logger.Debug

3. Notice of intended deprecation: Access to the dataLogger is planned to be deprecated in a future version of SV.

   To log request and response data for a specific data element, add the following line to the script. Assign a name for the custom log file, and enter actual names for the request and response operations, and data elements.

   sv.dataLogger.log("<custom logfile name>.log", sv.request.<request operation name>.<element1 name>.<element2 name>, sv.response.<response operation name>.<element1 name>.<element2 name>)

Send messages to the Designer Problem List

To add messages to the Designer Problem List instead of logging to a file, add one of the following lines to your script:

You can then view logged messages in the Problem List.

By default, only errors and warnings are displayed in the Problem List. You can set the filter to display messages from other log levels as well. For details, see Problem list.

Back to top

Set options for the scripted rule

The following options are available for the scripted rule:

• Skip the first simulation pass. To modify or complete data filled in by another rule, the scripted rule must be have a higher priority than the rule you want to override. However, during the first simulation pass, all the response data for the script has not yet been filled in by the other rules. In this case, you may want to skip the scripted rule during the first simulation pass.
• Execute the rule only once. As an example, you may be using the script to add an item into an array, such as assigning an ID to a user. Each time the script is run, the rule will modify the response, causing the simulation process to continue repeatedly. In this case, use this option to properly execute the simulation.

By default, both of these options are enabled. (For more details on how simulation is performed, see The Simulation Process.)

To change this default setting and reduce CPU time during simulation, configure the rule's properties by right-clicking the scripted rule and select Properties.

Back to top

See also:

• Configure C# Security
• Use a third-party library in a C# rule
• Debug a C# scripted rule
• Persistent Sequences