Deploy SAP PI

Upgrade the SAP PI Adapters to SAP PI UDLP V2.5.0

The following tables outlines the steps that you must complete to upgrade this module to SAP PI UDLP V2.5.0.

Before you begin

These instructions assume that you have completed the steps for upgrading the basic GE Digital APM system architecture.

About this task

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

Procedure

Deploy the SAP PI Adapters for the First Time

The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic GE Digital APM system architecture.

About this task

Important: You must deploy the SAP adapters before deploying the SAP PI adapters.

These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.

Create an SAP PI EAM System Record

You must configure an EAM System Record to establish a connection between any EAM system and GE Digital APM.

Procedure

  1. Create a new record, using the EAM System family.
  2. In the Datasheet ID: box, select SAP PI.
  3. In the Name box, enter the name of your system.
  4. If this system is the system to and from which you want to send data by default, select the Default EAM System? check box.
  5. In the System Type box, select SAP_PI.
  6. In the User ID box, enter a valid User ID.
  7. In the Password box, select .
  8. In the Enter EAM System Password window, in the Password box, enter the password that is associated with the specified user ID.
  9. In the Confirm Password box, reenter the password.
  10. Select OK.
  11. In the SAP PI Host box, enter the name of the SAP PI Host server.
  12. In the SAP PI Port box, enter the port number associated with the SAP PI Host server.
  13. In the SAP PI Receiver Party box, enter the receiver party configured in the SAP PI ID configurations.
  14. In the SAP PI Receiver Service box, enter the receiver service configured in the SAP PI ID configurations.
  15. In the SAP PI Sender Party box, enter the sender party configured in the SAP PI ID configurations.
  16. In the SAP PI Sender Service box, enter the sender service configured in the SAP PI ID configurations.
  17. Optional: Select the SAP PI AAE check box, to use the Advanced Adapter Engine (AAE).
    Note: This capability is only available with SAP PI 7.3 or later.
  18. Select .
    The EAM System record is saved.
  19. Select , and then select Test Connection.
    The connection parameters are verified, and the System ID box is populated with your EAM System ID.

Results

  • An EAM system record is created for the EAM system that defines a connection with GE Digital APM. The ID for this EAM record should now be used in the Name field of a Site Reference field record.
  • Linking an EAM system to an EAM System record enables the APM Connect Adapters to create Notifications against that EAM System.

Import the Design Objects

Procedure

  1. Access the APM Connect installation package.
  2. Navigate to the folder that corresponds to the version of SAP PI that you are using. For example, if you are using SAP PI version 7.3, navigate to SAP PI 730.
  3. Copy the file APMConnect_DesignObjects_BaseV4.tpz.
  4. Paste copied file
    • To use a server: on the SAP PI Server, paste the copied file to the folder \usr\sap\<SID>\SYS\global\xi\repository_server\import, where <SID> is the system ID of the SAP PI Server.
    • For a local machine: Paste the copied file anywhere on your local machine.
  5. Log in to SAP as administrator.
    • If you are using a version prior to SAP PI 7.3, select Integration Repository.
    • If you are using SAP PI 7.3 or above, select Enterprise Services Builder.
    A login screen appears.

    Depending on the SAP PI Server version you are using, the Design: Integration Builder window or the Enterprise Services Builder window appears.

  6. On the Tools menu, select Import design objects.
    The Choose Import Source window appears.
  7. Select Client if the file copied in step 4 was pasted onto your local machine, or select Server if the file copied in Step 4 was pasted into the folder \usr\sap\<SID>\SYS\global\xi\repository_server\import on the SAP PI Server.
  8. Select the Design Objects folder.
  9. Select the file APMConnect_DesignObjects_BaseV4.tpz, and then select OK.
    A confirmation window appears.
  10. Select Import.
    The file is imported.
  11. Select the file APMConnect_DesignObjects_SupportPackV4.tpz, and then select OK.
    A confirmation dialog box appears.
  12. Select Import.
    The file is imported.
  13. Select Close.
    The design objects are imported and appear in the Objects section.

Import the Configuration Object

