JobBuilder - DemandTools Scenario Syntax

Modules that can be Scheduled include:

• MassEffect
• MassImpact
• Reassign Ownership
• MassBackup
• BulkBackup
• Single Table Dedupe
• Lead Conversion 
• Find/Report ID's
• EmailConnect

PowerGrid and ReportEdit cannot be scheduled

Things to know before scheduling a scenario

• Auto login must be enabled in DemandTools
• Must have access to Windows Task Scheduler
• The scheduled job will only run when the user is logged in to Windows at the specified interval
• If using a laptop, it must be plugged in. Scheduled jobs will not execute on a laptop running off of battery power

Notes on Scenario & Input/Output File Paths

• Order of file paths: scenario file path followed by the input/output file path (if needed)
• A space is needed between file paths and parameters
• All file paths should be surrounded by double quotes
• Scenario File Path: Specifies where to locate the scenario to execute
  • Example of a MassImpact scenario file path (will vary by user): "C:\Users\AB\Documents\DemandToolsData\MassImpact Scenarios\DT23_Account(BillingZip)_ZipCodeClean.MIxml"
• Input/Output File Path: Specifies where to locate or place the file
  • Not specifying a worksheet/table name: "C:\Users\AB\Desktop\JobBuilderTrainingExport.xlsx"
  • Specifying a worksheet/table name: "C:\Users\AB\Desktop\JobBuilderTrainingExport.xlsx" "Data"
    • When using .accdb, .mdb, .xls, .xlsx files as the input file, you MUST indicate the worksheet to use
  • Worksheet/table names are not applicable for .csv files

Module Specific Syntax

MassEffect - Export

Required Parameters

• Scenario file path
• Output file path
• Example: "C:\Users\AB\Documents\DemandToolsData\MassEffect\Lead Export.DExml" "C:\Users\AB\Desktop\LeadExport.xlsx"

MassEffect - Insert, Update, Upsert, Delete or UnDelete

Required Parameters

• Scenario file path
• Input file path
• Example: "C:\Users\AB\Documents\DemandToolsData\MassEffect\Account Insert.MExml" "C:\Users\AB\Documents\Account Insert.csv"

MassImpact

Required Parameters:

• Scenario file path
• Example: "C:\Users\AB\Documents\DemandToolsData\MassImpact Scenarios\DT23_Account_BillingCountry_ISO 3Character.MIxml"

Reassign Ownership

Required Parameters

• Scenario file path
• Example: "C:\Documents and Settings\Administrator\My Documents\DemandToolsData\Reassign Ownership Scenarios\NorthEast_Territory.ROxml"

When a Reassign Ownership scenario uses an input file (instead of where conditions), the input file and worksheet are saved as part of the scenario.  **If the input file cannot be found (i.e. it was deleted or moved) the scheduled job will fail.
 

MassBackup

Required Parameters

• Output file path
  • .mdb file type only
  • All tables will be included in the backup
  • MassBackup can only run in the 32 bit version of DemandTools
• Example: "C:\Users\AB\Desktop\MayMassBackUp.mdb"

** If you are using the 64 bit version of DemandTools, utilize the BulkBackup module

BulkBackup

Required Parameters

• Scenario file path
• Output file path / Directory for .csv 
  • When utilizing export to .CSV:
    • File encoding will default to use the encoding saved in the scenario
    • To overwrite the encoding saved in the scenario add the encoding AFTER the directory name, e.g. utf8
    • Example .csv file with encoding specified: "C:\Users\Olivia\Documents\DemandToolsData\Db org Account BBU.BBxml" "C:\Users\Olivia\Documents\Bulk BackUp" utf8

                     

• When utilizing export to .MDB (32 bit only) or .ACCDB Files:
  • Cannot overwrite encoding
  • Example .accdb file: "C:\Users\AB\Documents\DemandToolsData\AccountBBU.BBxml" "C:\Users\AB\Documents\Bulk BackUp\Account BackUp.accdb"

                 

Single Table Dedupe: Complete the Merge

Required Parameters:

• Scenario file path
  • Example: "C:\Users\AB\Documents\DemandToolsData\Scenarios\Contact\Contacts_WITHIN AN ACCOUNT_RIGID Criteria.ddXML"

             

