Commands to perform tasks with Projects
- The syntax for the commands that perform tasks with Projects
- List of Commands that perform tasks with Projects
The syntax for the commands that perform tasks with Projects
The syntax is as follows
oe.exe /command Parameter name= Parameter value, Parameter name= Parameter value
Where:
oe.exe is the name of the Offline Explorer Enterprise executable file
/command is a valid Offline Explorer Enterprise command name
Parameter name = Parameter valueis one or more optional Parameters, followed by the equals sign ("="), and the required Parameter value.
Notes: 1. Commands may require Parameters to specify how to execute Commands. 2. Commands are not case sensitive.
The following rules must be applied to the syntax of Parameters in command-line interface:
- Command and Parameter must be separated by the space.
- Several Parameters must be separated by commas.
- If a Parameter contains a space, the command and Parameters must be enclosed in double quotation marks
List of Commands that perform tasks with Projects
Command | Description | ||||||||||||||
/New= | Creates new Project The syntax for the /New= command must be as follows: oe.exe "/new=url=<value>,Parameter name= Parameter value, Parameter name= Parameter value Where: url=<value> is the starting URL for the newly created Project. Parameter name= Parameter valueis aParameter specifying the settings for the newly created Project. Notes: 2 You are enabled to specify multiple Parameters to adjust settings for the newly created Project. 2 You are enabled to specify run=true Parameter to start downloading a Project automatically. Example oe.exe "/new=url=http://www.server.com/file.asp,template=Template1,folder=MyFolder, run=true,level=3,url=Additional=DeleteProjectFiles;DeleteProjectSettings; AutoExport=c:export\" Offline Explorer Enterprise will do the following: 1 Create a new Project with the starting URL http://www.server.com/file.asp. 2 Adjust settings for this Project according to the template you specified, and set the Level Limit to 3. 3 Automatically start downloading the Project according to the Project settings. 4 Export the downloaded files to the local directory that you specified. 4 Delete the Project and its setting. 5 Delete the files downloaded for this Project. | ||||||||||||||
/Download | Starts downloading a Project. The syntax for the /Download command must be as follows: oe.exe /Download <Folder_name>/<Number_Project_in_Folder> Where: <Folder name> is a name of a Folder in the Project Tree where the Project belongs <Number_Project_in_Folder> is an ordinal number of a Project in the Folder where the Project belongs. Notes: 1 The Projects specified must be separated by the space(s.) 2 The ordinal numbers of Projects are counted from zero. Example oe.exe /Download Sports/0 Sports/4 The first and the fifth Projects from the Folder “Sports” will be downloaded. 3You are enabled to specify Projects from different Folders. Example oe.exe /Download Sports/3 Auto/5 Space/1 Offline Explorer Enterprise will start downloading of the following Projects: 1The forth Project from the Folder “Sports” 2The sixth Project from the Folder “Auto” 3The second Project from the Folder “Space”. 4 You are enabled to start downloading all Projects from the specified Folder. Example oe.exe Sports/all Offline Explorer Enterprise will start downloading all Projects that belong to the “Sports” Folder. | ||||||||||||||
/Suspend | Pauses the current download temporarily Example oe.exe /Suspend Note: If you suspended downloads to .wdq files, you can specify the .wdq filename extension in the command-line interface to download it into Offline Explorer Pro: oe.exe "c:pathmyqueue.wdq" | ||||||||||||||
/SuspendToFile= | Suspends the current download to a file. Note: You must specify a local directory where the state of the download will be saved. Example oe.exe /SuspendToFile=c:dir ile.wdq | ||||||||||||||
/Resume | Resumes the download that was suspended previously. Example oe.exe /Resume Offline Explorer Enterprise will resume previously suspended download. | ||||||||||||||
/NoMap | Skips creating a Project Map (list of all files downloaded for the Project) | ||||||||||||||
/StartSequencer | Starts sequencer | ||||||||||||||
/Log= | Enables automatic logging to a file. The syntax for the /Log= command must be as follows: oe.exe /Log=<local file> Where: <local file> is a file on your computer where the logging information will be saved. Example oe.exe /log=c:oe ile.log The logging information will be automatically save to c:oe. | ||||||||||||||
/Nolog | Stops saving logging information. Note: If Offline Explorer Pro runs with the /Log= command, start another copy of Offline Explorer Pro with the /Nolog command. | ||||||||||||||
/LogFilter= | Filters the amount of the logging information Example oe.exe /LogFilter=1111101 Note: The string of numbers in the /LogFilter=Command syntax represents fragments of logging information, where 0 – allows, and 1 – disallows to output the corresponding logging information.
| ||||||||||||||
/MaxLogSize= | Enables you to specify the limit of the logging information in Mb Note: By default, if the log file exceeds 100 MBs, Offline Explorer Enterprise erases it and starts saving the logging information from the scratch. Example oe.exe /MaxLogSize=10 Offline Explorer Enterprise will erase the log file when it exceeds 10 Mb. | ||||||||||||||
/ProjectsDir= | Enables you to specify local directory where Projects, Maps and Templates will be saved on your computer. The syntax for the /ProjectsDir=command must be as follows: oe.exe /ProjectsDir=<local directory> Where: <local directory>> is a directory on your computer where Projects, Maps and Templates will be saved. Example oe.exe /ProjectsDir=c:OEProjects Offline Explorer Enterprise will save Projects, Maps and Templates to c:OEProjects | ||||||||||||||
/NoSaveToFile | Skips saving Projects file when exiting the program. Example oe.exe /NoSaveToFile | ||||||||||||||
/Backup= | Creates a backup copy of a Project. The syntax for the /Backup=Command must be as follows: oe.exe /Backup= <local file> <Folder_name>/<Number_Project_in_Folder> Where: <local file> is a file on your computer where the backup copy of the Project will be saved <Folder name> is a name of a Folder in the Project Tree where the Project belongs <Number_Project_in_Folder> is an ordinal number of a Project in the Folder where the Project belongs. Example oe.exe /Backup=c: ile.boe Sports/3 Offline Explorer Enterprise will create a backup copy of the forth Project from the Folder “Sports” and save it to the c: ile on your computer. | ||||||||||||||
/Restore=<folder> | Restores a Project backup file. Note: You must specify a local directory where the backup file has been saved. Example oe.exe /restore="c:pathmybackup.boe" Offline Explorer Enterprise will restore previously created backup file. | ||||||||||||||
/Browse | Browses the specified Project in the Internal Browser. The syntax for the /Browse Command must be as follows: oe.exe /Browse <Folder_name>/<Number_Project_in_Folder> Where: <Folder name> is a name of a Folder in the Project Tree where the Project belongs <Number_Project_in_Folder> is an ordinal number of a Project in the Folder where the Project belongs. Notes: 1 The Projects specified must be separated by the space(s.) 2 The ordinal numbers of Projects are counted from zero. Example oe.exe /Browse Sports/3 The forth Project from the Folder “Sports” will be opened in the Internal Browser. | ||||||||||||||
/FindContents= | Searches the keywords in the downloaded files and saves the list of files with the found keywords to a text file. The syntax for the /FindContents=command must be as follows: oe.exe /FindContents=<Folder_Name>/ |