Procedure

  1. Access the APM Connect installation package.
  2. Navigate to the folder that corresponds to the version of SAP PI that you are using. For example if you are using SAP PI version 7.3, navigate to SAP PI 730.
  3. Copy the file APMConnect_ConfigurationObjectsV4.tpz.
  4. Paste the copied files.
    • On an SAP PI Server: paste the copied file into the folder \usr\sap\<SID>\SYS\global\xi\directory_server\import, where <SID> is the system ID of the SAP PI Server.
    • On a local machine: paste the copied file anywhere on your local machine.
  5. In a web browser, navigate to http://<SAP PI Server>:<port number>/rep/start/index.jsp, where <SAP PI Server> is the name of the SAP PI Server and <port number> is the port number of the specified SAP PI Server.
    The SAP Exchange Infrastructure window appears.
  6. Select Integration Directory.
    A login screen appears, prompting you to log in to the Configuration: Integration Builder.
  7. Log in as an administrator.
    The Configuration: Integration Builder window appears.
  8. In the Tools menu, select Import configuration objects.
    The Choose Import Source window appears.
  9. Select Client if the file copied in step 3 was pasted onto your local machine, or select Server if the file copied in step 3 was pasted into the folder \usr\sap\<SID>\SYS\global\xi\directory_server\import on the SAP PI Server.
  10. Select the Configuration Objects folder.
  11. Select the file APMConnect_ConfigurationObjectsV4.tpz, and then select OK.
    A confirmation window appears.
  12. Select Import.
    The file is imported, and a confirmation message appears.
  13. Select Close.
    The configuration object is imported, and the objects appear in the Configuration Integration Builder.

Modify the Baseline Communication Channels

Use this procedure to configure the baseline SAP PI communication channels.

About this task

notes:
  • If the FILE_MOVE_USE_PI parameter is set to false in the context file, you can skip this procedure, except step 9 if you are using SSL.
  • These instructions describe using the SAP PI 7.3 configuration interface. Different versions may have minor differences in interface labels or steps.

The SAP PI adapters have the following baseline communication channels that you will need to modify:

  • FileSender_SAP_Equipment
  • FileSender_SAP_FLOC
  • FileSender_SAP_StaticData
  • FileSender_SAP_TC_EQUI
  • FileSender_SAP_TC_IFLOT
  • FileSender_SAP_WMI
  • FileSender_SAP_Workhistory
  • FileReceiver_APMConnect_Equipment
  • FileReceiver_APMConnect_FLOC
  • FileReceiver_APMConnect_StaticData
  • FileReceiver_APMConnect_TC_EQUI
  • FileReceiver_APMConnect_TC_IFLOT
  • FileReceiver_APMConnect_WMI
  • FileReceiver_APMConnect_Workhistory

Procedure

  1. In a web browser, navigate to http://<SAP PI Server>:<port number>/rep/start/index.jsp, where <SAP PI Server> is the name of the SAP PI Server and <port number> is the port number of the specified SAP PI Server.
    The SAP Exchange Infrastructure window appears.
  2. Select Integration Directory.
    A login screen appears, prompting you to log in to the Configuration: Integration Builder.
  3. Log in as an administrator.
  4. In the Configuration: Integration Builder window, in the Scenarios section, expand the GE_APMConfigurations row.
  5. Expand the Communication Channel row.
    The row expands, and the following APM Connect Communication Channels appear:
    • FileReceiver_APMConnect_Equipment
    • FileReceiver_APMConnect_FLOC
    • FileReceiver_APMConnect_StaticData
    • FileReceiver_APMConnect_TC_EQUI
    • FileReceiver_APMConnect_TC_IFLOT
    • FileReceiver_APMConnect_WMI
    • FileReceiver_APMConnect_Workhistory
    • FileSender_SAP_Equipment
    • FileSender_SAP_FLOC
    • FileSender_SAP_StaticData
    • FileSender_SAP_TC_EQUI
    • FileSender_SAP_TC_IFLOT
    • FileSender_SAP_WMI
    • FileSender_SAP_Workhistory
  6. Configure the FileReceiver communication channels by performing these steps for each channel, replacing <interface> with the appropriate interface name.
    1. Select FileReceiver_APMConnect.
      The Display Communication Channel screen appears.
    2. Select .
    3. In the File Access Parameters section, in the Target Directory column, enter the target directory file path, for example, \\context\PLSAP_OUTPUT\<interface>\.
      Important: This path must match exactly the IR_TALEND_OUTPUT parameter in the context file.
    4. In the File Name Scheme column, enter *.*.
    5. In the Processing Parameters section, in the File Construction Mode box, enter the value Create.
    6. Select the Overwrite Existing File check box.
    7. In the Write mode box, select Directly.
    8. In the Empty-Message Handling section, select Write Empty File.
    9. In the Advanced section, in the Adapter-Speccific Message Attributes, select the following options:
      • Set Adapter-Specific Attributes
      • File Name
      • File Type
    10. Select .
  7. Configure the FileSender communication channels by performing these steps for each channel, replacing <interface> with the appropriate interface name.
    1. Select FileSender_APMConnect_<interface>.
      The Display Communication Channel screen appears.
    2. Select .
    3. In the File Access Parameters section, in the Source Directory column, enter the endpoint of the share between your SAP server and your SAP PI server exactly as it is in the PLSAP_INPUT parameter in the context file and corresponding interface folder name, for example, \\context.PLSAP_INPUT\<interface>\.
    4. Select .
    5. In the File Name Scheme column, enter *.*.
    6. In the Processing Parameters section, in the Poll Interval box, enter the recommended value of 10.
    7. In the Processing Mode box, select Delete.
    8. In the Quality of Service box, select Best Effort.
    9. In the Empty-File Handling box, select Process Empty Files.
    10. In the Advanced section, complete the following steps:
      • In the Adapter-Specific Message Attributes section, select the following options:

        • Set Adapter-Specific Message Attributes
        • File Name
        • File Type
      • In the Adapter Status section, in the Status box, select Active.
      • Select the Advanced Mode check box.
      • In the Additional Parameters section, in the Msecs to Wait Before Modification box, enter the recommended value of 1000 or more.
  8. Select .
  9. Optional: If you are using SSL, configure the SOAP channel to use SSL.
    1. In the Commmunication Channel row, select SOAPSender_APMConnect.
    2. In the Communication Channel menu, select .
    3. In the General section, in the HTTP Security Level box, select HTTPS Without Client Authentication.
    4. In the Communication Channel menu, select .
  10. Select Activate.

