MaintainX SAP ECC 6 Integration Setup and Configuration Guide

Legacy documentation

This documentation covers an older version of the MaintainX SAP ECC6 integration (Current versions no longer use Tray.io for automations). It's provided here as a reference for existing installations. It may contain errors or omissions.

This article provides detailed instructions for setting up the SAP ECC6 integration for MaintainX using Tray.io.

Testing Notes

MaintainX tested this documentation with the following configuration:

• SAP ECC 6.0 EHP8
• GUI:
  • Windows: SAP GUI for Windows 11
  • macOS: SAP GUI for Java for MacOS 14 (Sonoma)
• Server: Windows Server 2019

Requirements

• SAP ECC6 instance, version 6.0 EHP8
• Admin rights
• A webhook URL for Tray.io, provided by your MaintainX Integrations representative.

Create a New SAP User for the Integration

1. Enter transaction code:

   SU01

   The User Maintenance screen opens.

2. In the User field, enter the name for the new user.

3. From the menu, select User > Create.

   The Maintain Users screen opens.

4. On the Address tab enter all the required information for the new user.

   Required fields are marked with an asterisk (*) on Windows and a checkbox icon on macOS.

5. On the Profiles tab, add the following Administrator profiles:

   • SAP_ALL
   • SAP_NEW

6. On the Logon Data tab, go to the Password section and enter a password in the New Password and Repeat Password fields.

   This is the initial password. When you log in as the new user for the first time, you will have to reset it.

7. From the menu, select User > Save to save the new user.

8. Log out and log in again with the new user's username and password.

9. When prompted, create a new password.

Open the HTTPS port

1. Enter transaction code:

   RZ10

   The Edit Profiles screen opens.

2. Do one of the following:

   If this is an existing install of SAP ECC6 skip ahead to Configure the Profile.

   If this is a new install of SAP ECC6, you have to import the default profiles. Go to the next section, Import Default Profiles.

Import Default Profiles

If this is a new setup, you have to import the default profiles.

On the Edit Profiles screen:

1. From the menu, select Utilities > Import profiles > Of active servers.
2. Review the import message, and then, from the toolbar, select Back to return to the Edit Profiles screen.

Configure the Profile

1. On the Edit Profiles screen enter the following values:

   Field	Value
   Profile	If this is an existing install of SAP ECC6, do the following: Click the matchcode icon. The Hit List 3 Entries dialog opens. Select profile you want to use. Click the Copy button (checkmark) to load the profile. If this is a new install of SAP ECC6 set this to: DEFAULT
   Version	If this is an existing install of SAP ECC6, use the latest version number: Select the version dropdown icon in the Version field. A list of versions opens. Select the latest version. Click the Copy button (checkmark) to load the latest version. If this is a new install of SAP ECC6 set this to 1

2. In the Edit Profile section, select Extended Maintenance and click the Change button.

The Maintain Profile screen opens. It lists the profile parameters.

Use an Existing Parameter to Open the HTTPS Port

If this is a new install of SAP ECC6 follow the instructions in Create a New parameter to Open the HTTPS Port instead.

If this is an existing install of SAP ECC6 follow the instructions in this section.

On the Maintain Profile screen:

1. In the Parameter Name list, select the icm/server_port parameter.

   For example: icm/server_port_0

2. From the menu, select Parameter > Change. The parameter options open.

3. From the menu, select Parameter > Display <-> Change.

4. In the Parameter val.: field, enter PROT=HTTPS,PORT={Port Number}

   For example: PROT=HTTPS,PORT=8003,PROCTIMEOUT=15,TIMEOUT=15

5. From the menu, select Parameter > Display <-> Change again.

6. When prompted, click Yes to save your changes.

7. From the menu, select Goto > Back to return to the parameters list.

Create a New parameter to Open the HTTPS Port

If this is an existing install of SAP ECC6 follow the instructions in Use an Existing Parameter to Open the HTTPS Port instead.

If this is a new install of SAP ECC6 follow the instructions in this section.

On the Maintain Profile screen:

1. From the menu, select Parameter > Create.

2. Configure the new parameter as follows:

   For this setting	Enter this
   Parameter name	icm/server_port_{n} Where n is the first available number. For example, if you already have a parameters that uses icm/server_port_0, use icm/server_port_1.
   Parameter val.	PROT=HTTPS,PORT={Port Number} For example: PROT=HTTPS,PORT=8003,PROCTIMEOUT=15,TIMEOUT=15

3. From the menu, select Parameter > Display <-> Change.

