SOAP setup - j5 - 30 - Connectors & Integration

Select the SOAP connection protocol option.

Wizard - SOAP setup

Enter the SOAP connection details.

For more details, see SOAP protocol configuration

SAP Production Environment - Select True when you're setting up a Production environment.
Use j5 SAP PM Connector v2 - Select True when you want j5 to connect to SAP using the SAP Add-on Installation. Refer to j5 SAP Connector for more information.
Certificate Bundle Filename - If your SOAP connection uses HTTPS (recommended for security) and has a custom certificate chain (issued within your organization rather than part of the public trust network), you can use this setting to supply the required certificates. Navigate to the SSL certificate chain for j5 to connect to SOAP using HTTPS or enter the path to the file's location.

For more details, see Certificate bundle configuration
The certificate bundle configuration needs to point to a local file containing a Base64-encoded X.509 certificate store in PEM format, with the full chain of certificates: Root Certificate Authority, Intermediate Certificate Authority, and server certificate (in that order).

To create such a file:
1. Go to the HTTPS URL in your web browser. View the certificate chain.
2. Open the Windows Certificate Store in the Microsoft Management Console. Find each relevant certificate, and select Action > All Tasks > Export.
3. Save each certificate as a Base-64 encoded X.509 (.CER) file.
4. Create a new file in a text editor, and copy the contents of the other files into it.
Ensure that all the URLs use HTTPS. If they use HTTP, you will encounter an SSL Protocol Error because j5 will attempt to communicate with HTTPS.

Select SOAP as your connection configuration point

The information provided below is based on a standard setup. For customized setups, please consult your j5 service provider.

Setting	Description	Default
Enable Functional Location Sync	The URL to retrieve the WSDL document from, for setting up the Functional Location SOAP service.	True
Enable Equipment Sync	The URL to retrieve the WSDL document from, for setting up the Read Tables SOAP service.	True
Enable Work Order Sync	The URL to retrieve the WSDL document from, for setting up the Work Orders SOAP service.	True
Enable Operations Sync	The URL to retrieve the WSDL document from, for setting up the SOAP service for creating Work Notifications.	True
Enable Notification Sync	The URL to retrieve the WSDL document from, for setting up the Work Order Operations SOAP service.	True
Equipment WSDL URL	The URL to retrieve the WSDL document from, for setting up the Equipment SOAP service.	None
Functional Location WSDL URL	The URL to retrieve the WSDL document from, for setting up the Functional Location SOAP service.	None
Read Tables WSDL URL	The URL to retrieve the WSDL document from, for setting up the Read Tables SOAP service.	None
Work Orders WSDL URL	The URL to retrieve the WSDL document from, for setting up the Work Orders SOAP service.	None
Create Notifications WSDL URL	The URL to retrieve the WSDL document from, for setting up the SOAP service for creating Work Notifications.	None
Operations WSDL URL	The URL to retrieve the WSDL document from, for setting up the Work Order Operations SOAP service.	None
Equipment Method	The name of the SAP function used for retrieving equipment. Only used when SOAP is enabled with the v1 connector.	For a standard SAP system, the recommendation is to enter BAPI_EQUI_GETLIST.
Functional Location Method	The name of the SAP function used for retrieving functional locations. Only used when SOAP is enabled.	For a standard SAP system, the recommendation is to enter BAPI_FUNCLOC_GETLIST.
Work Orders Method	The name of the SAP function used for retrieving work orders. Only used when SOAP is enabled.	For a standard SAP system, the recommendation is to enter BAPI_ALM_ORDERHEAD_GET_LIST.
Create Notification Method	The name of the SAP function used for creating notifications. Only used when SOAP is enabled with the v1 connector.	For a standard SAP system, the recommendation is to enter EM_NTF_ORD_CREATE.
Operations Method	The name of the SAP function used for retrieving work order operations. Only used when SOAP is enabled.	For a standard SAP system, the recommendation is to enter BAPI_ALM_ORDEROPER_GET_LIST.
RFC Read Table Method	The name of the SAP function used for retrieving information from specific tables in SAP. Only used when SOAP is enabled with the v1 connector.	For a standard SAP system, the recommendation is to enter RFC_READ_TABLE or BBP_RFC_READ_TABLE.

Some of the methods are only visible or relevant when the v1 connector is used.

The Retry sending SOAP messages on failure checkbox is selected by default. This allows j5 to retry sending messages to SOAP when it doesn't get a response before the configured timeout period (the timeout period is configured on the next screen). If you don't want j5 to retry after the timeout period, clear this checkbox.
Select the Use j5 SAP PM Connector v2 checkbox when you want your j5 SAP connector to connect to SAP using the SAP Add-on Installation.

