配置 EPM 集成代理启动参数

Oracle Enterprise Performance Management Cloud URL 的启动参数和 EPM 集成代理的 EPM 云域在 agentparams.ini 文件中定义。

注:

在定义 EPM 集成代理启动参数之前,运行 createAppFolder.bat,这会创建填充有 EPM_AGENT_HOMEEPM_APP_DATA_HOME 参数的 INI 文件。有关详细信息,请参阅“创建应用程序文件夹”。

要加密 EPM 云用户使用的密码,必须运行 ecryptpassword.bat。有关详细信息,请参阅“加密 EPM 云用户密码”。

要配置 EPM 集成代理使用的启动参数:

  1. 转到 C:\EPMAgentData\config 目录。

  2. 双击 agentparams.ini 文件,使用 Notepad 之类的文本编辑器将其打开。

    agentparams.ini 文件即会以文本文件的形式打开:

    图中显示了 agentparamas.ini

  3. EPM_AGENT_HOME 为代理的主目录名称。此文件夹包含 bin 和 lib 文件夹。

    当运行 createappfolder.bat 时,脚本会自动填充 EPM_AGENT_HOME 参数。

    如果更改文件夹的名称,代理则从新位置运行,而且会在新 EPM_APP_DATA_HOME 文件夹中创建文件。

  4. EPM_APP_DATA_HOME 是应用程序数据文件夹的名称,其中包含 config、log 和 script 文件夹。config 文件夹还包含一个空的证书文件夹,目前不使用此文件夹。

    当运行 createappfolder.bat 时,脚本会创建一个填充有 EPM_APP_DATA_HOME 参数的 INI 文件。

  5. AGENT_NAME 中,指定 EPM 集成代理的唯一名称。

    只能在名称中使用字符和数字。AGENT_NAME 不得包含任何符号或空格。

  6. CLUSTER 中,指定代理所属的群集的名称。

    名称中只能使用字母数字字符。切勿使用特殊字符,如符号 (@) 或与符号 (&)。群集创建好后,无法再修改名称。

    默认群集名称为 EPMCLUSTER

    注:

    群集的名称必须已在数据集成中定义,然后才能在此处引用它。有关详细信息,请参阅“添加群集”。

    此参数是必需的。

  7. PORT 中,指定运行 EPM 集成代理的端口号。

    此参数是必需的。

  8. CLOUD_URL 中,指定用于对代理进行身份验证和启动代理的 EPM 云 URL。

    此为与代理相关联的 EPM 实例的 URL,例如:

    https://example-pbcs.us1.oraclecloud.com

    注:

    确保 Cloud_URL 的结尾处不包含 "epmcloud" 或 "HyperionPlanning"。

    此参数是必需的。

  9. CLOUD_DOMAIN 中,指定 EPM 云 URL 的唯一名称。

    身份域控制需要访问服务实例的用户的帐户。身份域还控制授权用户可以访问的功能。一个服务实例属于一个身份域。

    管理员可以更新为用户提供的域名,但数据管理需要客户注册服务时提供的原始域名。从数据管理中设置 EPM 云连接时,不能使用别名域名。

    注:

    除了任何第 2 代数据中心外,都需要 CLOUD_DOMAIN 参数。
  10. CLOUD_USER_NAME 中,指定 EPM 云环境中显示的管理员用户名。

    该用户名必须为本地用户,而且不得为 SSO 用户名。

    此参数是必需的。

  11. CLOUD_PASSWORD 中,指定管理员用户的加密密码字符串。

    可通过运行 encryptpassword.bat(适用于 Windows)或 ecryptpassword.sh(适用于 Linux)来加密 EPM 云用户的密码并获取加密密码字符串。有关详细信息,请参阅“加密 EPM 云用户密码”。

    此参数是必需的。

  12. LOG_LEVEL 中,指定本地 EPM 集成代理日志级别。

    有效的日志级别如下:

    • ALL - 显示最详细级别并打印所有日志语句。
    • INFO - 打印选定的重要日志。
    • ERROR - 日志记录最少,仅打印致命错误。

    所有日志均写入至 APPDATA_HOME\logs 文件夹内的某个文件。

    此参数为可选。All 为默认日志级别。

  13. POLL_INTERVAL 中,指定在异步模式下轮询时等待的时间间隔。

    指定的时间间隔以秒为单位。默认时间间隔为 120 秒。

  14. REGISTER_WITH_IP 中,指定 N 可使用主机名注册代理。指定 Y 可使用 IP 地址注册代理。

    此参数为可选。

  15. EXECUTION_POOL_SIZE 中,指定可并行运行的作业数。

    默认的执行池大小为 2。

    此参数为可选。

  16. JYTHON_HOME 中,指定安装 Jython 的顶级目录。

    仅在使用 Jython 作为脚本语言时,才需指定该目录。

  17. GROOVY_HOME 中,指定安装 Groovy 的顶级目录。

    仅在使用 Groovy 作为脚本语言时,才需指定该目录。

  18. CUSTOM_MEM_ARGS 中,指定要使用自定义内存参数覆盖传递至 Java 的标准内存参数的变量。

    例如,在参数 CUSTOM_MEM_ARGS=-Xms128m -Xmx4096m 中,128 MB 为最小初始内存大小,4096 MB 为最大内存大小。

    此参数为可选。

  19. CUSTOM_JAVA_OPTIONS 中,指定任何其他 Java 运行时参数。

    还可以将 CUSTOM_JAVA_OPTIONS 设置配置为使 EPM 集成代理使用代理身份验证方法。

    系统支持以下身份验证方法:

    • 简单
    • 基本
    • 摘要
    • NTLM

    如果使用代理身份验证方法,请根据代理身份验证方法在此字段中指定代理主机名、代理端口、代理用户名和加密密码。

    如果代理使用基本身份验证,则将 CUSTOM_JAVA_OPTIONS 设置为:

    -Djdk.http.auth.tunneling.disabledSchemes=""

    注:

    如果向 jdk.http.auth.tunneling.disabledSchemes 网络属性添加了 Basic,则默认情况下在 Oracle Java Runtime 中已禁用基本身份验证方案。因此,当为 HTTPS 设置隧道时,需要基本身份验证的代理默认情况下无法再成功。如果需要,可以重新激活此身份验证方案,方法时将其从 jdk.http.auth.tunneling.disabledSchemes 网络属性中删除。

    简单代理身份验证方法

    要启用简单代理身份验证,请将上面的 NTLM_PROXY_AUTH 字段设置为 N,并在 CUSTOM_JAVA_OPTIONS 中包含以下参数:

    对于 HTTP,指定:-Dhttp.proxyHost=proxy.example.com -Dhttp.proxyPort=80

    对于 HTTPS,指定:-Dhttps.proxyHost=proxy.example.com -Dhttps.proxyPort=443

    基本或摘要代理身份验证方法

    要启用基本或摘要代理身份验证,请将上面的 NTLM_PROXY_AUTH 字段设置为 N,并在 CUSTOM_JAVA_OPTIONS 中包含以下参数:

    -DproxyHost=proxy.example.com -DproxyPort=8080 -DproxyUser=username -DproxyPassword=encryptedpassword

    NTLM 代理身份验证方法

    要启用 NTML 代理身份验证,请将 NTLM_PROXY_AUTH 设置为 Y,并在 CUSTOM_JAVA_OPTIONS 中的参数中包含以下内容:

    -DproxyHost=proxy.example.com -DproxyPort=8080 -DproxyUser=username -DproxyPassword=encryptedpassword -DproxyDomain=domain

  20. CUSTOM_INTERFACE_CLASS_NAME 中,指定 custom.jar 中实施 EpmAgentInterface 的类的完全限定类名称。

    例如,指定 com.mycompany.agent.implementation.MyImplementation

    此参数为可选。

  21. CUSTOM_CLASS_PATH 中,指定 jar 的完整路径和名称(例如,C:\AgentDeployment\agenthome\myJarFolder\custom.jar

    此参数为可选。

    如果 Microsoft Java 数据库连接 (Microsoft Java Database Connectivity, JDBC) 驱动程序连接到 EPM 集成代理中的 SQL Server,请参阅“在 EPM 集成代理中配置适用于 SQL Server 的 Microsoft JDBC 驱动程序”。

  22. NTLM_PROXY_AUTH 中,指定 Y 以使用 NTLM 代理身份验证方法。

    如果使用 NTLM 代理身份验证,还必须在 CUSTOM_JAVA_OPTIONS 中指定代理参数。

    指定 N 以使用基本或摘要代理身份验证,或者不使用代理身份验证。

    注:

    如果要使用 Jython 或 Groovy 编写脚本,请设置 JYTHON_HOME 或 GROOVY_HOME。

    如果要使用自定义 Java 进行扩展,则设置 CUSTOM_JAVA_OPTIONS 和 CUSTOM_INTERFACE_CLASS。

  23. AMW_IDLE_TIME 中,为在自动维护窗口 (Automated Maintenance Window, AMW) 停机期间或计划外维护期间以异步模式运行的代理指定空闲时间值。

    AMW_IDLE_TIME 参数值是以分钟设置的,默认设置为 15 分钟。客户可以定义更长的空闲时间,但是不应当指定小于 15 分钟的空闲时间值。AMW 停机时间是连续的时间间隔,在这段时间内会对业务流程运行自动维护任务。

  24. Client_ID 中,输入身份域管理员为移动应用程序配置 OAuth 时生成的客户端 ID。它在应用程序的“配置”选项卡上可见,位于常规信息下。有关详细信息,请参阅“在 EPM 集成代理中启用 OAUTH 选项”。

    身份域管理员为移动应用程序配置 OAuth 时生成客户端 ID。它在应用程序的“配置”选项卡上可见,位于常规信息下。

  25. ENABLE_AUTO_COMMIT 中,指定自动提交行为。

    ENABLE_AUTO_COMMIT 参数确定每个数据库操作是否是在执行时提交的事务。此参数解决在某些版本的 JDBC 驱动程序(默认情况下执行自动提交,例如 IBM DB2)中进行代理处理期间可能出现的错误。

    默认值为 N

  26. RETRY_INTERVAL 中,指定重试逻辑期间(以指定的秒数表示)。

    默认值为 10(秒)。

  27. FILE_UPLOAD_SIZE 中,指定迭代中文件上传大小(以选定的兆字节 (MB) 值表示)。

    默认情况下,文件上传大小为 50 (MB)。

  28. 保存对 agentparamas.ini 文件进行的任何更改。

    定义了启动参数后,可以在诊断模式下运行 EPM 集成代理,通过这种方法,可以在无法启动代理时识别有关 EPM 集成代理启动参数或网络连接的任何问题。有关详细信息,请参阅“在诊断模式下运行 EPM 集成代理”。