ePublisher AutoMap Command Line Interface

ePublisher AutoMap : ePublisher AutoMap Command Line Interface

ePublisher AutoMap Command Line Interface

Although ePublisher AutoMap includes a graphical user interface (GUI) to create, edit, and schedule jobs, a command line interface is also available and included with the standard ePublisher AutoMap product release. The command line interface enables scripting control of ePublisher AutoMap from the Windows command line interface.

This chapter includes the following information:

This chapter is specific to running ePublisher AutoMap from the command line. It is not a guide on using the Windows command line interface or writing command line scripts.

Running ePublisher AutoMap on the command line

ePublisher AutoMap is accessed from the command line as any Windows command line application would be. In fact, the ePublisher AutoMap command line application is called WebWorks.Automap.exe. This application is installed at the root of your ePublisher AutoMap installation. The default location is:

C:\Program Files\WebWorks\ePublisher AutoMap\WebWorks.AutoMap.exe

If you chose a different location when you installed ePublisher AutoMap, then WebWorks.Automap.exe will be installed to that location and your paths should be adjusted accordingly.

WebWorks.Automap.exe depends on other files installed in the ePublisher AutoMap directory. You cannot move or copy WebWorks.Automap.exe independently.

Running WebWorks.AutoMap.exe:

1.	Open a Windows command line interface (DOS window).

2.	Type cd “cd”.

If you installed ePublisher AutoMap to a directory other than the default, use the corresponding path.

3.	Type WebWorks.AutoMap.exe and hit the Enter key.

Command line usage

If you run the command line interface without options or parameters, ePublisher AutoMap will return a typical usage clause:

WebWorks ePublisher AutoMap 9.3.20098.0

Usage: WebWorks.Automap.exe [-f|--nonotify] [-s|--stagingdir directory]

[-u|--userformats directory] [-t|--target target1,target2]

ePublisher Express project or Automap job file

The first line displays the application name followed by the version number. In this case, the version is 9.3.20098.0. This information is useful to determine the exact version of the product that you have installed.

Next, is the usage clause itself describing how to run ePublisher AutoMap. Shown is the ePublisher AutoMap command line application WebWorks.AutoMap.exe followed by the options that can be passed to the command line, and the expected application parameter.

The ePublisher AutoMap command line options are described in more detailed in the next section. The command line parameter in this case is either a ePublisher Pro project (.wrp) or ePublisher AutoMap job file (.waj). Just as the ePublisher AutoMap GUI interface can schedule a project-based or stationery-based job, the ePublisher AutoMap command line can schedule a ePublisher Pro project or ePublisher AutoMap job.

The following is an example of how the ePublisher AutoMap command line application may be called:

WebWorks.AutoMap.exe -s=”c:\Jobs\Staging” –t=”WebWorks Help” “c:\Projects\MyProject.wep”

In this case, ePublisher AutoMap will run the MyProject.wep job located in c:\Projects. The staging folder is set to c:\Jobs\Staging and only the WebWorks Help target will be generated.

Command line options

As with any command line application, ePublisher AutoMap includes command line options to specify how WebWorks.AutoMap.exe should run. The table below lists all of the available ePublisher AutoMap command line options.

Option

Function

-u

--userformats=directory path

The directory containing the user formats. This setting overrides the value in the ePublisher AutoMap preferences. See Setting the User Formats Folder location.

The default value is taken from the ePublisher AutoMap preferences.

-t

--target=target1, target2,…

Builds the specified targets only. This option is only used when passing a ePublisher Pro project (.wrp). See Target Selection.

The default value is to build all targets.

-n

--nodeploy

Do not deploy output, only generate. This setting overrides any Deploy setting in the ePublisher AutoMap job or ePublisher Pro project. See Target Info.

The default value is to use the Deploy setting specified in the ePublisher AutoMap job or ePublisher Pro project.

-c

--clean

Build from scratch and throw away any cached information. This option is only used when passing a ePublisher Pro project (.wrp). This option is equivalent to performing a Regenerate All in ePublisher Pro.

The default value is to only generate what is necessary and use any available cached information.

-l

--cleandeploy

Delete everything in the deploy location before deploying the next generation. This is to ensure that everything located in the deploy folder is only from the last generation.

-s

--stagingdir=directory path

Specifies the staging directory to use. This option is only used when passing a ePublisher AutoMap job (.waj). This setting overrides the value in the ePublisher AutoMap preferences. See Setting the Staging Folder location.

The default value is taken from the ePublisher AutoMap preferences.

-f

--nonotify

Do not send an email notification when this job completes. This setting overrides the value in the ePublisher AutoMap preferences. See Notification.

The default value is taken from the ePublisher AutoMap preferences.

-k

--keys

Displays the list of license keys installed in ePublisher AutoMap. See Configuring license keys.

-d | --deployfolder <path>

Allows you to specify alternate deployment path on the fly

Specifying command line options

Command line options are specified on the command line after the application name as with any command line application. Multiple command line options are separated by a space. Here are some additional notes concerning ePublisher AutoMap command line options:

The command line options have both shortened and verbose formats. For example, the clean option can be specified as –c or --clean. Both mean exactly the same thing and it is possible to mix the shortened and verbose formats across the options.

Some options require specifying additional information. For example, the staging folder option is specified as --stagingdir=directory path. The equal sign must be included without spaces on either side.

In cases where directory paths are specified, it is recommended, but not required, to include those paths in double quotes. This is to handle any paths that may contain spaces. For example, c:\projects will work as expected; however, c:\my projects will fail. The correct format for the latter is “c:\my projects”.

The --target option is capable of taking one or more target names. Multiple target names are separated with commas but no spaces. For example, --target=one, two, three will fail. The correct format is --target=one,two,three (no spaces).

Command line usage

Command line options

Specifying command line options

XHTML 1.0 CSS WAI-A