Class BaseAPI

java.lang.Object
com.jedox.etl.core.scriptapi.ScriptAPI
com.jedox.etl.components.scriptapi.BaseAPI
All Implemented Interfaces:
com.jedox.etl.core.scriptapi.IPropertiesAware, com.jedox.etl.core.scriptapi.IScriptAPI
Direct Known Subclasses:
ExecutionAPI, FileAPI, OlapAPI, VariableAPI

public abstract class BaseAPI extends com.jedox.etl.core.scriptapi.ScriptAPI implements com.jedox.etl.core.scriptapi.IPropertiesAware
Scripting API basic methods usable everywhere.
  • Constructor Details

    • BaseAPI

      public BaseAPI()
  • Method Details

    • setProperty

      public void setProperty(String name, String value)
      Sets the value of an Integrator variable.
      Parameters:
      name - name of the Integrator variable
      value - new value to set
    • getProperty

      public Object getProperty(String name)
      Gets the current value of an Integrator variable during an execution.
      Parameters:
      name - name of the variable
      Returns:
      value of the variable or the configured default value if called in a script to initialize this variable
    • clearProperties

      public void clearProperties()
      Clears all variables currently set with setProperty(String, String).
    • getProjectName

      public String getProjectName()
      Gets the name of the current Integrator project.
      Returns:
      name of the current Integrator project
    • getComponentName

      public String getComponentName()
      Gets the name of the current Integrator component (function or job).
      Returns:
      name of the current Integrator component
    • getLocalFilesDir

      @Deprecated(forRemoval=true) public String getLocalFilesDir()
      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.
    • getConfigSetting

      public String getConfigSetting(String key, String scope) throws com.jedox.etl.core.component.ConfigurationException
      Gets the value of a property from SettingsManager for a given scope (i.e. the technical name of a model).
      Parameters:
      key - key name of the property
      scope - scope in SettingsManager; if not specified the current scope is used (global projects or the current project's model)
      Returns:
      value of the property
      Throws:
      com.jedox.etl.core.component.ConfigurationException
    • getConfigSetting

      public String getConfigSetting(String key) throws com.jedox.etl.core.component.ConfigurationException
      Gets the value of a property from SettingsManager for the current scope (global projects or the current project's model).
      Parameters:
      key - key name of the property
      Returns:
      value of the property
      Throws:
      com.jedox.etl.core.component.ConfigurationException
    • getGlobalConnections

      @Deprecated(forRemoval=true) public org.jdom2.Element[] getGlobalConnections(String type) throws com.jedox.etl.core.component.ConfigurationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is deprecated and will be removed.
      Throws:
      com.jedox.etl.core.component.ConfigurationException