4. When prompted, click Yes to save your changes.

5. From the menu, select Goto > Back to return to the parameters list.

Save the Profile

1. In the toolbar, click Back to return to the Edit Profiles screen.

2. In the toolbar, click Save to save your profile.

   If you get an error message about the name of your database, ignore it and save the profile.

Restart the SAP Server

You need to restart the SAP server to apply the new profile. To restart the server, you need access to the server itself or the SAP Microsoft Management Console (MMC).

From the MMC, directly on the server running SAP:

1. Right-click the server.

2. From the context menu, select Restart.

   The SAP System Restart dialog opens.

3. From the Shutdown Type section, select Soft.

   tip

   We recommend a soft rather than a hard reboot. A soft reboot sends a signal to SAP before rebooting, which allows the system to be shut down properly, and reduces the risk of corrupting SAP.

   You can also schedule soft reboots to coincide with planned downtime.

Test the HTTPS Port

After the reboot, return to SAP and do the following:

1. Enter transaction code:

   SMICM

   The ICM Monitor screen opens.

2. From the application toolbar, click , or press Shift+F1.

   The ICM Monitor - Service Display screen opens.

   You should see your new ports in the Active Services list.

3. Enter transaction code:

   SICF

   The Define Services screen opens.

4. From the menu, select Program > Execute. The service configuration options appear.

5. In the Virtual Hosts table, navigate to default_host > SAP > public > ping.

6. Right click ping, and from the context menu, select Activate Service. The Activation of ICF Services dialog appears.

7. Click Yes to activate the ping service.

   If you see two yes buttons

   Do not click the Yes button with a tree icon.

8. Open a web browser and enter the following address in the address bar:

   HTTPS://{hostname}:{port}/sap/public/ping

   Where hostname is the IP address hostname where your SAP ECC6 instance is hosted, and port is the port number when you set up the icm/server_port parameter (see Configure the Profile).

9. Make sure you can connect to the ping URL.

10. In the Virtual Hosts table, right click the ping service, and from the context menu, select Deactivate Service to close public ping service.

Activate the iDoc Service

note

You should still have the Define Services screen open if you don't:

1. Enter transaction code:

   SICF

   The Define Services screen opens.

2. In the application toolbar, click Execute. The service configuration options appear.

1. In the Virtual Hosts table, navigate to default_host > sap > bc.

2. In the table of services, navigate to default_host > sap > bc > idoc_xml.

3. Right click idoc_xml, and from the context menu, select Activate Service. The Activation of ICF Services dialog appears.

4. Click Yes to activate the idoc_xml service.

   If you see two yes buttons

   Do not click the Yes button with a tree icon.

Create Logical Systems

Create a New Logical System

1. Enter transaction code:

   SALE

   The Display IMG screen opens.

2. On the Display IMG screen, navigate to IDoc Interface / Application Link (ALE) > Basic Settings > Logical Systems.

3. Click the clock icon next to Define Logical System.

   The Change View "Logical Systems": Overview screen opens.

4. In the application toolbar, click New Entries. The New Entries: Overview of Added Entries screen opens.

5. In the Logical Systems table, add an entry for your new logical system.

   tip

   Take note of the name of the new logical system, you'll need it later.

6. In the toolbar, click Save.

7. Do one of the following:

   • If SAP prompts you to create a new Workbench Request, continue to the next section, Create a New Workbench Request.
   • If not, skip to Assign the Logical System to a Client.

Create a New Workbench Request

When you create a new logical system, SAP might prompt you to create a new Workbench Request. The Prompt for Workbench Request dialog will open.

To create a new Workbench Request:

1. In the Request field, click the matchcode icon to open a second Prompt for Workbench Request dialog with a list of current requests.

2. From the toolbar at the bottom of the dialog box, click Create Request.

   The Create Request dialog opens.

3. In the Short Description field, add a short description for your request. Then, from the toolbar at the bottom of the dialog box, click Save.

4. In the list of Workbench Requests, select your new request. Then, from the toolbar at the bottom of the dialog box, click Choose (checkmark).

5. In the Prompt for Workbench Request dialog, make sure that the Request filed shows the ID for the request you created.

6. From the toolbar at the bottom of the dialog box, click Continue (checkmark).

Assign the Logical System to a Client

1. Return to the Display IMG screen.

2. Navigate to IDoc Interface / Application Link (ALE) > Basic Settings > Logical Systems.

3. Click the clock icon next to Assign Logical System to Client.

   The Change View "Clients": Overview screen opens.

   Take note of the highest number in the Client column.