Results

The communication channels are configured.

Activate the RFCReceiver_SAP Object

Use this procedure to activate the RFCReceiver_SAP Object for SAP PI.

Procedure

  1. In the Configuration: Integration Builder, select the Change Lists tab.
  2. In the Change Lists section, select | GE_APM_SAP | RFCReceiver_SAP.
    Note: The Error Loading Adapter Metadata window may appear. If it appears, select Close.

    The communication channel details appear on the screen.

  3. Select .
  4. In the Parameters section, in the Adapter Type row, select .
    The Choose Adapter Metadata window appears.
  5. Select the latest RFC Adapter from the list, and then select Apply.
    The communication channel details return to focus.
  6. In the Properties section, confirm or enter values for the following parameters:
    • RFC Server Type: this parameter must be set to SAP System.
    • Application Server
    • System Number
    • Authentication Mode: this parameter must be set to Use Logon Data for SAP System.
    • Logon User
    • Logon Password
    • Logon Language
    • Logon Client
  7. Select .
  8. In the Change Lists section, right-click on PI <version number > Import, and then select Activate.
    A confirmation message appears.
  9. Select Activate.
    The object is activated.

Define the Command Name in SAP

If you are using a compression option in the context file, you need to define the command name for the compression type you are using. There are two types of compressions for APM Connect SAPCAR and ZIP. You can only use one type of compression.

About this task

Notes:
  • If you are not using a compression method during the extraction, then you can skip this procedure.
  • It is recommended to use SAPCAR as your compression type.

Procedure

  1. In SAP, run the transaction code SM69.
    The External Operation System Commands screen appears.
  2. Select .
    The Create an External Command screen appears.
  3. In the Command section, in the Command Name box, enter one of the following the command names:
    • ZSAPCAR: if you are using SAPCAR for compression.
    • ZZIP: if you are using ZIP for compression.
  4. In the Definition section, in the Operating system command box, enter one of the following systems commands:
    • SAPCAR -cvf: if you are using SAPCAR for compression.
    • ZIP -9 -j: if you are using ZIP for compression.
  5. Select Save.
    The Command Name is defined.

Install the SAPCAR File on the APM Connect Server

To use SAPCAR to compress files, you must install the file on the APM Connect Server.

About this task

Note: If you are not using SAPCAR to compress files, then skip this procedure and proceed to the next procedure.

Procedure

  1. On the SAP Server, copy the SAPCAR.exe file.
  2. Access the APM Connect Server.
  3. In the windows\system32 directory, paste the SAPCAR.exe file, as shown in the following image:

Results

The SAPCAR file is installed.

Create SAP PI Directory Structure

You will need to set up a directory structure on your SAP server to facilitate transfers from SAP PI to APM Connect.

About this task

The structure depends on the FILE_MOVE_USE_PI parameter and the COMPRESS_TYPE parameter usage in the context file.

Procedure

On your SAP server, create one directory and subdirectory according to the following grid:
If FILE_MOVE_USE_PI is......adn COMPRESS_TYPE is...... create the following directory structure
falseNONE<root:>/<New Directory Name>
falseZIP or SAPCAR<root:><New Directory Name>/Compress
trueNONE<root:>/<New Directory Name>
trueZIP or SAPCAR<root:>/<New Directory Name>/Compress
Note: Each directory needs to be in a shared directory that APM Connect can access, and should be the base path value in PLSAP_INPUT parameter. Additionally, once the job is run, the compress directory will be programmatically added to the value PLSAP_INPUT in the context file.
The directories are created, and the SAP PI server and APM Connect server can extract files from the SAP sever.