For more details, see j5 SAP Connector
The j5 SAP PM Integration supports two connection methods: v1 (standard BAPI) and v2 (SAP Add-on installation).

j5 SAP PM v2 Connector

The v2 Connector was released in j5 SAP PM 30 update 6.

The v2 Connector has the following features:
- It's certified by SAP.
- It supports the creation of notification records from j5 to SAP.
- It uses the standard BAPIs and the new certified extension points.
- It can be deployed to j5 on-premise and j5 on Smart Cloud.
- It was tested successfully with a large volume of data.
- j5 on Smart Cloud supports the use of the SOAP interface only.
- SAP ECC transport is available on request.
- SAP S/4 HANA transport fixes an issue with equipment ordering and is available on request.
We recommend you use the updated SAP S4/HANA version.

j5 SAP PM v1 Connector

The v1 Connector has the following limitations:
- SAP notifications can't be created from j5 with the latest versions of SAP.
- SAP customization is sometimes necessary.
- It requires permissions to execute the RFC_READ_TABLE function. This was sometimes viewed as problematic from a SAP security perspective.
The SAP Production Environment checkbox is selected by default. If you're setting up a non-production environment (for example, a testing environment), clear this checkbox.
Select the Disable SOAP Connection checkbox if the SAP interface isn't required or if it will be configured later.

Select Next.

Enter the general SAP configuration details.

For more details, see j5 SAP PM General Configuration

This configuration screen allows you to configure certain settings pertaining to the j5 SAP PM Integration.

