Script Item Property Reference

This section explains the properties can be accessed on the various items in Badboy Scripts. There are 4 different property types that are recognized by Badboy. These are:

  • String (text)
  • Integer
  • Boolean - set as "true" or "false"
  • Date / Time - set in format YYYY-MM-DD Hour:Minute:Second

Accessing Properties

Properties are accessed using the get and set functions that are available on all script item objects. For example, to access the type of the item with id 32 in your script you could use the "get" function from JScript as follows:

badboy.script.find(32).get("itemType");

Available Properties

The following table lists the properties that are accessible on each type of item.

All Items  Property Name Notes
  itemType (readonly)  
All Playable Items    
  timeoutSeconds  
  timeoutEnabled  
  timeoutAction  
  targetWindow  
  itemName  
  disabled set to 'true' or 'false' to disable or enable the item.
  documentation  
  waitForPageToLoad  
  sourceLocation  
  recordResponses  
  quiescenceTimeMs  
  isInherited  
Assertion    
  captureScreenShot  
  scalingPercent  
  captureDuplicates  
AssertionFailure    
  description  
  timeStamp  
BitmapCheckItem    
  RGBTolerance  
  yTolerance  
  xTolerance  
  b  
  g  
  r  
  y  
  x  
  type  
CaptureItem    
  name  
  timeStamp  
ClickItem    
  xPosition  
  yPosition  
  windowName  
  windowSizeX  
  windowSizeY  
  enableRestoreSize  
  waitForPageLoad  
  cascade  
  raiseToTop  
  clickType  
  upXPosition  
  upYPosition  
  dragMouse  
  waitForWindow  
ContentCheckItem    
  pattern  
  type  
  searchMode  
  bUseRegex  
  checkMessageBoxes  
  checkRuntimeBodyContent  
Custom    
  name  
  toolboxName  
  modifiedTimeStamp  
DataSourceItem    
  connectString  
  loadString  
  loadType  
  mapType  
  tableName  
  dataSourceName  
FormPartItem    
  headers  
  substituteVariables  
  sourceType One of either "file" or "script"
  sourceFile Used only if sourceType is set to "file".
FormPopulator    
  headers  
  substituteVariables  
  formName  
  submit  
  formIndex  
  actionType  
  ignoreHiddenFields  
  useRegex  
FormValue    
  name  
  value  
  index Index of element to populate when duplicate names exist.
Increment    
  variableName  
  strategy  
JScriptCheck    
  script  
  frameType  
  frameName  
KeysItem    
  keys characters / virtual key codes to send
  runInBackground true / false - whether to execute asynchronously
  delaySeconds number of seconds to wait before sending keystrokes
  windowCaption window to wait to have focus before sending keystrokes
Navigation    
  reference Reference for the active reference type. Note: A referenceType must be set prior to setting the reference property.
  targetFrame  
  continueOnFailure  
  referenceType Integer from 1 to 3, indicating type of reference
  index Integer, zero-based, indicating index of reference to Navigate for the active reference type when executed. Note: each reference type maintains its own index, setting the index using this property only sets it for the current active reference, as controlled by referenceType property. This property can be set but is ignored for JavaScript references.
  filterType One of the values "All", "Links", or "Buttons". The referenceType must be set prior to setting filterType.
  eventType  
  isPassive  
  passiveTimeoutMs  
  useRegex Boolean property - set to 'true' or 'false'
MessageBoxItem 
 message
 type
 response
 useRegex
 waitTimeSeconds
Parameter    
  name  
  value  
  method  
PlayContext    
  playPosition  
Request    
  host  
  path  
  postData  
  protocol  
  resource  
  targetFrame  
  label  
  headers  
  multipartBoundary  
  newWindowWidth  
  newWindowHeight  
  formCharset  
  defaultMethod  
  bUseLenientSubrequestCount  
Response    
  timeMs  
  size  
  content  
  totalSize  
  errorFlag  
  errorCode  
  timeStamp  
  logContent  
ResponseCheckItem    
  minSeconds  
  maxSeconds  
  minSizeKB  
  maxSizeKB  
  checkSize  
SaveItem    
  writerClass  
  fileName  
  variableExpression  
  styleSheet  
  exportImages  
  showSavedFile  
  includeResponseContent  
  sendType  
  emailTo  
  emailCC  
  emailSubject  
  appendMode  
  sendAsAttachment  
  frameName  
ScheduleItem    
  scriptType  
  scheduleDelayType  
  scriptFile  
  delayHours  
  delayMinutes  
  inheritVariables  
ScreenShot    
  label  
  scalingPercent  
  fileName  
  saveToFile  
  addLabel  
SpiderItem    
  browseLinks  
  clickButtons  
  captureResponses  
  randomPopulate  
  navigationMode  
  targetType  
  targetFrame  
  loopAutomatically  
  randomWalk  
Step    
  name  
  repeatVariable  
  repetitions  
  repeatType  
  incrementAutomatically  
  incrementAll  
SummaryCheckItem    
  locatorType  
  summaryId  
  summarySelector  
  combineType  
TestItem    
  title  
  template  
ThreadItem    
  maxThreads  
  pauseWhileStarting  
  startGradual  
  startIncrement  
  startInteveralSeconds  
  pauseWhileStopping  
  stopGradual  
  stopIncrement  
  stopInteveralSeconds  
  durationType  
  durationTimeSeconds  
  engine  
  maxIterations  
Timer    
  waitMs  
  cascade  
Variable    
  dataSourceId  
  isAutoVariable  
  autoVariableExpression  
VariableSetter    
  regex  
  variableName  
  valueList  
  regex  
  targetFrame  
  parseVariableReferences  
  isCascading  
  noOverWrite  
  fileName  
WindowControlItem    
  targetType  

Badboy Documentation Generated on Mon Dec 29 22:28:42 EST 2008