Send Console Command [ ] with P1 = [ ] and P2 = [ ] and P3 = [ ]

Important: After using this command click the Show Columns button on the Gateway Live screen and check the required Visible Columns to view more data.

 

Command

SENDCONSOLECOMMAND2

Image
Group Engine
Section Events
Description

Used to raise messages to the Console

Parameter 1

The Command to be raised, one of:

  • STARTTASK
  • GATEWAY
  • SETSPLIT
  • BROWSER_SETURL
  • BROWSER_SETFIELD
  • BROWSER_PUSHBUTTON
  • BROWSER_GETFIELD
  • BROWSER_INSERTSCRIPT
  • BROWSER_INVOKEFUNCTION
  • BROWSER_GETSTATE
  • BROWSER_SUPPRESSERRORS
  • BROWSER_UNSUPPRESSERRORS
  • BROWSER_EVENTONCOMPLETE
  • BROWSER_EVENTONNAVIGATING
  • BROWSER_EVENTONTIMER
  • BROWSER_IGNOREELEMENTS
  • BROWSER_EVENTONCHANGE
  • BROWSER_GETURL
  • BROWSER_ONCHANGEFIELD
Parameter 2

1st parameter for the command, which will vary depending on command

  • BROWSER_xxx: This will be the title of the web tab that will be given the command
  • GATEWAY: This will be the variable you wish to send to the Gateway service
  • SETSPLIT: Allows you to specify the size of the split between the contact manager panel and the other console dlls.  Is either a size as:
    • n% ie 25%
    • npx ie 250px
    • SWITCH
    • MINIMUM
    • MAXIMUM
  • STARTTASK: Description of task to be started
Parameter 3

2nd parameter for the command, which will vary depending on command. If the command is not listed then this parameter is not required.

  • GATEWAY: This will be the value you wish to send to the Gateway service.
  • BROWSER_SETURL: This parameter will hold the URL that the browser is to navigate to
  • BROWSER_EVENTONTIMER: This is the interval in seconds that needs to elapse before the current variables of the browser page are raised to the script
  • BROWSER_ONCHANGEFIELD: This parameter will hold a comma separated list of element ids/names, that will be used to trigger the sending of the browser elements back to the script
  • BROWSER_IGNOREELEMENT: This parameter will hold a comma separated list of element types that you do not want raised back to the script. The possible values are:

    Code Element
    SEL Select
    BTN Button
    OPT Option
    ITM Item
    OLI Ordered Item
    ULI Unordered Item
    SPN Span
    DIV Div
    ANC Anchor
    LAB Label
    TEX Textbox
    RAD Radiobutton
    CHE Checkbox
  • BROWSER_INSERTSCRIPT: This parameter will hold the javascript that is to be injected into the browser
  • BROWSER_INVOKEFUNCTION: This will be the name of the javascript function to be invoked in the browser
  • BROWSER_GETFIELD: This is the id of the HTML element you wish to read the value for. If you wish for a more accurate match prefix the id with '='.

    You can also suffix the id with |<type> to assist in extracting the correct value. The supported <type> values are:

    • SELECT
    • RADIOBUTTON
    • CHECKBOX
    • SPAN
    • MULTICHECK-TEXT
    • MULTICHECK-VALUE
    • TABLECELL
  • BROWSER_PUSHBUTTON: This is the id of the HTML button you wish to “push”.
  • SETSPLIT: Not used
  • STARTTASK: This is a string detailing the script to be launched built up using one or more of the following items in a pipe delimited string
    • A:<data> - Additional Info to be passed to the script
    • U:<id> - the ID of the contact record to be used
    • C:<cli> - the CLI to be passed to the script
    • CB:<id> - the ID of the call back record
    • L:<id> - the List ID to be used
    • P:<id> - the ID of the project, if not set then the current project ID will be automatically added
    • T:<id> - the ID of the task type
    • TR:<id> - the ID of any related task ie pEmail record
    • X1:<data> - data for script variable SCRIPTX1
    • X2:<data> - data for script variable SCRIPTX2
    • X3:<data> - data for script variable SCRIPTX3
Parameter 4

3rd parameter for the command, which will vary depending on command:

  • BROWSER_GETFIELD: You can set P3 with then <type> to assist in extracting the correct value – supported <type> values are:
    • SELECT
    • RADIOBUTTON
    • CHECKBOX
    • SPAN
    • MULTICHECK-TEXT
    • MULTICHECK-VALUE
    • TABLECELL
  • BROWSER_SETFIELD: This is the value you wish to set the field to