A Single Table Dedupe scenario file extension can be .stddxml or .ddxml; depending on the DemandTools version with which it was created. Scenarios saved pre DemandTools version 2.7 will have the .ddxml extension.

Single Table Dedupe:  Export Found Duplicates (Do Not Merge)

• Facilitates the export of the duplicate grid after the master rule has been applied
• Duplicates WILL NOT BE MERGED
• To ensure the merge does not execute, the addition of an export file path is required after the scenario file path
• An additional “formatted” parameter can be added to export a formatted .xls file (export file type must be .xls)
  • The output file name will have "_YYYYMMDD_X" automatically appended

Required Parameters:

• Scenario file path
• Output file path
• Optional formatted parameter
• Supported file types: .xls (formatted or raw data file),.xlsx,.csv,.tab,.accdb,.mdb (32 bit version only),.dbf,.xml,.sql

Examples

• Export found duplicate sets to a formatted .xls file:   "C:\Users\AB\Documents\DemandToolsData\Scenarios\Account\Accounts(Billing)_SEMI Rigid Criteria.ddXML" "C:\Users\AB\Documents\AcctSemiRigidDedupeExport.xls" formatted

       

• Export found duplicate sets to a raw .csv file:  "C:\Users\AB\Documents\DemandToolsData\Scenarios\Account\Accounts(Billing)_SEMI Rigid Criteria.ddXML" "C:\Users\AB\Documents\AcctSemiRigidDedupeExport.csv"

       

Lead Conversion:  Complete the Conversion

Required Parameters:

• Scenario file path
  • Example: "C:\Users\AB\Documents\DemandToolsData\Lead Conversion Scenarios\Lead Conversion Rigid.LCxml"

               

Lead Conversion:  Export Found Matches (do not convert)

• Lead Conversion can export found matches from the results grid vs. proceeding with the conversion
• To schedule a results export only:
  • Add the output file path after the scenario file path
  • An additional parameter can be added to export a formatted .xls file (applicable only to .xls) 
  • The output files (up to 3) will use the output name specified with _{Contact/Account/FinalMatch}_YYYYMMDD_X appended
  • Supported file types: .xls (formatted or raw data file), .xlsx, .csv, .tab, .accdb, .mdb (32bit version only), .dbf, .xml, .sql

Required Parameters:

• Scenario file path
• Output file path
• Optional formatted parameter
  • Example: "C:\Users\AB\Documents\DemandToolsData\Lead Conversion Scenarios\Lead Conversion Rigid.LCxml" "C:\Users\AB\Desktop\LCMatches.xls" formatted

                  Do not process the conversion, just export found matches to a formatted .xls file
                 
                 Output File Name will be: LCMatches_YYYYMMDD_X.xls, and it will be the formatted
                 xls version

• Example: "C:\Users\AB\Documents\DemandToolsData\Lead Conversion Scenarios\Lead Conversion Rigid.LCxml" "C:\Users\AB\Desktop\LCMatches.csv"

         Do not process the conversion, just export found matches to raw .csv files

       

        Output File Name(s) will be: LCMatches_Contact_YYYYMMDD_X.csv,

        LCMatches_Account_YYYYMMDD_X_1.csv,

        LCMatches_FinalMatch_YYYYMMDD_X_1.csv

Lead Conversion:  Populate Account IDs (do not convert)

Lead Conversion can populate a Lead field with its matching Account's ID vs. proceeding with the actual conversion.

Required Parameters

• Scenario file path
• populateaccountids:lead field to be updated
  • Example: "C:\Users\AB\Documents\DemandToolsData\Lead Conversion Scenarios\Lead Conversion Rigid.LCxml" populateaccountids:Matching_Account__c

               
                **Do not put quotes around the keyword parameter
                **A space is required between the end quotes of the scenario file path and the
                   keyword parameter

Find/Report IDs

Required Parameters

• Scenario file path
• Input file path
• Output file path
  • Example: "C:\Users\AB\Documents\DemandToolsData\FindIDs\Lead Find.FIDsxml" "C:\Users\AB\Documents\Leads to find.xlsx" "New Leads" "C:\Users\AB\Documents\Leads matched.xlsx"

                 

EmailConnect

Required Parameters:

• Scenario file path
  • Example: "C:\Users\AB\Documents\DemandToolsData\EmailConnect Scenarios\MonthlyUpdate.ECxml"