4. In the application toolbar, click New Entries. The New Entries: Details of Added Entries screen opens.

5. Fill in the following fields:

   Field	Value
   Client	In the short field, enter the key for the entry. This should be at least one higher than the number you noted from the Client column on the previous screen. In the long field, enter a name for the entry.
   City	Add your city.
   Logical system	Click the matchcode icon in this field to open a list of logical systems. Select the system you created earlier and then click the Cont. (checkmark) button.
   Currency	Click the matchcode icon in this field to open a list of currencies. Select your local currency and then click the Cont. (checkmark) button.
   Client role	Set this to Customizing.

6. In the toolbar, click the checkmark button to validate the entry.

7. From the menu, select Table View > Save.

Download and Import the Tray.io Certificate

For the SAP ECC6 MaintainX integration to work over SSL, you need to import the Tray.io certificate.

Download the Tray.io Certificate

Google Chrome

1. In a new browser tab, go to https://tray.io/.
2. In the address bar, click the View site information icon to the left of the URL.
3. From the popup, select Connection is secure to open the Security options.
4. From the Security options, select Certificate is valid. The Certificate Viewer window opens.
5. On the Details tab, click Export. The export dialog opens.
6. Choose a folder to save the certificate to.
7. Set Format to PKCS #7, certificate chain.
8. Click Save.

Firefox

1. In a new browser tab, go to https://tray.io/.
2. In the address bar, click the lock icon to the left of the URL.
3. From the popup, select Connection secure and then select More Information. The Page Info window opens.
4. On the Security tab, click View Certificate. The certificate opens in a new browser tab.
5. Navigate to the Miscellaneous section and, on the Download line, click PEM (chain).

Firefox saves the certificate to your downloads folder.

Safari

1. In a new browser tab, go to https://tray.io/.
2. In the address bar, click the lock icon to the left of the URL.
3. From the popup window, click Show Certificate.
4. Click and drag the certificate icon from the popup window to a Finder window to save it to your computer.

Import the Tray.io Certificate

1. In SAP ECC6, enter transaction code:

   STRUST

   The Trust Manager: Display screen opens.

2. In the application toolbar, click the Display <-> Change button to enter edit mode.

