Package com.jedox.etl.components.scriptapi

Class OlapGlobalAPI

java.lang.Object
com.jedox.etl.core.scriptapi.ScriptAPI
com.jedox.etl.components.scriptapi.OlapGlobalAPI
All Implemented Interfaces:
com.jedox.etl.core.scriptapi.IScriptAPI
public class OlapGlobalAPI extends com.jedox.etl.core.scriptapi.ScriptAPI
Use with binding OLAP, only available in Integrator variables.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OlapGlobalAPI()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    IConnection
    getGlobalConnection(String globalConnection)
    Returns a global connection defined in Administration → Connections.

    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

    • OlapGlobalAPI

      public OlapGlobalAPI()

  • Method Details

    • getGlobalConnection

      public IConnection getGlobalConnection(String globalConnection) throws com.jedox.etl.core.component.ETLRuntimeException, com.jedox.etl.core.config.auth.AuthorizationException
      Returns a global connection defined in Administration → Connections.
      Parameters:
      globalConnection - name of the global connection
      Returns:
      an IConnection of the global connection, this connection is already opened
      Throws:
      com.jedox.etl.core.config.auth.AuthorizationException - if no user name was set for the current execution context
      com.jedox.etl.core.component.ETLRuntimeException - if an error occurs while opening the global connection