Package com.jedox.etl.components.scriptapi

Class JobAPI

java.lang.Object

com.jedox.etl.core.scriptapi.ScriptAPI

com.jedox.etl.components.scriptapi.BaseAPI

com.jedox.etl.components.scriptapi.ExecutionAPI

com.jedox.etl.components.scriptapi.JobAPI

All Implemented Interfaces:

com.jedox.etl.core.scriptapi.IPropertiesAware, com.jedox.etl.core.scriptapi.IScriptAPI

public class JobAPI
extends ExecutionAPI

Use with binding API, only available in Integrator jobs. Use it to define workflows for ETL processes.

Constructor Summary

Constructors

Constructor	Description
JobAPI()

Method Summary

Modifier and Type	Method	Description
State	executeJob(String name)	Executes a job with all variable values set with BaseAPI.setProperty(String, String).
State	executeLoad(String name)	Executes a load with all variable values set with BaseAPI.setProperty(String, String).
State	getConnectionMetadata(String name, String selector, Properties metadataProps)	Returns the metadata (see Metadata Extract) of a connection with all variable values set with BaseAPI.setProperty(String, String).
State	getJobState()	Deprecated, for removal: This API element is subject to removal in a future version. This method is deprecated and will be removed.
Object	getMailer()	Returns a MailAPI to send emails via SMTP.
State	testConnection(String name)	Tests a connection with all variable values set with BaseAPI.setProperty(String, String).
State	testJob(String name)	Tests a job with all variable values set with BaseAPI.setProperty(String, String).
State	testLoad(String name)	Tests a load with all variable values set with BaseAPI.setProperty(String, String) .
State	testSource(String name)	Tests a source with all variable values set with BaseAPI.setProperty(String, String).
void	tracepoint(Object... watches)	Creates a tracepoint for the currently executed script.

Methods inherited from class com.jedox.etl.components.scriptapi.ExecutionAPI

getSource, getState, initSource, initSource, isNumeric

Methods inherited from class com.jedox.etl.components.scriptapi.BaseAPI

clearProperties, getComponentName, getConfigSetting, getConfigSetting, getGlobalConnections, getLocalFilesDir, getProjectName, getProperty, setProperty

Methods inherited from class com.jedox.etl.core.scriptapi.ScriptAPI

getDefaultImports, getExtensionPoint, getParameters, setAPIDescriptor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobAPI

public JobAPI()

Method Details

executeJob

public State executeJob(String name)
                 throws com.jedox.etl.core.component.ETLRuntimeException

Executes a job with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the job to execute

Returns:

the State of the executed job

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during job execution

executeLoad

public State executeLoad(String name)
                  throws com.jedox.etl.core.component.ETLRuntimeException

Executes a load with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the load to execute

Returns:

the State of the executed load

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during load execution

testJob

public State testJob(String name)
              throws com.jedox.etl.core.component.ETLRuntimeException

Tests a job with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the job to test

Returns:

the State of the completed job test

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during job test

testLoad

public State testLoad(String name)
               throws com.jedox.etl.core.component.ETLRuntimeException

Tests a load with all variable values set with BaseAPI.setProperty(String, String) .

Parameters:

name - the name of the load to test

Returns:

the State of the completed load test

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during load test

testSource

public State testSource(String name)
                 throws com.jedox.etl.core.component.ETLRuntimeException

Tests a source with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the source to test

Returns:

the State of the completed source test

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during source test

testConnection

public State testConnection(String name)
                     throws com.jedox.etl.core.component.ETLRuntimeException

Tests a connection with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the connection to test

Returns:

the State of the completed connection test

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during connection test

getConnectionMetadata

public State getConnectionMetadata(String name,
 String selector,
 Properties metadataProps)
                            throws com.jedox.etl.core.component.ETLRuntimeException

Returns the metadata (see Metadata Extract) of a connection with all variable values set with BaseAPI.setProperty(String, String).

Parameters:

name - the name of the connection

selector - the connection specific characteristic (see Metadata Extract)

metadataProps - Properties with additional filter parameters for the characteristic provied with selector, or null

Returns:

the State of the executed metadata execution, State.getData() returns the result

Throws:

com.jedox.etl.core.component.ETLRuntimeException - if an error occurs during metadata execution

getJobState

@Deprecated(forRemoval=true)
public State getJobState()

Deprecated, for removal: This API element is subject to removal in a future version.

This method is deprecated and will be removed. Use ExecutionAPI.getState() instead.

Gets the State of the current execution including start date, first error message (if one exists) and status.

Returns:

the State of the current execution

tracepoint

public void tracepoint(Object... watches)

Creates a tracepoint for the currently executed script.

Parameters:

watches - an array of Objects to add to the tracepoint

getMailer

public Object getMailer()

Returns a MailAPI to send emails via SMTP.

Overrides:

getMailer in class ExecutionAPI

Returns:

a MailAPI