Tuesday, May 19, 2009

HowToEpipOM: All available jobs through epichannel

$ epichannel -help
-------------------------------------------------------------------------------
EpiChannel -help
EpiChannel Version 7.1.1.0.1293
-------------------------------------------------------------------------------
EpiChannel executes extraction jobs locally or remotely, runs MomentumBuilder,
AggregateBuilder, Scrutiny, RandomPerm, and CreateCurrentViews.

-------------------------------- Example Usage --------------------------------
Run a job:
EpiChannel -l -b -s
-u -d -p
-J
Run a job:
EpiChannel -i -j

Run MomBuilder in ForceRebuild mode:
EpiChannel -i -mom -fb

Run Scrutiny and check the Outbound Marketing Server, the Mart, and AggBuilder
EpiChannel -i -scr AppServer Mart AggBuilder

List completed, running, and pending EpiChannel tasks:
EpiChannel -i -ls -all

Run a job on the remote server:
EpiChannel -i -j -r

Attach to the job with ID 3579 and print its log files as it runs:
EpiChannel -i -a 3579

Kill the job with ID 3579:
EpiChannel -i -k 3579

Run a job; Override the mail configuration specified in the instance storage:
EpiChannel -i -j -mh mail.mydomain.com
-ma martin@mydomain.com -ms it_worked@mydomain.com
-mw something_wrong@mydomain.com -mf it_failed@mydomain.com

