This document describes how to install the IFS integration to IFS Enterprise RCM.
When the necessary IFS components and IFS Enterprise RCM components are installed, this guide describes how to configure the two systems to work together.
Note: Please note that many of the system settings are already inserted into the system. However, in some cases, these setting needs to be verified and/or modified. This guideline is also useful for troubleshooting scenarios.
For an Azure hosted RCM Toolkit
Please contact RCM-Toolkit.Support@baesystems.com. You will be given two 32 character strings for customer id and web service token.
For a locally hosted Toolkit
You need to get the Web Service Token for the customer from the Toolkit
database. You can get this by running the following SQL statement:
SELECT * FROM CustomerWebServices
If the table is empty, please run the following SQL:
INSERT INTO CustomerWebServices SELECT CustomerID, NewID() FROM Customers
Note: Please keep these values secure – they are the username/password needed by the interface to access the customer’s Toolkit database.
The required parameters below are found in Solution Manager/System Parameters with the following Parameter Name:
Customer Id to connect RCM Toolkit
This parameter is used to identify a unique RCM Toolkit instance. One IFS
applications instance can only have one RCM Toolkit instance, but the Toolkit
can be connected to many IFS instances. Enter the Customer Id provided by the
Toolkit under the property value. See below for instructions on obtaining this
value.
Token to connect RCM Toolkit
Each RCM toolkit Customer ID will have a unique Token. Enter the correct token
in the property value. See step above for instructions on obtaining this value.
Below parameter required is found in Application Base Setup/System Setup/System Definitions/Object Property tab with the following Parameter Property Name:
ENABLE_RCM - Possible values are TRUE or FALSE. TRUE means RCM integration is activated for basic data and insert/update on respective IFS tables will trigger data transfer to RCM integration. FALSE means although RCM Integration is installed it is not activated for basic data. Therefore insert/update on respective IFS tables will NOT trigger data transfer to RCM integration. This parameter now controls the available basic data schedule tasks only.
Toolkit Server Address
In some of the steps below, the BizAPIs require the address of the Toolkit
Server.
If the customer is using the Azure hosted RCM Toolkit, the server address is:
https://www.rcmtoolkit.net/RCMToolkit_api.asmx
If the customer is hosting the RCM Toolkit locally, you will need to ask the
server’s administrator for the correct URL. It will usually be of the format:
http(s)://[ServerName]/RCMToolkit/RCMToolkit_api.asmx
Enable RCM related context menu options
In order to enable context menu options in RCM Toolkit the
relevant RCM Toolkit user must have the Admin, Author, and Reviewer roles
assigned. This is done in the RCM Toolkit Client.
All the required routing addresses and routing rules below are created during the initial installation. But the values must be checked before enabling them.
Check if the following transformers are installed in Solution Manager/Integration/IFS Connect/Setup IFS Connect, navigate to the node Integration/Transformers.
RCM_SEND_LIVE_ANALYSIS_IDS_TRANS
RCM_SEND_LIVE_ANALYSIS_TRANS
RCM_UPDATE_FOLDERS_TRANS
RCM_UPDATE_BASIC_DATA
RCM_UPDATE_EQP_TRANS
RCM_UPDATE_TASKS_TRANS
Check Envelopes in Solution Manager/Integration/IFS Connect/Setup IFS Connect, navigate to the node Integration/Envelopes. RCM_SOAP_SIMPLE envelope must be installed.
Check if the Message classes are setup as follows in Solution Manager/Integration/Connectivity/Setup Connectivity:
Check for the Message Receiver:
Routing Address is defined in Solution Manager/Integration/IFS Connect/Routing Addresses. All the following routing addresses must be present. The http sender details needs to be set to the details of the web service connected to RCM toolkit. Therefore change the URL and SOAP action accordingly. Also verify that Format options are set as described below.
Note: For RCM Receive MMS Links this is only incoming routing address. Manual changes are not necessary. Check for the following settings above.
Under tab Outbound in Solution Manager/Integration/IFS Connect/Routing Rules, please check if the following routing rules are enabled and setup like below:
Check if the following database task is available in Solution Manager/Backgroud Processsing/Database Tasks/Database Tasks:
Create Basic Data Bizapi Messages for RCM Toolkit
The database task in step 4 needs to be scheduled. When scheduling this task, consideration must be given to how often you need the toolkit and IFS applications to be synchronized. Open My Administration/Scheduled Tasks/Schedule Database Tasks. Using this window it is possible to set how often the above task needs to run.
Search for the task you want to set the schedule for. RMB on the task and select View Schedule:
Select the appropriate schedule interval. Set task
Active and save.
This parameter is found in Application Base
Setup/System Setup/System Definitions/Object Property tab. The parameter
is tagged as RcmIntegration for column Object LU in the
Parameter Property Name.
During the initial setup stage when the above parameters are set, and the
FULL_UPDATE flag is set to TRUE, IFS Applications would send all the basic data
to the RCM Toolkit.
Once all basic data is transferred, the FULL_UPDATE flag will be set to FALSE
automatically. If basic data items are not transferred to the RCM Toolkit check
Solution Manager/Integration/IFS Connect/Application
Messages for any errors. Once all the errors are corrected the
FULL_UPDATE flag can be manually set to TRUE to resend all the data back to the
RCM Toolkit.
The Prepare for RCM Analysis dialog under Service and
Maintenance/Preventive Maintenance/RCM Integration, will send RCM Analysis data
to the Toolkit. Enter the required data and click OK to trigger a
background job for the data transfer.
The Monitor RCM Analysis Preparation window under Service and Maintenance/Preventive Maintenance/RCM Integration, will shows all the messages sent to the Toolkit to prepare RCM Analysis.
The Receive RCM Analysis dialog under Service and Maintenance/Preventive Maintenance/RCM Integration, forces the Toolkit to send the live RCM Analysis details to IFS Applications, which can be used to create or edit a PM Action. If the same version of the RCM Analysis is already received it will not be received again. The From Date and To Date fields are mandatory to identify the validity of the RCM Analysis.
The Monitor RCM Analysis Receipt window in Service and Maintenance/Preventive Maintenance/RCM Integration, will shows all the live RCM Analysis received. Right-click on a line and select View/Apply RCM Analysis to create PM Actions from the received RCM Analysis data.
