EPM Integration Agent Context Functions

EPM Integration Agent API, context functions are available that provide important contextual information for script writers.

The contextual functions are as follows:

Function Description

agentContext["JOBTYPE"]

Provides the job type being executed by the agent. At this time, the JOBTYPE processes are "EXTRACT" and "DRILL".

When performing a drill-through operation, the agent must execute the query instead of using code to run a custom query. When running an extract, it is possible to use a script to directly execute a query, create an output file, and then save that file to the data directory that will ultimately get picked up by the agent for upload to the Oracle Fusion Cloud Enterprise Performance Management. (This also requires the use of the skipAction() api.)

The drill operation requires that the agent run the query using the defined connection, and does not pickup a file from the data directory. Because of this, if you want to use a different query, you need to use the agentAPI.UpdateQuery() method to update the query, and use the setCustomConnection() api, if needed, to update the agent connection information. The agent then passes the query output to the cloud in a JSON payload instead of a file.

agentContext["EPM_APP_DATA_HOME"]

Provides the data home specified in the INI file used when starting the EPM Integration Agent.

agentContext["DELIMITER"]

Provides the file delimiter specified as part of the data source entry from the Cloud EPM.

agentContext["DATAFILENAME"]

Provides the path and name of the file that is uploaded to the Cloud EPM. Use this function instead of building file names manually.

agentContext["JOBID"]

Provides the job ID from the integration submitted in the Cloud EPM.

agentContext["INTEGRATION"]

Provides the name of the INTEGRATION being executed.

agentContext["WRITEBACK_DATA_FILE"]

Provides the path and name of the write-back data export file that is that is downloaded from the Cloud EPM. Use this function instead of building file names manually.

agentContext["LOCATION"]

Provides the location from the integration submitted in the Cloud EPM.

agentContext["SOURCE_APPLICATION"]

Provides the source application from the integration submitted in the Cloud EPM.

agentContext["TARGET_APPLICATION"]

Provides the target application from the integration submitted in the Cloud EPM.