Run a task from command line

SPListX command line feature allows the user to instantiate a task from DOS command prompt anytime after an export task has been created using SPListX's task wizard.

To run a SPListX export task from command line:

1.

Usage:
SPListXTaskRunner
<task name>[/profile:user name] [/u:user name] [/p:password] [/noprompt]

where,

SPListXTaskRunner

Name of the SPListX Task Runner application. Specify absolute path where the SPListXTaskRunner located.

For example:
C:\Program Files\SPListX\SPListXTaskRunner

task name

Name of the SPListX Task to be run from DOS command prompt. Enclose the task name in double quotes.

For example:
"Sample Task1"

/profile Denotes profile name stored in the current user context using SPListX's Profile Manager, in which SPListX task must be run. Enclose the user name in double quotes.

For example:
"/profile:voyager\adminuser"
"/profile:contoso\johndoe"
"/profile:johndoe@contoso.com"
"/profile:johndoe"
/u

Denotes user name context in which SPListX task must be run in the domain\username format. Enclose the user name in double quotes.

For example:
"/u:voyager\administrator"
"/u:contoso\johndoe"
"/u:johndoe@contoso.com"
"/u:johndoe"

/p

Denotes the password for the user name specified in /u parameter. Enclose the password in double quotes.

For example:
"/p:2ab45fb"

/noprompt

This optional flag suppresses SPListX's login dialog prompt to enter user credentials to connect to SharePoint

2. If /noprompt flag is not used, then the Credential Dialog will appear as shown below. The given credential will be used to connect to SharePoint.

3.

The export task will be reported in a new dialog as shown below:

Runtime statistics:

  1. Number of items processed - Shows the number of line items that have been processed at any given instance.

  2. Total size processed (in KB) - Shows the total size of files that were exported from SharePoint at any given instance, including documents, version history, and file attachments.

  3. Total items processed - Shows the number of folders and items (documents & list items) exported from SharePoint at any given time instance. The count does not include version histories and file attachments.

  4. Elapsed Time - Shows the elapsed time from the instance the export task started or commenced.

4.

Once the export task is complete, click Refresh button available in Task History pane in SPListX main application. A new entry will be added in Task History section, where you can view the export activity performed when the task ran last.

Examples of invoking an export task from the command prompt:

 

C:\Program Files\SPListX> SPListXTaskRunner "mytask1" "/u:voyager\administrator" "/p:2az" /noprompt

C:\Program Files\SPListX> SPListXTaskRunner "Sample Task1" "/u:voyager\adminuser" "/p:2az$%&" /noprompt

C:\Program Files\SPListX> SPListXTaskRunner "Sample Task2" "/profile:voyager\adminuser" /noprompt

D:\>"C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task3" "/u:voyager\adminuser" "/p:2az$%&" /noprompt

D:\>"C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task3" "/u:voyager\adminuser" "/p:2az$%&" /noprompt  

5.

For import tasks configured with SharePoint Online sites using Web Single Sign-on credential, only task name has to be provided as input as shown below. Other optional parameters except "/noprompt" are ignored for this authentication type.

C:\Program Files\SPListX> SPListXTaskRunner "Office 365 import" /noprompt

6.

DOS batch file examples:

  • To execute SPListX task one by one from a batch file:

    "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task1" "/u:johndoe@contoso.com" "/p:test" /noprompt
    "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task2" "/u:voyager\adminuser" "/p:2az$%&" /noprompt
    "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task3" "/u:johndoe@contoso.com" "/p:test" /noprompt "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task4" "/profile:johndoe@contoso.com"  /noprompt

  • To execute multiple SPListX tasks simultaneously:
    start "cmd" "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task1" "/u:voyager\user1" "/p:ctest1" /noprompt
    start "cmd" "C:\Program Files\SPListX\SPListXTaskRunner" "Sample Task2" "/u:voyager\user2" "/p:ctest2" /noprompt