Option	Description	Default
Company Code Restrictions for Maintenance Plants	This setting configures the relevant company codes for the work orders from each maintenance plant. When fetching work orders, a filter will be set to include only the specified company codes for the maintenance plant. For more details, see Company Code Restrictions for Maintenance Plants The Company Code Restrictions for Maintenance Plants option allows j5 to use the OPTIONS_FOR_COMP_CODE option on BAPI calls to fetch work orders. This can result in better performance on large installations. The value is formatted as first a company code, followed by a colon (:), then a comma-separated list of maintenance plants under that code, followed by a semicolon (;) to separate each company code section. For example, if you have Maintenance Plants 1000, 1100, 1200 and 1300 under Company Code 1000, and Plant 3000 under Company Code 3000, the configuration will be: 1000:1000,1100,1200,1300;3000:3000
Equipment Status Filter	Defines whether the equipment statuses (below) are included or excluded from the import.	Exclude
Equipment Statuses	A comma-separated list of the equipment statuses. Only four-character SAP statuses can be used. (For example, AVLB, DLFL, INST) Compound four-character statuses with space separators are not allowed.
Functional Location Status Filter	Defines whether the functional location statuses (below) are included or excluded from the import.	Exclude
Functional Location Statuses	A comma-separated list of functional location statuses. Only four-character SAP statuses can be used. (For example, AVLB, DLFL, INST) Compound four-character statuses with space separators are not allowed.
Maintenance Plant Filter	A comma-separated list of maintenance plants that need to be imported. When specified, each request is split up for functional locations, equipment, work orders and notifications, and one maintenance plant is requested per request.
Maintenance Plant Restrictions for Planning Groups	If your SAP installation is very large, requests need to be chunked to keep the replies small enough for SAP PM to be able to reply. Maintenance Plants Filter (above) is one of the main chunking configuration points. If chunking by maintenance plants isn’t enough, here you can specify a mapping of which planning groups to fetch for each maintenance plant. When this is specified, the Planning Group Filter is ignored, and this mapping is used instead. For more details, see Maintenance Plant Restrictions for Planning Groups The Maintenance Plant Restrictions for Planning Groups option allows j5 to use a map to filter only by relevant planning groups for that maintenance plant on BAPI calls. This can result in better performance on large installations. This overrides any value set in Planning Group Filter. The value is formatted as first a maintenance plant, followed by a colon (:), then a comma-separated list of planning groups under that code, followed by a semicolon (;) to separate each maintenance plant section. The special value NULL is used to indicate the filter should include the empty option for planning group. If a maintenance plant has no planning groups configured, the BAPI calls for that maintenance plant will not filter by PLANGROUP_RA. For example, if you have Planning Groups 100, IW3 and ZH1 under Maintenance Plant 1000, and Planning Groups 100, 101, 102 under Maintenance Plant 3000, and some Functional Locations under Maintenance Plant 3000 having no Planning Group, the configuration will be: 1000:100,IW3,ZH1;3000:100,101,102,NULL
No IN PROCESS filter on Work Orders	Removes the SHOW_DOCUMENTS_IN_PROCESS filter when fetching work orders.
Notification Types	A comma-separated list of notification types that should be imported.
Planning Group Filter	A comma-separated list of planning groups that should be imported.
Planning Plants Filter	A comma-separated list of planning plants that should be imported.
Restrict Work Order FROM and TO Date	Tightens the filter on SHOW_DOCS_WITH_FROM_DATE and likewise for TO for fetching work orders. For more details, see Restrict Work Order FROM and TO Date By default, when fetching work orders, j5 uses the most permissive settings for SHOW_OPTIONS_WITH_FROM_DATE and SHOW_OPTIONS_WITH_TO_DATE to prevent any variance in these from the synchronization windows from missing work orders. This can cause performance issues with very large SAP installations. The option Restrict Work Order FROM and TO Date tightens these filters to set SHOW_OPTIONS_WITH_FROM_DATE to the start of the period being fetched, and SHOW_OPTIONS_WITH_TO_DATE to the current day. There is a risk that this will cause valid work orders to be filtered out.	False
Restrict Work Order Release Date	Tightens the filter on OPTIONS_FOR_ACTUAL_RELEAS_DATE for fetching work orders. For more details, see Restrict Work Order Release Date By default, when fetching work orders, j5 filters work orders to those which have been released (so SHOW_OPTIONS_WITH_ACTUAL_RELEAS_DATE greater than zero). This can cause performance issues with very large SAP installations. The option Restrict Work Order Release Date tightens this filter to only fetch work orders which have been released since the start of the period being synced for new work orders, and only fetch work orders which have been released since the initial sync start as set in option Synchronize From Date.	False
Sort Field Filter	A comma-separated list of sort field values that should be imported.
Work Order Operation Deleted Statuses	A comma-separated list of statuses that denote a work order as deleted, and should not be synced.	DLT
Work Order Types	A comma-separated list of work order types that should be imported.
Misc	-	-
Include Sub-equipment	Select True to import the sub-equipment of the equipment items into j5. Select False to exclude the sub-equipment.	True
Language	The language used in SAP integration calls.	EN
Sync	-	-
Automatic Sync	Select False to manually trigger the sync. For more details, see Automatic Sync and Automatic WRO Sync schedules Automatic Sync and Automatic WRO Sync cannot run at the same time due to memory limits. If one sync operation is already running the other will not run as j5 prioritizes the syncs on a first come - first serve basis. If a sync cannot run at its scheduled time due to the other sync running, it emails the administrator with an error alert that the sync failed to run. Therefore, you need to set up the scheduler times in such a way that it will guarantee that both will not run at the same time. For example: Automatic Sync: Hour: 01 Sync Period: Daily Automatic WRO Sync: Hour: 01 Minute: 30 WRO Sync Period: Hourly	True
Cache Folder Path for SAP Synchronization	The path to a folder where sync data is cached during the synchronization. The default folder is the j5 program data cache folder.
Disable Creation of IndustraForms on Bulk Imports	Select True to prevent the creation of IndustraForms when doing a bulk import from SAP.	True
Hour	The time the sync will take place.	01
Prepend to Asset Register Description	Select what should be added to the beginning of the SAP equipment descriptions when the SAP equipment is imported into the j5 Asset Register. The options are Nothing, Equipment ID, and Functional Location.	Equipment ID
Sync Period	A dropdown selection of sync period options. The options are Daily, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, and Monthly.	Daily
WROSync	-	-
Automatic WRO Sync	Select False to manually trigger the sync. For more details, see Automatic Sync and Automatic WRO Sync schedules Automatic Sync and Automatic WRO Sync cannot run at the same time due to memory limits. If one sync operation is already running the other will not run as j5 prioritizes the syncs on a first come - first serve basis. If a sync cannot run at its scheduled time due to the other sync running, it emails the administrator with an error alert that the sync failed to run. Therefore, you need to set up the scheduler times in such a way that it will guarantee that both will not run at the same time. For example: Automatic Sync: Hour: 01 Sync Period: Daily Automatic WRO Sync: Hour: 01 Minute: 30 WRO Sync Period: Hourly	True
Hour	The time the WRO sync will take place.	01
Minute	The minute the WRO sync will take place.	00
WRO Sync Period	Determines whether the sync should happen hourly or daily.	Hourly

SOAP setup - j5 - 30 - Connectors & Integration - Hexagon

j5 and SAP PM Configuration