Scripting > Custom Scripts

Custom Scripts

<< <%SKIN-STRTRANS-SYNTOC%> >>

Navigation:  Scripting >

Custom Scripts

A custom script is the script used by an Execute Script command to execute custom functionality. The Execute Script command provides a list of predefined scripts that can be used directly or edited to suit specific needs. Please see the Execute Script topic for more information about how to use the predefined scripts.

 

A custom script can be added to an Execute Script command by setting the Script type to Custom Script:

 

customScriptCommand

 

The following example writes extracted data to a database. Normally a Data Export script would be used to write extracted data after an agent has completed, but an Execute Script command could be used to write data as it's being extracted:

 

using System;

using Sequentum.ContentGrabber.Api;

using Sequentum.ContentGrabber.Commands;

public class Script

{        

 public static CustomScriptReturn CustomScript(CustomScriptArguments args)

 {

         IConnection connection = args.GetDatabaseConnection("exportDatabase");

         connection.OpenDatabase();

         try

         {

                 ICommand command = connection.GetNewCommand();

                 command.SetSql("insert into export_table values (@title, @description)");                

                 command.AddParameterWithValue("title", args.DataRow["title"], CaptureDataType.ShortText);

                 command.AddParameterWithValue("description", args.DataRow["description"], CaptureDataType.ShortText);

                 command.ExecuteNonQuery();

         }

         finally

         {

                 connection.CloseDatabase();

         }                

         return CustomScriptReturn.Empty();

 }

}

 

The above script uses the IConnection and ICommand interfaces which are part of Content Grabber's Script Utilities.

 

The script must have a static method with the following signature.

 

public static CustomScriptReturn CustomScript(CustomScriptArguments args)

 

The script must return an instance of a class CustomScriptReturn. This class has the following 4 public static methods:

 

Method

Description

static CustomScriptReturn RetryContainer(IContainer container)

The agent will retry the specific container command. The container command must be a parent of the current command.

static CustomScriptReturn ExitContainer(IContainer container)

The agent will exit the specific container command. The container command must be a parent of the current command.

static CustomScriptReturn Pause()

The agent pauses and displays an agent web browser, which allows a user to interact with the web browser before continuing processing.

static CustomScriptReturn Empty()

The agent continues its normal executing flow.

 

An instance of the CustomScriptArguments class is provided by Content Grabber and has the following functions and properties:

Property or Function

Description

Agent Agent

The current agent.

ScriptUtils ScriptUtilities

A script utility class with helper methods. See Script Utilities for more information.

Command Command

The current agent command being executed.

IContainer ParentContainer

The parent container command of the current command.

IConnection DatabaseConnection

The current internal database connection used by the agent. This connection is already open and should not be closed by your script.

IHtmlNode HtmlNode

The extracted HTML node.

IInternalDataRow DataRow

The current internal data row containing the data that has been extracted so far in the current container command.

bool IsDebug

True if the agent is running in debug mode.

bool IsSchemaOnly

If true, only the data schema is required, so you can optimize processing by only returning the data schema with no data.

IInputData InputDataCache

All input data available to the current command.

void WriteDebug(string debugMessage, DebugMessageType messageType = DebugMessageType.Information)

Writes log information to the agent log. This method has no effect if agent logging is disabled, or if called during design time.

void WriteDebug(string debugMessage, bool showMessageInDesignMode, DebugMessageType messageType = DebugMessageType.Information)

Writes log information to the agent log. This method has no effect if agent logging is disabled, or if called during design time.

void Notify(bool alwaysNotify)

Triggers notification at the end of an agent run. If alwaysNotify is set to false, this method only triggers a notification if the agent has been configured to send notifications on critical errors.

void Notify(string message, bool alwaysNotify)

Triggers notification at the end of an agent run, and adds the message to the notification email. If alwaysNotify is set to false, this method only triggers a notification if the agent has been configured to send notifications on critical errors.

GlobalDataDictionary GlobalData

Global data dictionary that can be used to store data that needs to be available in all scripts and after agent restarts.

 

Input Parameters are also stored in this dictionary.

IConnection GetDatabaseConnection(string connectionName)

Returns the specified database connection. The database connection must have been previously defined for the agent or be a shared connection for all agents on the computer. Your script is responsible for opening and closing the connection by calling the OpenDatabase and CloseDatabase methods.

IInputDataRow GetInputData()

If the current command is a data provider, the data for that command is returned. Otherwise this function searches the command's parents and returns the first found input data.

IInputDataRow GetInputData(Command command)

If the specified command is a data provider, the data for that command is returned. Otherwise this function searches the command's parents and returns the first found input data.

IInputDataRow GetInputData(string commandName)

If the specified command is a data provider, the data for that command is returned. Otherwise this function searches the command's parents and returns the first found input data.

IInputDataRow GetInputData(Guid commandId)

If the specified command is a data provider, the data for that command is returned. Otherwise the function throws an error.