Index (ETL-Components 25.1 API)

A B C D E F G I J L M N O R S T U V W Z
All Classes and Interfaces|All Packages

A

addAttachment(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Adds an email attachment.
addBccRecipient(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Adds a blind carbon copy email recipient (Bcc)).
addCcRecipient(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Adds a carbon copy email recipient (Cc)).
addRecipient(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Adds an email recipient (To).

B

BaseAPI - Class in com.jedox.etl.components.scriptapi: Scripting API basic methods usable everywhere.
BaseAPI() - Constructor for class com.jedox.etl.components.scriptapi.BaseAPI

C

clearProperties() - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Clears all variables currently set with BaseAPI.setProperty(String, String).
close() - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Closes all processors created with initSource(String) or initSource(String, String, int)
close() - Method in class com.jedox.etl.components.scriptapi.Source: Closes the source.
com.jedox.etl.components.scriptapi - package com.jedox.etl.components.scriptapi: Integrator Scripting API

D

data(String, String, String[]) - Method in class com.jedox.etl.components.scriptapi.OlapAPI: Returns the cell value of a cube in a database referenced by a JedoxOlap connection.
delete(String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Deletes the file or directory referenced by a file-based connection in its location.

E

Element - Class in com.jedox.etl.components.scriptapi: An element of a tree-based source, represents an IElement.
enableAuth(boolean) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
enableTLS(boolean) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
erename(String, String, String[], String[]) - Method in class com.jedox.etl.components.scriptapi.OlapAPI: Renames a list of elements of a dimension in a database referenced by a JedoxOlap connection.
erename(String, String, String, String) - Method in class com.jedox.etl.components.scriptapi.OlapAPI: Renames a single element of a dimension in a database referenced by a JedoxOlap connection.
executeJob(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Executes a job with all variable values set with BaseAPI.setProperty(String, String).
executeLoad(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Executes a load with all variable values set with BaseAPI.setProperty(String, String).
ExecutionAPI - Class in com.jedox.etl.components.scriptapi: Common methods available for jobs and functions.
ExecutionAPI() - Constructor for class com.jedox.etl.components.scriptapi.ExecutionAPI
exists() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Tests whether the file or directory referenced by this FileInfo exists.

F

FileAPI - Class in com.jedox.etl.components.scriptapi: Use with binding FILE to work with files and folders in file-based connections of Integrator projects.
FileAPI() - Constructor for class com.jedox.etl.components.scriptapi.FileAPI
FileInfo - Class in com.jedox.etl.components.scriptapi: Handle to access information about a file or directory referenced by a file-based connection.
FunctionAPI - Class in com.jedox.etl.components.scriptapi: Use with binding API, only available in functions of Integrator transforms.
FunctionAPI() - Constructor for class com.jedox.etl.components.scriptapi.FunctionAPI

G

getAbsolutePath() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Deprecated.
This method is deprecated and will be removed in an upcoming release, use FileInfo.getPath() instead.
getAttachmentsList() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the attachments added to the current email.
getAttributeValue(String) - Method in class com.jedox.etl.components.scriptapi.Element: Returns the value of an attribute of this element.
getBccList() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the list of blind carbon copy recipients.
getCalculationCount() - Method in class com.jedox.etl.components.scriptapi.FunctionAPI: Gets the number of times a function has been calculated in the source.
getCcList() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the list of carbon copy recipients.
getChildCount() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the number of children of this element.
getChildren() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the children of this element.
getColumnString(String) - Method in class com.jedox.etl.components.scriptapi.Source: Returns the value of a column in the current row as String.
getColumnValue(String) - Method in class com.jedox.etl.components.scriptapi.Source: Returns the value of a column in the current row.
getComponentName() - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Gets the name of the current Integrator component (function or job).
getConfigSetting(String) - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Gets the value of a property from SettingsManager for the current scope (global projects or the current project's model).
getConfigSetting(String, String) - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Gets the value of a property from SettingsManager for a given scope (i.e. the technical name of a model).
getConnection(String) - Method in class com.jedox.etl.components.scriptapi.OlapAPI: Opens a connection to the OLAP server from a JedoxOlap connection.
getConnectionMetadata(String, String, Properties) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Returns the metadata (see Metadata Extract) of a connection with all variable values set with BaseAPI.setProperty(String, String).
getData() - Method in class com.jedox.etl.components.scriptapi.State: Returns the result of this execution as a string.
getDatabase(String) - Method in class com.jedox.etl.components.scriptapi.OlapAPI: Opens a connection to the OLAP server from a JedoxOlap connection and returns an IDatabase object for the database of the JedoxOlap connection.
getEmailFromAddress() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getEmailList() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the list of email recipients (To).
getEmailMsgTxt() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the message text (BODY) of the email.
getEmailMsgTxtSubType() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getEmailSubjectTxt() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Returns the email subject.
getErrors() - Method in class com.jedox.etl.components.scriptapi.State: Returns the number of errors that occurred in this execution.
getExecutionId() - Method in class com.jedox.etl.components.scriptapi.State: Returns the internal execution id of this execution.
getExecutionParentId() - Method in class com.jedox.etl.components.scriptapi.State: Returns the execution id of the parent execution which has started the execution represented by this state.
getFileInfo(String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Retrieves information of the file or directory referenced by a file-based connection.
getFilename(String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Returns the filename as specified in the connection definition.
getFirstErrorMessage() - Method in class com.jedox.etl.components.scriptapi.State: Returns the error message of the first error occurring in this execution.
getGlobalConnection(String) - Method in class com.jedox.etl.components.scriptapi.OlapGlobalAPI: Returns a global connection defined in Administration → Connections.
getGlobalConnections(String) - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated and will be removed.
getJobState() - Method in class com.jedox.etl.components.scriptapi.JobAPI: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated and will be removed. Use getState() instead.
getLocalFilesDir() - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated and will be removed. Use FileAPI to work with local files.
getLog() - Method in class com.jedox.etl.components.scriptapi.State: Returns the complete execution log of this execution.
getLog(String) - Method in class com.jedox.etl.components.scriptapi.State: Returns the execution log of this execution filtered by log level.
getMailer() - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated and will be removed, use JobAPI.getMailer() instead.
getMailer() - Method in class com.jedox.etl.components.scriptapi.JobAPI: Returns a MailAPI to send emails via SMTP.
getName() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the name of this element.
getName() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Returns the name of the file or directory referenced by this FileInfo.
getName() - Method in class com.jedox.etl.components.scriptapi.State: Returns the name of this execution (e.g.
getParentCount() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the number of parents of this element.
getParents() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the parents of this element.
getPath() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Returns the path of the file or directory referenced by this FileInfo.
getPosition() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the position of this element in a tree.
getProjectName() - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Gets the name of the current Integrator project.
getProperty(String) - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Gets the current value of an Integrator variable during an execution.
getSize() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Returns the size of the file or directory referenced by this FileInfo.
getSmtpAuthPwd() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getSmtpAuthUser() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getSmtpHostName() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getSmtpPort() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns null. SMTP settings are now configured in Jedox Cloud Console.
getSource(String) - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Gets an existing Source for a given name.
getStartDate() - Method in class com.jedox.etl.components.scriptapi.State: Returns the time at which this execution started.
getState() - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Gets the State of the current execution including start date, first error message (if one exists) and status.
getStatus() - Method in class com.jedox.etl.components.scriptapi.State: Returns the status of this execution (e.g.
getStopDate() - Method in class com.jedox.etl.components.scriptapi.State: Returns the time at which this execution terminated.
getTreeElement() - Method in class com.jedox.etl.components.scriptapi.FunctionAPI: Gets the currently processed element of a tree (only for functions inside of TreeElement transforms)
getType() - Method in class com.jedox.etl.components.scriptapi.Element: Returns the type of this element.
getType() - Method in class com.jedox.etl.components.scriptapi.State: Returns the type of this execution (e.g.
getUserName() - Method in class com.jedox.etl.components.scriptapi.State: Returns the name of the user who has started this execution.
getWarnings() - Method in class com.jedox.etl.components.scriptapi.State: Returns the number of warnings that occurred in this execution.

I

initSource(String) - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Initializes a Source for a given name (extract or transform) with no tree format and processes all rows.
initSource(String, String, int) - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Initializes a Source for a given name (extract or transform).
isAuth() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns false. SMTP settings are now configured in Jedox Cloud Console.
isDirectory() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Tests whether the file referenced by this FileInfo is a directory.
isFile() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Tests whether the file referenced by this FileInfo is a normal file.
isNumeric(String) - Method in class com.jedox.etl.components.scriptapi.ExecutionAPI: Tests if a given string is numeric.
isOK() - Method in class com.jedox.etl.components.scriptapi.State: Tests if this execution state's result code is ok.
isTls() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns false. SMTP settings are now configured in Jedox Cloud Console.
isTrustAllServers() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method returns false. SMTP settings are now configured in Jedox Cloud Console.

J

JobAPI - Class in com.jedox.etl.components.scriptapi: Use with binding API, only available in Integrator jobs.
JobAPI() - Constructor for class com.jedox.etl.components.scriptapi.JobAPI

L

lastModified() - Method in class com.jedox.etl.components.scriptapi.FileInfo: Returns the time that the file or directory referenced by this FileInfo was last modified.

M

MailAPI - Class in com.jedox.etl.components.scriptapi: Utility class to send emails via SMTP, only available in Integrator jobs.
MailAPI() - Constructor for class com.jedox.etl.components.scriptapi.MailAPI
mkdirs(String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Creates the directory referenced by a file-based connection, including any necessary but nonexistent parent directories.

N

nextRow() - Method in class com.jedox.etl.components.scriptapi.Source: Sets the row cursor to the next row of data from the source.

O

OlapAPI - Class in com.jedox.etl.components.scriptapi: Use with binding OLAP to work with Jedox OLAP databases.
OlapAPI() - Constructor for class com.jedox.etl.components.scriptapi.OlapAPI
OlapGlobalAPI - Class in com.jedox.etl.components.scriptapi: Use with binding OLAP, only available in Integrator variables.
OlapGlobalAPI() - Constructor for class com.jedox.etl.components.scriptapi.OlapGlobalAPI

R

readBinary(String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Reads the binary data contained in a file referenced by a file-based connection via an InputStream.
rename(String, String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Renames the file or directory referenced by one file-based connection in its location to the name of a second file-based connection.
reset() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Reset the current email fields.

S

send() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Sends an email once its composition is complete.
setHtmlMessage(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Sets the email body (MIME type text/html).
setMessage(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Sets the email body (MIME type text/plain).
setMessage(String, String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
Use MailAPI.setMessage(String) for text/plain or MailAPI.setHtmlMessage(String) for messages in HTML (text/html instead. Any other value for subType is ignored and MIME type text/plain is used (MailAPI.setMessage(String) is called).
setProperty(String, String) - Method in class com.jedox.etl.components.scriptapi.BaseAPI: Sets the value of an Integrator variable.
setSender(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
setServer() - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
setServer(String, String, String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
setSMTPServer(String, String, String, String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.
setSubject(String) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Sets the email subject.
Source - Class in com.jedox.etl.components.scriptapi: Processes Integrator sources (extracts or transforms) to read data row by row.
State - Class in com.jedox.etl.components.scriptapi: State of the currently active or any finished Integrator execution.

T

testConnection(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Tests a connection with all variable values set with BaseAPI.setProperty(String, String).
testJob(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Tests a job with all variable values set with BaseAPI.setProperty(String, String).
testLoad(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Tests a load with all variable values set with BaseAPI.setProperty(String, String) .
testSource(String) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Tests a source with all variable values set with BaseAPI.setProperty(String, String).
tracepoint(Object...) - Method in class com.jedox.etl.components.scriptapi.JobAPI: Creates a tracepoint for the currently executed script.
trustAllServers(boolean) - Method in class com.jedox.etl.components.scriptapi.MailAPI: Deprecated, for removal: This API element is subject to removal in a future version.
As of Jedox 24.2, calling this method has no effect. SMTP settings are now configured in Jedox Cloud Console.

U

unzip(String, String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Unzips all files and directories from a zip archive referenced by the first file-based connection to a target directory referenced by a second file-based connection.
unzip(String, String, String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Unzips all files and directories from a zip archive referenced by the first file-based connection to a target directory referenced by a second file-based connection.

V

VariableAPI - Class in com.jedox.etl.components.scriptapi: Use with binding API, only available in Integrator variables.
VariableAPI() - Constructor for class com.jedox.etl.components.scriptapi.VariableAPI

W

writeBinary(String, InputStream) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Writes binary data from an InputStream to a file referenced by a file-based connection.

Z

zip(String, String...) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Deprecated.
Use FileAPI.zip(String, List) or FileAPI.zip(String, List, String) instead.
zip(String, List<String>) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Creates a zip archive, referenced by the first file-based connection, from a list of file and directories referenced by subsequent file-based connections.
zip(String, List<String>, String) - Method in class com.jedox.etl.components.scriptapi.FileAPI: Creates a zip archive, referenced by the first file-based connection, from a list of file and directories referenced by subsequent file-based connections.

A B C D E F G I J L M N O R S T U V W Z
All Classes and Interfaces|All Packages