Usage Notes:
All command line parameters are case insensitive.
All command line parameters can begin with /, -, or --.
Command line parameters can appear in any order.
-------------------------------- Return Codes ---------------------------------
(0) EPICHANNEL_SUCCESS EpiChannel executed successfully
(1) EPICHANNEL_FAILURE EpiChannel failed as a result of a user or an
environmental error
(2) EPICHANNEL_USERCANCEL EpiChannel failed because it was canceled with
the --kill command.
(3) EPICHANNEL_RUNTIMEEXCEPTION
EpiChannel failed because of an internal error.
Send all log files to [906] Customer
Support.
-------------------------------------------------------------------------------
-h, -?, /?, --help Display this list of command-line options.
-------------------------------------------------------------------------------
-j, --Job Run the specified extraction job.
-t, --TrialRun Simulate execution of the SQL on the source and
destination databases without making any changes
to the data.
--LogRows Log the contents of the first rows of
every extraction statement.
-#, --MaxSelects
The maximum number of rows to fetch in any SQL
statement.
-f, --ForceRestart Ignore previous execution history and start
executing job from the beginning.
-------------------------------------------------------------------------------
-mom, --MomBuild Run MomentumBuilder. Generate or update the
accelerators required for generating lists and
campaigns.
-npt, --NumParallelThreads
The number of concurrent accelerator creation
queries issued.
-f, --ForceRestart Ignore previous execution history and build all
accelerators requested by the metadata
-fb, --ForceRebuild Rebuild accelerators from scratch. Do not
attempt to incrementally update.
--NoMirror Run MomBuilder against the currently active
datamart partition.
-------------------------------------------------------------------------------
-agg, --AggBuild Run AggregateBuilder. Build aggregate tables to
improve query response time.
-------------------------------------------------------------------------------
-scr, --Scrutiny ...
Run the specified internal consistancy checks on
the EpiCenter. consists of one or
more of the options below separated by spaces.
All Run all Scrutiny checks.
Meta Run Scrutiny checks on the metadata.
Mart:Next Run Scrutiny checks on the EpiMart (in the next
space).
Mart:Current Run Scrutiny checks on the EpiMart (in the
current space).
Mart:Prev Run Scrutiny checks on the EpiMart (in the
previous space).
Op Run Scrutiny checks on the EpiOp.
AppServer Run Scrutiny checks required by the Outbound
Marketing Server.
EpiChannel Run Scrutiny checks required for EpiChannel
extraction.
AggBuilder Run Scrutiny checks required by
AggregateBuilder.
MomBuilder Run Scrutiny checks required by MomentumBuilder.
SchemaGen Run Scrutiny checks required for adaptive schema
generation.
Warning Run Scrutiny checks for warnings in addition to
errors.
-------------------------------------------------------------------------------
-rnd, --RandPerm Build a random sampling table used for sampling
of demographic dimensions and for populating
random lists.
-------------------------------------------------------------------------------
-ccv, --CreateCurrentViews Rebuild external reporting views which select
the currently active versions of the base tables.
-------------------------------------------------------------------------------
-dae, --Daemon Spawn a daemon process that checks the metadata
for remote requests to execute EpiChannel, and
acts on those requests.
-------------------------------------------------------------------------------
-stop, --StopDaemon Request a running daemon to kill all the remote
jobs it has spawned and exit.
-------------------------------------------------------------------------------
-ls, --List List currently running and pending EpiChannel
executions.
--All Show completed instances as well.
-------------------------------------------------------------------------------
-a, --Attach Attach to and print the logs from the specified
execution instance of EpiChannel. The instance
can be currently running or completed. Get
by executing the --List command.
-------------------------------------------------------------------------------
-k, --Kill Kill the specified running instance of
EpiChannel. Get by executing the
--List command.
------------------------------- General Options -------------------------------
-b, --DBVendor The name of the vendor of the dbms on which the
SQLServer EpiMeta database resides.
Oracle
-s, --Server The name of the server where the EpiMeta
database resides.
-u, --UserName The username of the EpiMeta database. Pass ""
to request the use of operating system level
authentication.
-d, --DBName The database name of the EpiMeta database.
This parameter is not required on Oracle.
-p, --Password The password for the user of the EpiMeta database
-pt, --Port The port to use to connect to the EpiMeta
database. If not supplied, database type default
is used.
-disableDBLog Disable logging to the Epiop database
-int, --Interactive Run EpiChannel in interactive mode. This is
incompatible with the --RemoteLaunch option and
the --Noninteractive option.
-nonint, --Noninteractive Disable use of interactive mode for job steps
whose debug level is set to interactive. This
option is incompatible with the --Interactive
option.
-r, --RemoteLaunch Request that the remote daemon process launch an
EpiChannel instance with the specified command
line (excluding --RemoteLaunch and its options).
-dt, --Detach Dont attach to the remotely spawned process and
dont print its log files. Send the request to
the Daemon process and exit immediately.
-dwc, --DieWithClient Request that the remotely spawned EpiChannel
execution instance kill itself if the connection
with this client is lost.
-i, --InstanceName The name of an EpiCenter instance stored
locally. Connection information and other
EpiChannel options are taken from this local set
of defaults. Options specified via command line
parameters override options specified inside the
local instance storage.
--InstallRootDir
The directory in which this version of [906]
Outbound Marketing is installed.
-l, --LoggingDir
The directory where logging files will be
created.
--DisableDBLog Disables logging to the EpiOp data store. This
option should only be necessary if DB-Logging is
causing short jobs that would otherwise run
in only a few minutes to run for a long time.
-sch, --Scheduler Directs EpiChannel to fail if a previously
failed job failed on a job step that had OnError
action set to ManualRepeat. This should be used
whenever EpiChannel is being called from an
automated scheduler.
-ma, --MailAdmin The e-mail address of the administrator for your
application, which is used as the return address
for automatic e-mail notification of job status.
-mh, --MailHost The hostname of the SMTP host computer through
which e-mail is to be sent.
-ms, --MailSuccess
The address to which an e-mail containing
EpiChannel log files is to be sent on successful
completion of an extraction job. Multiple
addresses can be separated by commas (without
spaces).
-mw, --MailWarning
The address to which an e-mail containing a
warning message is to be sent when a warning is
generated during execution of an extraction job.
Multiple addresses can be separated by commas
(without spaces).
-mf, --MailFailure
The address to which an e-mail containing
EpiChannel log files is to be sent on failure of
an extraction job. Multiple addresses can be
separated by commas (without spaces).
-------------------------------------------------------------------------------
EpiChannel| |Completed|
| | |

Labels: