Enterprise Resource Planning Connection Profiles

The following topics describe connection profiles for enterprise resource planning (ERP) systems:

ConnectionProfile:OEBS

The following example shows how to define an Oracle E-Business Suite (OEBS) connection profile for OEBS jobs in Control-M.

The OEBS job type is available in Control-M, and you can export it to Control-M Automation API, where only limited support is available for this job type (Job:OEBS). For more information, see Other Job Types.

Copy 
"OEBS_CP": {
   "Type": "ConnectionProfile:OEBS",
   "TargetAgent": "dba-t-makkp",
   "TargetCTM": "dba-t-makkp",
   "Centralized": true,
   "DatabaseConnectionParameters": {
      "ServiceName": "CLOUD2",
      "UserName": "apps",
      "Password": "apps"
   },
   "AppendToJobOutput": {
      "AppendRequestLog": true,
      "AppendRequestOutput": true
   },
   "JobCompletionStatus": {
      "ConvertWarningToOK": true,
      "MonitorChildRequests": {
         "JobCompletionDependsOnChildRequestStatus": true
      }
   }
}

The following table describes the Oracle E-Business Suite (OEBS) connection profile parameters:

Parameter

Description

TargetAgent

Determines the Agent where the connection profile deploys.

TargetCTM

Determines the Control-M/Server where the connection profile deploys. If there is only one Control-M/Server, it defaults to that Control-M/Server.

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false

DatabaseConnectionParameters

Groups parameters for the details of the connection with OEBS.

ServiceName

Defines the Oracle client connection identifier registered in the tnsnames.ora file.

For more information, contact your Oracle Database Administrator.

UserName

Defines the username for the OEBS server.

Password

Defines the password for the OEBS server.

Language

(Optional) Determines the language to use for database connections.

Values: Languages that appear in the OEBS language settings

Default: As set in the Oracle client

CharacterSet

(Optional) Enables you to set the National Character Set (NLS) for database connections.

Values: Character sets supported by OEBS

Default: As set in the Oracle client

AppendToJobOutput

Groups parameters that control what content is appended to the job output.

AppendRequestLog

Determines whether to copy the OEBS request log to the Control-M job output.

Values:

  • true: Copy the OEBS request log to the Control-M job output.

  • false: Do not copy.

Default: true

AppendRequestOutput

Determines whether to copy the OEBS request output to the Control-M job output.

Values:

  • true: Copy the OEBS request output to the Control-M job output.

  • false: Do not copy.

Default: false

JobCompletionStatus

Groups parameters that control job completion status.

ConvertWarningToOK

Determines whether to allow the OEBS job to complete even if a warning appears.

Values:

  • true: Allow completion of the OEBS job when a warning is issued.

  • false: Do not allow completion of the OEBS job in the case of a warning.

Default: false

MonitorChildRequests

Determines whether to track OEBS child jobs.

Inclusion of this object (without a value) along with the next-level parameter (described in the next row) indicates that OEBS child jobs are tracked.

JobCompletionDependsOnChildRequestStatus

Determines whether to set the OEBS job ending status according to the lowest completion status of all the child requests.

Values:

  • true: Set the ending status according to the child requests.

  • false: Set the ending status without dependency on the child requests.

Default: false

ConnectionProfile:PeopleSoft

Control-M for PeopleSoft is an Oracle-based application that enables you to develop, test, and run large-data batch processes. It also enables you to execute common human resources tasks, such as approving promotions, viewing pay slips, or editing employee information.

The following example shows how to define a PeopleSoft connection profile:

Copy 
"PS_CONNECT": 
{
   "Type": "ConnectionProfile:PeopleSoft",
   "TargetAgent": "AgentHost",
   "TargetCTM": "CTMHost",
   "Centralized": true,
   "User": "User_Name",
   "Password": "Password",
   "DomainPassword": "****",
   "PeopleToolsVersion": "8.52",
   "ApplicationServers": [
   {
      "ApplicationServer": "ApplicationServer1",
      "JoltPort": "1024"
   },
   {
      "ApplicationServer": "ApplicationServer2",
      "JoltPort": "65535"
   } ]
}

The following table describes the PeopleSoft connection profile parameters.

Parameter

Description

TargetAgent

Determines the Agent where the connection profile deploys.

TargetCTM

Determines the Control-M/Server where the connection profile deploys. If there is only one Control-M/Server, it defaults to that Control-M/Server.

User

Determines the valid PeopleSoft user, as defined on PSOPRDEFN.

This user must have the roles to submit and execute processes.

Password

Defines a password to connect the specified user to the PeopleSoft server.

Use Secrets in code to not expose the password in the code.

To update an existing connection profile and keep the current password, type five *, as follows:

*****

DomainPassword

Defines a password for the PeopleSoft domain, PeopleTools 8.51 or higher.

To update an existing connection profile and keep the current password, type five *, as follows:

*****

PeopleToolsVersion

Defines the version of PeopleTools, in the following format:

<major.minor>

  • 8.48

  • 8.52

To determine the exact version, consult with your PeopleSoft administrator.

ApplicationServers

Defines details of the associated PeopleSoft application servers.

ApplicationServer

Determines the name of a PeopleSoft application server.

   JoltPort

Defines the number of the jolt port on the PeopleSoft application server.

Valid Values: 1024–65535

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false

ConnectionProfile:SAP

SAP-type jobs enable you to manage SAP processes through the Control-M environment.

The following examples show how to define an SAP job connection profile.

  • This JSON defines a connection profile for a specific SAP Application Server:

    Copy 
    "SAP-SERVER-CONN" : 
    {
       "Type" : "ConnectionProfile:SAP",
       "User" : "my-user",
       "Password" : "123456",
       "SapClient" : "100",
       "Language" : "",
       "XBPVersion": "XBP3.0",
       "AppVersion": "R3",
       "ApplicationServerLogon" : 
       {
          "Host" : "localhost",
          "SystemNumber" : "12"
       },
       "SecuredNetworkConnection": 
       {
          "SncLib": " " ,
          "SncPartnerName": "",
          "QualityOfProtection": "2",
          "SncMyName":""
       },
       "SapResponseTimeOut" : "180",
       "UseExtended": true,
       "SolutionManagerConnectionProfile" : "IP4-GROUP",
       "IsSolutionManagerConnectionProfile": true
    }

  • This JSON defines a connection profile for an SAP logon group:

    Copy 
    "SAP-GROUP-CONN" : 
    {
       "Type" : "ConnectionProfile:SAP",
       "User" : "my-user",
       "Password" : "123456",
       "SapClient" : "100",
       "Language" : "",
       "XBPVersion": "XBP3.0",
       "AppVersion": "R3",
       "GroupLogon": 
       {
          "SystemID": "123",
          "MessageServerHostName": "msgsv",
          "GroupName": "group1"
       },
       "SecuredNetworkConnection": 
       {
          "SncLib": " " ,
          "SncPartnerName": "",
          "QualityOfProtection": "2",
          "SncMyName":""
       },
       "SapResponseTimeOut" : "180",
       "UseExtended": true,
       "SolutionManagerConnectionProfile" : "IP4-GROUP",
       "IsSolutionManagerConnectionProfile": true
    }

The following table describes the SAP connection profile parameters.

Parameter

Description

User

Defines the SAP user name.

Password

Defines the password for the SAP user.

To update an existing connection profile and keep the current password, type five *, as follows:

*****

SapClient

Defines the SAP client number.

Valid Values: 1–3 digits.

Language

Defines the SAP language.

Default: English
XBPVersion

Determines the SAP XBP interface version installed on the SAP server.

Valid Values:

  • XBP 1.0

  • XBP 2.0

  • XBP 3.0 (Default).

AppVersion

Determines the version of the SAP application.

Valid Values:

  • R3

  • BW 2.<X>.

  • BW 3.<X> or higher.

GroupLogon

Defines parameters for an SAP logon group.

   SystemID

Defines the SAP system ID.

Valid Values: 3 alpha-numeric characters.

   MessageServerHostName

Defines the Host name of the computer on which the SAP System Message Server is running.

   GroupName

Determines the SAP logon Group name.

The Group name is defined in the SAP SMLG transaction.

ApplicationServerLogon

Defines parameters for a specific SAP Application Server.

   Host

Defines the host name of the computer that runs the SAP Application Server.

   SystemNumber

Defines the SAP instance number.

Valid Values: 2 numerical digits.

SecuredNetworkConnection

Defines Parameters that you can use to activate a secured network connection.

   SncLib

Defines the client full path and filename for SAP crypto lib.

/home1/agsapfp/SNC/libsapcrypto.sl

   SncPartnerName

Defines the SNC name of the application server.

p:CN=LE1, OU=BPM, O=BMC, C=US

   QualityOfProtection

Determines quality of the protection.

Valid Values:

1, 2, 3, 8, and 9.

Default: 8

   SncMyName

Determines the SNC name of the user sending the RFC.

Default: The name provided by the security product for the user who is logged on.

SapResponseTimeOut

Defines the number of seconds that the program waits for an RFC request to be handled by the SAP system before returning a timeout error.

Default: 180

UseExtended

Defines whether the extended functionality of Control-M for SAP should be used.

Valid Values:

  • true

  • false

Default: false

If you select this option, the Control-M Function Modules must be installed on your SAP server, as described in Control-M for SAP XBP Interface and Control-M Function Modules.

SolutionManagerConnectionProfile

Determines the Solution Manager connection profile for retrieval of SAP job Documentation.

This parameter is relevant only if the current connection profile is not a Solution Manager connection profile, as discussed in the next parameter.

IsSolutionManagerConnectionProfile

Determines whether the current connection profile is a Solution Manager connection profile.

Valid Values:

  • true

  • false

Default: false