3. In the Personal Security Environment (PSE) list in the left hand pane, expand the SSL client SSL Client (Anonymo category, and double click the PSE in that category.

4. From the menu, select Certificate > Import. The Import Certificate dialog opens.

5. On the File tab, go to the File path field and click the matchcode icon.

6. Navigate to the certificate that you want to import, select it, and click Open.

7. In the Import Certificate dialog, click the Continue (checkbox) button to close the dialog box and import the certificate.

8. In the SSL client SSL Client (Anonymo options in the right hand pane, click the Add to Certificate List button.

   You should now see the certificate you imported in the Certificate List section.

9. In the toolbar, click Save.

Create an HTTPs Connection to the External Server

1. Enter transaction code:

   SM59

   The Configuration of RFC Connections screen opens.

2. In the RFC Connections table, select HTTP Connections to External Server.

3. From the menu, select Edit > Create. The RFC Destination screen opens.

4. In the RFC Destination field, enter a name for the connection.

5. Go to the Technical Settings tab and find the Target System Settings section.

6. You should have a webhook URL for Tray.io, provided by MaintainX. Enter the URL without the URL prefix (i.e., remove the https:// from the beginning),in the Target Host field.

   note

   MaintainX supplies . If you don't have your Tray.io webhook URL, contact your MaintainX Account Manager.

7. Set Service No. to 443.

8. Go to the Logon & Security tab and find the Security Options section.

9. In the Status of Secure Protocol section, make sure SSL is set to Active.

10. From the SSL Certificate dropdown, select the certificate you imported in Download and Import the Tray.io Certificate.

11. From the menu, select Utilities > Connection Test to make sure the connection works.

Create a Port for IDoc Processing

1. Enter transaction code:

   WE21

   The Ports in IDoc Processing screen opens.

2. In the table, select XML HTTP.

3. In the application toolbar, click Create.

   The Add XML HTTP Port screen opens.

4. Set the port fields as follows:

   Field	Value
   Port	The name for the port.
   Description	A description for the port. For example: xml http port for Tray.IO
   RFC Destination	Select the connection you created in Create an HTTPS Connection to the External Server.
   Content Type	Make sure this is set to Text/XML.
   SOAP Protocol	Make sure this checkbox is cleared.

5. In the Toolbar, click Save.

Create Partner Profiles

You need to create both an inbound and an outbound partner profile to handle information coming in from MaintainX and information going out to MaintainX respectively.

This section describes how to create a new partner profile, and how to configure it for inbound or outbound information.

Create a New Partner Profile

1. Enter transaction code:

   WE20

   The Partner Profiles screen opens.

2. In the application toolbar, click Create.

3. Configure the new partner profile as follows:

   Field	Value
   Partner No.	The name of the logical system you created in Create a New Logical System
   Partn. Type	Select LS.

   In the Post Processing: permitted agent section:

   Field	Value
   Ty.	Select the user agent type for the user associated with this partner profile. for example, US for User.
   Agent	Select the user you create in Create a New SAP User for the Integration
   Lang.	Select your preferred language.

4. From the toolbar, Click Save.

5. Do one of the following:

   • If you're creating an inbound partner profile, follow the instructions in Set Inbound Partner Profile Parameters.
   • If you're creating an outbound partner profile, follow the instructions in Set Outbound Partner Profile Parameters.

Set Inbound Partner Profile Parameters

In the partner profile options, go to the Inbound parmtrs. table, and add the IDocs you want the MaintainX integration to interact with.

The list is different depending on the type of MaintainX entity you're setting up the integration for.

For each IDoc type, you need to create and configure a new inbound parameter.

To create a new inbound parameter:

1. Under the Inbound parmtrs. table, click the Create inbound parameter (+) button. The Partner profiles: Inbound parameters screen opens.

2. On the The Partner profile: Inbound parameters screen, enter the Message type and Process code for the IDoc type you want to configure.

   The tables below list the correct values for each IDoc type:

   Parts Inventory

   Message type	Process code	Description
   MATMAS	MATM	Parts information
   MBGMCR	BAPI	Inventory control

   Purchase Orders

   Message type	Process code	Description
   PORDCH	BAPI	Update a purchase order
   PREQCR	BAPI	Create a purchase request
   PORDCR	BAPI	Create a purchase order
   CREMAS	CRE1	Vendor information

Set Outbound Partner Profile Parameters

In the partner profile options, go to the Outbound parmtrs. table, and add the IDocs you want the MaintainX integration to interact with.

The list is different depending on the type of MaintainX entity you're setting up the integration for.

For each IDoc type, you need to create and configure a new outbound parameter.

To create a new outbound parameter:

1. Under the Outbound parmtrs. table, click the Create outbound parameter (+) button. The Partner profiles: Outbound parameters screen opens.

2. On the The Partner profile: Outbound parameters screen, fill in the following fields:

   • Message type
   • On the Outbound Options tab:
     • Receiver port
     • Output Mode
     • Basic type (in the IDoc Type section)

   The tables below list the correct values for each IDoc type:

Parts Inventory

Message Type	Receiver port	Basic type	Output Mode	Description
MATMAS	Use the port you created in Create a Port for IDoc Processing	MATMAS05	Pass IDoc Immediately	Parts information
LOIMSO	Use the port you created in Create a Port for IDoc Processing	LOIMS01	Pass IDoc Immediately	Inventory control

Purchase Orders

Message Type	Receiver port	Basic type	Output Mode	Description
ORDERS	Use the port you created in Create a Port for IDoc Processing	ORDERS05	Pass IDoc Immediately	Purchase order information
CREMAS	Use the port you created in Create a Port for IDoc Processing	CREMAS06	Pass IDoc Immediately	Vendor information

Create a Distribution Model to Trigger an Outbound IDoc

1. Enter transaction code:

   BD64

   The Display Distribution Model screen opens.

2. From the menu, select Distribution Model > Switch Processing Mode to switch to editing mode.

   The title bar should now read Change Distribution Model.

3. From the menu, select Edit > Model View > Create. The Create Model View dialog opens.

4. Configure the model view as follows:

   Field	Value
   Short text	Enter a description for the model view.
   Technical name	Enter a name of the model view.
   MainT System	Set this to the inbound logical system you created in Create a New Logical System.

5. Click Continue (checkmark). You should see the new distribution model in the table.

6. Select the new distribution model, and, from the menu, select Edit > Add Message Type. The Add Message Type dialog opens.

7. Configure the message type as follows:

   Field	Value
   Model view	This should be set to the name of the distribution model you just created.
   Sender	Set this to the inbound logical system you created in Create a New Logical System.
   Receiver	Set this to the outbound logical system you created in Create a New Logical System.
   Message Type	Set this to MATMAS.