Sunteți pe pagina 1din 364

Nucleus 360

Application Version: 5.2.0


Operation Instructions

Operations Guide
Document Revision: 1
Publication Date: October 1, 2015
Prepared for: IMS Health

Prepared by: Technology Solutions


This document contains information specific to IMS Health. This document is protected by copyright laws and the information
contained herein shall not be reproduced or distributed in whole or in part, under any circumstances without the prior written
permission of IMS Health. Names of IMS Health solutions, products, and services are either trademarks or registered trademarks of
IMS Health.

IMS Health
1425 U.S. Highway 206
2015 IMS Health Bedminster, NJ 07921 908.443.2000 DEV-OPSG-US-05
Nucleus 360 Version 5.2.0
Operation Instructions

CONTENTS
1. Publication Record.............................................................................................................................. 21
2. Introduction.......................................................................................................................................... 22
2.1 Purpose and Audience..................................................................................................................... 22
2.2 User Prerequisites............................................................................................................................ 22
2.3 Documentation Conventions............................................................................................................ 22
3. Text Conventions................................................................................................................................. 23
3.1 Running SQL Plus............................................................................................................................ 23
3.2 Accessing Microsoft Windows Command Prompt............................................................................23
4. Nucleus 360 Conventions................................................................................................................... 24
4.1 Environment Variables..................................................................................................................... 24
4.2 Server Layer Directory Structure...................................................................................................... 24
5. Operation Checklist............................................................................................................................. 28
5.1 System Initialization.......................................................................................................................... 28
5.2 Third Party Data Processing Strategy.............................................................................................. 28
5.2.1 Processing Batch Data.............................................................................................................. 28
5.2.2 Processing Real-Time Data....................................................................................................... 32
5.3 Processing Data Files...................................................................................................................... 35
6. Middle Tier Servers.............................................................................................................................. 38
6.1 Overview.......................................................................................................................................... 38
6.2 Common Server............................................................................................................................... 38
6.2.1 Description................................................................................................................................. 38
6.2.2 Prerequisites.............................................................................................................................. 38
6.2.3 Command Line Parameters/Usage............................................................................................ 39
6.3 Customer Resolution Server............................................................................................................ 39
6.3.1 Description................................................................................................................................. 39
6.3.2 Prerequisites.............................................................................................................................. 39
6.3.3 Command Line Parameters/Usage............................................................................................ 40
6.4 Configuration Assistant Server......................................................................................................... 40
6.4.1 Description................................................................................................................................. 40
6.4.2 Prerequisites.............................................................................................................................. 40
6.4.3 Command Line Parameters/Usage............................................................................................ 41
6.5 Practitioner Verification Server......................................................................................................... 41
6.5.1 Description................................................................................................................................. 41

IMS Health Operations Guide Page 2 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.5.2 Prerequisites.............................................................................................................................. 42
6.5.3 Command Line Parameters/Usage............................................................................................ 42
6.5.4 General Troubleshooting on a Client Machine...........................................................................42
6.6 Middle Tier Startup and Maintenance...............................................................................................44
6.6.1 Middle Tier System Structure and Directory Layout...................................................................44
6.7 Middle Tier Server Operation........................................................................................................... 45
6.7.1 Running Servers as Windows 2008 Services............................................................................46
6.7.2 Running All Servers as Normal Console Applications on Windows 2008..................................47
6.7.3 Starting a Middle Tier Server Automatically...............................................................................47
6.7.4 Starting a Middle Tier Server Manually......................................................................................48
6.7.5 Using the Orbix Server Manager............................................................................................... 48
6.7.6 Starting a Server Manually via Orbix Server Manager...............................................................50
6.7.7 Viewing a Listing of All Registered Server Executables.............................................................51
6.7.8 Stopping (Killing) a Server Manually.......................................................................................... 51
6.8 Troubleshooting................................................................................................................................ 52
6.8.1 Middle Tier Machine on Windows 2008.....................................................................................52
7. Standardizer Server............................................................................................................................. 54
7.1 Command Line Parameters/Usage.................................................................................................. 54
7.2 Running the Standardizer Daemon from the Windows Command Prompt.......................................55
7.2.1 Launch the Server..................................................................................................................... 55
7.2.2 Shut Down the Server................................................................................................................ 55
7.2.3 Output........................................................................................................................................ 55
7.3 Running the Standardizer Daemon via the ONE Point Application...................................................56
7.4 Checking Status of the Server.......................................................................................................... 56
7.4.1 View the Status.......................................................................................................................... 56
7.5 Troubleshooting................................................................................................................................ 56
7.5.1 Standardizer Daemon Is Not Running/Unable to Reach Daemon.............................................56
7.5.2 Standardizer Daemon Is Already Running/Unable to Launch Daemon.....................................57
7.5.3 Standardizer Daemon Is Already Running but Address Standardization Does Not Happen......57
Note:................................................................................................................................................... 57
8. Web Server........................................................................................................................................... 58
8.1 Overview.......................................................................................................................................... 58
8.2 Customer Maintenance Java Business Objects...............................................................................58
8.2.1 Description................................................................................................................................. 58
8.3 Tomcat Startup and Maintenance..................................................................................................... 58
8.3.1 Tomcat Server Directory Layout................................................................................................. 58

IMS Health Operations Guide Page 3 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8.3.2 Tomcat Maintenance.................................................................................................................. 59


8.4 Server Operation.............................................................................................................................. 59
8.4.1 Running Tomcat as Windows 2008 Services.............................................................................59
8.4.2 Running Tomcat Server as Normal Application on Windows 2008............................................60
8.5 Troubleshooting................................................................................................................................ 60
8.5.1 Help Does Not Display Contents............................................................................................... 60
9. Data Import Process............................................................................................................................ 61
9.1 Overview.......................................................................................................................................... 61
9.1.1 What Data Import Process Does............................................................................................... 61
9.1.2 What Data Import Process Requires.........................................................................................61
9.2 Operational Modes........................................................................................................................... 61
9.3 The Run Script run_dataimport.exe.................................................................................................. 62
9.4 Command Line Parameters............................................................................................................. 65
9.5 Running the Process in Batch Compare Mode................................................................................69
9.5.1 Identify Source Files.................................................................................................................. 70
9.5.2 Verify Postalsoft (IACE) Directories...........................................................................................70
9.5.3 Perform a Dry Run..................................................................................................................... 71
9.5.4 Analyze the Dry Run Results..................................................................................................... 72
9.5.5 Load Data Using run_dataimport.exe in Non-Auto Mode..........................................................72
9.5.6 Analyze the Results................................................................................................................... 72
9.5.7 Load Data Using run_dataimport.exe in Auto Mode (-a option)...............................................72
9.6 Running the Data Import Process in Transactional Mode................................................................73
9.6.1 Identify Source File.................................................................................................................... 73
9.6.2 Verify Postalsoft Directories....................................................................................................... 73
9.6.3 Load Data.................................................................................................................................. 73
9.6.4 Analyze the Load Results.......................................................................................................... 73
9.7 Running the Data Import for XML Data............................................................................................73
9.7.1 Identifying/Preparing the Configuration File...............................................................................73
9.7.2 Running the Data Import Process in Transactional Mode..........................................................74
9.7.3 Identify Source File.................................................................................................................... 74
9.7.4 Verify Postalsoft Directories....................................................................................................... 74
9.7.5 Load Data.................................................................................................................................. 74
9.7.6 Analyze the Load Results.......................................................................................................... 75
9.7.7 Running the Data Import Process in Real-time Mode................................................................75
9.7.8 Load Data.................................................................................................................................. 75
9.7.9 Load Data from a Priority Queue...............................................................................................75

IMS Health Operations Guide Page 4 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.7.10 Writing Rejected Transactions to Exception Queue.................................................................75


9.7.11 Handling Rejected Transactions.............................................................................................. 76
9.7.12 Shut Down the Real-time Import Process................................................................................76
9.7.13 Analyze the Load Results........................................................................................................ 76
9.8 Running Data Import Process Using ONE Point Application............................................................77
9.8.1 Batch Import.............................................................................................................................. 77
9.8.2 Real Time Import....................................................................................................................... 77
9.9 Operation Instructions to Load OneKey Data into Nucleus 360.......................................................77
9.9.1 Overview.................................................................................................................................... 77
9.9.2 Manual OneKey Staging Import and Code Processing...........................................................82
9.9.3 Manual - OneKey Data Processing (IDL)...................................................................................85
9.9.4 Automatic OneKey Data Processing (IDL)..............................................................................93
9.10 Operation Instructions to Load OneKey F-II Data into Nucleus 360...............................................95
9.10.1 Overview.................................................................................................................................. 95
9.10.2 OneKey F-II Data Load............................................................................................................ 96
9.11 Monitoring the Data Import Process............................................................................................. 108
9.12 Analyze Table............................................................................................................................... 109
9.13 Troubleshooting............................................................................................................................ 109
9.13.1 Check paths in ace.cfg and dir expiration dates (or) Check paths in configuration file and dir
expiration dates................................................................................................................................ 109
9.13.2 Kickout files cannot exist........................................................................................................ 110
9.13.3 Options [o | n | d | w] are required.......................................................................................... 110
9.13.4 Delta Exception: Phase Init(0), Code: delta engine initialization error(10) Description: errno(2)
LFileResultSet open error in <new_file.txt>......................................................................................110
9.13.5 An entry in NP_DELTA_RECOVER table already exist for this mapping................................111
9.13.6 The files are not in proper chronological order.......................................................................111
9.13.7 FAIL: transaction rejected and sent to bad files. See log........................................................111
9.13.8 No item code is found for External Item Code external item................................................112
9.13.9 Running Bad Files through NPDataImport.............................................................................112
9.13.10 newline not found................................................................................................................. 113
9.13.11 Expected record length <Record Length>............................................................................113
9.13.12 Key field field name is empty in file name row record # field: field position................114
9.13.13 Not null field field name is empty in file name row record # field: field position..........114
9.13.14 Keys not exclusively incremental at file name row record #............................................115
9.13.15 Database and ACE/IACE Postalsoft Errors..........................................................................115
9.13.16 LException: No more database connections available.........................................................115
9.13.17 Delta Exception: Phase Delta(3), Code: transaction manager processing error..................116
IMS Health Operations Guide Page 5 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.18 An Unhandled Exception occured. Refer to the dump file for details.
npdataimport.exe_YYYYMMDD_HHMMSS.dmp..............................................................................116
9.13.19 Processing Real-time Exception Messages.........................................................................117
9.13.20 List of Errors Logged by the run_dataimport Script..............................................................119
9.13.21 Exception Handling During OneKey Data Load...................................................................121
9.13.22 Processing Rejected OneKey Profiles.................................................................................121
9.14 Restarting the Data Import Process.............................................................................................128
9.15 Tables Modified by Data Import Process......................................................................................128
10. DQT - Populating the De-normalized Query Tables......................................................................129
10.1 Overview...................................................................................................................................... 129
10.1.1 What DQT Does.................................................................................................................... 129
10.1.2 What DQT Requires.............................................................................................................. 129
10.2 Main Procedure............................................................................................................................ 129
10.2.1 Main Procedure Arguments................................................................................................... 130
10.2.2 Running DQT in Incremental Mode.......................................................................................130
10.2.3 Running DQT in Refresh Mode.............................................................................................. 130
10.2.4 Log File.................................................................................................................................. 130
10.3 ProcessImportedProfiles Function................................................................................................130
10.3.1 ProcessImportedProfiles Function Arguments.......................................................................131
10.3.2 Running DQT in Real-time Mode...........................................................................................131
10.3.3 Log File.................................................................................................................................. 131
10.4 processSingleProfile Procedure................................................................................................... 131
10.4.1 processSingleProfile Procedure Arguments...........................................................................132
10.4.2 Running DQT for a Single Profile........................................................................................... 132
10.4.3 Log File.................................................................................................................................. 132
10.5 Analyze Results............................................................................................................................ 132
10.6 Running DQT Process Using ONE Point Application...................................................................132
10.7 Analyze Table............................................................................................................................... 133
10.8 Troubleshooting............................................................................................................................ 133
10.8.1 identifier must be declared..................................................................................................... 133
10.8.2 The parameters passed to procedure are invalid...................................................................133
10.8.3 When any database package is invalid =>............................................................................134
10.8.4 When the error message range is not between ORA-20000 and ORA-20999 =>.................135
10.9 Restarting the Process................................................................................................................. 135
10.10 Tables Modified by DQT............................................................................................................. 135

IMS Health Operations Guide Page 6 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

11. Data Quality Process....................................................................................................................... 136


11.1 Overview....................................................................................................................................... 136
11.1.1 What Data Quality Process Does........................................................................................... 136
11.1.2 What Data Quality Process Requires.....................................................................................136
11.2 Process Parameters..................................................................................................................... 136
11.3 Running Data Quality Rules Engine.............................................................................................137
11.4 Running Data Quality Rules Engine for a Single Profile...............................................................138
11.4.1 Output Generation................................................................................................................. 138
11.5 Running Data Quality Process Using ONE Point Application.......................................................138
11.6 Analyze Table............................................................................................................................... 139
11.7 Monitoring the Data Quality Process............................................................................................ 139
11.8 Troubleshooting............................................................................................................................ 139
11.8.1 When the Parameter Is Not Passed Correctly.......................................................................139
11.8.2 When Any Database Package Is Invalid =>...........................................................................140
11.8.3 When Invalid Component Type Is Passed as Argument Value...............................................140
11.8.4 When Invalid Process Mode Is Specified...............................................................................140
11.9 Restarting the Process................................................................................................................. 141
11.10 Tables Modified Directly by Data Quality Process......................................................................141
12. The Hash Creator............................................................................................................................. 142
12.1 Overview...................................................................................................................................... 142
12.1.1 What Hash Does.................................................................................................................... 142
12.1.2 What Hash Requires.............................................................................................................. 142
12.2 The Run Script run_hashcreator.exe............................................................................................ 143
12.3 Command Line Parameters/Usage..............................................................................................143
12.4 Executing the Process.................................................................................................................. 144
12.4.1 Run for locked profiles in STG_IMPORTED_PROFILE table (Incremental Mode)................144
12.4.2 Run for All Active Profiles (Refresh Mode).............................................................................144
12.4.3 Output.................................................................................................................................... 144
12.5 Executing the Process Using nphash.exe....................................................................................145
12.5.1 To Delete Profiles from NUC_PROFILE_LKUP Table............................................................145
12.5.2 To Truncate NUC_PROFILE_LKUP Table.............................................................................145
12.5.3 To Clean Up NUC_PROFILE_LKUP Table from Inactive Data..............................................145
12.5.4 To Generate Hash Keys in Incremental Mode.......................................................................145
12.5.5 To Generate Hash Keys in Refresh Mode..............................................................................146
12.5.6 To Refresh Hash Keys for Profiles in STG_IMPORTED_PROFILE without Submitting Them for
Matching........................................................................................................................................... 146

IMS Health Operations Guide Page 7 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

12.5.7 To Refresh Hash Keys for a Range of Profiles Without Submitting Them for Matching.........146
12.5.8 Verify Successful Completion................................................................................................ 146
12.6 Running the Hash Process Using ONE Point Application............................................................146
12.7 Monitoring the Hash Process....................................................................................................... 147
12.7.1 View Progress........................................................................................................................ 147
12.8 Analyze Table............................................................................................................................... 148
12.9 Troubleshooting............................................................................................................................ 148
12.9.1 Rollback Segment Errors....................................................................................................... 148
12.9.2 The Logging option is required. A log file name must be passed...........................................149
12.9.3 Hash Key Configuration ID option argument is required........................................................149
12.9.4 Hash Key Configuration Code argument is required..............................................................149
12.10 Restarting the Process............................................................................................................... 149
12.11 Tables Modified by the Hash Process.........................................................................................149
13. The Match Utility (NPMU)................................................................................................................ 150
13.1 Overview...................................................................................................................................... 150
13.1.1 Pre-process........................................................................................................................... 150
13.1.2 Match..................................................................................................................................... 151
13.1.3 What Match Does.................................................................................................................. 152
13.1.4 What Match Requires............................................................................................................ 152
13.2 Running the Match Utility............................................................................................................. 153
13.2.1 Running the Match from Command Prompt...........................................................................153
13.3 Running the Match Process Using ONE Point Application...........................................................156
13.4 Analyze the Results...................................................................................................................... 157
13.4.1 Viewing Log Files................................................................................................................... 157
13.4.2 Debugging Using the -d Option..............................................................................................159
13.5 Analyze Table............................................................................................................................... 159
13.6 Monitoring the Status of Match Utility........................................................................................... 160
13.7 Troubleshooting............................................................................................................................ 161
13.7.1 Process Slows Down............................................................................................................. 161
13.7.2 Pre-process mode does not support the following options [-r,-s,-q,-t, -m]..............................161
13.7.3 The Logging option is required..............................................................................................161
13.7.4 The Rule File option is required.............................................................................................162
13.7.5 The Estimated Volume (-e) option argument is required........................................................162
13.8 Restarting Match Utility................................................................................................................ 162
13.8.1 Restarting the Match Pre-process......................................................................................... 162
13.8.2 Restarting the Match Process................................................................................................163

IMS Health Operations Guide Page 8 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.9 Tables Modified by Match Utility................................................................................................... 164


13.9.1 Tables Modified by Match Pre-process..................................................................................164
13.9.2 Tables Modified by Match...................................................................................................... 164
14. ID Assign Process............................................................................................................................ 165
14.1 Overview...................................................................................................................................... 165
14.1.1 What ID Assign Does............................................................................................................. 165
14.2 The Run Script run_idassign.exe................................................................................................. 166
14.3 Command Line Parameters......................................................................................................... 166
14.4 Running ID Assign........................................................................................................................ 167
14.4.1 Running ID Assign Using the Run Script...............................................................................167
14.4.2 Running ID Assign Manually.................................................................................................. 168
14.4.3 Running the Pre-process Manually........................................................................................ 168
14.5 Running ID Assign Process Using ONE Point Application............................................................169
14.6 Analyze Table............................................................................................................................... 169
14.7 Monitoring ID Assign Progress..................................................................................................... 169
14.8 Analyzing the Results................................................................................................................... 169
14.8.1 Viewing the Log File.............................................................................................................. 169
14.8.2 Verify Successful Completion................................................................................................ 172
14.9 Troubleshooting............................................................................................................................ 172
14.9.1 not enough memory............................................................................................................... 172
14.9.2 The Logging option is required. A proper file name must be passed....................................172
14.9.3 The Mode option is required. A proper mode name must be passed....................................172
14.10 Maintaining Manual Resolution History......................................................................................173
14.11 Restarting the ID Assign Pre-process (Group Match Output).....................................................173
14.12 Restarting ID Assign................................................................................................................... 173
14.13 EXT_MODIFIED_FLG................................................................................................................ 174
14.14 ID Assign Resolution Descriptions.............................................................................................. 174
14.15 Tables Modified by the Pre-process and the ID Assign Process.................................................176
15. The Reverse Link Creator............................................................................................................... 177
15.1 Overview...................................................................................................................................... 177
15.2 Running Reverse Link Creator..................................................................................................... 177
15.2.1 Running the Process............................................................................................................. 177
15.2.2 Output Generation................................................................................................................. 177
15.3 Analyze Table............................................................................................................................... 177
15.3.1 Analyze Results..................................................................................................................... 178
15.4 Running Reverse Link Creator Process Using ONE Point Application.........................................178

IMS Health Operations Guide Page 9 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

15.5 Troubleshooting............................................................................................................................ 178


15.5.1 When the system parameter 1309 with last run date has not been created..........................178
15.5.2 When any database package is invalid =>............................................................................179
15.5.3 Restart Reverse Link Creator................................................................................................ 179
15.6 Restarting the Process................................................................................................................. 179
15.7 Tables Modified by Reverse Link Creator Process.......................................................................179
16. Reverse Data Monitor (RDM)........................................................................................................... 180
16.1 Overview...................................................................................................................................... 180
16.1.1 What RDM Does.................................................................................................................... 180
16.1.2 What RDM Requires.............................................................................................................. 180
16.1.3 What Data is Processed by RDM..........................................................................................180
16.2 ReverseCheck Procedure............................................................................................................ 181
16.2.1 ReverseCheck Procedure Arguments....................................................................................181
16.3 Running the Process Using runstoredproc.exe............................................................................181
16.4 Running the Process Using ONE Point........................................................................................182
16.4.1 Refresh and Incremental Mode..............................................................................................182
16.4.2 Dry Run................................................................................................................................. 183
16.4.3 Range of Customers.............................................................................................................. 183
16.5 Analyze Table............................................................................................................................... 183
16.5.1 Dry Run Mode........................................................................................................................ 184
16.6 RDM Resolution Descriptions....................................................................................................... 184
16.7 Auditing RDM Resolutions............................................................................................................ 184
16.8 Restarting the Process................................................................................................................. 185
16.9 Tables Modified by RDM Process................................................................................................. 186
17. The Standardizer.............................................................................................................................. 187
17.1 Overview...................................................................................................................................... 187
17.1.1 What Standardizer Does........................................................................................................ 187
17.1.2 What Standardizer Requires.................................................................................................. 187
17.2 Command Line Parameters/Usage..............................................................................................187
17.3 Running the Standardizer............................................................................................................. 188
17.3.1 Output.................................................................................................................................... 189
17.4 Running Standardizer Using ONE Point Application....................................................................189
17.5 Analyze Tables............................................................................................................................. 190
17.6 Troubleshooting............................................................................................................................ 190
17.6.1 Printing Results on Screen Using the -N Option....................................................................190
17.6.2 Standardize Prof/Org task is not found..................................................................................191

IMS Health Operations Guide Page 10 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

17.6.3 Standardization type required................................................................................................ 191


17.6.4 The Log file name is required................................................................................................ 191
17.7 Restarting the Process................................................................................................................. 191
17.8 Tables Modified by Standardizer Process.....................................................................................192
18. Practitioner Verification................................................................................................................... 193
18.1 Exporting Practitioner to Validation Vendor..................................................................................193
18.1.1 Running the Practitioner Verification Export...........................................................................194
18.1.2 Populating CUS_VERIFICATION_PROFILE Table................................................................194
18.1.3 Executing the Export Business Rule Packages.....................................................................194
18.1.4 Creating the Practitioner File for Validation Vendor...............................................................194
18.1.5 Creating the Practitioner File using NPImportExport.............................................................195
18.2 Importing Practitioners from Validation Vendor.............................................................................195
18.2.1 Executing Practitioner Verification Import..............................................................................195
18.2.2 Executing Practitioner Verification Import Business Rule Packages......................................195
18.2.3 Loading the Practitioner File from Validation Vendor.............................................................196
18.2.4 Loading the Practitioner File Using NPImportExport...........................................................196
18.2.5 Verifying Mid-level Practitioners with Restricted Status.........................................................196
18.3 Practitioner Export to an External System (such as Sample Guardian).......................................196
18.3.1 Practitioner Verification Full Refresh Export...........................................................................197
18.3.2 Queue-based Practitioner Verification Export........................................................................197
18.4 Authorization Form Import............................................................................................................ 197
18.5 State Eligibility Rules Import from an External System.................................................................197
18.6 Authorization Form Validation....................................................................................................... 198
18.7 Apply State Eligibility Status Changes..........................................................................................198
18.8 Internal Re-verification................................................................................................................. 198
18.9 Verification Status Batch Export................................................................................................... 198
18.10 Troubleshooting.......................................................................................................................... 198
18.10.1 TNS:could not resolve service name...................................................................................198
18.10.2 invalid username/password; logon denied...........................................................................199
18.10.3 Process failure during PV export.........................................................................................199
18.10.4 Process failure during PV import.........................................................................................199
18.11 Restarting Practitioner Verification Export Process....................................................................199
18.12 Restarting Practitioner Verification Import Process....................................................................200
18.13 Restarting Annual Re-Verification Process.................................................................................201
19. Practitioner Verification (PracVer) Real-time Mode.......................................................................202
19.1 Starting PracVer Services............................................................................................................ 202

IMS Health Operations Guide Page 11 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

19.2 Stopping PracVer Services........................................................................................................... 202


19.3 Troubleshooting............................................................................................................................ 202
19.3.1 Unable to Stop Service.......................................................................................................... 202
19.3.2 Export data not moved from XTTRANSACTION_TABLE_1 to NP_PV_OUT_Q Queue........202
20. Consolidated Customer View (CCV)..............................................................................................203
20.1 Overview...................................................................................................................................... 203
20.2 Enabling Standard delimeted export............................................................................................203
20.3 Enabling AggregateSpend360 Data Export..................................................................................204
20.4 Enabling Mobile-Intelligence Data Export.....................................................................................204
20.5 Running CCV............................................................................................................................... 204
20.5.1 NPBestCustomer.IdentifyNucleusIDs for incremental processing..........................................204
20.5.2 RunCCV.exe.......................................................................................................................... 205
20.5.3 Structure of NPBestCustomer.RealTimeProcess()................................................................205
20.5.4 Structure of NPBestCustomer.batchProcess().......................................................................206
20.5.5 Analyze the Tables................................................................................................................. 207
20.5.6 Running in Incremental Mode................................................................................................ 207
20.5.7 Running in Refresh Mode...................................................................................................... 207
20.5.8 To Process all the Components Unconditionally....................................................................207
20.5.9 Running for a Range of Customers.......................................................................................207
20.5.10 Running Multiple Copies of the Process in Parallel.............................................................207
20.5.11 Affiliation Batch Export to Identify Activity Status Change....................................................208
20.5.12 Output Generation............................................................................................................... 208
20.5.13 Analyze Results................................................................................................................... 209
20.6 Running the CCV Process Using ONE Point Application.............................................................210
20.7 Analyze Table............................................................................................................................... 210
20.8 Restarting the CCV Process......................................................................................................... 211
20.9 Troubleshooting............................................................................................................................ 211
20.9.1 When the Parameters Are Not Passed Correctly...................................................................211
20.9.2 When Any Database Package Is Invalid................................................................................211
20.9.3 When the Error Message Range Is Between ORA-20000 and ORA-20999..........................212
20.9.4 When the Error Message Range Is Not Between ORA-20000 and ORA-20999....................213
20.9.5 Failure to Export Data through Xtelligent Service..................................................................214
21. Data Export Real-time Mode........................................................................................................... 215
21.1 Starting the Export Service........................................................................................................... 215
21.2 Stopping the Export Service......................................................................................................... 215
21.3 Monitoring the Export Service...................................................................................................... 216

IMS Health Operations Guide Page 12 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

21.4 Entity Specific Schema IDs.......................................................................................................... 216


21.5 Status Codes Used by Xtelligent Export Service..........................................................................217
21.6 XTTRANSACTION_TABLE_1 Field Description..........................................................................217
21.7 Troubleshooting............................................................................................................................ 226
21.7.1 Unable to stop service........................................................................................................... 226
21.7.2 Failure to export data through Xtelligent service....................................................................226
21.7.3 Failed to configure queue processor......................................................................................226
21.8 Restarting the Export Service....................................................................................................... 227
22. AggregateSpend360 Data Export................................................................................................... 229
22.1 Exporting Data in Manual Mode................................................................................................... 229
22.2 Exporting Data in Real Time Mode............................................................................................... 230
22.2.1 Log File.................................................................................................................................. 230
22.2.2 Stopping the Real Time Data Export Configuration...............................................................230
22.3 Check Progress............................................................................................................................ 230
22.4 Archiving the Export Tables.......................................................................................................... 231
22.4.1 CUS_TRANSACTION_EXPORT Table.................................................................................231
22.4.2 CUS_TRANSACTION_EXPORT_XREF Table......................................................................231
22.4.3 Process Parameters.............................................................................................................. 231
22.4.4 Analyzing the Log File............................................................................................................ 232
23. Merge................................................................................................................................................ 233
23.1 Overview...................................................................................................................................... 233
23.1.1 What Merge Process Does.................................................................................................... 233
23.2 Running the Process.................................................................................................................... 233
23.2.1 Command Line Parameters................................................................................................... 233
23.2.2 Merge Run Script Parameters...............................................................................................235
23.3 Monitoring Merge Process........................................................................................................... 236
23.3.1 Analyze the Tables................................................................................................................. 236
23.4 Analyzing the Results................................................................................................................... 237
23.4.1 View the Log File................................................................................................................... 237
23.4.2 Log Message Explanations.................................................................................................... 237
23.5 Restarting the Merge Process...................................................................................................... 238
23.6 Tables Modified by Merge Process...............................................................................................239
24. Runstoredproc Utility...................................................................................................................... 240
24.1 Overview...................................................................................................................................... 240
24.2 Command Line Parameters......................................................................................................... 240
24.3 To Execute a Stored Procedure.................................................................................................... 240

IMS Health Operations Guide Page 13 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

24.4 To Execute a Stored Function...................................................................................................... 241


24.5 To Execute a SQL file That Contains An Anonymous PL/SQL Block............................................241
24.6 Restarting the Process................................................................................................................. 241
25. Zip Information Extract Utility......................................................................................................... 242
25.1 Overview...................................................................................................................................... 242
25.2 Command Line Parameters/Usage..............................................................................................242
25.3 Running npzipinfo......................................................................................................................... 243
25.4 Monitoring the Progress............................................................................................................... 243
25.5 Troubleshooting............................................................................................................................ 243
25.5.1 Missing Zip Codes................................................................................................................. 243
25.5.2 The Logging option argument is required..............................................................................244
25.5.3 Ace Block Name is required................................................................................................... 244
25.5.4 Pls specify the destination of the extract using -f, -t or -c.......................................................244
25.6 Restarting the Process................................................................................................................. 244
26. Nucleus 360 Import/Export Utility................................................................................................... 245
26.1 Overview...................................................................................................................................... 245
26.2 Running the NPImportExport Process.......................................................................................... 245
26.3 Running the NPImportExport Process Using ONE Point Application...........................................247
26.4 Analyze the Results...................................................................................................................... 247
26.4.1 Viewing the Log File.............................................................................................................. 247
26.4.2 Debugging Using the -d Option..............................................................................................248
26.5 Troubleshooting............................................................................................................................ 248
26.5.1 Log file option argument is required.......................................................................................248
26.5.2 Process type argument value (Import/Export/Copy) is required.............................................248
26.5.3 Invalid Process mode............................................................................................................ 249
26.5.4 Input file name is required for Import process........................................................................249
26.5.5 Bad Record file name is required........................................................................................... 249
26.5.6 Format file name argument value is required.........................................................................249
26.5.7 Cannot open Format File....................................................................................................... 250
26.5.8 Output file name is required for Export process.....................................................................250
26.5.9 Destination database connection block name is required......................................................250
26.5.10 Source database connection block name is required..........................................................250
26.6 Restarting the Process................................................................................................................. 251
27. Data Extract...................................................................................................................................... 252
27.1 Overview...................................................................................................................................... 252
27.1.1 Address Extract...................................................................................................................... 252

IMS Health Operations Guide Page 14 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

27.2 Professional Profile Extract.......................................................................................................... 252


27.3 Organization Profile Extract.......................................................................................................... 252
27.4 Professional Customer Extract..................................................................................................... 253
27.5 Organization Customer Extract.................................................................................................... 253
27.6 Extracting Data............................................................................................................................. 253
27.6.1 Command Line Parameters/Usage........................................................................................253
27.6.2 Analyze the Tables................................................................................................................. 254
27.6.3 Execute the Data Extract Process.........................................................................................254
27.7 Troubleshooting............................................................................................................................ 255
27.7.1 Service dies without generating the output file.......................................................................255
28. Migration Utility................................................................................................................................ 256
28.1 Export of NUCLEUS ID................................................................................................................ 256
28.2 Import of NUCLEUS ID................................................................................................................ 256
28.3 Process Parameters..................................................................................................................... 256
28.3.1 Export Process...................................................................................................................... 256
28.3.2 Running Migration Utility Export Manually.............................................................................257
28.3.3 Running Export in Default Mode............................................................................................ 257
28.3.4 Analyze Results..................................................................................................................... 257
28.3.5 Import Process....................................................................................................................... 258
28.3.6 Running Migration Utility Import Manually.............................................................................258
28.3.7 Logging.................................................................................................................................. 259
28.3.8 Running Import in Default Mode............................................................................................259
28.3.9 Analyze Results..................................................................................................................... 259
28.3.10 Troubleshooting................................................................................................................... 259
29. ONE Point Application..................................................................................................................... 260
29.1 Overview...................................................................................................................................... 260
29.2 Running Processes from nponepoint.exe and Batch....................................................................260
29.3 Convention................................................................................................................................... 261
29.3.1 Configuration Type Icon Conventions....................................................................................261
29.3.2 Process Status Icon Conventions..........................................................................................261
29.4 Operation..................................................................................................................................... 261
29.4.1 Real-time Configuration Start and Stop.................................................................................261
29.4.2 Batch Configuration Start and Stop.......................................................................................261
29.4.3 Exclusive Share Key.............................................................................................................. 261
29.4.4 Auto Pause Real-time Configuration......................................................................................262
29.4.5 Wait between Executions....................................................................................................... 263

IMS Health Operations Guide Page 15 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

29.4.6 Configuring a Database-stored Procedure Call.....................................................................263


29.4.7 Configuring a Database-stored Function Call........................................................................263
29.4.8 Configuring a Batch Command or an Executable..................................................................263
29.5 Configuration Elements................................................................................................................ 264
29.5.1 NPProcessConsole Element.................................................................................................. 265
29.5.2 Configuration Element........................................................................................................... 265
29.5.3 Entity Element........................................................................................................................ 266
29.5.4 Argument Element................................................................................................................. 268
29.5.5 ListItemElement..................................................................................................................... 269
29.5.6 ReturnCodeList Element........................................................................................................ 269
29.6 Restarting ONE Point................................................................................................................... 269
30. Mapping Configuration Generator.................................................................................................. 271
30.1 Overview...................................................................................................................................... 271
30.2 Running the Process.................................................................................................................... 271
30.2.1 Command Line Parameters................................................................................................... 271
30.2.2 Output.................................................................................................................................... 272
30.3 Troubleshooting............................................................................................................................ 272
30.3.1 Log file option argument is required.......................................................................................272
30.3.2 Configuration file name is required........................................................................................272
30.3.3 Cannot open Format file........................................................................................................ 272
30.4 Restarting the Process................................................................................................................. 273
31. Customer Identifier Xref Export...................................................................................................... 274
31.1 Enabling XREF Export................................................................................................................. 274
31.2 Running Customer Identifier XREF Export...................................................................................274
31.2.1 Exporting Data to Staging Table............................................................................................ 274
31.2.2 Exporting Data to Flat File..................................................................................................... 275
31.3 Check Progress............................................................................................................................ 276
31.4 Archiving CUS_TRANSACTION_EXPORT_XREF table..............................................................276
31.4.1 Process Parameters.............................................................................................................. 276
31.4.2 Starting Archival Process in Manual Mode............................................................................277
31.4.3 Log File.................................................................................................................................. 277
31.5 Troubleshooting............................................................................................................................ 277
31.5.1 Unable to stop service........................................................................................................... 277
32. Mapping Configuration Generator.................................................................................................. 278
32.1 Overview...................................................................................................................................... 278
32.2 Running the Process.................................................................................................................... 278

IMS Health Operations Guide Page 16 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

32.2.1 Command Line Parameters................................................................................................... 279


32.2.2 Output.................................................................................................................................... 279
32.3 Troubleshooting............................................................................................................................ 279
32.3.1 Log file option argument is required.......................................................................................279
32.3.2 Configuration file name is required........................................................................................279
32.3.3 Cannot open Format file........................................................................................................ 279
32.4 Restarting the Process................................................................................................................. 280
33. MQtest Utility.................................................................................................................................... 281
33.1 Overview...................................................................................................................................... 281
33.2 Command Line Parameters......................................................................................................... 281
33.3 Running mqtest.exe..................................................................................................................... 281
33.3.1 To read all messages from a queue (e.g. WBI.TO.NP.QL).....................................................281
33.3.2 To delete all messages from a queue (e.g. WBI.TO.NP.QL)..................................................281
33.3.3 To delete all messages from a queue without displaying them on the screen (e.g.
WBI.TO.NP.QL)................................................................................................................................ 282
33.3.4 To get a count of messages from a queue (e.g. WBI.TO.NP.QL)...........................................282
33.3.5 To push a XML message file contents (e.g. test.xml) to the queue (e.g. WBI.TO.NP.QL)......282
34. UniqueIDGenerator Utiltiy............................................................................................................... 283
34.1 Overview...................................................................................................................................... 283
34.2 Configuration File......................................................................................................................... 283
34.3 Command Line Parameters......................................................................................................... 283
34.3.1 Output.................................................................................................................................... 283
34.4 Troubleshooting............................................................................................................................ 284
34.4.1 Connect Failed....................................................................................................................... 284
34.4.2 Logon Denied........................................................................................................................ 284
34.4.3 Connect Failed....................................................................................................................... 284
34.4.4 Logon Denied........................................................................................................................ 284
35. Command Definitions for Scripts................................................................................................... 286
35.1 runstoredproc Analyzing Tables................................................................................................. 286
35.1.1 Usage.................................................................................................................................... 286
36. Nucleus 360 Services List............................................................................................................... 288
36.1 List of Services Provided by Nucleus 360....................................................................................288
36.1.1 NUC360Standardizer............................................................................................................. 288
36.1.2 Nuc360DataImport................................................................................................................. 289
36.1.3 Nuc360PollingSvc.................................................................................................................. 290
36.1.4 Orbix Daemon........................................................................................................................ 291

IMS Health Operations Guide Page 17 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.5 Apache Tomcat...................................................................................................................... 291


36.1.6 CustomerLookup................................................................................................................... 292
36.1.7 CustomerLookup2................................................................................................................. 293
36.1.8 QuickSearch.......................................................................................................................... 293
36.1.9 NUC360PingFederateService................................................................................................ 294
36.1.10 Security Service................................................................................................................... 295
36.1.11 ProfileDetailsService............................................................................................................ 295
36.1.12 CustomerManage................................................................................................................ 296
36.1.13 Database Search Service.................................................................................................... 297
36.1.14 Standardizer Service........................................................................................................... 298
36.1.15 Unique ID Generator Service...............................................................................................298
36.1.16 Quick Search Indexer Service............................................................................................. 299
36.2 Check if IIS Is Up and Running.................................................................................................... 300
37. Adhoc Match.................................................................................................................................... 301
37.1 Overview...................................................................................................................................... 301
37.2 What Adhoc Match Process Does................................................................................................301
37.3 Running the Adhoc Match Process.............................................................................................. 301
37.3.1 Running the Adhoc Match Process Using the Komodo Job Scheduler..................................301
37.3.2 Running the Adhoc Match Manually from Application Server.................................................309
37.4 Troubleshooting............................................................................................................................ 310
37.4.1 Adhoc Match process completes but output files within .zip file are empty............................310
37.4.2 Errors in matchlog.log File..................................................................................................... 310
37.5 Restarting the Adhoc Match Process............................................................................................ 311
Appendix A: Frequently Asked Questions...........................................................................................312
Appendix B: Database Errors............................................................................................................... 313
LConnectionPool.Init failed. Check database configuration file............................................................313
ORA-01017: invalid username/password; logon denied.......................................................................314
ORA-12154: TNS:could not resolve service name...............................................................................314
Slow performance................................................................................................................................ 314
Rollback segment error........................................................................................................................ 315
Appendix C: Database Configuration File -Dbcfg.Txt.........................................................................316
Appendix D: Miscellaneous Errors....................................................................................................... 318
User Id: <username> not in NUCLEUS.System_User or inactive........................................................318
Explanation....................................................................................................................................... 318
Solution............................................................................................................................................. 318
Environment variable NP_APP_USER not defined..............................................................................318

IMS Health Operations Guide Page 18 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Explanation....................................................................................................................................... 318
Solution............................................................................................................................................. 318
Appendix E: Configuration Assistant Timeout Errors........................................................................319
Run Time Errors................................................................................................................................... 319
Exceptions........................................................................................................................................ 319
Explanation....................................................................................................................................... 321
Solution............................................................................................................................................. 321
Appendix E: ACE/IACE Postalsoft Errors............................................................................................ 322
Run Time errors................................................................................................................................... 322
Exception: open (Engine) failed, check ............................................................................................ 322
Explanation 1.................................................................................................................................... 322
Solution 1.......................................................................................................................................... 322
Explanation 2.................................................................................................................................... 322
Solution 2.......................................................................................................................................... 322
Explanation 3.................................................................................................................................... 322
Solution 3.......................................................................................................................................... 322
Error: DIRECTORY OUT OF DATE.................................................................................................. 322
Explanation....................................................................................................................................... 323
Solution............................................................................................................................................. 323
Error: Failed to initialize config file : ace.cfg.........................................................................................323
File:\cdis\wkenv\serverapps\nucleuspharma_x3.1.0.latest\aceinterface\src\lacemainapp.cpp Line:
192.................................................................................................................................................... 323
Explanation....................................................................................................................................... 323
Solution............................................................................................................................................. 323
No Address standardization option selected. NP_EXCLUDE_ADDRESS_STD was set.....................323
Explanation....................................................................................................................................... 323
Solution............................................................................................................................................. 323
Standardization Error Codes................................................................................................................ 323
Appendix F: IACE Configuration File................................................................................................... 325
Ace.cfg................................................................................................................................................. 325
iace_usa.cfg......................................................................................................................................... 326

IMS Health Operations Guide Page 19 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Appendix G: Xtelligent - Executing Service Manually........................................................................327


Appendix H: Command Line Support for ONE Point Configuration.................................................328
Appendix I: Updating the Xtelligent Adapter Configurations for Real Time Data Import and Export
Process................................................................................................................................................... 355
Appendix J: FND_EXTRACT_RUN_LOG Table....................................................................................358
Appendix K: Processes That Are Internal to IMS Health....................................................................359
Approvals................................................................................................................................................. 360

IMS Health Operations Guide Page 20 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

1. PUBLICATION RECORD
Revision Publication Date Overview of Revisions
1 May 11, 2015
Upon approval of this document, Revision 1 is the current version of the IMS Health Nucleus 360 5.2.0
Operation Instructions Operations Guide. Please destroy or archive all previous revisions.

IMS Health Operations Guide Page 21 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2. INTRODUCTION

2.1 Purpose and Audience


The purpose of this guide is to provide the technical operational information required to maintain, monitor,
and control Nucleus 360.
The audience for this document is the clients Production Control Group/IT (programmers, production
control personnel, and/or support personnel) or Customer Support.

2.2 User Prerequisites


This guide requires a basic working knowledge of the Windows operating system and Oracle SQL.

2.3 Documentation Conventions


Important: This document assumes a monthly data load. Depending on data update frequency, the
naming conventions used throughout this document might change.
A gray box, in Courier font, identifies sessions that interact with the
production system.

Any text that must be entered verbatim is in boldface.

Any text that you must interpret before you enter it is in double-underlined
boldface.

Replace <YYYY_MM Curr> with the current production cycles year and month.
Replace <YYYY_MM Prev> with the previous production cycles year and month.

Commands may span multiple lines. The fact that a command is on multiple lines
does not necessarily mean that the Enter key should be pressed. The symbol
denotes when to press Enter.

SQL commands are generally prefixed by a SQL prompt (SQL>).

Text that is boxed and not shaded usually represents output initiated by a session; it does not represent
an interactive session.

IMS Health Operations Guide Page 22 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. TEXT CONVENTIONS
In this document, the following text conventions are used:
Text that is in bold represents the following elements:
The names of screen fields, tabs, buttons, and menu options. For example, Affiliations
(tab), File (menu), OK (button).
File names, script names, and folder and directory names. For example, pracval.exe,
c:\Program Files
Prompts in user input. For example, sql>select length(...
Commands and command syntax. For example, The UNIX ps -ef | grep orbixd
command.
Text that is italicized represents specific field values or literals such as passwords.
Quotation marks are used to identify messages.
Sample code is in fixed width font (Courier). For example, select length(
Text that is blue and underlined represents a hyperlink to another section of the current document or
to another document.

3.1 Running SQL Plus


To run any of the queries, run SQL*Plus as follows:
$ sqlplus
SQL*Plus: Release 11.2.0.1.0 Production on Mon May 11 14:39:59 2015
Copyright (c) 1982, 2010, Oracle. All rights reserved.

Enter user-name: <USERID>/<PWD>@<SID>

Connected to:
Oracle Database 11g Enterprise Edition Release 11.2.0.3.0 64bit Production
With the Partitioning, OLAP, Data Mining and Real Application Testing options

SQL>

3.2 Accessing Microsoft Windows Command Prompt


To enter the command shell in Microsoft Windows:
1. Click Start.
2. Select the Run menu.
3. Enter cmd in the dialog box.

IMS Health Operations Guide Page 23 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

4. NUCLEUS 360 CONVENTIONS


This section describes the organization and flow of the system batch jobs. The processes of loading
customer information, data standardization, and matching are distributed in the form of independent batch
processes.

4.1 Environment Variables


Nucleus 360 environments are initialized by running the np_env.bat file (located in the <NP_ROOT>
directory, where the Nucleus 360 server layer installation is done) or by adding this file to the startup list of
programs under Windows. Therefore, all Nucleus 360 environment variables should be available
immediately after login. This implies that Nucleus 360 commands can be run immediately after login
without any explicit initialization. Following are the environment variables used by the Server Layer
processes.
Environment Variable Description
ORACLE_SID Set this variable with the database instance name
ORACLE_LOGON_USER Set this variable with the Oracle login user name
Set this variable to the directory path where the Postalsoft software is
NP_ACE_ROOT
installed
Set this variable with %NP_IACE_ROOT%\adm;%NP_IACE_ROOT
PW_PATH
%\acelib;
Set this variable to the directory path where the Nucleus 360 Server Layer
DRTE_ROOT
is installed
DRTE_THIRD_PARTY Set this variable with %DRTE_ROOT%\third_party
Set this variable with the FND_SYS_USER that runs the server layer
NP_APP_USER
processes (NP_PROCESS)
DRTE_NP_ROOT Set this variable with %DRTE_ROOT%\np
DRTE_NP_BIN Set this variable with %DRTE_ROOT%\np\bin
DRTE_NP_LIB Set this variable with %DRTE_ROOT%\np\lib
DRTE_NP_DEFS Set this variable with %DRTE_ROOT%\np\defs
DRTE_NP_LOGS Set this variable with %DRTE_ROOT%\np\log

4.2 Server Layer Directory Structure


The server layer installation for Nucleus 360 is laid out as follows.

IMS Health Operations Guide Page 24 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Application
Directory Name Description
Layer
Server Layer \archives Created under the installation root specified by the user during the
installation.
This file system contains all the files processed during a set
timeframe. The length of time that files reside in this area is
determined based on space availability and file system size. Files
should not be removed from this file system until they have been
archived to tape.
Only third-party import data files that have been successfully
processed are compressed and moved to a holding area
(\archives\np) under this directory.
Subfolders such as \archives\np\database and \archives\np\log
are available to the user to back up any database or log files.
Server Layer \daily_bck Created under the installation root specified by the user during the
installation. This holding area and its subfolders are available to
the user to back up any daily database or log files.
Server Layer \drte_install\log Created during the server layer installation process. Houses the
logs generated at that time.
Server Layer \np Created under the installation root specified by the user during
installation. It contains all the server layer processes. The various
subdirectories are defined later in this section.
Subfolder Contents
bin Server Layer processes and its
configuration files
Wrapped run scripts
Database connection details file (dbcfg.txt)
Real-time data import transformation files
database Server Layer processes that are implemented
using Oracle objects such as stored
procedures and functions are installed from this
holding area during the installation.
datasource Scripts to install the third party data sources
and their configuration (such as Match/ID
Assign rules, Merge rules, Standardization
patterns, External code values) are stored
under subfolders of this directory.
This directory and its subfolders are used only
during server layer installation.

IMS Health Operations Guide Page 25 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Application
Directory Name Description
Layer
defs This directory and its subfolders are used to
hold additional configuration files.
Subfolder defs\ace holds the Postalsoft IACE
configuration files.
Subfolder defs\xtelligent holds the raw
configuration and metadata files that are
required for Xtelligent Adapter installation. A
copy of these raw files will be made and
custom configured during the adapter
installation. Final configured files are stored in
the Xtelligent Adapter installation directories
such as:
<Xtelligent Adapter
Root>\<Prod>\DataInterfaces\Interfaces\Confi
guration
<Xtelligent Adapter
Root>\<Prod>\DataInterfaces\Interfaces\Meta
data
<Xtelligent Adapter
Root>\<Prod>\DataInterfaces\Interfaces\xsl
lib Stores shared libraries. There are none for this
version.
log Application logs of Server Layer processes will
be created in this directory.
testdata Stores test data files that are used to validate
the Postalsoft installation.
utilities\migr Holds the installer and scripts that are applied
ation to the source database to perform the data
migration.

IMS Health Operations Guide Page 26 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Application
Directory Name Description
Layer
Server Layer \third_party\np Created under the installation root specified by the user during the
installation. It houses the third-party data files.
Subfolder Contents
in\<DATA_SOURCE> Stores data delivered to Nucleus 360
that is not made available through
database tables. Directories
under
\third_party\np\in\<data_source>
follow a YYYY_MM format (YYYY being
the year, and MM the month,
represented by its constituent data
files).
out\<DATA_SOURCE> Stores Nucleus 360 extracts.
Directories
under
\third_party\np\out\<data_source>
follow a YYYY_MM format (YYYY being
the year, and MM the month,
represented by its constituent data
files).

Please see the Architecture Document for sizing requirements for these file systems.

IMS Health Operations Guide Page 27 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

5. OPERATION CHECKLIST
This section outlines tasks that need to be executed for day-to-day operational activities associated with
Nucleus 360.

5.1 System Initialization


The system should be operational with all the following servers, which are integral for the Nucleus 360
processes to run successfully:
Middle Tier Server(s) Refer to section 6, Middle Tier Servers.
Standardizer Server Refer to section 7, Standardizer Server.
Web Server Refer to section 8, Web Server.
Nucleus 360 Services Refer to section 36, Services List.

5.2 Third Party Data Processing Strategy


Customer data that originates from external systems, such as an SFA system, a legacy internal system,
or from third-party data providers such as OneKey, is loaded into and processed by Nucleus 360. Data
can be processed in batch and/or in real time mode. The following sections explain the most efficient
strategy for processing batch and real time data.

5.2.1 Processing Batch Data


Customer data in batch mode is received in files (fixed length, delimited, or XML). The strategy for
processing the data files during an initial data load is different from the ongoing processing.

5.2.1.1 Initial Data Load Strategy (IDL)


It is recommended to process one data source at a time in an IDL scenario. For the first source to load,
identify a data source that has the greatest number of addresses and maximum customer details. Load
the identified data source and process the data by running it through the following processes:
Data Quality
Denormalized customer view
Hash
Match
ID Assign
Refer to section 5.2.1.1.2 for details on running these processes with prerequisites.
Upon completion of the first data source, the Nucleus 360 system will have established a quality customer
database for the subsequent data sources to be processed. Identify the second data source and process
it by performing all the steps followed for the first source. Repeat this for each data source, one at a time.

5.2.1.1.1 Optimizations
The following optimizations can be applied to boost the throughput of the Data Import process during an
initial data load.

IMS Health Operations Guide Page 28 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

As a validation step, the Data Import process performs a database lookup to check the existence of
the customer profile in the Nucleus 360 system. As it is known that a customer will not exist during the
IDL, the process can be configured to perform this check one time for all the profiles of the data
source, using Configuration Assistant. (Under Data Sources, locate the data source you have
selected for IDL, click Mappings, click the particular mapping, then Fields, then Tasks. On the Tasks
window, select the Configuration Settings task and enable the Profile ID Cache argument.) This
optimization is not recommended for ongoing data processing.
The Nucleus 360 core customer tables are built with indexes to facilitate efficient data search
operations by various server layer, middle tier, and GUI processes. These indexes can be dropped to
maximize the data load performance and can be recreated.

5.2.1.1.2 Sample Data Load and Processes Execution Sequence


The following example lists the execution sequence of processes to be run to load the first data source,
for example, AMA. The following processes should be executed in this sequence using the ONE Point
application (nponepoint.exe). Repeat these steps for each IDL data source.

Process Description Configuration Process


Analyze the newly created empty database. Manual - Database Full Schema Analyze
Execute this step only before the first Maintenance
data source; do not repeat it for
subsequent data sources.
Drop the DQT table indexes (Performance Manual DQT Index Drop Indexes
optimization). Execute this step only Maintenance
before the first data source; do not repeat
it for subsequent data sources.
Drop the core table indexes (Performance Prerequisite - IDL Data Import Drop Indexes
optimization)
Load the AMA file Manual - Data Import AMA
Recreate the core table indexes Prerequisite - IDL Data Import Create Indexes
Post Data Import database maintenance Manual - Database Post Data Import
Maintenance
Lock the imported profiles for processing Manual - Process Management Lock Staging Profiles
Execute the Data Quality process Manual - Process Management Data Quality
Post Data Quality database maintenance Manual - Process Management Post Data Quality DB
process Maintenance
Generate Hash keys Manual - Process Management Hash
Generate Denormalized customer view Manual - Process Management DQT
(DQT)
Post DQT database maintenance Manual - Process Management Post DQT DB
Maintenance
Unlock the imported profiles Manual - Process Management Unlock and Delete
Staging Profiles
Execute the Pre Match database Manual - Process Management Pre Match DB
maintenance Maintenance

IMS Health Operations Guide Page 29 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Process Description Configuration Process


Execute the Match Pre-process to generate Manual - Process Management Match Pre-process
Match candidates
Execute the Match process Manual - Process Management Match
Post Match DB Maintenance Manual - Process Management Pre Group Match
Output DB Maintenance
Group Match output Manual - Process Management Group Match Output
Pre ID Assign database maintenance Manual - Process Management Pre ID Assign DB
Maintenance
Execute the ID Assign process (Batch Manual - Process Management ID Assign
customer resolution)
Post ID Assign database maintenance Manual - Process Management Post ID Assign DB
Maintenance
Reverse Link Creator Manual - Process Management Reverse Link Creator
Resolve customers that have profiles with Manual - Process Management Reverse Data Monitor
conflicting data conditions
Post Reverse Data Monitor database Manual - Process Management Post RDM DB
maintenance Maintenance

After processing all the data sources, execute the following processes.
Process Description Configuration Process
Manual DQT Index
Create the DQT table indexes Create Indexes
Maintenance
Consolidated Customer View generation (CCV) Manual - Process Consolidated Customer
Management View
Post CCV database maintenance Manual - Process Post CCV DB
Management Maintenance
Merge Manual - Process Merge Customer/
Management Merge Address
Post Merge database maintenance Manual - Process Post Merge DB
Management maintenance

5.2.1.2 Ongoing Data Load Strategy


On an ongoing basis, the data sources are expected to provide 10% to 20% of customer data changes
per month. As long as the volume of changes is within this limit, multiple sources can be loaded and
processed at the same time. If a particular source triggers an abnormal volume of changes to the Nucleus
360 database, process it separately, as it would be handled in an IDL scenario.

5.2.1.2.1 Sample Data Load and Processes Execution Sequence


The following example lists the execution sequence of processes to be run to load ongoing updates
received on three data sources: AMA, DEA, and State License. Run the processes using the ONE Point
application.

IMS Health Operations Guide Page 30 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Process Description Configuration Process


Load the AMA file Manual - Data Import AMA
Load the DEA file Manual - Data Import DEA
Load the State License file Manual - Data Import State License
Post Data Import database maintenance Manual - Database Post Data Import
Maintenance
Lock the imported profiles for processing Manual - Process Lock Staging Profiles
Management
Execute the Data Quality process Manual - Process Data Quality
Management
Post Data Quality database maintenance Manual - Process Post Data Quality DB
process Management Maintenance
Generate Hash keys Manual - Process Hash
Management
Generate Denormalized customer view (DQT) Manual - Process DQT
Management
Post DQT database maintenance Manual - Process Post DQT DB Maintenance
Management
Unlock the imported profiles Manual - Process Unlock and Delete Staging
Management Profiles
Execute the Pre Match database maintenance Manual - Process Pre Match DB Maintenance
Management
Execute the Match Pre-process to generate Manual - Process Match Pre-process
Match candidates Management
Execute the Match process Manual - Process Match
Management
Manual - Process Pre Group Match Output DB
Post Match DB Maintenance
Management Maintenance
Group Match output Manual - Process Group Match Output
Management
Pre ID Assign database maintenance Manual - Process Pre ID Assign DB
Management Maintenance
Execute the ID Assign process (Batch customer Manual - Process ID Assign
resolution) Management
Post ID Assign database maintenance Manual - Process Post ID Assign DB
Management Maintenance
Reverse Link Creator Manual - Process Reverse Link Creator
Management
Resolve customers that have profiles with Manual - Process
Reverse Data Monitor
conflicting data conditions Management

IMS Health Operations Guide Page 31 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Process Description Configuration Process


Post Reverse Data Monitor database Manual - Process Post RDM database
maintenance Management maintenance
Consolidated Customer View generation (CCV) Manual - Process Consolidated Customer
Management View
Post CCV database maintenance Manual - Process Post CCV DB Maintenance
Management
Merge Manual - Process Merge Customer/Merge -
Management Address
Post Merge database maintenance Manual - Process Post Merge DB
Management maintenance

5.2.2 Processing Real-Time Data


In Nucleus 360, real-time operation refers to processing of customer data when it is made available on
the message queues by the external sources. The ONE Point application offers various configurations to
process real-time data, as follows.
Real Time Data Import: Configuration to import real-time customer data into Nucleus 360 from the
input message queues.

IMS Health Operations Guide Page 32 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Real Time Data Processing Services: Configuration to process the imported real-time data
through various server layer components.

Real Time Data Export: Configuration to publish the processed data to the output message
queues.

Real Time Standardization Service: Address correction service to Customer Maintenance users.

Real Time PracVer Services: Practitioner verification services to publish practitioners for external
vendor verification and to import verified practitioners from the message queues.

5.2.2.1 Optimization
During the initial data load, if the source is fed through the real-time message queues, launch only the
Real Time Data Import configuration to import the volume data. The core table indexes can be dropped
to improve the load throughput as explained in the batch data processing section 5.2.1. Once the load is
complete, recreate the indexes.

IMS Health Operations Guide Page 33 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

5.2.2.2 Sample Real Time Initial Data Load and Processes Execution Sequence
The following example lists the execution sequence of processes to be run to perform an IDL from the
message queues.

Process Description Configuration Process


Drop the core table indexes (Performance Prerequisite - IDL Data Drop Indexes
optimization) Import
Launch the Real Time Data Import Real Time - Data Import Not applicable
configuration to import data from the message
queues
Recreate the core table indexes Prerequisite - IDL Data Create Indexes
Import
Post Data Import database maintenance Manual - Database Post Data Import
Maintenance
Lock the imported profiles for processing Manual - Process Lock Staging Profiles
Management
Execute the Data Quality process Manual - Process Data Quality
Management
Post Data Quality database maintenance Manual - Process Post Data Quality DB
process Management Maintenance
Generate Hash keys Manual - Process Hash
Management
Generate Denormalized customer view (DQT) Manual - Process DQT
Management
Post DQT database maintenance Manual - Process Post DQT DB
Management Maintenance
Unlock the imported profiles Manual - Process Unlock and Delete
Management Staging Profiles
Execute the Pre Match database maintenance Manual - Process Pre Match DB
Management Maintenance
Execute the Match Pre-process to generate Manual - Process Match Pre-process
Match candidates Management
Execute the Match process Manual - Process Match
Management
Group Match output Manual - Process Group Match Output
Management
Execute the Permission Validator component Manual - Process Permission Validator
(skip this step if this functionality is not Management
implemented by the client team)
Pre ID Assign database maintenance Manual - Process Pre ID Assign DB
Management Maintenance
Execute the ID Assign process (Batch customer Manual - Process ID Assign
resolution) Management

IMS Health Operations Guide Page 34 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Process Description Configuration Process


Post ID Assign database maintenance Manual - Process Post ID Assign DB
Management Maintenance
Reverse Link Creator Manual - Process Reverse Link Creator
Management
Resolve customers that have profiles with Manual - Process
Reverse Data Monitor
conflicting data conditions. Management
Consolidated Customer View generation (CCV) Manual - Process Consolidated Customer
Management View
Post CCV database maintenance Manual - Process Post CCV DB
Management Maintenance
Merge Manual - Process Merge
Management

5.2.2.3 Sample Real Time Ongoing Data Load and Processes Execution Sequence
The following example lists the execution sequence of processes to be run to perform an ongoing data
load from the message queues.

Process Description Configuration Process


Launch the Real Time Data Import Real Time - Data Import Not applicable
configuration to import data from the message
queues
Also launch the Real Time Data Processing Real Time - Data Processing Not applicable
Services configuration immediately after Services
launching the Real Time Data Import
configuration

5.3 Processing Data Files


When a new data file arrives, proceed as follows:
1. Before starting the Data Import process (in Batch Comparison Mode), begin with the dry run mode to
check for any bad records in the data files. Please refer to section 29.2 for details on running batch
processes manually while nponepoint.exe is running.
$cd %DRTE_NP_BIN%
$run_dataimport m=<mapping id> -o=<old file name> -n=<new filename>
--dry_run
Notes:
Ensure that there are no failures, exception, or Address standardization data file expiry
messages in the log file.
Check for any bad files and try to fix the rejected records before the actual import
process.
2. After the successful dry run mode, start the actual import process for the data files.
$cd %DRTE_NP_BIN%
$run_dataimport m=<mapping id> -o=<old file name> -n=<new file name>

IMS Health Operations Guide Page 35 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. If any *.bad files are generated due to rejected records, re-run the import process after doing the
following:
Rename the existing .bad files.
Ensure that the errors in the .bad files have been resolved.
$ cd %DRTE_NP_BIN%
$ npdataimport -m<mapping id> -o<old file name> -n<renamed bad file> -d<old
bad file> -w<new bad file> -l<log file>

4. Analyze Data Import related tables by executing the following command:


$ cd %DRTE_NP_BIN%
$ runstoredproc spkg_db_maintenance.process_maintenance(6)
5. Run the Data Quality engine to generate Data Quality codes.
$ cd %DRTE_NP_BIN%
$ runstoredproc -sNP_Data_Quality_Engine.main
6. To populate the de-normalized query tables for organization and professionals, run the DQT process.
$ cd %DRTE_NP_BIN%
$ runstoredproc -sPKG_Denorm_Populate.main(1)
7. After running the DQT process, analyze the table by executing the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc spkg_db_maintenance.process_maintenance(32)
8. Start the Hash Creator in the selective mode.
$ cd %DRTE_NP_BIN%
$ run_hashcreator
9. Before starting the Match Pre-process, analyze the table by executing the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc -spkg_db_maintenance.process_maintenance(7)
10. Note that after the Match Pre-process is done, it will automatically analyze the tables that it updated.
The Match Pre-process does this by invoking the pkg_db_maintenance.process_maintenance()
with value 30.
11. The Match process can be instantiated using the script. This script automatically invokes the Pre-
process once. After the Pre-process completes, it launches two copies of the Match process.
$ cd %DRTE_NP_BIN%
$ run_match c=2
Note: Where c is the number of copies of match process to be instantiated. This number is
dependent on the number of CPUs available in the system.
12. Before starting the ID Assign Process, analyze the tables by executing the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc -spkg_db_maintenance.process_maintenance(16)

IMS Health Operations Guide Page 36 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13. Start the ID Assign process to assign NUCLEUS IDs for the profiles in the
NUC_RESOLUTION_PENDING table with the following command:
$ cd $DRTE_NP_BIN
$ run_idassign
14. Execute the Reverse Link Creator process. This process prepares the unresolved queue to be
viewable on the Customer Resolution GUI for profiles that were not resolved automatically for the ID
Assign process.
$ cd $DRTE_NP_BIN
$ runstoredproc -sNP_ReverseLinkCreator
15. After finishing the ID Assign Process, analyze the tables by executing the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc -spkg_db_maintenance.process_maintenance(17)
16. Before starting the Consolidate Customer View Process, analyze the table by executing the following
command:
$ cd %DRTE_NP_BIN%
$ runstoredproc -s pkg_db_maintenance.process_maintenance(31)
17. Consolidated Customer view represents the best customer view that is generated from the customer
details that are available through different data sources for a NUCLEUS ID. To start the process, use
the following command:
$ cd %DRTE_NP_BIN%
$ run_bob
$ run_bob -affiliation
18. After running the CCV process, analyze the related tables by executing the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc spkg_db_maintenance.process_maintenance(6)

IMS Health Operations Guide Page 37 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6. MIDDLE TIER SERVERS

6.1 Overview
The Nucleus 360 middle tier (MT) is one of the standard tiers within the application architecture. The
middle tier handles the logic and rules that govern the way the business processes operate. It also
handles all interactions between the Presentation Layer Tier (GUI) and the Database/Server Tier. It
handles requests from the Presentation Layer to retrieve data from, or modify data in, the Nucleus 360
database, which is part of the Server Tier. The following figure illustrates the multiple tiers and the
interactions among them.

Figure 1. Nucleus 360 Middle Tiers

6.2 Common Server

6.2.1 Description
The purpose and responsibility of the Common Server is to provide all of the database access/interaction
functionality that is common to several or all of the applications in the IMS Health Home Office Application
Suite. For example, the Common Server contains the security login database functionality, since this
functionality is required by all of the applications in the IMS Health Home Office Application Suite.

6.2.2 Prerequisites
To start the Common Server manually:
The Orbix Daemon must be running.
Connectivity must be available to the Nucleus 360 database.

IMS Health Operations Guide Page 38 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.2.3 Command Line Parameters/Usage


To invoke the Common Server manually from a command line, the usage is as follows:
Drive:\> cd <MT directory>
Drive:\<MT directory>> cd bin
Drive:\<MT directory>\bin> <exe name> <orbix name> <timeout length>
Each of the command line parameters is described below:
Parameter Description
<MT drive> Drive where the MT servers were installed
<MT directory> Directory where MT servers were installed
<exe name> File name of the Common Server executable
<orbix name> The name that the Common Server has been registered as in Orbix
<time out length> Length of time (in milliseconds) of Common Server inactivity until the
server will automatically shut down
Following are examples of the Common Server usage.
Windows 2008 Server:
Drive:\> c:
c:\> cd C:\sai\mt\bin
c:\sai\mt\bin> saiCommonSrv.exe saiCommonSrv 36000000
In these examples, saiCommonSrv.exe is the file name of the Common Server executable.
saiCommonSrv is the name that the Common Server has been registered as in Orbix. This name is
displayed in the Orbix Server Manager. The configuration file is located in the directory C:\sai\mt\bin\ on
Windows 2008. Finally, the timeout length is set to 36000000 milliseconds, or 10 hours.

6.3 Customer Resolution Server

6.3.1 Description
The Customer Resolution server (saiCRSrv) encapsulates most of the Customer Resolution business
logic. It also provides the database interface between the Customer Resolution GUI and the database.
The most important function of the Customer Resolution server is to execute unresolved profile matches,
customer moves, and profile classifications that are requested from the GUI.

6.3.2 Prerequisites
To start the Customer Resolution Server manually:
The Orbix Daemon must be running.
Connectivity must be available to the Nucleus 360 database.

IMS Health Operations Guide Page 39 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.3.3 Command Line Parameters/Usage


To invoke the Customer Resolution Server manually from a command line, the usage is as follows:
Drive:\> cd <MT directory>
Drive:\<MT directory>> cd bin
Drive:\<MT directory>\bin> <exe name> <orbix name> <location of configuration
file> <timeout length>
Each of the command line parameters is described below:
Parameter Description
<MT drive> Drive where the MT servers were installed
<MT directory> Directory where MT servers were installed
<exe name> File name of the Customer Resolution Server executable
<orbix name> Name that the Customer Resolution Server has been registered as in
Orbix
<location of configuration Full path where the middle tier configuration file (dbcfg.txt) is located
file>
<time out length> Length of time (in milliseconds) of Customer Resolution Server inactivity
until the server will automatically shut down

Following is an example of the Customer Resolution Server usage:


Windows 2008 Server:
c:\>
c:\> cd C:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin
c:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin> saiCRSrv.exe saiCRSrv
C:\sai\mt\bin 36000000
In the previous examples, saiCRSrv.exe is the file name of the Customer Resolution Server executable.
The name saiCRSrv is the name that the Customer Resolution Server has been registered as in Orbix.
This name is displayed in the Orbix Server Manager. The configuration file is located in the directory
C:\sai_mt\bin\ on Windows 2008. Finally, the timeout length is set to 36000000 milliseconds, or 10 hours.

6.4 Configuration Assistant Server

6.4.1 Description
The Configuration Assistant server (saiCASrv) provides the database interface between the
Configuration Assistant GUI and the database. The Configuration Assistant Server retrieves and saves
the mappings and other Nucleus 360 configuration information.

6.4.2 Prerequisites
To start the Configuration Assistant Server manually:
The Orbix Daemon must be running.
Connectivity must be available to the Nucleus 360 database.

IMS Health Operations Guide Page 40 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.4.3 Command Line Parameters/Usage


To invoke the Configuration Assistant Server manually from a command line, the usage is as follows:
Drive:\> cd <MT directory>
Drive:\<MT directory>> cd bin
Drive:\<MT directory>\bin> <exe name> <orbix name> <location of configuration
file> <timeout length>
Each of the command line parameters is described below:
Parameter Description
<MT drive> Drive where the MT servers were installed
<MT directory> Directory where MT servers were installed
<exe name> File name of the Configuration Assistant Server executable
<orbix name> Name that the Configuration Assistant Server has been registered as in
Orbix
<location and name of Full path and file name of the middle tier configuration file (dbcfg.txt)
configuration file>
<time out length> Length of time (in milliseconds) of Configuration Assistant Server
inactivity until the server will automatically shut down
An example of the Configuration Assistant Server usage follows:
Windows 2008:
c:\>
c:\> cd C:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin
c:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin> saiCASrv.exe saiCASrv
C:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin\dbcfg.txt 36000000
In the previous examples, saiCASrv.exe is the file name of the Configuration Assistant Server
executable. The name saiCASrv is the name that the Configuration Assistant Server has been registered
as in Orbix. This name is displayed in the Orbix Server Manager. The configuration file is located in the
directory C:\sai_mt\bin\ on Windows 2008. Finally, the timeout length is set to 36000000 milliseconds, or
10 hours.

6.5 Practitioner Verification Server

6.5.1 Description
The Practitioner Verification server (saiPVSrv) encapsulates the Practitioner Verification business logic. It
also provides the database interface between the Practitioner Verification clients and the database. The
Practitioner Verification Server saves the decision matrices defined in the GUI into the database and
performs the sampling status changes and practitioner re-verification requests that are initiated in the
GUI.

IMS Health Operations Guide Page 41 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.5.2 Prerequisites
To start the Practitioner Verification Server manually:
The Orbix Daemon must be running.
Connectivity must be available to the Nucleus 360 database.

6.5.3 Command Line Parameters/Usage


To invoke the Practitioner Verification Server manually from a command line, the usage is as follows:
Drive:\> cd <MT directory>
Drive:\<MT directory>> cd bin
Drive:\<MT directory>\bin> <exe name> <orbix name> <location of configuration
file> <timeout length>
Each of the command line parameters is described below:
Parameter Description
<MT drive> Drive where the MT servers were installed
<MT directory> Directory where MT servers were installed
<exe name> File name of the Practitioner Verification Server executable
<orbix name> Name that the Practitioner Verification Server has been registered as in
Orbix
<location and name of Full path and file name of the middle tier configuration file (dbcfg.txt)
configuration file>
<time out length> Length of time (in milliseconds) of Practitioner Verification Server
inactivity until the server will automatically shut down

An example of the Practitioner Verification Server usage follows:


Windows 2008:
c:\>
c:\> cd C:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin
c:\Program Files (x86)\Cegedim\Nucleus360\5.2.0\MT\bin> saiPVSrv.exe saiPVSrv
C:\sai\mt\bin\dbcfg.txt 36000000
In the previous example, saiPVSrv.exe is the file name of the Practitioner Verification Server executable.
The name saiPVSrv is the name that the Practitioner Verification Server has been registered as in Orbix.
This name is displayed in the Orbix Server Manager.

6.5.4 General Troubleshooting on a Client Machine


When troubleshooting a client machine concerning a suspected middle tier issue, refer to the Connection
Failure screen (Figure 2) and the Connection Failure Details screen (Figure 3) for information. It is
important to determine the value of the minor code field from the Connection Failure Details error
screen. For example, on a client machine, the following Connection Failure screen is the most typical type
of error that appears for middle tier related problems:

IMS Health Operations Guide Page 42 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Figure 2. Connection Failure screen

The Connection Failure screen provides basic information regarding the issue:
The type of middle tier server that the client application is attempting to access (in the above
example, Common).
The Orbix-registered name of the middle tier server that the client application is attempting to access
(in the above example, saiCommonSrv).
The machine name of the host that the client application is attempting to access (in the above
example, Z_APP_01_NT).
The Connection Failure screen does not include details regarding the specific nature of the issue. For
specific information, click the Details button. An error screen similar to the one in Figure 3 will display:

Figure 3. Connection Failure Details screen (for saiCommonForms)

The saiCommonForms error screen describes the error in greater detail, including:
The source and location within the application code where the issue occurs.
A description of the error, which can be used to help resolve the issue. In the above example, the
description shows that the error is a CORBA (Orbix) error and displays the minor code for that error
(10085). The minor code is a critical piece of information for troubleshooting Orbix errors.

IMS Health Operations Guide Page 43 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.6 Middle Tier Startup and Maintenance


This section provides the technical operational information required for maintaining, monitoring, and
controlling the middle tier servers for Nucleus 360.

6.6.1 Middle Tier System Structure and Directory Layout


This section details the logical directory structure that is used by the middle tier. This section also
provides a description of the files contained within the directory structure.

6.6.1.1 Home Directory

6.6.1.1.1 Description
Windows 2008: The standard Nucleus 360 5.2 home directory is C:\Program Files
(x86)\Cegedim\Nucleus360\5.2.0\MT. All of the directories and files that are specific to the middle tier
are contained within this directory.
Note: The Orbix installation and Oracle Client installation are not installed in the Nucleus 360 home
directory. The two software packages are installed in separate directories.

6.6.1.1.2 Files
The Nucleus 360 Middle Tier home directory contains only one Uninst.isu file (for uninstall program) and
the following subdirectories.

6.6.1.1.3 Subdirectories
The Nucleus 360 home directory contains the following subdirectories:
Subdirectory Name Description
bin Nucleus 360 middle tier executables and supporting files
log Nucleus 360 middle tier log and error files

6.6.1.2 bin Directory

6.6.1.2.1 Description
The bin directory exists directly under the Nucleus 360 home directory. This directory contains the
Nucleus 360 middle tier executable files, as well as other supporting files that are needed for the
executable files to run properly.

6.6.1.2.2 Files
The bin directory contains the following files:
File Name Description
saiCommonSrv.exe Executable file for the middle tier Common Server
saiCASrv.exe Executable file for the middle tier Configuration Assistant Server
saiCRSrv.exe Executable file for the middle tier Customer Resolution Server
saiPVSrv.exe Executable file for the middle tier Practitioner Verification Server

IMS Health Operations Guide Page 44 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

File Name Description


dbcfg.txt Supporting file for all of the middle tier server executables. This is the
configuration file, which contains settings for each of the middle tier server
executables
startServer.bat Batch file invoked by the Orbix Daemon to start the Common Server
saiCASrv.bat Batch file invoked by the Orbix Daemon to start the Configuration Assistant
Server
saiCRSrv.bat Batch file invoked by the Orbix Daemon to start the Customer Resolution
Server
saiPVSrv.bat Batch file invoked by the Orbix Daemon to start the Practitioner Verification
Server

6.6.1.2.3 Subdirectories
The bin directory contains no subdirectories.

6.6.1.3 log Directory

6.6.1.3.1 Description
The log directory exists directly under the home directory. This directory contains all log files generated
by the middle tier servers, depending on whether or not logging is enabled. All of the log files are in plain
text format and can be viewed with any standard text editor.

6.6.1.3.2 Files
The log directory contains the following middle tier server log files:
File Name Description
SYSTEM.log Log file generated by the core object framework library. Since the core object
framework library is part of all servers, all servers write to this file.

COMMON.log Log file generated by the middle tier Common Server (saiCommonSrv.exe)

Customer.log Log file generated by the middle tier Customer Resolution Server
(saiCRSrv.exe)
Note: The log directory will not contain the files mentioned above immediately after a clean installation of
the middle tier. The middle tier servers generate the above files, and they will not be created until the
middle tier server executables are executed. In addition, logging must be enabled for the server in the
dbcfg.txt file to generate a log.

6.7 Middle Tier Server Operation


During normal day-to-day operation, very little manual effort is required for the middle tier. The Orbix
Daemon launches the middle tier server executables when a request is made from a client machine; there
is no need to launch the servers manually. To ensure that IMS Health applications operate properly, make
sure the Orbix Daemon is running. Under normal circumstances, as long as the Orbix Daemon is active
on the middle tier server, no other human intervention is required. Middle tier servers can be started in
two different modes: as background Services or as a normal Console Application on the Windows 2008
platform. The following sections describe each mode.

IMS Health Operations Guide Page 45 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.7.1 Running Servers as Windows 2008 Services


The middle tier server executables may be run as Windows 2008 Services. To do this, the Orbix Daemon
needs to be set up to run as a Windows 2008 Service. When the Orbix Daemon is running as a service,
any middle tier server executables that it launches will run as services as well.
To set up the Orbix Daemon to run as a service automatically upon machine startup, do the following on
the Windows 2008 Server Machine:
1. Click the Windows Start button, Settings, then select Control Panel to open the Windows 2008
Control Panel.
2. On the Control Panel window, double-click Administrative Tools.
3. On the Administrative window, double-click Services to open the Services window.
4. On the Services window, select Orbix Daemon from the Services drop-down list. Double-click Orbix
Daemon to open Properties. If the Orbix Daemon service was not installed on your computer you
need to execute orbixd j from a DOS command prompt.
5. In the Startup type combo box, select Automatic and then click the OK button.
6. Click the OK button to close the Services window.
7. Close the Control Panel window.
The next time the machine is restarted, the Orbix Daemon will automatically launch as a Windows 2008
Service.

6.7.1.1 Changing the connection timeout (-x) argument of the Orbix Daemon
The Orbix Daemon takes several optional command line arguments, one of which is the connection
timeout argument. This argument controls the length of time (in seconds) to establish that a connection to
the Orbix Daemon is fully operational. To specify this argument for the Orbix Daemon as it is running as a
Windows 2008 Service, do the following:
1. Click the Windows Start button, select Run, and in the Open field on the Run window, type regedit
and click the OK button. The Registry Editor Utility program starts.
2. In the left-hand pane of the Registry Editor, drill down to the following location: /My
Computer/HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Services/Orbix Daemon,
highlighting the Orbix Daemon key.
3. In the right-hand pane, double-click the value titled ImagePath. The Edit String window for this value
opens.
4. In the Value data field on the Edit String window, append the following:
-x <numbervalue>
where <numbervalue> is the desired literal integer value to be used as the argument
5. Click the OK button on the Edit String window and then close the Registry Editor Utility program.
Once the above steps have been completed, the next time the Orbix Daemon service is started, it will use
the specified value for the connection timeout argument.
Note: For further information regarding this parameter as well as the other command line parameters that
the Orbix Daemon accepts, please consult the Orbix Administrators Guide C++ Edition electronic
document (orbix33cxx_admin.pdf), which is included with the Orbix 3.3.5 for Windows application.

IMS Health Operations Guide Page 46 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.7.2 Running All Servers as Normal Console Applications on Windows 2008


The middle tier server executables may be run as normal console applications. To do this, the Orbix
Daemon needs to be run normally as a Windows application. When the Orbix Daemon is running in this
way, any middle tier server executables that it launches will run as a normal console application in a
command prompt window.

6.7.2.1 To launch the Orbix Daemon to run as a normal Windows application:


1. Click the Windows Start button, and select Programs and then Orbix 3.3.5 for Windows and Orbix
Daemon.
2. The Orbix Daemon launches as a Windows application. It will look similar to Figure 4.

Figure 4. Orbix Daemon screen

To have the Orbix Daemon launch automatically when a user logs into Windows 2008 on the middle tier
server machine, create a shortcut for orbixd.exe, then drag and drop the shortcut file to the startup folder.
This adds the executable file to the list of programs that will be launched on system startup.

6.7.3 Starting a Middle Tier Server Automatically


Middle tier server executables are started automatically when the Orbix Daemon receives a request from
a client machine (a machine with the IMS Health Home Office Application Suite installed on it). When an
IMS Health application is launched on a client machine, it requests connections to the middle tier server
executables that it requires. The Orbix Daemon on the middle tier machine receives these requests. The
Orbix Daemon checks whether the requested middle tier server executable is already running. If it is,
Orbix makes the connection from the client application to the running middle tier server executable. If the
executable is not already running, the Orbix Daemon launches the requested middle tier server, and then
Orbix makes the connection from the client application to the newly launched middle tier server
executable.

6.7.3.1 Starting servers automatically as a Windows 2008 Service:


1. Ensure that the Orbix Daemon is currently running as a Windows 2008 Service.
2. On a client machine (a machine with the IMS Health Home Office Application Suite installed on it),
launch the appropriate IMS Health application. The middle tier server executables that are required by
that application will automatically be launched as Windows 2008 Services.

6.7.3.2 Starting a server automatically as a normal console application on Windows 2008:


1. Ensure that the Orbix Daemon is currently running as a normal Windows application.

IMS Health Operations Guide Page 47 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2. On a client machine, launch the appropriate IMS Health application. The middle tier server
executables that are required by that application will automatically be launched as normal console
applications.

6.7.4 Starting a Middle Tier Server Manually


To start a server manually via the command line on Windows 2008:
1. Start a Command Prompt session by clicking the Windows Start button and selecting Programs and
then Command Prompt (if available). Alternatively, click the Windows Start button, select Run, type
cmd in the Open field on the Run window, and click the OK button.
2. In the Command Prompt session, go to the directory where the middle-tier server executables are
located (using the cd command).
3. To run the desired server executable, type the executable name followed by the appropriate
command line arguments. See the Command Line Parameters/Usage subsections of the specific
server sections following for a listing of the parameters that each server executable expects.
The server executable launches and the following message is displayed in the command prompt session:
server x is now available to the network.
The display will look similar to Figure 5.

Figure 5. Command Prompt screen

6.7.5 Using the Orbix Server Manager


The Orbix Server Manager is a Windows GUI application that Orbix provides as part of the installation.
The Orbix Server Manager can be used to monitor servers running on Windows platform.

6.7.5.1 Starting the Orbix Server Manager


1. Click the Windows Start button and select Programs and then Orbix 3.3 and Server Manager.
2. The Orbix Server Manager will launch as a Windows application.

6.7.5.2 Checking the Status of a Server Using Orbix Server Manager


To display the middle tier servers in the Orbix Server Manager, do the following:
1. In the menu of the Orbix Server Manager, select Host and then Connect. The Connect window
appears.

IMS Health Operations Guide Page 48 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2. In the Connect window, type the IP address or the name of the machine on which the Orbix Daemon
is running in the Location of Orbix Daemon field.
Note: If the Orbix Server Manager is being executed from the same Windows machine that the Orbix
Daemon is on, this field can be left blank.
3. Click the OK button. The Connect window disappear, and an entry for the machine, as well as entries
for the middle tier server executables, is displayed in the left-hand pane of the Orbix Server Manager.
Refer to Figure 6 for details.
The Orbix Server Manager will look similar to the following:

Figure 6. Orbix Server Manager

The Orbix Server Manager shows all of the middle tier server executables that are registered on the
machine in the left-hand pane. It also shows which server executables are currently running and which
are not. A running server executable will have an animated icon next to it (the notches on the icon will be
rotating clockwise). An inactive server executable will have a static icon.

6.7.5.3 Checking the Status of a Server via Command Line (Command Prompt Session)
Orbix provides the command psit to provide a listing of all the active (running) server executables on a
Windows machine. It generates output similar to Figure 7.

IMS Health Operations Guide Page 49 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Figure 7. Orbix psit command on Windows 2008

6.7.6 Starting a Server Manually via Orbix Server Manager

6.7.6.1 Starting a Server Manually as a Windows 2008 Service via Orbix Server Manager
1. Ensure that the Orbix Daemon is currently running as a Windows 2008 Service. Refer to section 6.7.1
for details.
2. If the Orbix Server Manager is not already running and connected, launch the Orbix Server Manager
and connect it to display the middle tier server executables. Refer to section 6.7.5.1.
3. In the left-hand pane of the Orbix Server Manager, click the name of the middle tier server executable
that is to be started. The name is highlighted and information about that particular server is displayed
in the right-hand pane.
4. On the toolbar of the Orbix Server Manager, click the Launch server button (the button with a green
traffic signal). The specified server launches, and its icon in the left-hand pane displays a green traffic
light to indicate that the server is running.

6.7.6.2 Starting a Server Manually as a Normal Console Application via Orbix Server
Manager
To start a server manually using the Orbix Server Manager, and to have that server run as a normal
console application, do the following:
1. Ensure that the Orbix Daemon is currently running as a normal console application. Refer to section
6.7.2.
2. If the Orbix Server Manager is not already running and connected, launch the Orbix Server Manager
and connect it to display the middle tier server executables. Refer to section 6.7.5.1.
3. In the left-hand pane of the Orbix Server Manager, click the name of the middle tier server executable
that is to be started. The name is highlighted, and information about that particular server is displayed
in the right-hand pane.
4. On the toolbar of the Orbix Server Manager, click the Launch server button (the button with a green
traffic signal). The specified server launches, and its icon in the left-hand pane rotates to indicate that
the server is now running.

IMS Health Operations Guide Page 50 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6.7.7 Viewing a Listing of All Registered Server Executables


Orbix provides the command lsit to use to retrieve a listing of all the server executables that are
registered with Orbix on a particular machine. It generates output similar to Figure 8.

Figure 8. Orbix lsit command on Windows 2008

6.7.8 Stopping (Killing) a Server Manually


IMPORTANT: Before shutting down a middle tier server, shut down IIS on the Web server.

6.7.8.1 Windows 2008 Service via Orbix Service Manager


To stop a server manually when running as a Windows 2008 Service via Orbix Server Manager, do the
following:
1. If the Orbix Server Manager is not already running and connected, launch the Orbix Server Manager
and connect it to display the middle tier server executables. Refer to section 6.7.5.1.
2. In the left-hand pane of the Orbix Server Manager, click the name of the middle tier server executable
that is to be stopped. The name is highlighted, and information about that particular server is
displayed in the right-hand pane.
3. On the toolbar of the Orbix Server Manager, click the Kill server button (the button with a red traffic
signal). The specified server stops, and its icon in the left-hand pane becomes static to indicate that
the server is no longer running.

6.7.8.2 Windows 2008 Service via Command Line


To stop a server manually when running as a Windows 2008 Service via command line:
Orbix provides a command to use to stop/kill a particular middle tier server executable: killit. The
command requires the server name as a parameter, killit <server name>. It generates output similar to
Figure 9.

IMS Health Operations Guide Page 51 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Figure 9. Orbix killit command on Windows 2008

6.7.8.3 Normal Console Applications


The two previous sections (sections 6.7.8.1 and 6.7.8.2) describe methods for stopping a server manually
when the server is running as a Windows 2008 Service. Those methods are also valid for stopping a
server manually when the server is running as a normal console application. However, there is an
additional method for stopping the server when the server is running as a normal console application:
To stop a server manually when running as a normal console application:
1. Locate the command prompt window that corresponds to the middle tier server executable that is to
be stopped.
2. Close the command prompt window normally by clicking the X (Close) button in the upper-right-hand
corner, or by clicking the icon in the upper-left-hand corner and selecting Close from the menu.
The server executable is stopped and the command prompt window is closed.

6.8 Troubleshooting

6.8.1 Middle Tier Machine on Windows 2008


Troubleshooting the middle tier machine may be difficult depending on the mode in which the middle tier
server executables are being run. When the executables are being run as Windows 2008 Services, it is
very difficult to troubleshoot an executable that has encountered an error. If the issue is recurring, the best
solution is to change the setup of the middle tier server executables so that they are run as normal
console applications. This allows an individual to inspect the console window of the executable for error
messages.
However, in certain situations where the middle tier server executable fails immediately upon starting,
even running the server automatically as a normal console application may not be helpful if the console
window closes as soon as the issue is encountered. In this situation, the best method to troubleshoot the
executable is to launch the server executable manually via command line.
Follow these steps to troubleshoot the middle tier machine:
1. Determine in which mode the middle tier server executables are running.
2. If the servers are running in Windows 2008 Service mode, check the status of the servers via the
Orbix Server Manager.
a. If the server in question is still running, stop the server via the Orbix Server Manager, and then
attempt to restart it again via the Orbix Server Manager.
If the server restarts successfully, check the issue again.
IMS Health Operations Guide Page 52 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

If the issue still exists, change the mode of the servers so that they will run as normal
console applications. Then continue troubleshooting using the normal console application
instructions in step 3.
If the issue is resolved, troubleshooting is complete.
If the server dies not restart successfully, continue troubleshooting using the manual
instructions following.
b. If the server in question is not running, attempt to start it via the Orbix Server Manager.
If the server starts successfully, check the issue again.
If the issue still exists, change the mode of the servers so that they will run as normal
console applications. Then continue troubleshooting using the normal console application
instructions in step 3.
If the issue is resolved, troubleshooting is complete.
If the server did not restart successfully, continue troubleshooting using the manual
instructions in step 4.
3. If the servers are running as normal console applications, check the status of the servers using the
Orbix psit command, and by manually inspecting the console window of each server executable.
If the server in question has an error message displayed in its console window, note the exact
error (take a screenshot of the console window). Then close the console window for that
server.
Attempt to restart the server again via the Orbix Server Manager.
If the server restarts successfully, check the issue again.
If the issue still exists, note all relevant information regarding the issue and contact IMS
Health.
If the issue is resolved, troubleshooting is complete.
If the server in question did not restart successfully, continue troubleshooting using the
manual instructions in step 4.
4. Troubleshoot the server manually as follows:
If the server in question is still running, shut down the server.
Attempt to launch the server via command line.
If the server restarts successfully, check the issue again.
If the issue still exists, note all relevant information regarding the issue and contact
IMS Health.
If the issue is resolved, troubleshooting is complete.
If the server in question did not restart successfully, note all relevant information
regarding the issue and contact IMS Health.

IMS Health Operations Guide Page 53 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

7. STANDARDIZER SERVER
Standardizer Server is used by applications that require real-time address/name standardization, such as
Customer Maintenance. The server can accept and process multiple requests from the client applications
concurrently using TCP/IP queuing mechanisms. The server communicates with the client processes
using the TCP/IP protocol.

Figure 10. Standardizer Server

7.1 Command Line Parameters/Usage


$ run_stddaemon -?

SYNOPSIS
run_stddaemon [--ip=ip_adress] [--port=port_number] -[ltshv]

DESCRIPTION
This script can Launch/Stop/Test the standardizer daemon.

OPTIONS
--launch, -l
Launch the standardizer daemon

--stop, -s
Stop the standardizer daemon

--test, -t

IMS Health Operations Guide Page 54 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Test the standardizer daemon. Using this option the user can
dynamically enter
an address to validate the standardized output from the daemon. It can
also be used to get the service statistics.

--ip, -i
IP Address on which the daemon resides. Default is localhost.
ex: --ip=127.0.0.1

--port, -p
Port number on which the communication takes place. Default is 49152.
ex: --port=49152

--debug, -d
Debug level. (0)No logging, (1)Errors, (2)Terse (3/4)Log all. Default
is 2

--help, -h, -?
Usage. Displays the usage of this script. Same as the one that
you read now.

--version, -v
Displays version information.

7.2 Running the Standardizer Daemon from the Windows Command


Prompt
To start and stop the server, use the commands at the command line.

7.2.1 Launch the Server


To launch the server, execute the following command from the command prompt. An exit code of non-
zero value will be returned if the server did not launch successfully.
$ cd %DRTE_NP_BIN%
$ run_stddaemon --launch

7.2.2 Shut Down the Server


To shut down the server, use the following command. An exit code of zero will be returned if the server
shuts down successfully; otherwise a non-zero value is returned.
$ cd %DRTE_NP_BIN%
$ run_stddaemon --stop

7.2.3 Output
The server logs all the requests it receives in a log file, which is named in the format
np_stddaemon_<timestamp>.log.

IMS Health Operations Guide Page 55 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

7.3 Running the Standardizer Daemon via the ONE Point Application
To launch the standardization daemon via the ONE Point application, right-click the Real Time
Standardization Service and select Start. To shut down the standardization daemon, right-click the Real
Time Standardization Service and select Stop.

7.4 Checking Status of the Server

7.4.1 View the Status


To check whether the server is running:
1. Execute the following command from the prompt:
$ cd %DRTE_NP_BIN%
$ run_stddaemon --test
2. If the Daemon is not running or if there is a network problem, the following message is displayed:
*****
***** Standardizer daemon is not running/Unable to reach daemon.
*****
If it is running, it will display the following message:
What do you want to test?

A. Address standardization
B. Name standardization
3. Daemon statistics
4. Exit testing

******************************************************************
Enter a valid choice:
Enter 4 to exit.

7.5 Troubleshooting

7.5.1 Standardizer Daemon Is Not Running/Unable to Reach Daemon


Failure Description
Standardizer Daemon is not Running/Unable to Reach Daemon
Failure Condition
This error occurs if the server stop or test option is specified when the server is not running.
Solution
Check the status of the server before running standardizer daemon with -t or -s options. Refer to
section 7.4 Checking Status of the Server. To launch the server, refer to section 7.2.1.

IMS Health Operations Guide Page 56 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

7.5.2 Standardizer Daemon Is Already Running/Unable to Launch Daemon


Failure Description
Standardizer daemon is already running/Unable to launch daemon.
Use the --test option to check the status of the daemon.
Failure Condition
This error occurs if the server launch option is used and the server is already launched in another
instance and running.
Solution
Check the status of the server before launching the server. Refer to section 7.4 Checking Status of the
Server.

7.5.3 Standardizer Daemon Is Already Running but Address Standardization Does


Not Happen
Failure Description
Standardizer Daemon is already running but address standardization does not happen
Failure Condition
The Daemon may have lost the connection to the port but Windows does not return the correct status.
Solution
This issue could be resolved by shutting down and restarting the Daemon.

Note:
Refer to Appendix B for database-related errors.
Refer to Appendix E for ACE/IACE errors.

IMS Health Operations Guide Page 57 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8. WEB SERVER

8.1 Overview
The Nucleus 360 Web Server is one of the standard tiers within the application architecture. The Web
Server handles the presentation layer for Web applications such as Customer Maintenance. It also
handles all interactions between the Web browser and the database interface.

8.2 Customer Maintenance Java Business Objects

8.2.1 Description
The Tomcat Web Server must be started for the Customer Maintenance Web GUI. This server can be
started as a service or as a console application (refer to section 8.4). After the Web Server is started, the
Customer Maintenance Web GUI is accessed through the users Web browser by entering the URL in the
browsers address bar.
http://<machine-name>:8080/CustMaint/Jsp/Login.jsp
Note: The user must specify the port number in the browsers address bar. By default, Tomcat Web
Server is configured to use port 8080.

8.3 Tomcat Startup and Maintenance


This section provides the technical operational information for maintaining, monitoring, and controlling the
Tomcat Web Server for Nucleus 360.

8.3.1 Tomcat Server Directory Layout


This section details the logical directory structure that is used by Tomcat Server.

8.3.1.1 Home Directory

8.3.1.1.1 Description
Based on the installation directory provided by the user, on installation, the Home Directory will have all
the files and directories that are specific to the Tomcat Server. Generally, by default installation, it should
be C:\Program Files (x86)\Apache Software Foundation\Tomcat 5.5. This should be referred as
<Tomcat root>.

8.3.1.1.2 Subdirectories
Assuming that the installation directory is C:\ Program Files
(x86)\Cegedim\Nucleus360\5.2.0\GUI\CustomerMaintenance, this directory contains the following
subdirectories:
Subdirectory Name Description
Jweb Contains the jsp, jar, images, logs, and other directories of Customer
Maintenance

IMS Health Operations Guide Page 58 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8.3.1.2 Log Directories


The logs for Web applications are created in the following directory:

<INSTALL_PATH>\CustomerMaintenance\jweb\log

8.3.2 Tomcat Maintenance


When the Tomcat server keeps running for a prolonged amount of time, it caches a lot of data and the
size of the log files grows. The server needs weekly maintenance to clean up the cache and log files.
Following are the steps for maintenance.

1. Go to the Run command and type services.msc. When the services window opens, select Apache
Tomcat service and stop the service if it is running.
2. If the Customer Maintenance application is hosted on a domain, go to <Tomcat
root>\work\Catalina\<domain URL>, e.g. qa-nucleus-
cm.emea.cegedimdendrite.com>\jweb\org\apache\jsp\CustMaint\Jsp folder. Otherwise, go to
<Tomcat root>\work\Catalina\localhost\jweb\org\apache\jsp\CustMaint\Jsp folder. Delete all the
files from this folder.
Similarly go to the <Tomcat root>\logs folder and archive or delete all the log files. Also archive or
delete the application log files from <INSTALL_PATH>\CustomerMaintenance\jweb\log folder.

3. Start the Apache Tomcat service from the service window again.

8.4 Server Operation

8.4.1 Running Tomcat as Windows 2008 Services


The Tomcat server executable may be run as Windows 2008 services. For more information on how to
control a service, please refer to the Microsoft Windows documentation.
Start Tomcat as follows:
1. Click the Start Button, select Settings from the drop-down list, and then select Control Panel.
2. On the Control Panel window, double-click Administrative Tools.
3. On the Administrative window, double-click Services to open the Services window.
4. Locate the Apache Tomcat service in the list, right-click the service and click Start.

8.4.2 Running Tomcat Server as Normal Application on Windows 2008


If Tomcat is not installed as an automated service in Windows, it must be started from the Start prompt.

8.4.2.1 Startup: Tomcat Server


1. Go to Start and click ProgramsApache Tomcat 5.5 Monitor Tomcat.

2. The Apache Tomcat icon is created in the System Tray (right lower corner of the screen). Right-
click the Apache Tomcat icon and click the Start service menu item.

IMS Health Operations Guide Page 59 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8.4.2.2 Shutdown: Tomcat Server

Go to the system tray, right-click the Apache Tomcat icon , and click the Stop service menu item.
This will stop the Tomcat server.

8.5 Troubleshooting

8.5.1 Help Does Not Display Contents


Failure condition
If multiple versions of Java Runtime are installed on the machine and the default is set to a version other
than 1.4.0, the content of the Help window may not display.
Solution
Solution 1:
1. Uninstall all the Java Runtime Environments from the machine and login to Customer
Maintenance, letting it install Java Runtime again.
Solution 2:
1. Access the Control Panel, select Java Plug-in, and then click the Advanced tab and select Set
Java Runtime Environment to JRE 1.4.0.
2. Click Apply and close the window. Clear the Internet cache and temporary files and log back into
Customer Maintenance.

IMS Health Operations Guide Page 60 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9. DATA IMPORT PROCESS

9.1 Overview
The Data Import process is responsible for loading all customer and affiliation data entities into the
Nucleus 360 system that originate from external systems, such as SFA/CRM; a legacy or internal system,
or from third-party data providers such as the AMA or DEA. The Data Import process supports reading
data from fixed length, delimited, and XML-based files as well as subscribing messages from a Message
Queue in real time. Depending on the data stream being used, the Data Import process can process the
data using its Batch or Transactional Comparison modes for greater efficiency.

9.1.1 What Data Import Process Does


The Data Import process loads the data from different data sources and stores the data in the Nucleus
360 database. Data coming in from different sources in different formats is translated and stored in
Nucleus 360specific core tables. Before saving the data in core tables, it passes through standardization
based on the business rules specified.

9.1.2 What Data Import Process Requires


The Data Import process requires a data file to be loaded into the Nucleus 360 database. Based on the
file format, a mapping needs to be created using the Configuration Assistant GUI. The mapping contains
the format and type of file. Also, the mapping maps required fields from the data file to the tables and
fields of the Nucleus 360 database.

9.2 Operational Modes


The Data Import process supports reading and processing customer data from the following data sources.
Delimited-Length file A type of file whose record size is determined by a special character(s) that
separates individual fields in the dataset. Pipe (|), tilde (~), and comma (,) are examples of common
industry accepted delimiters. Optionally, each field in the record may be enclosed with a special
character, known as a text qualifier, such as a single quotation mark (). The Comma Separated
Values (CSV) file is an example of a Delimited-Length file that uses both field separator (,) and a text
qualifier (). Each record in the dataset is separated by a new line.
Fixed-Length file A type of file whose record size is predetermined and constant. A fixed-length
record always takes up the same amount of space on a disk, even when the amount of data stored in
the record is small. Each record in the dataset is separated by a new line.
Flat file A type of file whose record size is predetermined and constant. Like a fixed-length file, the
flat file always takes up the same amount of space on a disk, even when the amount of data stored in
the record is small. Unlike the fixed-length file, the flat file does not contain a record separator. It will
assume the start of the record after the end of the previous records last character.
XML Short for Extensible Markup Language. XML is a W3C specification for a simple, very flexible
text format that is self-documenting. The Data Import component supports reading and processing
customer transactions contained within an XML based text file or an XML document from a message
queue.

IMS Health Operations Guide Page 61 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Once data has been received from the input source, the data must be validated, compared, and
processed. The Data Import process supports the following modes of operations:
Batch comparison mode processing Two files having the same format are required for
processing the current version and a previous version. The two files are verified for correctness,
and each transaction in the current and previous files is intelligently compared field by field where
changes are identified and transaction types (Add, Update, Delete, or No Change) are determined for
processing and passed along to the Transaction Manager module.
If the transaction was successfully processed by the Transaction Manager module, the process is
repeated for the next transaction within the dataset. If the process is unsuccessful, then both the
current and previous transactions are written to an error file along with the error description, and the
process is repeated for the next transaction within the dataset.
This mode accepts profile data received in fixed-length, delimited, or flat file formats encoded using
the ASCII character set.
Transactional mode processing A single file is verified for correctness and processed based on
pre-identified transactions within the file against the database records. The Import application
identifies Add, Update, and No Change transaction types, while the data source identifies all Delete
transactions. Each transaction is passed along to the Transaction Manager module.
If the transaction was successfully processed by the Transaction Manager module, the process is
repeated for the next transaction within the dataset. If the process is unsuccessful, then the
transaction is written to an error file along with the error description, and the process is repeated for
the next transaction within the dataset.
This mode accepts profile data received in fixed length, delimited, flat, or XML file formats encoded
using the ASCII character set.
Real-time mode processing Transactions posted to message queues by external sources are
processed by the Import application. Each transaction within the pre-identified transaction set is
optionally transformed using an XSLT parser and verified for correctness using a Schema Definition
file (XSD). The Import application identifies Add, Update, and No Change transaction types, while the
message identifies all Delete transactions. Each transaction is passed along to the Transaction
Manager module.
If the transaction was successfully processed by the Transaction Manager module, the process is
repeated for the next transaction within the dataset. If the process is unsuccessful, then the
transaction is written to an error file/exception queue along with the error description and the
process is repeated for the next transaction within the dataset. Whether or not transactions are
processed successfully, they are removed from the message queue.
The Real-time Mode accepts profile data received in XML format encoded using the ASCII character
set.

9.3 The Run Script run_dataimport.exe


Note: Options for the run_dataimport.exe script are listed in the table in section 9.4.
run_dataimport.exe is a run script that encapsulates the command line options of the npdataimport.exe
to simplify the command line options of the data import application. The run script has an automatic mode
to import third party data files. A typical run of the dataimport.exe is done with the auto mode option. The
following steps are performed in auto mode:
The new file, old file, and bad file names are identified automatically based on the data source. The
default third party file name and the directory name are listed in the following table. These names are
derived by the run_dataimport.exe based on the data source.

IMS Health Operations Guide Page 62 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Data
and
Data Bad Old Data New Data New Bad File Old Bad File Data and Bad File
Source File File Name File Name Name Name Directory
Name
Prefix
newbadAMA.sort oldbadAMA.sort <DRTE_THIRD_PARTY
AMA AMA AMA<*>.old AMA<*>.new
>\np\in\ama
newbadAOA.sort oldbadAOA.sort <DRTE_THIRD_PARTY
AOA AOA AOA<*>.old AOA<*>.new
>\np\in\aoa
newbadDEA.sort oldbadDEA.sort <DRTE_THIRD_PARTY
DEA DEA DEA<*>.old DEA<*>.new
>\np\in\dea
Prefix: The default file name Prefix can be changed for a data source using the p option of the
run_dataimport.exe script.
Third Party Directory: The default third party directory name for a data source can be changed by
setting the directory name in the environment variable <Prefix>_DIR.
Example:
a. Overriding the file naming convention of a standard data source. (File name prefix
change).
If the AMA data file name is prefixed with the letter F (say F1.old and F2.new), use the p
option to override the default prefix AMA to F. A sample command line is provided here:
$ cd %DRTE_NP_BIN%
$ run_dataimport.exe -m=1000 -a -p=F
b. Overriding the data file directory of a standard data source without changing the file
naming convention.
To override the data file location, create an environment variable using the naming convention
Prefix_DIR, where Prefix is the data source file name prefix. As an example, to change the
default location of the AMA file, define an environment variable with the name AMA_DIR and
set the variable with the directory path of the file relative to the third party input directory
<DRTE_THIRD_PARTY>\np\in. Add the environment variable to the np_env.bat file to
export it automatically each time the np_env.bat file is run.
If the new AMA data file location is <DRTE_THIRD_PARTY>\np\in\data, open the
np_env.bat and add the following command to the end of the file. Save, close, and execute
the np_env.bat to export the environment variables.
Set AMA_DIR=data
The run_dataimport.exe script will now use the AMA data files from the new location data.
$ cd %DRTE_NP_BIN%
$ ..\..\np_env.bat
$ run_dataimport.exe -m=1000 -a

IMS Health Operations Guide Page 63 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

c. Overriding the data file directory of a standard data source and the file naming
convention.
The file name prefix is overridden using the p option of the run script. To change the data file
directory along with the file name, create an environment variable using the new prefix and
set the variable with the directory path of the file relative to the third party input directory
<DRTE_THIRD_PARTY>\np\in. The environment variable naming convention is Prefix_DIR.
Add the environment variable to the np_env.bat file to export it automatically each time the
np_env.bat file is run.
As an example, if the AMA data file name is prefixed with the letter F (say F1.old and
F2.new), use the p option to override the default prefix AMA to F. If the new AMA data
file location is <DRTE_THIRD_PARTY>\np\in\data, open the np_env.bat and add the
following command to the end of the file. Save, close, and execute the np_env.bat to export
the environment variables.
Set AMA_DIR=data
The run_dataimport.exe script will now use the AMA data files from the new location data.
$ cd %DRTE_NP_BIN%
$ ..\..\np_env.bat
$ run_dataimport.exe -m=1000 -a -p=F
d. Accessing data files from a different drive
If the third party data files are located in a drive that is different from the one where the Server
Layer processes are installed, set the DRTE_THIRD_PARTY environment variable with the
new drive name. DRTE_THIRD_PARTY environment variable is defined in the np_env.bat
file. As an example, if the Server Layer processes are installed on the C drive and the data
files are located on the D drive, set the DRTE_THIRD_PARTY environment variable with D:
in the np_env.bat file. The run script always looks for np\in directory beneath the directory
that is set in the DRTE_THIRD_PARTY environment variable. In our example, the AMA data
file will be picked from the D:\np\in\ama directory. If the ama folder is created directly under
the D drive as D:\ama, set the AMA_DIR environment variable with the value ..\..\ama.
Set DRTE_THIRD_PARTY=D:
Set AMA_DIR=..\..\ama
Note: By default, the archived data files are stored in the %DRTE_ROOT%\archives\np
directory, where DRTE_ROOT is defined in np_env.bat file. To store the archived files in a
different drive, set the new drive name in the DRTE_ROOT variable. Make sure that the new
drive has the following directory structure under it: DriveName:\archives\np.
e. Defining the file name prefix and the data file directory of a new data source
For a new data source, define the file name prefix using the p option. Using the prefix,
create an environment variable and then set the variable with the directory path of the data
file relative to the third party input directory <DRTE_THIRD_PARTY>\np\in. The variable
naming convention is Prefix_DIR. Add the environment variable to the np_env.bat file to
export it automatically each time the np_env.bat file is run.
As an example, you want to import a new data source State License whose data files are
named using the convention STL_MMDDYYYY.old and STL_MMDDYYYY.new. It is located
in the directory %DRTE_THIRD_PARTY%\np\in\stl. Open the np_env.bat and add the
following command to the end of the file. Save, close, and execute the np_env.bat to export
the environment variables.

IMS Health Operations Guide Page 64 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

set STL_DIR=stl
Following is a sample command line to execute the run script.
$ cd %DRTE_NP_BIN%
$ run_dataimport.exe -m=2000 -a -p=stl
The last modified date of the new file is set with the system timestamp to make it more recent than
the old file.
The following operations are performed if the Data Import application completes successfully:
A copy of the old and the new file is compressed using the WinZip command line utility
(Version Winzip Pro v11 with the command line add-on support). The zipped file name will be of
the format:
archive.<Prefix>.YYYYMMDD_HHMISS.zip.
For example, the archive file name of a DEA data load will be
archive.DEA.20080327_155224.zip. The zipped file will be archived in the
<DRTE_ROOT>\archives\np directory.
The old data file is deleted.
The new data file extension is renamed to .old, to be used as an old file in the next run.
The database maintenance process can be optionally invoked to analyze the tables that
are impacted by the data import process.
An exit code of zero 0 is returned from the run script if the Data Import process
completes successfully. Otherwise a non-zero value is returned.
Other features of the run script are as follows:
The bad file names are generated based on the data source and the files will be created in
<DRTE_THIRD_PARTY>\np\in\<data source> directory. Refer to the above table for format details.
The log file name will be generated based on the data source and placed in
<DRTE_THIRD_PARTY>\np\log directory.
Format: npdataimport_<Prefix>.log
Example: npdataimport_DEA.log will be generated for the DEA data source.

9.4 Command Line Parameters


npdataimport.exe [-?] [-v] [-V] [-c<dbconfig>] -l<logfile> [-m<mapid>]
[-o<oldfile>] [-n<newfile>] [-d<oldbadfile>] [-w<newbadfile>] [-D] [-N]
[-X] [-f<commit>] [-s] [-q<queue>] [-k<control queue>] [-
e<exceptionqueue>] [-C<mappingconfigfile>] [-F<QueuePollingFrequency>] [-
B<BlockName>] [-p<port>]

Run Script Application Description Applicable In


Parameter Parameter (Processing Mode)
(run_dataimport. (npdataimport.exe)
exe)
-? -? Detailed Help All modes
-h N/A Detailed Help All modes

IMS Health Operations Guide Page 65 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description Applicable In


Parameter Parameter (Processing Mode)
(run_dataimport. (npdataimport.exe)
exe)
-v -v Version Information All modes
N/A -V Extended Version Information All modes
N/A -c<dbconfig> Database configuration file All modes
(defaulted to dbcfg.txt)
N/A -l<logfile> Specify the log file name All modes
-m -m<mapid> Specify the Mapping ID (see Batch or Transaction
Configuration Assistant Comparison only.
Application User Guide) Applicable only for fixed
length, delimited, and
flat files.
-o -o<oldfile> Specify the old file name Batch Comparison only
-n -n<newfile> Specify the new file name Batch or Transaction
Comparison only
N/A -d<oldbadfile> Specify the bad file name for the Batch Comparison only
old file
N/A -w<newbadfile> Specify the bad file name for the All modes
new file
N/A -D Application debug mode Batch or Transaction
Comparison only
-d -N Dry run mode (no database Batch or Real-time only
commits)
-s -X Bypass validation of the data files Batch Comparison only
for key ordering and record
lengths.
WARNING: Use of this option is
HIGHLY inadvisable. Improper
key order within data files will
cause corruption in the database.
N/A -f<commit> Database commit frequency, Batch or Transaction
defaulted to 1 Comparison only. In
real-time mode, the
database and message
queues are committed
after each message is
processed.

IMS Health Operations Guide Page 66 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description Applicable In


Parameter Parameter (Processing Mode)
(run_dataimport. (npdataimport.exe)
exe)
-t -s Use Numeric Sort for validation of Batch or Transaction
keys. By default, dataimport runs Comparison only
in character-based sorting; e.g., if
there are two records with keys 2
and 11, 11 will be picked first and
then 2. If the file has numeric
keys, this parameter can be
passed which sorts the keys
explicitly in numeric format, so
that 2 will be picked and then 11.
-q -q<queue> Input Message queue name from Real-time
where XML transactions are read
N/A -k Control queue name. This queue Real-time
is used to start or stop dataimport
from reading or writing to the
queues.
-e -e<exceptionqueue> Exception queue name to post Real-time
rejected transactions
-c - Mapping Configuration file name Real-time and XML-
C<mappingconfigfile (this is the XML Data Import based Transaction
> configuration file). Using this Comparison only
configuration file, Data Import
identifies the mapping to use
when running in a Real Time
Mode (Message Queue setup).
-f - Polling frequency of the inbound Real-time
F<QueuePollingFreq message queue in seconds.
uency>
The data queue will be polled
every n seconds for new incoming
messages when the Data Import
process is in the idle state.
Defaulted to 10 seconds.
ex: -f=5

-b<buffer> -f Buffer size. Number of profiles to


cache in memory buffer until it is
applied to the database. Not
applicable for real-time
transactions and Incremental
loads. Use only for IDL
operations.
-s Use Numeric Sort for validation of
keys.

IMS Health Operations Guide Page 67 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description Applicable In


Parameter Parameter (Processing Mode)
(run_dataimport. (npdataimport.exe)
exe)
-B Query Block Name (for reading
data from db using SQL query)
-k Control queue name
-p Port Number (for reading data
from a port. Default value is
49152)
-r N/A Launch the run script in restart Batch or Transaction
mode if an entry exists in Comparison only
NP_DELTA_RECOVER table for
the current mapping
-a N/A This parameter enables the data Batch Comparison Auto
import process to run in Auto Mode only
mode.
Note:
Auto mode is applicable only for
batch file processing in which the
old and new data file are
automatically identified from the
appropriate third party data
directory. After data import is
completed, data files are
compressed and archived in the
archive directory. After the files
are archived, the old file from the
third party data directory is
deleted and the new file is copied
as .old, to be used as the old file
in the next run.
-p N/A Using this parameter, Prefix value Batch Comparison Auto
could be passed expliclty, while Mode only
Auto mode (-a) option is enabled.
If this value is not specified, the
default Prefix Directories are used
to get the old and new data files
in Auto mode.
Example:
If default prefix is changed to
EPHARMA, the data file names
are EPHARMA*.new and
EPHARMA*.old. The data file
directory should be set in the
environment variable
EPHARMA_DIR.
ex: --prefix=EPHARMA

IMS Health Operations Guide Page 68 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description Applicable In


Parameter Parameter (Processing Mode)
(run_dataimport. (npdataimport.exe)
exe)
-z N/A Perform database maintenance to Manual Mode
analyze tables/indexes that are
modified by the data import
process.
N/A -B Dataimport can run in a query Batch or Transaction
mode where the input is not a file Comparison only
but a query, and the result set is
treated as input data. By default,
this query reads from the current
database user, which is
configured in the default
NUCLEUSPHARMA block of the
dbcfg.txt file. The query can be
configured to read the source
data from a different database
user; just create another block in
the dbcfg.txt file and pass the
block name using this parameter.
N/A -p Dataimport can read data from a Real-time
tcp port in xml format the way it
can read from queues. Using this
parameter, the port number can
be specified.

9.5 Running the Process in Batch Compare Mode


The process of preparing and running the processes is the same for every data source that uses the
Batch Comparison Mode.
Identify the two files to be used for the same data source, the current and previous data files.
Verify Postalsoft directories.
Perform a dry run.
Analyze the dry run results.
Load with the Import process.
Analyze the results.

IMS Health Operations Guide Page 69 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.5.1 Identify Source Files


Identify the source files required for running the process. The conventions in the following table assume a
monthly data load for common data sources. You may need to change this depending on the frequency of
the data load.
AMA
Previous Months File %DRTE_THIRD_PARTY%\np\in\ama\<YYYY_MM Prev>\AMA.DAT
Current Months File %DRTE_THIRD_PARTY%\np\in\ama\<YYYY_MM Curr>\AMA.DAT
AOA
Previous Months File %DRTE_THIRD_PARTY%\np\in\aoa\<YYYY_MM Prev>\AOA.DAT
Current Months File %DRTE_THIRD_PARTY%\np\in\aoa\<YYYY_MM Curr>\AOA.DAT
DEA
Previous Months File %DRTE_THIRD_PARTY%\np\in\ntisdea\<YYYY_MM Prev>\DEA.DAT
Current Months File %DRTE_THIRD_PARTY%\np\in\ntisdea\<YYYY_MM Curr>\DEA.DAT
State License
Previous Months File %DRTE_THIRD_PARTY%\np\in\stlic\<YYYY_MM Prev>\STATE_LIC.DAT
Current Months File %DRTE_THIRD_PARTY%\np\in\stlic\<YYYY_MM Curr>\STATE_LIC.DAT

9.5.2 Verify Postalsoft (IACE) Directories


Postalsoft Directories are lookup files used by the Postalsoft (IACE) software. Postalsoft directory updates
must be installed when they are received to ensure that they are compatible with the current software.
Incompatible or out-of-date directories will render the software unusable, causing the Data Import
application to throw exceptions related to failed address standardization.
The aceinfo.exe utility can be used to ensure that the Postalsoft directories are current. Execute
aceinfo.exe using the -v option to assess the status of the directories as follows:
$ cd %DRTE_NP_BIN%
$ aceinfo.exe -v
If it displays the version information without errors, the directories are current. The following shows
sample output displayed by aceinfo.exe with no errors.
*******************************************************************
ACE library information for block : IACE_USA
*******************************************************************
PostalSoft Version : IACE:7.70c
Revision :
IACE:7.70c IIE:770c IIEPUB:770c AUS:770c IDA:218 INTL_LL:218 AUSACC:218
AUCZS:218 OCFACC:218 CAN:770
c CCGEO:770c GMI:77

IACE library directory path : c:\pw\dirs\us\


IACE library key path : c:\pw\iacelib\

IMS Health Operations Guide Page 70 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

An error message similar to the following is displayed if the directories have already expired. The error
message will always contain the following text: check paths in ace.cfg and dir expiration dates. The Data
Import process should not be run until the Postalsoft directory updates are installed.
The specified ZIP+4 directory has expired. Exception: ACE_OPEN failed, check
paths in ace.cfg and dir expiration dates.
An error message similar to the following is displayed if the directories are about to expire. The error
message will always contain the following text: check paths in configuration file and dir expiration dates.
The Data Import process should not be run until the Postalsoft directory updates are installed.
Open (Engine) failed, check paths in configuration file and dir expiration
dates. ZIP+4 directory expires in n days.

9.5.2.1 Certified/Non-Certified Mode (CASS/Non-CASS mode)


Expired Postalsoft directories can be used for an additional 10 months grace period from the date of
expiry in non-Certified/non CASS mode. Though the recommended approach is to install the current
directory updates received from Postalsoft, the non-Certified option can be used on a temporary basis if
there is a delay in receiving the update. Refer to the Business Objects documentation for the differences
between Certified and non-Certified Mode.
To use the Postalsoft directories in non-Certified mode:
1. Open the ace.cfg file from the bin directory (%DRTE_NP_BIN%).
2. Inside ace.cfg, search for all configuration files that are currently used. Configuration file names are
defined using the convention CONFIG_FILE_NAME=..\defs\ace\<filename>. If the keyword
CONFIG_FILE_NAME is prefixed with a semicolon ;, then the configuration is not used. If the
keyword is not prefixed with a semicolon, the corresponding configuration file associated with the
keyword is in use.
3. Open each configuration file that is mentioned against the CONFIG_FILE_NAME variable in the file,
and search for the keyword NACE_OPT_NON_CERTIFIED. Replace its value as shown:
NACE_OPT_NON_CERTIFIED=NACE_OPT_NON_CERTIFIED_YES. Save the file and close it.
4. After modifying all the configuration files that are in use, execute aceinfo.exe to verify the changes.
Note: After you receive and install the current directory updates, remember to update the configuration
files back to NACE_OPT_NON_CERTIFIED=NACE_OPT_NON_CERTIFIED_NO to turn Certified mode
back ON.

9.5.3 Perform a Dry Run


This step simulates the expected output that may be generated, except that it does not update the
database.
This example depicts the dry run process for monthly AMA data.
$ cd %DRTE_NP_BIN%
$ run_dataimport -m=1 -o=%DRTE_THIRD_PARTY%\np\in\ama\AMA.OLD -n=
%DRTE_THIRD_PARTY%\np\in\ama\AMA.NEW --dry_run
Where:
-o Old file name
-n New file name
--dry_run Dry run mode

IMS Health Operations Guide Page 71 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

-m Mapping ID. To get the mapping ID of a data source, execute the following command at the
prompt:
run_dataimport. exe -?

9.5.4 Analyze the Dry Run Results


Open the log file produced by the Data Import process.
Ensure that nothing prevented the npdataimport process from running.
Examine the transaction count summaries at the bottom of the file.
The number of rejected transactions should be zero.
There should not be an excessively large (or excessively small) number of inserts, updates, or
deletes1.
Note: The absence of exceptions or bad files during the test does not mean that they will not occur during
the actual run. A full analysis of the log file from the actual data load is required.

9.5.5 Load Data Using run_dataimport.exe in Non-Auto Mode


In this process, the Data Import application validates the old and new file, processes them, and commits
the transactions to the database.
When running the Data Import process in Non-Auto mode, you can specify the old and new file
information as mentioned here. Data Import does not use any default standard prefix in Non-Auto mode,
though it can be explicitly provided through the Environment Variable specified in section 9.3.
$ cd %DRTE_NP_BIN%
$ run_dataimport m=<mapping_id> -o=<Any Directory>\old_file_name_any_format
-n=<Any Directory>\new_file_name_any_format

9.5.6 Analyze the Results


Perform all the steps that you performed when analyzing the dry run results. Run the following command
to ensure that no transactions were rejected.
$ dir %DRTE_THIRD_PARTY%\np\in\ama *.sort
If you find .sort files, do not attempt to process them. If possible, determine why the transactions were
rejected and try to resolve them before running the rejected profiles again. Contact your support team if
the issue still exists.

9.5.7 Load Data Using run_dataimport.exe in Auto Mode (-a option)


In auto mode, the run script identifies the new file and the old file automatically from the appropriate third
party data directory based on the mapping ID. The data files will be archived after successful completion
of the Data Import. The old file is deleted from the third party directory and the new file is renamed with an
extension .old.
$ cd %DRTE_NP_BIN%

1
What might be considered a normal transaction count for one data source might not be a normal transaction count for another.
Being able to identify what is a normal transaction count will come with experience. Excessively high or low transaction counts do
not constitute an error, but there is most likely an exceptional condition occurring. Investigation into the cause of the abnormal
transaction count might be necessary.
IMS Health Operations Guide Page 72 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

$ run_dataimport.exe -m=1010 -a

9.6 Running the Data Import Process in Transactional Mode


The process of preparing and running the processes is the same for every data source that uses the
Transactional Mode.
1. Identify the file to be used.
2. Verify Postalsoft directories.
3. Load with the Import process.
4. Analyze the results.

9.6.1 Identify Source File


Running the process in transactional mode requires only one file. Identify the single file required to run the
process.

9.6.2 Verify Postalsoft Directories


Refer to section 9.5.2 for details.

9.6.3 Load Data


$ cd %DRTE_NP_BIN%
$ run_dataimport -m=1 -n=%DRTE_THIRD_PARTY%\np\in\ama\AMA.DAT

9.6.4 Analyze the Load Results


Ensure there are no messages that contain the words Fail, Exception, Expire, or Expires.
Ensure that nothing prevented the npdataimport process from actually running.
Examine the transaction count summaries at the bottom of the file.
There should not be an excessively large (or excessively small) number of inserts, updates, or
deletes.

9.7 Running the Data Import for XML Data

9.7.1 Identifying/Preparing the Configuration File


An XML-based configuration file is required to import customer or affiliation data that is in XML format. A
default configuration file, config.xml, is installed in the %DRTE_NP_BIN% folder. It is configured to
validate, transform, and import data that complies with IMS Healths Common Object Model (COM)
specification. Any deviation from COM specifications would require customization to the transformation
(XSL) and validation (XSD) files that are defined in the config.xml file. The elements in the configuration
file are explained here.
Element Name Description
CONFIGURATION_LIST Root element of the configuration file.

IMS Health Operations Guide Page 73 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element Name Description


SRC_TYPE Configured for each data source that provides data in XML
format.
CONFIGURATION Defined for each type of transaction that is received from a data
source. Transactions can be classified as Professional,
Organization, or Affiliation based on a predefined attribute value
that is found in the data.
COMMON_MESSAGE_XSLT_FILE XSL transformation file that identifies the data source type
SRC_TYPE and transaction type CONFIGURATION to be used
to import the current XML transaction being processed.
PRE_TRANSFORM_XSD_FILE Specifies the XSD file to validate the source transaction.
XML_TRANSFORMATION_FILE Specifies the XSL file to transform the source transaction to the
Nucleus 360 standard format (refer to the Data Interface
Document for the standard format).
POST_TRANSFORM_XSD_FILE Specifies the XSD file to validate that the transformed
transaction is of standard format.

9.7.2 Running the Data Import Process in Transactional Mode


The process of preparing and running the processes is the same for every data source that uses the
Transactional Mode.
1. Identify the data file to be used.
2. Identify the mapping configuration file to be used.
3. Verify Postalsoft directories.
4. Load with the Import process.
5. Analyze the results.

9.7.3 Identify Source File


Running the process in transactional mode requires only one file. Identify the single file required to run the
process.

9.7.4 Verify Postalsoft Directories


Refer to section 9.5.2 for details.

9.7.5 Load Data


$ cd %DRTE_NP_BIN%
$ run_dataimport -m=1 -n=%DRTE_THIRD_PARTY%\np\in\sfa\<YYYY_MM Curr>\SFA.XML
c=config.xml

9.7.6 Analyze the Load Results


Ensure that no messages contain the words Fail, Exception, Expire, or Expires.
Ensure that nothing prevented the npdataimport process from actually running.
IMS Health Operations Guide Page 74 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Examine the transaction count summaries at the bottom of the file.


There should not be an excessively large (or excessively small) number of inserts, updates, or
deletes.

9.7.7 Running the Data Import Process in Real-time Mode


The process of preparing and running the processes is the same for every data source that uses the
Real-time Mode.
1. Identify the Data queue to be used.
2. Identify the Exception queue to publish rejected transactions.
3. Load with the Import process.
4. Shut down the Real-time Import process.
5. Analyze the results.

9.7.8 Load Data


$ cd %DRTE_NP_BIN%
$ run_dataimport --queue=<message_queue_name> --equeue=<EXCEPTION_QUEUE_NAME>
-c=<config.xml>

9.7.9 Load Data from a Priority Queue


Priority queues are meant for transactions that require immediate processing. To process transactions
that are in the priority queue, launch another instance of the Data Import process that listens to the priority
queue.
$ cd %DRTE_NP_BIN%
$ run_dataimport --queue=<priority_queue_name> --equeue=<EXCEPTION_QUEUE_NAME>
-c=<config.xml>

9.7.10 Writing Rejected Transactions to Exception Queue


The default behavior of the run_dataimport.exe script is to take the rejected transactions that failed
during processing and write them to an exception XML file. Optionally, these transactions can be
published to an exception queue.
$ cd %DRTE_NP_BIN%
$ run_dataimport --queue=<priority_queue_name> -c=<config.xml>
--exception_queue=<exception queue name>

9.7.11 Handling Rejected Transactions


Rejected transactions in the exception queue need to be corrected and then executed.
$ cd %DRTE_NP_BIN%
$ run_dataimport --queue=< exception queue name> -c=<config.xml>

IMS Health Operations Guide Page 75 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.7.12 Shut Down the Real-time Import Process


The Import process continuously listens to the message queue for input transactions even if the queue is
empty. Execute the following command to shut down the Import process.
$ cd %DRTE_NP_BIN%
$ npprocessctrl -oSHUTDOWN
By default the npprocessctrl.exe waits for the Data Import process to read the shutdown message. The
Process Control application can also be executed in an asynchronous mode to post shutdown messages.
In this mode the application terminates immediately after posting the message.
Execute the following command to post an asynchronous shutdown message.
$ cd %DRTE_NP_BIN%
$ npprocessctrl -oSHUTDOWN a

9.7.12.1 Command Line Parameters/Usage


Application Parameter Description
(npprocessctrl.exe)
-? Detailed Help
-v Version Information
-V Extended Version Information
-c Database configuration file (dbcfg.txt is the default file)
-o Operation [ SHUTDOWN | PAUSE | RESTART ]
-q Message posted for application listening to this queue
-k Control queue
-a Do not wait for the message to be read by the Data Import process

9.7.13 Analyze the Load Results


Ensure that no messages contain the words Fail, Exception, Expire, or Expires.
Ensure that nothing prevented the npdataimport process from actually running.
Examine the transaction count summaries at the bottom of the file.

9.8 Running Data Import Process Using ONE Point Application

9.8.1 Batch Import


The Data Import process can be launched using the ONE Point configuration Manual Data Import.
Select a mapping for the Data Import process.

IMS Health Operations Guide Page 76 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.8.2 Real Time Import


The Data Import process can be launched using the ONE Point configuration. Right click Real Time
Data Import and select Start.

9.9 Operation Instructions to Load OneKey Data into Nucleus 360

9.9.1 Overview
The OneKey source is configured as a third party data source and data is loaded into Nucleus 360 Core
tables using the Data Import Process. Unlike other data sources, OneKey provides international data.
Therefore the address standardization feature provided by ACE Postalsoft engine is disabled for this data
source.
A separate ONE Point configuration file, BMS_Onepoint.xml, has the configurations for loading the
OneKey codes and data through the Data Import process.
OneKey data and codes can be loaded to staging tables by running either the Automatic OneKey
Staging Import and Code processing or Manual OneKey Staging Import and Code processing
configurations.
OneKey data should be loaded to core tables after the OneKey data and codes are loaded to staging
tables either by running the Automatic OneKey Data Processing or Manual OneKey Data
Processing configurations in IDL or Incremental modes.
IDL OneKey data load is carried out in two phases.
Automatic OneKey Data Processing (IDL) or Manual OneKey Data Processing (IDL): This
process will load all the OneKey data, including the inactive data, into the Nucleus 360 database.

IMS Health Operations Guide Page 77 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Automatic OneKey Data Processing (IDL Inactive) or Manual OneKey Data Processing (IDL
Inactive): This process will inactivate the inactive data loaded as part of the IDL. The incremental
mode takes care of deleting/inactivating OneKey data when it is run, with no need to perform any
further steps.
Following are the processes configured for loading OneKey Data and Codes using Manual and Automatic
Data Processing configurations.
DB Connection Verification This process verifies the database connection using the
COF_DBConnect application.
Import OneKey Data to Staging tables Perl process that invokes the Oracle SQL Loader utility to
load OneKey data and codes from flat files received from OneKey source into Temporary staging
tables. Following is the list of staging tables populated by this process.
Staging Table Name Comments
STG_OK_RELATION OneKey Relation data from different countries.
STG_OK_WORKPLACE OneKey Workplace data from different countries.
STG_OK_INDIVIDUAL OneKey Individual data from different countries.
STG_OK_ACTIVITY OneKey Activity data from different countries.
STG_OK_ADDRESS OneKey Address data from different countries.
STG_OK_WORKPLACE_ADDRESS_REL OneKey Address relation data from different countries.
Migrate OK codes from STG to BLT PL/SQL process that loads OneKey code data from the
OneKey codes staging table to the appropriate BLT table. The following shows the association
between the OneKey Codes staging table and the OneKey Codes BLT table.
Staging Table Name Comments BLT Table Name
STG_OK_CODES OneKey code data from BLT_OK_CODES
different countries.
Migrate OK Data from STG to BLT PL/SQL process that loads OneKey Entity data from OneKey
data staging tables to the appropriate BLT tables. The following table shows the association between
OneKey data staging tables and OneKey data BLT tables.
Staging Table Name BLT Table Name
STG_OK_RELATION BLT_OK_RELATION
STG_OK_WORKPLACE BLT_OK_WORKPLACE
STG_OK_INDIVIDUAL BLT_OK_INDIVIDUAL
STG_OK_ACTIVITY BLT_OK_ACTIVITY
STG_OK_ADDRESS BLT_OK_ADDRESS.
STG_OK_WORKPLACE_ADDRESS_REL BLT_OK_WORKPLACE_ADDRESS_REL
Populate code verification table PL/SQL process that evaluates the OneKey codes in the
OneKey code BLT table and populates the qualified codes into the
EXTERNAL_CODES_VERIFICATION table with an APPROVAL_STATUS_CD as Auto Approved
(506905).

IMS Health Operations Guide Page 78 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Create/Update FND Codes PL/SQL process that evaluates code records with
APPROVAL_STATUS_CD as Auto Approved (506905) or Manually Approved (506904) from
EXTERNAL_CODES_VERIFICATION table, and PROCESSING_STATUS_CD as Not Processed
(506907), determines the type of transaction (Insert/Update/Inactivate) for the code item, and
modifies the respective FND code tables. Following is the list of tables modified by this process.
FND CODE TABLES MODIFIED
FND_CODE_ITEM
FND_CODE_ITEM_STRING
FND_CODE_EXTERNAL_ITEM
FND_CODE_HEADER
FND_CODE_HEADER_STRING
Import Workplace Data Import application configured to load OneKey Workplace data from
OneKey BLT tables to Nucleus 360 core tables. Profiles created for this OneKey entity are classified
as Organization profiles. Following is the list of tables modified by this process.
CORE TABLES MODIFIED
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF
CUS_ORGANIZATION_PROFILE
CUS_ADDRESS
CUS_OPTOUT_PROFILE
CUS_SPECIALTY
CUS_BUSINESS_PERIOD
Import Individual Data Import application configured to load OneKey Individual data from OneKey
BLT tables to Nucleus 360 core tables. Profiles created for this OneKey entity are classified as
Professional profiles. Following is the list of tables modified by this process.
CORE TABLES MODIFIED
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF
CUS_PROFESSIONAL_PROFILE
CUS_ADDRESS
CUS_PROFESSIONAL_DEGREE
CUS_OPTOUT_PROFILE
CUS_SPECIALTY

Import Workplace_Relation Data Import application configured to load OneKey Workplace


Relation data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Organization Affiliations into CUS_AFFIL_PROFILE table.

IMS Health Operations Guide Page 79 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Import Individual_Relation Data Import application configured to load OneKey Individual Relation
data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Professional Affiliations into CUS_AFFIL_PROFILE table.
Import Individual_Roles Data Import application configured to load OneKey Individual Roles data
from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as Professional
Affiliation Roles into CUS_AFFIL_ROLE table.
Import Workplace_Communication Data Import application configured to load OneKey
Workplace Communication data from OneKey BLT tables to Nucleus 360 core tables. Data from this
entity is loaded as Organization Communication data into CUS_COMMUNICATION_PROFILE table.
Import Individual_Communication Data Import application configured to load OneKey Individual
Communication data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is
loaded as Professional Communication data into CUS_COMMUNICATION_PROFILE table.
Import Workplace_Identifiers - Data Import application configured to load OneKey Workplace
Identifier data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Organization Identifier data into CUS_SECONDARY_ID_XREF table.
Import Individual_Identifiers - Data Import application configured to load OneKey Individual
Identifier data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Professional Identifier data into CUS_SECONDARY_ID_XREF table.
Import Workplace_Specialty Data Import application configured to load OneKey Workplace
Specialty data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Organization Specialty data into CUS_SPECIALTY table.
Import Individual_Specialty Data Import application configured to load OneKey Individual
Specialty data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is loaded as
Professional Specialty data into CUS_SPECIALTY table.
Import Workplace_Business_Hours Data Import application configured to load OneKey
Workplace Business Hours data from OneKey BLT tables to Nucleus 360 core tables. Data from this
entity is loaded as Workplace Business Hours data into CUS_BUSINESS_HOURS table.
Import Individual_Business_Hours Data Import application configured to load OneKey Individual
Business Hours data from OneKey BLT tables to Nucleus 360 core tables. Data from this entity is
loaded as Individual Business Hours data into CUS_BUSINESS_HOURS table.
Delete Duplicate/Inactive Workplace Data Import application configured to load Inactive OneKey
Workplace profiles from OneKey BLT tables to Nucleus 360 core tables. This process will inactivate
the OneKey organization profiles which were loaded as Active during IDL. CUS_PRIMARY_ID_XREF
table will be modified by this process.
Delete Duplicate/Inactive Individual Data Import application configured to load Inactive OneKey
Individual profiles from OneKey BLT tables to Nucleus 360 core tables. This process will inactivate
the OneKey professional profiles which were loaded as Active during IDL. CUS_PRIMARY_ID_XREF
table will be modified by this process.

9.9.1.1 OneKey Operational Configuration Differences

9.9.1.1.1 Automatic Vs Manual configurations


Automatic Configurations Manual Configurations
All the processes listed under this configuration User has to select and start each process. User
will be run once, in the sequence as configured. can pile up processes in sequence as configured.

IMS Health Operations Guide Page 80 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Automatic Configurations Manual Configurations


No need to run individual processes. Need to run individual process
If an exception is encountered while running any When running a process within this configuration,
of the processes, ONE Point application prompts when exception encountered, ONE Point
for Continuation. If user clicks to continue, ONE application prompts the error and stops.
Point application ignores the exception and
proceeds.
User cannot modify the default parameters set for User can modify the default parameters specified
each process. for each process.

9.9.1.1.2 IDL Vs Incremental Configurations


IDL (Initial Data Load) Configurations Incremental Configurations
This configuration should be used when data is This configuration should be used after the initial
initially loaded in the database. one cycle of data load is completed.
IDL process will load both Active and Inactive Incremental process will load only Active data and
OneKey data into the Nucleus 360 database delete the inactivated OneKey data from the
Nucleus 360 database

IMS Health Operations Guide Page 81 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.2 Manual OneKey Staging Import and Code Processing


Processes involved in loading to staging table of OneKey data and codes are configured under this
configuration. These processes can be executed manually or by using Automatic OneKey Staging
Import and Code processing. The following screenshot shows the list of configured processes involved
in OneKey data and code load to staging tables.

IMS Health Operations Guide Page 82 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.2.1.1 Import OneKey Data to Staging Tables


1. Under Manual Onekey Staging Import and Code processing configuration, right-click Import
OneKey Data to Staging tables and click Start to open the Arguments dialog window.

2. Specify the path of the sql loader controls files directory for Control Files Directory. A default value
is already available.
3. Specify the path of the OneKey data files directory for Data Files Directory. A default value is already
available.
4. Specify the connection string details of the NP_ADMIN user for Connection String. Replace the
placeholder with the actual connect string details.
5. Click OK to run the process.
6. Check log file <NP_ROOT>\np\log\ok_staging_data_load.log to view the results logged.

IMS Health Operations Guide Page 83 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.2.1.2 Migrate OK Codes from STG to BLT


1. Under Manual Onekey Staging Import and Code processing configuration, right-click Migrate
OK codes from STG to BLT and click Start to open the Arguments dialog window.
2. Keep the default values for Stored procedure name and Log File name parameters.
3. Click OK to run the process.
4. Check log file <NP_ROOT>\np\log\ok_migrate_codes_to_blt.log to view the results logged.

9.9.2.1.3 Migrate OK Data from STG to BLT


1. Under Manual Onekey Staging Import and Code processing configuration, right-click Migrate
OK Data from STG to BLT and click Start to open the Arguments dialog window.
2. Keep the default values for Stored procedure name and Log File name parameters.
3. Click OK to run the process.
4. Check log file <NP_ROOT>\np\log\ok_migrate_data_to_blt.log to view the results logged.

9.9.2.1.4 Populate Code Verification Table


1. Under Manual Onekey Staging Import and Code processing configuration, right-click Populate
code verification table and click Start to open the Arguments dialog window.

2. Keep the default values for Stored procedure name and Log File name parameters.
3. Click OK to run the process.
4. Check log file <NP_ROOT>\np\log\ok_populate_codes_verification.log to view the results logged.

9.9.2.1.5 Create/Update FND Codes


1. Under Manual Onekey Staging Import and Code processing configuration, right-click
Create/Update FND Codes and click Start to open the Arguments dialog window.

2. Keep the default values for Stored procedure name and Log File name parameters.
3. Click OK to run the process.
4. Check log file <NP_ROOT>\np\log\ok_fnd_codes_create.log to view the results logged.

IMS Health Operations Guide Page 84 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3 Manual - OneKey Data Processing (IDL)


Processes involved in loading and processing OneKey data are configured under this configuration.
These processes need to be executed manually. The following screenshot shows the list of configured
processes involved in the OneKey data load.

9.9.3.1 Operating Instructions


This section explains the steps to load OneKey data manually through the ONE Point console application.
Note: Before starting any process, make sure all required argument values are provided. For most of the
arguments, default values have already been defined during implementation. Use these default values
wherever applicable to execute the process properly. Before changing any default value, be sure you
understand the usage of the argument.

IMS Health Operations Guide Page 85 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3.1.1 Import Workplace


1. Under Manual Onekey Data Processing configuration, right-click Import Workplace and click
Start to open the Arguments dialog window.

2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. The default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name Log File. The default log file name is provided.
7. Enter the bad file name for Bad File. The default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure. To re-process the rejected profiles, refer to troubleshooting section 9.13.22.1.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/IDL_ok_npdataimport_Workplace.log for the
data import statistics.

IMS Health Operations Guide Page 86 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3.1.2 Import Individual


1. Under Manual OneKey Data Processing configuration, right-click Import Individual, and click
Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure. To re-process the rejected profiles, refer to troubleshooting section 9.13.22.2.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/IDL_ok_npdataimport_Individual.log, for the
data import statistics.

9.9.3.1.3 Import Workplace_Relation


1. Under Manual OneKey Data Processing configuration, right-click Import Workplace_Relation
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Enter the log file name for Log File. Default log file name is provided.
6. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to bad file can be reprocessed after fixing the exception for failure.
To re-process the rejected profiles, refer to troubleshooting section 9.13.22.3.
7. Click OK button to start the Import process.
8. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Workplace_Relation.log for the data import statistics.

9.9.3.1.4 Import Individual_Relation


1. Under Manual OneKey Data Processing configuration, right-click Import Individual_Relation
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Enter the log file name for Log File. Default log file name is provided.

IMS Health Operations Guide Page 87 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to bad file can be reprocessed after fixing the exception for failure.
To re-process the rejected profiles, refer to troubleshooting section 9.13.22.4.
7. Click OK button to start the Import process.
8. Check the Application log file, <NP_ROOT>/np/log/IDL_ok_npdataimport_Individual_Relation.log
for the data import statistics.

9.9.3.1.5 Import Individual_Roles


1. Under Manual OneKey Data Processing configuration, right-click Import Individual_Roles and
click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to bad file can be reprocessed after fixing the exception for failure.
To re-process the rejected profiles, refer to troubleshooting section 9.13.22.5.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/IDL_ok_npdataimport_Individual_Roles.log for
the data import statistics.

9.9.3.1.6 Import Workplace_Communication


1. Under Manual OneKey Data Processing configuration, right-click Import
Workplace_Communication and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure. To re-process the rejected profiles, refer to troubleshooting section 9.13.22.5.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Workplace_Communication.log for the data import
statistics.

IMS Health Operations Guide Page 88 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3.1.7 Import Individual_Communication


1. Under Manual OneKey Data Processing configuration, right-click Import
Individual_Communication and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.6.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Individual_Communication.log for the data import
statistics.

9.9.3.1.8 Import Workplace_Identifiers


1. Under Manual OneKey Data Processing configuration, right-click Import Workplace_Identifiers
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name Log File. Default log file name is provided.
7. Enter the bad file name Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.7.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Workplace_Identifiers.log for the data import
statistics.

9.9.3.1.9 Import Individual_Identifiers


1. Under Manual OneKey Data Processing configuration, right-click Import Individual_Identifiers
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.

IMS Health Operations Guide Page 89 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to the troubleshooting section 9.13.22.8.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Individual_Identifiers.log for the data import statistics.

9.9.3.1.10 Import Workplace_Specialty


1. Under Manual OneKey Data Processing configuration, right-click Import Workplace Specialty
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.9.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Workplace_Specialty.log for the data import statistics.

9.9.3.1.11 Import Individual_Specialty


1. Under Manual OneKey Data Processing configuration, right-click Import Individual_Specialty
and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.9.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/IDL_ok_npdataimport_Individual_Specialty.log for the data import statistics.

IMS Health Operations Guide Page 90 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3.1.12 Import Workplace_Business_Hours


1. Under Manual Onekey Data Processing configuration, right-click Import
Workplace_Business_Hours and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to the troubleshooting section 9.13.22.11.
8. Click OK button to start the Import process.
9. Check the Application log file,
NP_ROOT>/np/log/ok_npdataimport_Workplace_Business_Hours.log for the data import
statistics.

9.9.3.1.13 Import Individual_Business_Hours


1. Under Manual Onekey Data Processing configuration, right-click Import
Individual_Business_Hours and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to a bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.12.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Individual_Business_Hours.log for the data import
statistics.

9.9.3.1.14 Post Data Import DB Maintenance


1. Under Manual Onekey Data Processing configuration, right-click Post Data Import DB Maintenance
and click Start to open the Arguments dialog window.
2. The DB Maintenance procedure name and the process ID is already specified for Stored procedure
name. Please dont modify the value for this argument.
3. Click OK to start the DB Maintenance Process.
4. Check the Application Log tab to learn the status of the process.

IMS Health Operations Guide Page 91 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.3.2 Process Inactive OneKey Profiles


OneKey source provides both active and inactive data in the same data file. In Nucleus 360, Active and
Inactive profiles are categorized differently. If a profile imported from a third party source does not exist in
core tables, the profile will be treated as a new profile to be Inserted with a status of Active.
To handle both Active and Inactive profiles received from OneKey and to keep Nucleus 360 data in sync
with OneKey data, the following design considerations have been followed:
During IDL, all Active and Inactive OneKey profiles are loaded into Nucleus 360 as Active profiles.
After IDL is complete, through another set of mapping, Data Import is invoked to process Inactive
OneKey profiles.
Execute the processes in the following sections to inactivate OneKey profiles.

9.9.3.2.1 Delete Duplicate/Inactive Workplace


1. Under Manual Onekey Data Processing configuration, right-click Delete Duplicate/Inactive
Workplace and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.13.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/ok_npdataimport_Workplace_Delete.log for
the data import statistics.

9.9.3.2.2 Delete Duplicate/Inactive Individual


1. Under Manual Onekey Data Processing configuration, right-click Delete Duplicate/Inactive
Individual and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the query file name for Query File Name. Default query filename is provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
Note: The rejected profiles written to bad file can be reprocessed after fixing the exception for
failure.To re-process the rejected profiles, refer to troubleshooting section 9.13.22.14.
8. Click OK button to start the Import process.

IMS Health Operations Guide Page 92 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9. Check the Application log file, <NP_ROOT>/np/log/ok_npdataimport_Individual_Delete.log for the


data import statistics.

9.9.4 Automatic OneKey Data Processing (IDL)


Processes configured under this configuration are executed automatically in sequential order. Incremental
loads are processed using this configuration.The following screenshot shows the list of processes
involved in loading OneKey data.

IMS Health Operations Guide Page 93 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.9.4.1 Operating Instructions


The following steps explain how to execute the Automatic Onekey Data Processing configuration.
1. Select Automatic Onekey Data Processing and right-click Start.

IMS Health Operations Guide Page 94 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2. Each process in the configuration starts to execute independently in the order it appears in the ONE
Point console application.
3. Check the log files for each process in the log directory <NP_ROOT>/np/log to check the statistics.
4. The Automatic Onekey Data Processing cycle will stop if any process fails during execution.
Resolve the issue(s) and restart the cycle again.

9.10 Operation Instructions to Load OneKey F-II Data into Nucleus 360

9.10.1 Overview
OneKey F-II data is the same data set from OneKey but in a different interface. Refer to the DID for
OneKey F-II interface details.
Following are the major changes in terms of processing and storing data into Nucleus 360 between
OneKey F-11 (section 9.9) and OneKey F-II.
1. It has more normalized data.
2. Data import mappings are configured only one for Org and one for Prof.
3. Data is received and loaded in OneKey main object mode.
A small ONE Point configuration is provided just for loading OneKey F-II data. Once data is loaded,
remaining post data import steps should be run as configured and as required by the client.
Following are the important data load steps for OneKey F-II.
1. Open ONE Point console using rt_config_nuc_okc.xml config file for OneKey F-II data load.
2. Open a command prompt and change directory to <NP_ROOT>\np\bin folder.
CMD> cd <NP_ROOT>\np\bin
3. Execute the following command from there.
CMD> ..\..\np_env.bat
4. Launch ONE Point console using the rt_config_nuc_okc.xml file as shown.
CMD> nponepoint.exe rt_config_nuc_okc.xml
5. Following is a screenshot of the ONE Point console. Run the processes one by one to load OneKey
F-II data to Nucleus 360.

IMS Health Operations Guide Page 95 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.10.2 OneKey F-II Data Load


Import OK F-II Data to Staging tables

A Perl process invokes the Oracle SQL Loader utility to load OneKey data and codes from flat files
received from OneKey source into temporary staging tables. Following is the list of staging tables
populated by this process. Copy the files to be loaded by unpacking to the above shown Data Files
Directory. Make sure connection string is correct and click OK.
Staging Table Name Comments
STG_OKC_RELATION OneKey F-II Relation data from different countries.
STG_OKC_WORKPLACE OneKey F-II Workplace data from different countries.

IMS Health Operations Guide Page 96 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Staging Table Name Comments


STG_OKC_INDIVIDUAL OneKey F-II Individual data from different countries.
STG_OKC_ACTIVITY OneKey F-II Activity data from different countries.
STG_OKC_ADDRESS OneKey F-II Address data from different countries.
STG_OKC_WORKPLACE_ADDRESS_REL OneKey F-II Address relation data from different
countries.
STG_OKC_ACTIVITY_ROLE OneKey F-II Activity Role data from different
countries.
STG_OKC_BUSINESS_HOURS OneKey F-II Business Hours data from different
countries.
STG_OKC_COMPLIANCE OneKey F-II Compliance identifiers data from
different countries.
STG_OKC_EXTERNAL_ID OneKey F-II External Identifiers data from different
countries.
STG_OKC_INDIVIDUAL_EDUCATION OneKey F-II Individual Degree data from different
countries.
STG_OKC_MERGE OneKey F-II Merge data from different countries.
STG_OKC_PHONE_MEDIA OneKey F-II Communication data from different
countries.
STG_OKC_QUALIFYING_DATA OneKey F-II Specialty data from different countries.
STG_OKC_CODE OneKey F-II Codes from different countries.
STG_OKC_CODE_DESCRIPTION OneKey F-II Code Descriptions from different
countries in different languages.

IMS Health Operations Guide Page 97 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Migrate OKC Data from STG to BLT

A PL/SQL process loads OneKey data from the OneKey codes staging table to the appropriate BLT
table. The following shows the association between the OneKey staging table and the OneKey BLT
table.
Staging Table Name BLT Table Name
STG_OK_RELATION BLT_OK_RELATION
STG_OK_WORKPLACE BLT_OK_WORKPLACE
STG_OK_INDIVIDUAL BLT_OK_INDIVIDUAL
STG_OK_ACTIVITY BLT_OK_ACTIVITY
STG_OK_ADDRESS BLT_OK_ADDRESS.
STG_OK_WORKPLACE_ADDRESS_REL BLT_OK_WORKPLACE_ADDRESS_REL
STG_OKC_ACTIVITY_ROLE BLT_OKC_ACTIVITY_ROLE
STG_OKC_BUSINESS_HOURS BLT_OKC_BUSINESS_HOURS
STG_OKC_COMPLIANCE BLT_OKC_COMPLIANCE
STG_OKC_EXTERNAL_ID BLT_OKC_EXTERNAL_ID
STG_OKC_INDIVIDUAL_EDUCATION BLT_OKC_INDIVIDUAL_EDUCATION
STG_OKC_MERGE BLT_OKC_MERGE
STG_OKC_PHONE_MEDIA BLT_OKC_PHONE_MEDIA
STG_OKC_QUALIFYING_DATA BLT_OKC_QUALIFYING_DATA

IMS Health Operations Guide Page 98 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Staging Table Name BLT Table Name


STG_OKC_CODE BLT_OKC_CODE
STG_OKC_CODE_DESCRIPTION BLT_OKC_CODE_DESCRIPTION
OKC BLT DB Maintenance A step configured for analyzing the above staging and BLT tables for
better performance.

IMS Health Operations Guide Page 99 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Populate code verification table PL/SQL process that evaluates the OneKey codes in the
OneKey code BLT table and populates the qualified codes into the
EXTERNAL_CODES_VERIFICATION table with an APPROVAL_STATUS_CD as Auto Approved
(506905).

IMS Health Operations Guide Page 100 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Create/Update FND Codes

A PL/SQL process evaluates code records with APPROVAL_STATUS_CD as Auto Approved


(506905) or Manually Approved (506904) from EXTERNAL_CODES_VERIFICATION table, and
PROCESSING_STATUS_CD as Not Processed (506907), determines the type of transaction
(Insert/Update/Inactivate) for the code item, and modifies the respective FND code tables. Following
is the list of tables modified by this process.
FND CODE TABLES MODIFIED
FND_CODE_ITEM
FND_CODE_ITEM_STRING
FND_CODE_EXTERNAL_ITEM
FND_CODE_HEADER
FND_CODE_HEADER_STRING

IMS Health Operations Guide Page 101 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Create Complete Profile from Partial OKC Data

OneKey F-II data comes in main object mode to Nucleus. This means only data that got changes will
come to Nucleus; e.g., if Specialty is modified, then only Specialty data for the Individual or
Workplace will be received from OneKey in Qualifying Data file. But Nucleus required a top level
customer, either Prof or Org, to load any data to Nucleus. Hence this PL/SQL method is created to
create a complete view of the profile by putting the Individual ID or Workplace ID in the
STG_OKC_INDIVIDUAL or STG_OKC_WORKPLACE table. Only top level entity is selected. Data
Import is now supported to load partial transactional data. For every entity there is an operation type
and the data import reacts to operation type for each entity.

IMS Health Operations Guide Page 102 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Populate_okc_xml_staging_table

OneKey F-II data is not loaded using flat file transactional mode as in F-11. In F-II, data is now
converted to xml structures. Each profile Prof or Org is converted to a XML message in this step. The
xml message has each sub-entity like address or specialty as nodes. When this step is run, it
converts the entire staging OneKey F-II data to XML structures and stores in the following tables.
STG_OKC_PROF_XML_INPUT
STG_OKC_ORG_XML_INPUT
These tables have a column ROW_ID that contains Workplace ID or Individual ID. And for that ID
there is another column called XML_DATA that has the actual xml message for the profile.

IMS Health Operations Guide Page 103 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Create Groups For Data Import

This step splits the input profiles to groups for parallel processing. In the above mentioned staging
tables STG_OKC_PROF_XML_INPUT and STG_OKC_ORG_XML_INPUT, there is a column called
rank. By default the rank is a group ID and it is split into 20 groups each for prof and Org. It can be
configured to split into as many groups as required. Depending on the number of groups, those many
data import copies will be invoked in parallel for better performance.

IMS Health Operations Guide Page 104 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Import OKC US Workplace

Data Import application configured to load OneKey Workplace data from


STG_OKC_ORG_XML_INPUT table to Nucleus 360 core tables. Profiles created for this OneKey
entity are classified as Organization profiles. Following is the list of tables modified by this process.
CORE TABLES MODIFIED
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF
CUS_ORGANIZATION_PROFILE
CUS_ADDRESS
CUS_OPTOUT_PROFILE
CUS_SPECIALTY
CUS_BUSINESS_PERIOD
CUS_BUSINESS_HOURS
CUS_COMMUNICATION_PROFILE
CUS_AFFIL_PROFILE

IMS Health Operations Guide Page 105 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Exception: Import OKC US Workplace

This step is for loading rejected data in above step. Unlike F-11 data load, in F-II rejected profiles data
is not written to bad files; rather it is written to a table called CUS_EXCEPTION_PROFILE. When this
step is run after fixing any issue or code failure, data is read from STG_OKC_ORG_XML_INPUT
table for only those profiles written to the exception table. After successful processing, it removes the
entry from the exception table.

IMS Health Operations Guide Page 106 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Import OKC US Individual

Data Import application configured to load OneKey Individual data from


STG_OKC_PROF_XML_INPUT table to Nucleus 360 core tables. Profiles created for this OneKey
entity are classified as Professional profiles. Following is the list of tables modified by this process.
CORE TABLES MODIFIED
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF
CUS_PROFESSIONAL_PROFILE
CUS_ADDRESS
CUS_OPTOUT_PROFILE
CUS_SPECIALTY
CUS_BUSINESS_PERIOD
CUS_BUSINESS_HOURS
CUS_COMMUNICATION_PROFILE
CUS_AFFIL_PROFILE
CUS_PROFESSIONAL_DEGREE
CUS_AFFIL_ROLE

IMS Health Operations Guide Page 107 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Exception: Import OKC US Workplace

This step is for loading rejected data in the above step. Unlike F-11 data load, in F-II rejected profiles
data is not written to bad files; rather it is written to a table called CUS_EXCEPTION_PROFILE.
When this step is run after fixing any issue or code failure, data is read from
STG_OKC_ORG_XML_INPUT table for only those profiles written to the exception table. After
successful processing, it removes the entry from the exception table.

9.11 Monitoring the Data Import Process


Execute the following query from a SQL prompt to check the progress of the Data Import process when
performing a file-based load (Fixed length, Delimited, or Flat File). The value returned is the position of
the current record in the new data file that is getting processed. This value will increase while the Data
Import process is running.
SQL> SELECT NEW_FILE_POSITION RECORDS_PROCESSED_IN_FILE FROM NP_DELTA_RECOVER
WHERE MAPPING_ID = <MAPPING_ID>
Note: Replace <MAPPING_ID> in the above query with the actual Data source mapping ID for which the
file is imported.
To check the progress of the Data Import process when processing in Real Time Mode, execute the
following query. The count returned is the total number of new/updated profiles that are queued up for
processing after being successfully imported.

IMS Health Operations Guide Page 108 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

SELECT COUNT(0) FROM STG_IMPORTED_PROFILE WHERE STATUS_CD = 504900


After the imported records have been processed by a Real Time Data Processing loop, the records are
unlocked and deleted from this table.

9.12 Analyze Table


After the Data Import process has been successfully completed, a database maintenance package should
be run to rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID = 6
of ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(6)"

9.12.1.1 Command Line Parameters/Usage


Application Parameter Description
(runstoredproc.exe)
-? Detailed Help
-v Version information
-V Extended Version information (IMS Health internal)
-s Stored procedure command line
-f Stored function command line
-a File that contains anonymous PL/SQL block
-p Database configuration file Block/Pool Name; default is NUCLEUSPHARMA
-c Database configuration file; default is dbcfg.txt
-l Log file

9.13 Troubleshooting
This section provides information about error messages.

9.13.1 Check paths in ace.cfg and dir expiration dates (or) Check paths in
configuration file and dir expiration dates
Failure Description
Postalsoft directory files have expired. An error message similar to the one given here is an indication of
Postalsoft directory expiration.
The specified ZIP+4 directory has expired. Exception: ACE_OPEN failed, check paths in ace.cfg and dir
expiration dates. Press return to continue.
Or
Open (Engine) failed, check paths in configuration file and dir expiration dates. ZIP+4 directory expires in
n days.
IMS Health Operations Guide Page 109 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Failure condition
This error occurs when the Postalsoft directory files are not current and are expired.
Solution
Install the current directory updates for Postalsoft received from Business Objects. Refer to section 9.5.2
for details.

9.13.2 Kickout files cannot exist


Failure Description
Delta Exception: Phase Init(0), Code: bad record manager error(8) Description: kickout files cannot exist:
old.sort and new.sort - resolve bad records and try again.
Failure condition
This error occurs when the bad (error) file names that are passed using the -d and -w options already
exist in the directory.
Solution
Load the .sort files, Refer to section 9.13.9 to load bad files. After loading successfully, move them to a
different directory or rename the bad file.

9.13.3 Options [o | n | d | w] are required.


Failure Description
This mapping is configured to run in batch comparison mode. Options [o | n | d | w] are required.
Failure condition
This error occurs when one of these options is not provided in the command line string when running the
data import application
Solution
Make sure all the above mentioned options are specified in the command line while running Data Import
application.

9.13.4 Delta Exception: Phase Init(0), Code: delta engine initialization error(10)
Description: errno(2) LFileResultSet open error in <new_file.txt>
Failure Description
Delta Exception: Phase Init(0), Code: delta engine initialization error(10) Description: errno(2)
LFileResultSet open error in <new_file.txt>
Failure condition
This error occurs when either new or old data file does not exist in the path specified in option n for new
file and o for old file.
Solution
Make sure the old and new file exists in the specified path.

IMS Health Operations Guide Page 110 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.5 An entry in NP_DELTA_RECOVER table already exist for this mapping.


Failure Description
ERROR An entry in NP_DELTA_RECOVER table already exist for this mapping.
ERROR Execute the script in restart mode.
Failure condition
The npdataimport process registers the process progress status in the NP_DELTA_RECOVER table
when running in Batch Compare or Transactional Mode for certain file types. When the process is
terminated abnormally then it leaves an entry in the NP_DELTA_RECOVER table. This error occurs when
there is an entry in the NP_DELTA_RECOVER table and if the Data Import process is run again in the
Batch Compare or Transactional Mode.
Solution
If there is an entry in the NP_DELTA_RECOVER table, start the Data Import application using the
run_dataimport.exe script in restart mode. The entry in the NP_DELTA_RECOVER table will be used to
restart the process from the point where it was stopped last time.

9.13.6 The files are not in proper chronological order


Failure Description
The files are not in proper chronological order. Verify that the files were properly specified, or use a tool
like "touch" to put the files in proper order. FAIL: Validation failed.
Failure condition
This error only occurs in Batch Compare Mode when the old file is more recent than the new file. The new
file must be more recent than the old file and the process checks for the last update time of the files to
validate this.
Solution
Make the new file time stamp more recent than the old file by using some tool like touch. Then run the
process again to load the file.

9.13.7 FAIL: transaction rejected and sent to bad files. See log.
Failure Description
FAIL: transaction rejected and sent to bad files. See log.
Failure condition
When the npdataimport process rejects a transaction, it is saved in a bad file. The bad file name
extension is .sort file. The process rejects transactions based on its configuration. Any of the following
situations could cause a transaction to be rejected. Though the list of reasons is not limited to the ones
provided here, these are the most common reasons.
A Delete transaction on an already inactive profile.
An Update transaction on a non-existing profile.
An Insert transaction on an existing active profile.
A transaction has a blank address, and Nucleus 360 is configured to reject empty addresses.
A transaction includes an invalid Physician Specialty that is not configured in the Nucleus 360
database.

IMS Health Operations Guide Page 111 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

A transaction includes an invalid Professional Degree.


A transaction includes an invalid Communication type (Common examples of supported values are
Phone, Fax, or E-mail).
A transaction includes an invalid Address type (Common examples of supported values are Home,
Office, or Mailing).
A transaction includes an invalid Professional type (Common examples of supported values are
Physician, Nurse, or Pharmacist).
A transaction includes an invalid Profile type (such as Organization, Professional, or Unclassified).
A transaction includes an invalid Secondary ID (Common examples of supported values are DEA
Number, ME Number, or DDD Number).
A transaction includes an invalid Organization type (Common examples of supported values are
Blood Bank, Clinic, or Dialysis Center).
Solution
Bad files can be reloaded through the import process after fixing the file or by changing the data load
configuration (mapping). Refer to section 9.13.9 to load bad files. If the bad records are generated
because of external codes refer to 9.13.8.

9.13.8 No item code is found for External Item Code external item
Failure Description
FAIL: transaction rejected and sent to bad files. See log.
Delta Exception: Phase Delta(3), Code: transaction manager processing error(13) Description: Code: 0|
Desc: No item code is found for External Item Code external item in the Header Code code_header_id
Failure condition
This error occurs when some external codes in the file for Degree, Prefix, and Suffix, etc. are not mapped
to Nucleus 360 internal codes.
Solution
Add an external code for that reference using Code Table Maintenance (refer to the Code Table
Maintenance Users Guide for more information). Reload the bad file after successfully creating the
external code.

9.13.9 Running Bad Files through NPDataImport


This applies only to processing fixed-length and delimited file based data sources. The execution of the
import process may complete successfully and still produce bad files that contain rejected transactions.
The rules for creating these files are based on the type of transaction.
Note: If the rejected transactions are exclusively insert transactions or exclusively delete transactions,
only one file will be created.
All bad files must be resolved and processed before the next cycle of the data source. The reason for the
bad file should be analyzed and appropriate bad file processing options determined.

IMS Health Operations Guide Page 112 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

If only an old bad file exists, create a dummy empty file representing the new file. If only a new bad
file exists, create a dummy empty file representing the old file. The last modified date or timestamp for
the new bad file should be more recent than for the old bad file. If both files exist, use the options
listed following. Note that an old bad file and a new bad file from a run of Data Import may get
created for different profiles; in this case it is important to resolve errors related to both the profiles
before attempting a run of the bad files, or bad file(s) may be created again.
Perform a dry run and analyze results. Substitute <mapping_id>, <old_bad_file>, <new_bad_file> and
<log_file_name> with actual values before executing.
$ cd %DRTE_NP_BIN%
$ npdataimport m<mapping_id> o<old_bad_file> -n<new_bad_file>
-dold1.sort wnew1.sort l%DRTE_NP_LOGS%\<log_file_name> N
Load the data and analyze results.
$ cd %DRTE_NP_BIN%
$ npdataimport -m<mapping_id> o<old_bad_file> -n<new_bad_file>
-dold1.sort wnew1.sort l%DRTE_NP_LOGS%\<log_file_name>

9.13.10 newline not found


Failure Description
File I/O: validation:errno(0) LDelimitedFileResultSet newline not found in file name row record #
Delta Exception: Phase Validate(2), Code: validation error(1) Description: File I/O: validation:errno(0)
LDelimitedFileResultSet newline not found in file name row record #
file name Name of the new file specified with n option
record # Record number in which the newline was found.
Failure condition
The Import process validates the non-XML input files before applying them to the database. It calculates
the record length from the individual field length. If the record length is N, then the N+1 position should
contain an EOL marker. If the EOL marker is not found, then it will produce this error message.
Solution
Check that record for end of line marker (EOL). Insert the required end of line marker, generally a newline
and rerun the process. If it is a file with very few records then it can be edited in some editor to manually
insert newline by pressing ENTER key at required position. If the file contains more records then some
scripting language can be used like shell scripting or Perl scripting to write a script which will do the job.

9.13.11 Expected record length <Record Length>


Failure Description
File I/O: validation:errno(2) LFlatFileResultSet read error. Expected record length Record Length. Bytes
read Record Length Read in file name row record #
Delta Exception: Phase Validate(2), Code: validation error(1) Description: File I/O: validation:errno(2)
LFlatFileResultSet read error. Expected record length Record Length. Bytes read Record Length Read
in file name row record #
Record Length Length of the record defined in business rules
Record Length Actual length of record present in the file

IMS Health Operations Guide Page 113 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Read
file name Name of the new file specified with n option
record # Record number in which the length was improper.
Failure condition
The Import process validates the non-XML, fixed length input files before applying them to the database.
It calculates the record length from the individual field length. If the record length is N, then the N+1
position should contain an EOL marker, if EOL marker present, but not at N+1 position, then it will
produce this error message.
Solution
Check that record for missing or extra length provided at some position. Correct the length of the record
to the expected record length and re- run the process.

9.13.12 Key field field name is empty in file name row record # field: field
position
Failure Description
validation error: Key field field name is empty in file name row record # field: field position
field name Name of the field that has violated this rule.
file name Name of the new file specified with n option
record # Record number in which the empty key was found.
field position Position of the field in the record.
Failure condition
This error occurs when a field is defined as a key field in the input file and the value for that field is empty.
Solution
Key fields cannot be empty in the file. Provide a valid value for the key field in the file and import the
records.

9.13.13 Not null field field name is empty in file name row record # field:
field position
Failure Description
validation error: Not null field field name is empty in file name row record # field: field position
field name Name of the field that has violated this rule.
file name Name of the new file specified with n option
record # Record number in which the empty key was found.
field position Position of the field in the record.

IMS Health Operations Guide Page 114 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Failure condition
This error occurs when a field is defined as a mandatory field in the input file and the value for that field is
empty.
Solution
Not null fields cannot be empty in the file. Provide values for all the required fields in the file and import
the records.

9.13.14 Keys not exclusively incremental at file name row record #


Failure Description
keys not exclusively incremental at file name row record# and row record#
FAIL: Validation failed.
Delta Exception: Phase Validate(2), Code: delta engine initialization error(10) Description: FAIL: Validation
failed.
file name Name of the new file specified with n option
record # Record number in which the key field was not incremental.
Failure condition
If the key field is not in ascending order then the process will encounter this error. The input files must be
sorted by the key field in ascending order. This is a prerequisite for processing data through Batch
Comparison Mode or Transactional Mode for non-XML-based data sources.
Solution
Sort the file on key field and then rerun the process again. If the file is big and key fields are not sorted
then some sorting techniques can be implemented to sort the file on key field.

9.13.15 Database and ACE/IACE Postalsoft Errors


Refer to Appendix B for database-related failures.
Refer to Appendix E for ACE/IACE errors.

9.13.16 LException: No more database connections available


Failure condition
This error occurs when the number of blocks in the config.xml file is greater than the allowed database
connections. The number of database connections allowed depends on the MAXCON value in dbcfg.txt.
In the following example illustrates a block in the config.xml file.
<CONFIGURATION_LIST>
<SRC_TYPE SRC='TP'>
<CONFIGURATION MESSAGE_TYPE='Professional'>
<MAPPING_ID>1007</MAPPING_ID>
<PRE_TRANSFORM_XSD_FILE></PRE_TRANSFORM_XSD_FILE>
<XML_TRANSFORMATION_FILE>professional_transform.xsl</XML_TRANSFORMATION_FILE>
<POST_TRANSFORM_XSD_FILE></POST_TRANSFORM_XSD_FILE>
</CONFIGURATION>
.

IMS Health Operations Guide Page 115 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

.
.
</SRC_TYPE>
<COMMON_MESSAGE_XSLT_FILE>main_transform.xsl</COMMON_MESSAGE_XSLT_FILE>
</CONFIGURATION_LIST>

Solution
In the dbcfg.txt file in the %DRTE_NP_BIN% folder, change the MAXCON value to one greater than the
number of CONFIGURATION blocks in the config.xml file.

9.13.17 Delta Exception: Phase Delta(3), Code: transaction manager processing


error
Failure Description
Delta Exception: Phase Delta(3), Code: transaction manager processing
error(13) Description: Code: 1045| Desc: Database Error :ORA-01400: cannot
insert NULL into ("<User>"."<Table Name>"."<Code Column Name*>")
Failure condition
Data import application identifies the code fields in the file layout and performs a code lookup to get the
internal item code for the values specified in these code fields. If a NULL value is encountered by the data
import application for any of these code fields the above specified error will be logged. This is because an
equivalent code item is not defined for NULL (blank value) in the code tables for the corresponding code
header.
Solution
This error could be resolved by adding an external code item with the value ~~~~~ (equivalent to NULL)
using the Code Table Maintenance application (refer to the Code Table Maintenance Users Guide for
more information) against the corresponding code header and item code. This has to be done if NULL is
an acceptable value from the data source for the mentioned field.
*Note: All code fields in Nucleus 360 follow the convention _CD

9.13.18 An Unhandled Exception occured. Refer to the dump file for details.
npdataimport.exe_YYYYMMDD_HHMMSS.dmp.
Failure Description
When the Data Import application crashes due to an Unknown Error, it creates one or more dump files in
the application directory (BIN). The dump file is in binary format and it has details regarding the crash.
Solution
The files should be sent to the IMS Health Support team via email or ftp so that they can determine the
exact location of the source at which the crash occurred. The dump file name will be of the format
npdataimport.exe_YYYYMMDD_HHMMSS.dmp and is created in the bin directory of the server layer
installation.

IMS Health Operations Guide Page 116 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.19 Processing Real-time Exception Messages


Overview
Real-time XML messages (valid COM format messages) that are rejected by the Data Import process are
written to the exception queue. In COM, the Exception entity is used to describe the reason for an
exception. The Data Import process constructs the Exception entity and adds it to the original message
before pushing it to the exception queue. The Exception entity has the following child elements or tags.
1. Type: This element indicates whether the exception is an import exception or an export exception.
Nucleus 360 throws an exception only during data import and the value is always set to IMPORT.
2. DateTime: This element contains the date and time when the exception occurred. Format:
MM/DD/YYYY HH:MI:SS am.
3. Description: This element contains the description of the exception.
The Exception entity will be added to the original message before it is pushed to the exception queue. As
an example, a real-time message with the Exception entity is given following. In this case the original
message was rejected due to an external code translation failure.
<?xml version="1.0" ?>
<ts:TransactionSet
msgid="ID:414d51205742494445564d513120202044d665a32024f801"
xmlns:dts="http://schemas/dendrite/xt/database"
xmlns:ts="http://schemas.dendrite.com/IS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema instance"
xmlns:xtc="http://schemas/dendrite/xt/core"
xmlns:xtd="http://schemas/dendrite/xt/datatypes">

<TransactionSetProperties
null_representation="implicit"
transaction_scope="entity">
<DateTimeFormats dateTimeFormat="YYYY MM DD HH24:MI:SS"/>
<Source>SFA</Source>
<Message_Version>1.0.0</Message_Version>
<COM_Version>1.0.0</COM_Version>
<Application_Version>1.7.1</Application_Version>
</TransactionSetProperties>

<Exception>
<Type>IMPORT</Type>
<DateTime>08/02/2008 03:35:23 PM</DateTime>
<Description>Code: 0|Desc: No item code is found for External Item Code Work in the Header
Code 1109|ProfileID: 10783501|ProfileType: 112451|ProfileIDVal: |ProfileIDType: 112451|
Datasource: 200078|DBErrorCode: 0|DBErrorMsg:</Description>
</Exception>

<xt:Professional
objectId="1299"
operation="REFRESH"
type_name="Professional"

IMS Health Operations Guide Page 117 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

xmlns:xt="http://schemas.dendrite.com/IS/1.0.0/Professional">
<Customer_ID>TEST_CUSTOMER_ID</Customer_ID>
<Activity_Status>CURR</Activity_Status>
<Professional_Type>Pharmacist</Professional_Type>
<First_Name>John</First_Name>
<Middle_Name></Middle_Name>
<Last_Name>Smith</Last_Name>
<Data_Source>SFA</Data_Source>

<Address_List type_name="Address_List">
<Address objectId="1300" operation="REFRESH" type_name="Address">
<Address_ID>TEST_ADDRESS_ID</Address_ID>
<Address_Type>Work</Address_Type>
<Address_Line1>1405 Route 206 South</Address_Line1>
<Address_Line2></Address_Line2>
<City>Bedminster</City>
<Region/>
<Postal_Area>07921</Postal_Area>
<Activity_Status>CURR</Activity_Status>
</Address>
</Address_List>

</xt:Professional>
</ts:TransactionSet>

9.13.19.1 Command Line Parameters/Usage


Application Parameter Description
(mqtest.exe)
-? Detailed Help
-v Version information
-V Extended Version Information
-c Configuration file (dbcfg.txt is the default)
-s Source queue name. Valid only for COPY operation.
-d Destination queue name.
-o Operation [ READ | WRITE | DELETE | LISTEN | COPY | COUNT | PURGE ]
-m Message ID
-f Import data from file to destination
-r Message recipient or consumer name, defaulted to NP_APP_SL_MQTEST

IMS Health Operations Guide Page 118 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.19.2 Reprocessing Instructions


The reason for the original message failure should be identified and resolved before reprocessing it.
Read all the rejected messages from the exception queue (say NP.X.QL) in the same order as it was
inserted by the Data Import process using the mqtest.exe utility. Execute the following command to
read the exception messages.
$ cd %DRTE_NP_BIN%
$ mqtest.exe -oREAD -dNP.X.QL
The mqtest.exe utility prints the message header first, then the XML data. Search for string <?xml
version="1.0"?> in the output displayed by the utility which indicates the start of the XML data.
Search for the string </ts:TransactionSet> which indicates the end of the XML data. Copy the XML
data from the output to a separate XML file (say exception.xml). Each message should be saved to a
separate XML file.
Open the saved XML file and remove the entire Exception entity from it (as marked in yellow in the
above example). Save the file and push it to the inbound queue (say WBI.TO.NP.QL) for
reprocessing. Execute the command given here to push the message saved in the XML file to the
inbound queue. Refresh Request messages that are in the exception queue should not be submitted
to the WBI.TO.NP.QL queue for reprocessing. It should be pushed to the NP.REF.REQ.QL queue.
$ mqtest.exe -oWRITE -dWBI.TO.NP.QL -fexception.xml
Purge the exception queue after confirming that all the exception messages are reprocessed
successfully.
Optionally, the failed messages can be refreshed from the source system for it to be reprocessed by
Nucleus 360 instead of taking it from the exception queue.

9.13.20 List of Errors Logged by the run_dataimport Script


The following table has the list of possible errors logged by the run_dataimport script. After resolving the
issues, restart the data import process as specified in section 9.13.21.
Sl No Failure Condition Failure Description
1 ERROR Invalid options, type A wrong command line option is passed to the run script.
'run_dataimport.exe -?' for usage
2 ERROR: DB Maintenance failed. This error is reported if the database maintenance failed
Check the log file. after successfully importing the data.
3 ERROR Unable to delete file <old The old file cannot be deleted from the third party data
file > after archiving directory after successfully archiving the data files.
4 ERROR Can't rename <new file> The new file cannot be renamed to have an .old
to <old file> extension after successfully archiving the data files.
5 ERROR Unable to archive files The data files cannot be archived.
<new file> and <old file>
6 ERROR Environment variable The np_env.bat file located in the <NP ROOT> directory
DRTE_ROOT is not defined. is not executed to initialize the environment variables.
7 ERROR Environment variable The np_env.bat file located in the <NP ROOT> directory
DRTE_THIRD_PARTY is not is not executed to initialize the environment variables.
defined.
8 ERROR Environment variable The np_env.bat file located in the <NP ROOT> directory
DRTE_NP_LOGS is not defined. is not executed to initialize the environment variables.

IMS Health Operations Guide Page 119 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Sl No Failure Condition Failure Description


9 Environment variable The environment variable is set with a directory path that
DRTE_ROOT is set to a invalid does exist in the file system.
directory: <DRTE_ROOT>
10 Environment variable The environment variable is set with a directory path that
DRTE_THIRD_PARTY is set to a does exist in the file system.
invalid directory: <
DRTE_THIRD_PARTY>
11 Environment variable The environment variable is set with a directory path that
DRTE_NP_LOGS is set to a does exist in the file system.
invalid directory:<
DRTE_NP_LOGS>
12 ERROR Invalid new file name No new file is found in the third party data file directory
or
ERROR New file not found in
<third party directory>
13 ERROR Invalid old file name No old file is found in the third party data file directory
or
ERROR Old file not found in
<third party directory>
14 ERROR Multiple new files exist in Multiple new files are found in the third party data file
the input directory directory.
15 ERROR Multiple old files exist in Multiple old files are found in the third party data file
the input directory directory.
16 ERROR A new bad file <bad file> One or more bad file(s) exists in the data file directory.
already exist
Or
ERROR A old bad file <bad file>
already exist
17 ERROR An entry in An entry exists in NP_DELTA_RECOVER table for the
NP_DELTA_RECOVER table mapping id that is currently used. This check is to
already exist for this mapping. prevent concurrent executions of the Data Import
process for the same mapping. But if it is a true restart
ERROR Execute the script in
scenario and no other instance of Data Import is running
restart mode.
for the same mapping, then the r option of the run script
should be used to skip the NP_DELTA_RECOVER table
check.

IMS Health Operations Guide Page 120 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.21 Exception Handling During OneKey Data Load

9.13.21.1 SQL Lookup Transform function Failure


Failure Description
SQL Lookup transform function used in a task will throw an exception if the lookup fails due to some
errors.
"SQL Lookup function returned more than one row."
SQL Lookup function did not return any row.
In case of error, the Action to be taken is configurable. Following are the available options:
Reject Transaction
Set Null
Set Input Value
Following are some possible scenarios for this error to occur during OneKey Data Load:
When processing Affiliation Roles, if affiliation record does not exist for the affiliation role record.
When processing Affiliations, if affiliated profile id is not present for the affiliation record.
Note: Refer to the actual task to know the value configured for the mapping.
Solution
Resolve the error by either fixing the data or the query if found discrepant.

9.13.22 Processing Rejected OneKey Profiles


OneKey profiles that are rejected by the Data Import process are written to bad files. The reason for
failure is logged to the application log file of the process. Common reasons for failure include code lookup
failure as explained in section 9.13.8, or sql lookup failure as explained in section 9.13.21.1. After
resolving the error, bad files corresponding to each OneKey entity could be processed again.
A separate configuration has been created in the ONE point Console application to process OneKey bad
files manually.
Note: Here the Data Import process is configured to run in transactional mode. The rejected bad file is
provided as a new file to the process.
The following section has instructions to execute the processes configured in Data Import Exception
Handler Mappings configuration.

IMS Health Operations Guide Page 121 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.22.1 Import Workplace (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import Workplace
(Exceptions) and click Start to open the Arguments dialog window.

2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/ok_npdataimport_Workplace_exception.log
for the data import statistics.

IMS Health Operations Guide Page 122 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.22.2 Import Individual (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import Individual
(Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Individual_Delete_exception.log for the data import
statistics.

9.13.22.3 Import Workplace_Relation (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Workplace_Relation (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Workplace_Relation_exception.log for the data import
statistics.

9.13.22.4 Import Individual_Relation (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Individual_Relation (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
IMS Health Operations Guide Page 123 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8. Click OK button to start the Import process.


9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Individual_Relation_exception.log for the data import
statistics.

9.13.22.5 Import Individual_Roles (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Individual_Roles (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/
ok_npdataimport_Individual_Roles_exception.log for the data import statistics.

9.13.22.6 Import Individual_Communication (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import Individual
(Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Workplace_Communication_exception.log for the
dataimport statistics.

9.13.22.7 Import Workplace_Identifiers (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Workplace_Identifiers (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
IMS Health Operations Guide Page 124 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Workplace_Identifiers_exception.log for the data import
statistics.

9.13.22.8 Import Individual_Identifiers (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Individual_Identifiers (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. Default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Individual_Identifiers_exception.log for the data import
statistics.

9.13.22.9 Import Workplace_Specialty (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Workplace_Specialty
(Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. Default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Workplace_Specialty_exception.log for the data import
statistics.

IMS Health Operations Guide Page 125 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.13.22.10 Individual_Specialty (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Individual_Specialty
(Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Individual_Specialty_exception.log for the data import
statistics.

9.13.22.11 Import Workplace_Business_Hours (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import Individual
(Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/
ok_npdataimport_Workplace_Business_Hours_exception.log for the data import statistics.

9.13.22.12 Import Individual_Business_Hours (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Import
Individual_Business_Hours (Exceptions) and click Start to open the Arguments dialog window
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.

IMS Health Operations Guide Page 126 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

8. Click OK button to start the Import process.


9. Check the Application log file, <NP_ROOT>/np/log/
ok_npdataimport_Individual_Business_Hours_exception.log for the data import statistics.

9.13.22.13 Delete Duplicate/Inactive Workplace (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Delete
Duplicate/Inactive Workplace (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file,
<NP_ROOT>/np/log/ok_npdataimport_Workplace_Delete_exception.log for the data import
statistics.

9.13.22.14 Delete Duplicate/Inactive Individual (Exceptions)


1. Under Data Import Exception Handler Mappings configuration, right-click Delete
Duplicate/Inactive Individual (Exceptions) and click Start to open the Arguments dialog window.
2. Select a value from the drop down for Mapping. This value determines the mapping to be used by
the process. A default mapping name is already selected.
3. Enter the exception file name for Exception File Name. A default file name is already provided.
4. Select a value from the drop down for Dry Run. The default value is already selected.
5. Select a value from the drop down for Skip Validation. The default value is already selected.
6. Enter the log file name for Log File. Default log file name is provided.
7. Enter the bad file name for Bad File. Default bad file name is provided.
8. Click OK button to start the Import process.
9. Check the Application log file, <NP_ROOT>/np/log/
ok_npdataimport_Individual_Delete_exception.log for the data import statistics.
Note: Execute the Post Data Import DB Maintenance process after execution of other processes in this
configuration.

IMS Health Operations Guide Page 127 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

9.14 Restarting the Data Import Process


This restart mechanism is applicable only for the file based Batch Comparison or Transactional mode of
processing. NP_DELTA_RECOVER table is used by the Data Import process to register the last
processed record number (from file) when it is importing a fixed length or a delimited file. If the process
completes successfully, the entry made to this table will be removed. If the process fails while importing,
the entry made to NP_DELTA_RECOVER table will remain and it can be used to restart the process from
where it stopped. The run script (run_dataimport.exe) has a switch (-r) to execute the process in restart
mode. If this switch is not used, the run script will not execute the Data Import process if an entry exists in
NP_DELTA_RECOVER table for the mapping that is currently specified in the command line. Before the
process is restarted, the cause for the initial failure or crash should be identified and resolved.
A sample command line is given here to restart the process in auto mode.
$ cd %DRTE_NP_BIN%
$ run_dataimport.exe -m=1010 -a r
A sample command line is given here to restart the process in non-auto mode by specifying custom data
files.
$ cd %DRTE_NP_BIN%
$ run_dataimport.exe -m=1010 n=<new_file> -o=<old_file> r

9.15 Tables Modified by Data Import Process


The following tables may be affected by the Data Import process, depending on the type of data coming
in and how the data is mapped in the mapping. Below the line (BLT) tables, if configured, are also directly
managed by the Data Import process.
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF
CUS_ADDRESS
CUS_ADDRESS_COMPONENT
CUS_COMMUNICATION_PROFILE
CUS_AFFIL_PROFILE
CUS_PROFESSIONAL_PROFILE
CUS_PROFESSIONAL_DEGREE
CUS_PROFESSIONAL_SPECIALTY
CUS_ORGANIZATION_PROFILE
STG_IMPORTED_PROFILE
CUS_INACTIVE_PROFILE_HIST
CUS_UNCLASSIFIED_PROFILE
CUS_CUSTOMER
CUS_CUSTOMER_INFO
CUS_OPTOUT_PROFILE
CUS_CUSTOMER_GROUP_LINK

IMS Health Operations Guide Page 128 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

10. DQT - POPULATING THE DE-NORMALIZED QUERY TABLES

10.1 Overview
The DQT process populates the de-normalized tables for Professionals and Organizations. Population of
the Professional table (DQT_PROFESSIONAL_PROFILE) or the Organization table
(DQT_ORGANIZATION_PROFILE) is based on the CUS_PRIMARY_ID_XREF.PROFILE_TYPE_CD.
The process is implemented in an Oracle PLSQL package PKG_Denorm_Populate, which exposes the
following procedure/functions to execute it in various modes.
1. Main: Procedure to launch the DQT process in Incremental or Refresh mode.
2. ProcessImportedProfiles: Function to process profiles that are in STG_IMPORTED_PROFILE table
3. ProcessSingleProfile: Procedure to process a single profile.

10.1.1 What DQT Does


The DQT process fetches data from core tables and dumps into the de-normalized tables such as
DQT_PROFESSIONAL_PROFILE and DQT_ORGANIZATION_PROFILE. The de-normalized tables
contain all relevant customer information in one row per profile. These are de-normalized tables and store
only active profiles. The GUI uses these tables to query data for the practitioner or organization for better
performance. If a change is found for an active profile, this process does not update the existing row.
Instead, it deletes the profile and then re-inserts the latest profile information. If a profile is no longer
active, this process will not re-insert the profile after deleting it.

10.1.2 What DQT Requires


The DQT process requires relevant data to be present in the core tables. The DQT process processes
data based on certain conditions, for example, if DEA number is to be populated in the
DQT_PROFESSIONAL_PROFILE table, then that should be linked to an active address. For state license
number to be populated, it should be linked to an active address and STATE_LICENSE_STATE should be
the same as the STD_STATE_CODE of CUS_ADDRESS table.

10.2 Main Procedure


This procedure is used to execute the process either in refresh or incremental mode. In refresh mode, the
DQT tables are truncated and all profiles from CUS_PRIMARY_ID_XREF table are reprocessed by
setting the CHANGE_IND to 1. In incremental mode, records for which the CHANGE_IND is set to 1
are deleted from the DQT table and are reprocessed. In both modes, the CHANGE_IND is reset to 0
(zero) after processing.
PKG_Denorm_Populate.main (nProcessMode IN NUMBER,
nCommitInterval IN NUMBER DEFAULT 1000,
nCacheSize IN NUMBER DEFAULT 300000

IMS Health Operations Guide Page 129 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

10.2.1 Main Procedure Arguments


Parameter Name Description Type
nProcessMode The parameter nProcessMode has two valid values: NUMBER
0 => Refresh Mode. It truncates both the DQT tables and updates the
cus_primary_id_xref.change_ind to 1. This indicates a fresh
reload of the DQT tables.
1 => Incremental Mode. It deletes and then inserts only those
records in the DQT tables which have
cus_primary_id_xref.change_ind set to 1.
nCommitInterval Commit Interval. NUMBER
NOTE: The default value is 1000
nCacheSize Memory cache size. NUMBER
NOTE: The default value is 300000

10.2.2 Running DQT in Incremental Mode


These steps execute the DQT process. A new log file is created each time the process is started. An exit
code of zero is returned if the DQT process completes successfully; otherwise a non-zero value is
returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"PKG_Denorm_Populate.main(1)"

10.2.3 Running DQT in Refresh Mode


These steps execute the DQT process. A new log file is created each time the process is started. An exit
code of zero is returned if the DQT process completes successfully; otherwise a non-zero value is
returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"PKG_Denorm_Populate.main(0)"

10.2.4 Log File


The output of the batch run is stored in a log file in the DRTE_NP_LOGS directory, and the log file name
is of the following format: PKG_Denorm_Populate.main_<YYYYMMDDHHMISS>.log.

10.3 ProcessImportedProfiles Function


This function is used to execute the DQT process in Real-time mode for profiles that are in the
STG_IMPORTED_PROFILE table with the STATUS_CD set to 504901 (Profile Status Locked). This
function also processes the CCV and MCP profiles for which the CHANGE_IND is set to 1 in
CUS_PRIMARY_ID_XREF table. The CHANGE_IND will be reset to 0 (zero) after processing. The
function returns the count of profiles processed as metrics.

IMS Health Operations Guide Page 130 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

PKG_Denorm_Populate.ProcessImportedProfiles(
tUserId IN FND_SYS_USER.SYS_USER_ID%TYPE,
nCacheSize IN NUMBER := 300000,
nCommitInterval IN NUMBER := 1000
);

10.3.1 ProcessImportedProfiles Function Arguments


Parameter Description Type
Name
tUserId User that launched the process. It should be a valid SYS_USER_ID NUMBER
from FND_SYS_USER table
nCacheSize Memory cache size. NUMBER
NOTE: The default value is 300000
nCommitInterval Commit Interval. NUMBER
NOTE: The default value is 1000

10.3.2 Running DQT in Real-time Mode


These steps execute the DQT process. A new log file is created each time the process is started. An exit
code of zero is returned if the DQT process completes successfully; otherwise a non-zero value is
returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -f"PKG_Denorm_Populate.ProcessImportedProfiles(1)"

10.3.3 Log File


The output of the run is stored in a log file in the DRTE_NP_LOGS directory, and the log file name is of
the following format: PKG_Denorm_Populate. ProcessImportedProfiles_<YYYYMMDDHHMISS>.log.

10.4 processSingleProfile Procedure


This procedure is used to execute the DQT process for a single profile unconditionally even if the
CHANGE_IND is set to 0 (zero) in CUS_PRIMARY_ID_XREF table. The CHANGE_IND will be reset to
0 (zero) after processing the single profile.
Note: This procedure does NOT commit the database after processing the single profile. It is the
responsibility of the application that calls this procedure to commit changes.
PKG_Denorm_Populate.processSingleProfile(
tProfileId IN CUS_PRIMARY_ID_XREF.PROFILE_ID%type,
tUserId IN FND_SYS_USER.SYS_USER_ID%TYPE,
tProfileTypeCd IN CUS_PRIMARY_ID_XREF.PROFILE_TYPE_CD%TYPE default NULL
);

IMS Health Operations Guide Page 131 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

10.4.1 processSingleProfile Procedure Arguments


Parameter Description Type
Name
tProfileId A valid professional or organization Profile ID to be processed which NUMBER
exist in CUS_PRIMARY_ID_XREF table
tUserId User that launched the process. It should be a valid SYS_USER_ID NUMBER
from FND_SYS_USER table.
tProfileTypeCd Profile type. Valid values are 112451 (Professional) and 112450 NUMBER
(Organization).
This argument is optional.

10.4.2 Running DQT for a Single Profile


These steps execute the DQT process for a sample profile ID 555. A new log file is created each time the
process is started. An exit code of zero is returned if the DQT process completes successfully; otherwise
a non-zero value is returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"PKG_Denorm_Populate.processSingleProfile(555,1)"

10.4.3 Log File


The output of the batch run is stored in a log file in the DRTE_NP_LOGS directory, and the log file name
is of the following format: PKG_Denorm_Populate. processSingleProfile_<YYYYMMDDHHMISS>.log.

10.5 Analyze Results


The log file should contain all the information about the records that have been processed. To evaluate
the details in the log file, start the SQL session.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>
Before running the DQT process, check the number of records to be processed if the value of
nProcessMode is set to 1. If nProcessMode has a value other than 1, then all the records are
processed.
SELECT COUNT(0) FROM CUS_PRIMARY_ID_XREF WHERE CHANGE_IND = 1;

The previous query returns the status of the DQT process irrespective of the nProcessMode value. If the
process has no error and if the query returns a value of 0, then the DQT process is done.

10.6 Running DQT Process Using ONE Point Application


The DQT process can be launched using the ONE Point configuration Manual Process Management.
Select DQT from the list of processes. DQT can be run either in Incremental mode or Full Refresh mode
by selecting one of them from the drop down box as shown below. The DQT process is also configured to
run in real time mode in Real Time Data Processing Services to enable automatic execution as part of
other Nucleus 360 processes.

IMS Health Operations Guide Page 132 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

10.7 Analyze Table


After a successful completion of the DQT process, the database maintenance package should be run to
rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID = 32 of
ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(32)"

10.8 Troubleshooting

10.8.1 identifier must be declared


Failure Description
BEGIN PKG_Denorm_Populate.main(A); END;
*
ERROR at line 1:
ORA-06550: line 1, column 32:
PLS-00201: identifier A must be declared
ORA-06550: line 1, column 7:
PL/SQL: Statement ignored
Failure condition
This error occurs when a character is passed instead of a number while running the package.
Solution
Provide a valid value while running the package. Refer to section 10.2.1 for valid arguments to run the
process.

10.8.2 The parameters passed to procedure are invalid


Failure Description
BEGIN pkg_denorm_populate.MAIN(-1); END;
*
ERROR at line 1:
ORA-20215: The parameters passed to procedure are invalid
ORA-06512: at "NP322_PRAC1.PKG_DENORM_POPULATE", line 1821
ORA-06512: at line 1
Or
IMS Health Operations Guide Page 133 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

BEGIN pkg_denorm_populate.MAIN(3); END;


*
ERROR at line 1:
ORA-20215: The parameters passed to procedure are invalid
ORA-06512: at "NP322_PRAC1.PKG_DENORM_POPULATE", line 1821
ORA-06512: at line 1
Failure condition
This error occurs when a negative number or invalid positive number is passed instead of a valid positive
number while running the package.
Solution
Provide a valid value while running the package. Refer to section 10.2.1 for valid arguments to run the
process.

10.8.3 When any database package is invalid =>


Failure Description
BEGIN PKG_Denorm_Populate.main(1); END;
*
ERROR at line 1:
ORA-04068: existing state of packages has been discarded
ORA-04063: package body PKG_DENORM_POPULATE has errors
ORA-06508: PL/SQL: could not find program unit being called

ORA-06512: at line 1
or
BEGIN pkg_denorm_populate.main; END;
*
ERROR at line 1:
ORA-20501: ORA-06508: PL/SQL: COULD NOT FIND PROGRAM UNIT BEING CALLED occurred
in main
ORA-06512: at "NP322_TRAINING.PKG_DENORM_POPULATE", line 1823
ORA-06512: at line 1
Failure condition
This condition would occur when one of the packages is invalid. The name of the invalid package can be
seen in the error message.
Solution
Recompile the specified package.

IMS Health Operations Guide Page 134 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

10.8.4 When the error message range is not between ORA-20000 and ORA-20999
=>
Failure Description
Get_Comm Error
ProfileId: 1234
AddressId: 3456
SQLCODE: ORA-02291
SQLERRM: integrity constraint (FK_PROFESSIONAL_PROFILE_PROF) violated - parent key not found

Start Time: 09:00:47 09/23/2002


End Time: 09:12:01 09/23/2002

PL/SQL procedure successfully completed.


Failure condition
This is a database generated error message.
Solution
Based on the Error Number generated, look at the Oracle document to find the Description, Cause, and
Action for the particular error message. If the error is critical then contact database administrator or IMS
Health support centre for further assistance.

10.9 Restarting the Process


If the DQT process fails or crashes in the middle of its execution, first identify the reason for the failure
and resolve the problem. After resolving the cause for the failure, restart the process using the same
command line options that were used in the initial (failed) run.

10.10 Tables Modified by DQT


Based on the type of data source classification, one of the DQT tables will be populated.
CUS_PRIMARY_ID_XREF
DQT_PROFESSIONAL_PROFILE
DQT_ORGANIZATION_PROFILE

IMS Health Operations Guide Page 135 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

11. DATA QUALITY PROCESS

11.1 Overview
Each significant component of the customer record is evaluated against a set of pre-configured (and
extensible) data quality rules. Depending on the result of the rule evaluation, a data quality value is
assigned to each record. Currently the following data record types can be evaluated and/or processed:
Professional names (CUS_PROFESSIONAL_PROFILE)
Organization names (CUS_ORGANIZATION_PROFILE)
Address (CUS_ADDRESS)
Secondary identifiers (CUS_SECONDARY_ID_XREF)
The result of the Data Quality indicators can be used downstream to affect the quality of other
processes, such as Hash, RDM, Match or custom exports. Processes such as the Reports and DQT have
access to the Data Quality indicators.

11.1.1 What Data Quality Process Does


The Data Quality process evaluates the data based on configurations defined in the
NP_CFG_DATA_QUALITY_RULE table, and assigns data quality codes such as Valid, Well Formed, etc.
These codes are further used for Hash and export process. Thus it is mandatory to run this process
before the Hash process. Refer to Appendix E of the Configuration Guide for the complete list of Data
Quality rules and its configuration.

11.1.2 What Data Quality Process Requires


The Data Quality process requires a database configuration that defines the data evaluation condition.
The following configuration table is used by the process.
NP_CFG_DATA_QUALITY_RULE: This is the configuration table for the Data Quality process. Each
configuration in this table defines a data evaluation scenario and its corresponding data quality code.
For further information on the configuration table, please refer to the Configuration Guide.

11.2 Process Parameters


NP_Data_Quality_Engine.main(nComponentType INTEGER DEFAULT 1,
nProcessMode INTEGER DEFAULT 501505,
nCommitInterval IN NUMBER DEFAULT 1000,
nCacheSize IN NUMBER DEFAULT 300000,
nDEAnameValidate IN NUMBER DEFAULT 1
);

IMS Health Operations Guide Page 136 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Parameter Name Description Type


NComponentType Which components should be processed against the Data INTEGER
Quality rules. This value must be one of the following
constant values from NP_Data_Qlty_Rules_Const package
header:
k_component_all
k_component_address
k_component_prof_details
k_component_org_details
k_component_identifier
Note: The default value is:
NP_Data_Qlty_Rules_Const.k_component_all
nProcessMode Processing mode. This value must be one of the following INTEGER
constant values from NP_Data_Qlty_Rules_Const package
header:
k_process_all
k_process_not_processed
Note: The default value is (new/updated records only):
NP_Data_Qlty_Rules_Const. k_process_not_processed
NCommitInterval Commit interval. NUMBER
Note: The default value is 1000
NcacheSize Memory cache size. NUMBER
Note: The default value is 300000
nDEAnameValidate Specific to DEA name validation NUMBER
Note: The default value is 1

11.3 Running Data Quality Rules Engine


The steps listed below will execute the process. A new log file will be created each time a process is
started. An exit code of zero is returned if the DQT process completes successfully; otherwise a non-zero
value is returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc -sNP_Data_Quality_Engine.main

IMS Health Operations Guide Page 137 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

11.4 Running Data Quality Rules Engine for a Single Profile


The following steps will execute the process. A new log file will be created each time a process is started.
An exit code of zero is returned if the DQT process completes successfully; otherwise a non-zero value is
returned.
$ cd %DRTE_NP_BIN%
$ runstoredproc -sNP_Data_Quality_Engine.
Processsingleprofile(NComponentType, TProfileId)

Parameter Name Description Type


NComponentType Which components should be processed against the Data INTEGER
Quality rules. This value must be one of the following
constant values from NP_Data_Qlty_Rules_Const package
header:
k_component_all
k_component_address
k_component_prof_details
k_component_org_details
k_component_identifier
Note: The default value is
NP_Data_Qlty_Rules_Const.k_component_all
TProfileId PROFILE_ID to be processed INTEGER

11.4.1 Output Generation


The output of the batch run is stored in a log file in the DRTE_NP_LOGS directory, and the log file name
is of the following format: NP_Data_Quality_Engine.main_<YYYYMMDDHHMISS>.log.

11.5 Running Data Quality Process Using ONE Point Application


The Data Quality process can be launched using the ONE Point configuration Manual Process
Management. Select Data Quality from the list of processes. Data Quality can be run for All Components
or for specific components such as Professional Details or Address by selecting one of them from the
drop down menu as shown below. Data Quality process is also configured to run in real time mode in
Real Time Data Processing Services to enable automatic execution as part of other Nucleus 360
processes.

IMS Health Operations Guide Page 138 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

11.6 Analyze Table


After a successful completion of the Data Quality process, the database maintenance package should be
run to rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID 104 of
the ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(104)"

11.7 Monitoring the Data Quality Process


To monitor the Data Quality process, the following queries can be used. Execute these queries initially
before starting the process. The results of the queries are the total number of records that are to be
processed by the Data Quality process for each entity.
To check the progress of the process, execute these queries at regular intervals and make sure that the
count is decreasing as the process is running.
After the Data Quality process completes, execute the queries again to ensure that the output of each
query returned is 0.
--Address
SQL> select count(0) from cus_address where data_quality_cd = 501505 and
delete_ind = 0;
--Professional
SQL> select count(0) from cus_professional_profile where data_quality_cd =
501505;
--Secondary
SQL> select count(0) from cus_secondary_id_xref where data_quality_cd = 501505
and delete_ind = 0;
--Organization
SQL> select count(0) from cus_organization_profile where data_quality_cd =
501505;

11.8 Troubleshooting

11.8.1 When the Parameter Is Not Passed Correctly


Failure Description
BEGIN NP_Data_Quality_Engine.main(A); END;
*
ERROR at line 1:
ORA-06550: line 1, column 32:
PLS-00201: identifier A must be declared
ORA-06550: line 1, column 7:
PL/SQL: Statement ignored
Failure Condition
When a character is passed instead of a number nComponentType.

IMS Health Operations Guide Page 139 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Pass a valid number as argument. Refer to section 11.2 for process parameters. When running through
the ONE Point Console application, choose the option values from the drop down list before running the
process.

11.8.2 When Any Database Package Is Invalid =>


Failure Description
BEGIN NP_Data_Quality_Engine.main(1); END;
*
ERROR at line 1:
ORA-04068: existing state of packages has been discarded
ORA-04063: package body NP_DATA_QUALITY_ENGINE has errors
ORA-06508: PL/SQL: could not find program unit being called
ORA-06512: at line 1
Failure condition
This condition would occur when any of the dependent packages are invalid. The name of the invalid
package can be seen in the error message.
Solution
Recompile the specified package. If the package is not compiled without any error, contact the IMS Health
Support Center for further assistance.

11.8.3 When Invalid Component Type Is Passed as Argument Value


Failure Description
ORA-20502: main|Invalid component type: -1
ORA-06512: at "NP322_PRAC1.NP_DATA_QUALITY_ENGINE", line 567
ORA-06512: at line 1
Failure Condition
This error occurs when an invalid number is provided as a component type (e.g., when a negative number
is passed).
Solution
Pass a valid number as argument. Refer to section 11.2 for process parameters.

11.8.4 When Invalid Process Mode Is Specified


Failure Description
ORA-20502: main|Invalid process mode: 2
ORA-06512: at "NP322_PRAC1.NP_DATA_QUALITY_ENGINE", line 567
ORA-06512: at line 1
Failure Condition
This error occurs when an invalid process mode is provided as an argument

IMS Health Operations Guide Page 140 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Provide a valid process mode as an argument when running directly from a command prompt. Refer to
section 11.2 for process parameters.

11.9 Restarting the Process


If the Data Quality process fails or crashes in the middle of its execution, identify and resolve the reason
for the failure. After resolving the cause for the failure, restart the process with the same command line
options that were used in the initial (failed) run.

11.10 Tables Modified Directly by Data Quality Process


The following tables are modified by the Data Quality process based on the component for which it is run.
The DATA_QUALITY_CD and the DATA_QUALITY_RULE_ID column will be updated for the tables.
CUS_ADDRESS
CUS_SECONDARY_ID_XREF
CUS_PROFESSIONAL_PROFILE
CUS_ORGANIZATION_PROFILE

IMS Health Operations Guide Page 141 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

12. THE HASH CREATOR

12.1 Overview
The Hash process creates a cross-reference table with string-based lookup keys for each profile. Lookup
keys are created by combining various sub-strings of essential information (name and address
components) of each profile. These keys serve as a compressed sub-string representation of the profile.
This causes the Hash process to create lookup keys of data based on intentionally vague criteria, thereby
allowing the Match process to process not only exact duplicates but also profiles that might have
approximately matching values (due to misspellings, truncation, and so on).
The keys created are used in searching for candidate profiles within the Match pre-process (profiles
having the same lookup keys become candidate to each other). This process enables the Match process
to work more effectively and efficiently in terms of retrieving the candidate records quickly (due to a key
lookup as opposed to a string-based search of the database) and selecting all of the probable candidates.
The generated Hash key is stored in the NUC_PROFILE_LKUP table.

12.1.1 What Hash Does


The process runs in two different modes:
Cleanup mode deletes the old Hash keys from the NUC_PROFILE_LKUP table. Old Hash keys
include keys of inactive profiles/addresses (which were active earlier) and the profiles that will be
processed in the current run.
Hash Key Generation mode populates the NUC_PROFILE_LKUP table with new Hash key values.

12.1.2 What Hash Requires


The Hash process requires the following:
The Data Quality process should be run for all profiles that are to be processed by Hash.
The Hash process requires a database configuration that defines the rules for generating the Hash
keys. The following configuration tables are used by the process.
1. NP_CFG_HASH: This table defines all the Hash configurations. A default hash configuration is
created as part of the core product installation (CFG_HASH_ID = 1).
2. NP_CFG_HASH_TYPE: For each Hash configuration defined in the NP_CFG_HASH table, one
or more Pattern Sets (created using the Configuration Assistant application) are used to generate
lookup keys based on the HASH_TYPE_CD and PROFILE_DETAIL_TYPE_CD. Valid
HASH_TYPE_CD values are as follows:
HASH_TYPE_CD Description
500100 Professional
500101 Organization
500104 Professional Hard Link
500105 Organization Hard Link
The PROFILE_DETAIL_TYPE_CD field is optionally set with a valid PROF_TYPE_CD (if the
HASH_TYPE_CD is Professional) or ORG_TYPE_CD (if the HASH_TYPE_CD is Organization).

IMS Health Operations Guide Page 142 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. NP_CFG_HASH_FIELD: This table defines the database columns that are used by the Hash
process to generate lookup keys. Fields that are defined as FIELD_ORDER 0 are not used in
the lookup key generation but are used by the Hash process internally. Fields that are defined
with FIELD_ORDER greater than zero are passed to the Pattern Set in the sequence mentioned
in the FIELD_ORDER. The Pattern Set uses these fields to generate lookup keys.

12.2 The Run Script run_hashcreator.exe


run_hashcreator.exe is a run script that encapsulates the command line arguments of the nphash.exe to
simplify various execution options of the Hash process. For each execution of the Hash process, the run
script creates a log file in the DRTE_NP_LOGS directory. The format of the log file name is
nphash_<YYYYMMDDHHMMSS.>log. An exit code of zero 0 is returned from the run script if the Hash
process completes successfully; otherwise a non-zero value is returned. The run script has two
operational modes:
Incremental Mode: In this mode (the default), existing lookup keys for profiles that are locked in
STG_IMPORTED_PROFILE (STATUS_CD 504901) will be deleted from the NUC_PROFILE_LKUP
table and will be regenerated for active profiles that are locked in the STG_IMPORTED_PROFILE
table.
Refresh Mode: In this mode the NUC_PROFILE_LKUP table will be emptied and lookup keys will be
regenerated for all active profiles in CUS_PRIMARY_ID_XREF.

12.3 Command Line Parameters/Usage


$ nphash [-?] -l<file> [-c<file>] [-a] [-t<type>] [-s<source>] [-x<start
value>] [-y<end value>] [-d<debug>] [-n] [-o<file>] [-z<process mode>]
[-v] [-V] -r<Hash configuration id> -h<Match Configuration ID>

Run Script Application Description


Parameter Parameter
(run_hashcreator.exe) (nphash.exe)
-? -? Detailed Help
N/A -l Log file name
N/A -c Database configuration file (dbcfg.txt is the default)
-a -a Process all profiles (If option(-a) is not specified then only
locked profiles from STG_IMPORTED_PROFILE records
are processed by default).
Note: When Hash process runs in refresh mode (-a),
Hash keys are regenerated for active profiles that are in the
CUS_PRIMARY_ID_XREF table. Processed profiles are
NOT copied to the NP_MATCH_PENDING table. Profiles
are not triggered for matching, as this mode is used only to
sync up the NUC_PROFILE_LKUP table. Only in
Incremental Mode (without -a option) are the profiles copied
to the NP_MATCH_PENDING table for matching after
generating the Hash keys.
N/A -t Filter by Profile type: ORG, PROF. Both types are
processed by default.

IMS Health Operations Guide Page 143 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description


Parameter Parameter
(run_hashcreator.exe) (nphash.exe)
N/A -s Filter by Data source code
N/A -x Filter by Profile range Start Profile ID
N/A -y Filter by Profile range End Profile ID
N/A -d Logging level: (1)Errors only (2)Terse-default (3)Verbose
(4)Detail
N/A -n Dry Run. Changes will not be applied to the database
N/A -o Output file name
N/A -z Process mode: TRUNCATE, DELETE, CLEANUP
-q -q Data Quality Code: (1)Valid (2)Well Formed (3)Unknown
(4)Poor-default (5) Invalid
-v -v Version Information
-V -V Extended Version Information
-h -h Generates Hash keys for profiles based on IDs; defaulted
to 1

12.4 Executing the Process

12.4.1 Run for locked profiles in STG_IMPORTED_PROFILE table (Incremental


Mode)
In this mode, existing lookup keys for profiles that are locked in STG_IMPORTED_PROFILE
(STATUS_CD 504901) are deleted from NUC_PROFILE_LKUP table and are regenerated. Processed
profiles are then copied to the NP_MATCH_PENDING table for matching if the REMATCH_IND is set to
1 in the STG_IMPORTED_PROFILE table.
$ cd %DRTE_NP_BIN%
$ run_hashcreator.exe

12.4.2 Run for All Active Profiles (Refresh Mode)


In this mode, NUC_PROFILE_LKUP table is emptied and hash keys are regenerated for active profiles
that are in the CUS_PRIMARY_ID_XREF table. Processed profiles are NOT copied to the
NP_MATCH_PENDING table. Profiles are not triggered for matching, as this mode is used only to sync
up the NUC_PROFILE_LKUP table.
$ cd %DRTE_NP_BIN%
$ run_hashcreator.exe -a

12.4.3 Output
Application status and process metrics are stored in a log file. The log file name is in the format
nphash_<timestamp>.log. Generated Hash keys are stored in the NUC_PROFILE_LKUP table.

IMS Health Operations Guide Page 144 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Note: Hash keys will not be generated for a profile if any of the following conditions are true:
The Data Quality process was not run successfully.
The profile is inactive.
No address records are found in CUS_ADDRESS table.
All addresses are inactive in CUS_ADDRESS table.
An active address is found but the address is not standardized. (In other words, an address record is
not found in CUS_ADDRESS_COMPONENT table.)
The profile type is Professional, and professional details are not found in the
CUS_PROFESSIONAL_PROFILE table.
The profile type is Organization, and organization details are not found in the
CUS_ORGANIZATION_PROFILE table.

12.5 Executing the Process Using nphash.exe

12.5.1 To Delete Profiles from NUC_PROFILE_LKUP Table


Execute the following command to delete profiles from the NUC_PROFILE_LKUP table that are currently
locked in the STG_IMPORTED_PROFILE table.
$ cd %DRTE_NP_BIN%
$ nphash.exe -zDELETE -l%DRTE_NP_LOGS%\nphash.log

12.5.2 To Truncate NUC_PROFILE_LKUP Table


Execute the following command to truncate the NUC_PROFILE_LKUP table. This option is preferred to
running the Hash process in refresh mode.
$ cd %DRTE_NP_BIN%
$ nphash.exe -zTRUNCATE -l%DRTE_NP_LOGS%\nphash.log

12.5.3 To Clean Up NUC_PROFILE_LKUP Table from Inactive Data


Execute the following command to delete inactive profiles and addresses from the NUC_PROFILE_LKUP
table.
$ cd %DRTE_NP_BIN%
nphash.exe -zCLEANUP -l%DRTE_NP_LOGS%\nphash.log

12.5.4 To Generate Hash Keys in Incremental Mode


Execute the following command to generate lookup keys for profiles that are currently locked in the
STG_IMPORTED_PROFILE table.
$ cd %DRTE_NP_BIN%
$ nphash.exe -l%DRTE_NP_LOGS%\nphash.log

IMS Health Operations Guide Page 145 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

12.5.5 To Generate Hash Keys in Refresh Mode


Execute the following command to generate lookup keys for profiles that are currently locked in the
STG_IMPORTED_PROFILE table.
$ cd %DRTE_NP_BIN%
$ nphash.exe a -l%DRTE_NP_LOGS%\nphash.log

12.5.6 To Refresh Hash Keys for Profiles in STG_IMPORTED_PROFILE without


Submitting Them for Matching
Execute the following command to generate lookup keys for profiles that are currently locked in the
STG_IMPORTED_PROFILE table. In this mode the profiles will not be copied to the
NP_MATCH_PENDING table.
$ cd %DRTE_NP_BIN%
$ nphash.exe a -l%DRTE_NP_LOGS%\nphash.log

12.5.7 To Refresh Hash Keys for a Range of Profiles Without Submitting Them for
Matching
Execute the following command to generate lookup keys for a range of profiles that are currently locked in
the STG_IMPORTED_PROFILE_table. In this mode the profiles will not be copied to the
NP_MATCH_PENDING table.
$ cd %DRTE_NP_BIN%
$ nphash.exe a -l%DRTE_NP_LOGS%\nphash.log x<Start Profile ID> -y<End
Profile ID>

12.5.8 Verify Successful Completion


The log file should not have the phrases Error, Failed, or Exception. The last lines of the log file should
contain the process end date and the total run time.

12.6 Running the Hash Process Using ONE Point Application


The Hash process can be launched using the ONE Point configuration Manual Process Management.
Select Hash from the list of processes as shown in the following example. From the drop down box, the
values can be changed as required. The Hash process is also configured to run in real time mode in Real
Time Data Processing Services to enable automatic execution as part of other Server Layer
processes.

IMS Health Operations Guide Page 146 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Note: The Copy Imported Profiles to Match Pending option should be set to Yes if the Profile
Selection Criteria is Staging Imported Profiles Only. This option is not applicable for other profile
selection criteria.

12.7 Monitoring the Hash Process

12.7.1 View Progress


To check the database for the status of the Hash process, run one of the following queries from the SQL
prompt.
Selective mode (Incremental mode)
If the process is running in Selective mode, the following query returns the number of profiles to be
processed.
SQL> select count (distinct profile_id) from stg_imported_profile;
To check the progress of the Hash process, execute the following query to get the number of profiles
that are processed. This count will increase as the process progresses. Hash keys will not be
generated for profiles that do not satisfy the conditions mentioned in the Note section of 12.4.3, even
after completion of the process.
SQL> select count (distinct lkp.profile_id) from stg_imported_profile stg,
nuc_profile_lkup lkp where lkp.profile_id = stg.profile_id;

IMS Health Operations Guide Page 147 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Refresh mode
1. If the process is running in Refresh mode, execute the following query to get the count of all active
profiles considered for refresh.
SQL> select count (profile_id) from cus_primary_id_xref where delete_ind = 0;
2. Then check the progress of the process by executing the following query to get the number of profiles
for which the Hash keys have currently been regenerated. This count will increase as the process
progresses.
SQL> select count (distinct profile_id) from nuc_profile_lkup;

12.8 Analyze Table


After a successful completion of the Hash process, database maintenance package should be run to
rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID= 7 of
ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(7)"

12.9 Troubleshooting

12.9.1 Rollback Segment Errors

12.9.1.1 ORA-01555 snapshot too old: rollback segment number string with name
string too small
Failure Condition
This could happen when multiple processes are running concurrently on the same set of data. Records
that are read by one process are overwritten by another process.
Solution
Avoid running concurrent processes that work on the same set of data.

12.9.1.2 ORA-01562 failed to extend rollback segment number string


Failure Condition
Oracle keeps the database changes made by the process in rollback segments until the process issues a
commit or rollback. When there is no space to store records in the rollback segment, Oracle tries to
extend the size of the rollback segment. If Oracle cannot extend the size, it generates this error message.
Solution
Ask the Oracle Database Administrator to increase the size of the rollback segment that has caused this
error. The rollback segment number can be obtained from the error message. Refer to Appendix B to
learn more about rollback segments.

IMS Health Operations Guide Page 148 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

12.9.2 The Logging option is required. A log file name must be passed.
Failure Condition
The logging option l is a mandatory option which must be passed while running the Hash process.
Solution
Pass the logging option l and log file name to run the process. Refer to section 12.2 for command line
options to run the process.

12.9.3 Hash Key Configuration ID option argument is required


Failure Condition
The Hash configuration option r requires a value. If it is not passed, the error will occur.
Solution
Pass a valid Hash configuration ID to hash configuration option r and run the process. Refer to section
12.2 for command line options to run the process.

12.9.4 Hash Key Configuration Code argument is required


Failure Condition
The Hash configuration option r is a mandatory option which must be passed while running the Hash
process.
Solution
Pass Hash configuration option r with some valid value and run the process. Refer to section 12.2 for
command line options to run the process.

12.10 Restarting the Process


If the Hash process fails or crashes in the middle of its execution, first identify the reason for the failure
and resolve it. After resolving the cause for the failure, follow one of these restart scenarios based on the
operational modes.
Restart using the run script run_hashcreator.exe. If the process initially failed when it was run via
the run script, restart it using the same command line options that were used when it failed.
Restart using nphash.exe. If the process failed while it was run via nphash.exe, restart it using the
same command line options that were used when it failed. If the process was run in steps using the
z option, then repeat the process from the beginning, using the same command line.
Restart using the ONE Point application. If the process initially failed when it was run via the ONE
Point application in Manual mode, restart it using the same command line options that were used
when it failed. It it failed when it was run in Real-time mode, restart the Real-time configuration.

12.11 Tables Modified by the Hash Process


The following tables will be modified by the Hash process.
NP_MATCH_PENDING
NUC_PROFILE_LKUP

IMS Health Operations Guide Page 149 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13. THE MATCH UTILITY (NPMU)

13.1 Overview
The Match process matches new or updated incoming profiles that are submitted for matching via the
NP_MATCH_PENDING table to other new incoming profiles or to existing customer records within the
Nucleus 360 database. This process executes in two stepsPre-process and Match.

13.1.1 Pre-process
The Match process creates Input-Target profile pairs based on the data sourcetodata source matching
configuration and the generated Hash keys. The Match Pre-process creates pairs of profiles based on the
equality of their Hash keys (profiles having the same lookup keys become candidate to each other).
Optionally, the Pre-process can also create Input-Target pairs based on the Peer profile selection (profiles
in the same NUCLEUS ID as that of the profile being matched are called Peer Profiles) configuration and
the Hard link configuration.
The Pre-process removes the profiles that exist in the Resolution Pending Queue at the time it is run.
These are resubmitted for matching again, since these profiles can possibly obtain a new match score
and new targets.
So in the Pre-process mode the Input-Target pairs are createdno matching is performed. While deleting
the profiles from the Resolution Pending Queue, the Pre-process ensures data integrity by handling the
following conditions:
All records for the profile being matched (occurring as Input) are deleted from the Resolution Pending
Queue where the profile is the Input.
The Input-Target pair for a profile being matched (where the profile being re-matched occurs as
Target) to another profile (occurring as Input) is deleted from the Resolution Pending Queue given
that the Input has at least one other Input-Target pair in the table (apart from the one being deleted).
The Input-Target pair for a profile being matched (where the profile being re-matched occurs as
Target) to another profile (occurring as Input) is updated as having No Candidates in the Resolution
Pending Queue where the Input has no more Input-Target pairs in the table, apart from the one being
updated. The updated Input Profile is then moved to the Match Output queue (NP_MATCH_OUTPUT
table) for ID Assign for further processing.
The Input-Target pairs derived based on the Hash keys (503601), Peer/Existing profiles (503600), and
Custom Candidates (503602 based on pairs created in the NP_MATCH_CUSTOM_CANDIDATE table),
as configured, are saved to the NP_MATCH_CANDIDATES table based on the configuration in the
NP_CFG_NMU_CANDIDATE_SELECTION table for the profiles data source.
The Input-Target pairs derived based on the hard link configuration (as set up in the
NP_CFG_NMU_ID_LINK table) are saved to the NP_MATCH_HARDLINK_CANDIDATES table. Note that
the hard-linked profiles should also have common lookup keys in NUC_PROFILE_LKUP table.
The candidate tables are completely deleted before new values are inserted. For performance
considerations, the Match Pre-process can be configured to execute in Cache or Non-Cache mode. The
data selection method in each mode of operation is explained in the following table.

IMS Health Operations Guide Page 150 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Hash Key Based


Mode Hard-link Candidates Peer Profile Candidates
Candidates
Cache mode Hash key based Hard-linked candidates are Peer profile candidates
(default) candidates are selected selected from are selected from
from CUS_SECONDARY_ID_XREF CUS_CUSTOMER table
NUC_PROFILE_LKUP table for all profiles in for all profiles in
table for all profiles in NP_MATCH_PENDING table in NP_MATCH_PENDING
NP_MATCH_PENDING a single query by joining with table in a single query.
table in a single query. NP_MATCH_CANDIDATES
table.
Note:
NP_MATCH_CANDIDATES
table is populated with hash key
based candidates, which also
includes a hash key generated
using the hard-linked identifier.
Non-Cache Hash key based Hard-linked candidates are Peer profile candidates
mode candidates are selected selected from are selected from
from CUS_SECONDARY_ID_XREF CUS_CUSTOMER table
NUC_PROFILE_LKUP table for all profiles in explicitly for each profile
table explicitly for each NP_MATCH_PENDING table in in
profile in a single query per run ID NP_MATCH_PENDING
NP_MATCH_PENDING (MATCH_RUN_ID).The query table in a separate query.
table in a separate will be executed once per run
query. ID.
NP_MATCH_CANDIDATES
table is not used in the
selection.
The Non-Cache method is preferred when there are an unusual number of targets for the input profiles,
which would cause an Oracle rollback segment error in the Cache mode. An unusual number of targets
may also be an indication of invalid Hash key generation due to poor data quality. The default mode of
execution is Cache mode.
Note: The Pre-process exposes a PL/SQL package (NPMatchCustomCandidateProc) which can be
modified or implemented to generate custom candidates for match pending profiles. The package should
populate the NP_MATCH_CUSTOM_CANDIDATE table with custom candidates (target profiles) for
profiles that are in the NP_MATCH_PENDING table.

13.1.2 Match
The Match process calculates and produces the similarity scores between the Input-Target profiles from
the candidates tables (created by the Match Pre-process), based on the system configuration. The
system can be configured to match on standardized IDs.

IMS Health Operations Guide Page 151 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.1.3 What Match Does


The complete database-based configuration for the Match utility is driven by a configuration ID from the
NP_CFG_NMU_CONFIGURATION table. Currently the configuration is saved under the
NMU_CONFIGURATION_ID = 1.
Each of the configured fields (defined in the NP_CFG_NMU_DATA_SELECTION table) in each input
record is compared to its associated field in the candidate record, and an error value representing the
differences in the fields is generated. Not all profiles from any data source are compared to each other;
only those configured in NP_CFG_NMU_CAND_DATA_SRC are considered. This configuration contains
the permissible candidate data sources to which an input record of a certain data source can match.
The Match utility uses a Plug-In architecture, which facilitates the use of DLLs to provide the custom
comparison and score calculation functions. The Plug-Ins are configured in the
NP_CFG_MATCH_PLUGIN table. Multiple Plug-Ins can be configured, thereby providing the flexibility to
choose comparison functions from multiple Plug-In sources.
The exact algorithms to be used in comparing fields are configured in the
NP_CFG_NMU_ALGORITHM_DETAIL table.
The core technique for calculating a cumulative score for the complete candidate record is based on
using fuzzy logic rules that are defined in the nucmatch.rul file. Note that this score calculation method
can be overridden with a custom method when using the Plug-In architecture.
Another method that is used for matching is called hard-linking. The STD_ID_VALUE field of the
CUS_SECONDARY_ID_XREF of input record and candidate record is matched. Only standardized
secondary identifiers are used in hard-linking (the STD_IND should be set to 1 in the
CUS_SECONDARY_ID_XREF table). Not all types of ID Values are considered for hard-linking; only
those that are configured in NP_CFG_NMU_ID_LINK table are considered.
Only records that have cumulative scores greater than 40 (default, or as specified in the s option) are
inserted into this table.
The NP_MATCH_OUTPUT table has a MATCH_SCORE column where the resultant score is logged.
This table also includes a SEND_TO_CLIENT_IND column. Normally this column is set to a value of zero
(0), but it is sometimes set to one (1) if the input profiles are invalid. Refer to the Nucleus 360
Configuration Guide for details regading validation rules in the NP_CFG_NMU_DATA_GRP_VALIDATION
table.
The EXCEPTION_CONDITION_CD column can have the following values:
504400 Profile was matched normally.
504401 Profile was matched as a hard-link match.
504402 No candidates could be found for the input profile.
504403 Profile is unmatchable due to null values in all key columns of a group (as configured in
the NUC_NMU_CFG_FLD_GRP table).
504404 Profile was matched as a hard-link match and as a potential merge candidate.

13.1.4 What Match Requires


NPMatch requires the following file to run in the normal mode apart from the core dbcfg.txt file:
nucmatch.rul This file has the matching rules for the fuzzy logic engine. These rules dictate the
logic with which the cumulative match score has to be calculated. To make updates to the file, please
contact your support team.

IMS Health Operations Guide Page 152 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.2 Running the Match Utility

13.2.1 Running the Match from Command Prompt

13.2.1.1 Run Match


Match can be invoked using an automated script or manually by executing each step required to complete
the operation. The following sections outline the minimum number of steps required to run the process in
either automatic or manual mode.

13.2.1.2 Running Match Automatically


The NPMatch process can be executed by running the script run_match.exe.
$ run_match.exe -?

SYNOPSIS
run_match.exe -c=3
run_match.exe -c=3 -i

DESCRIPTION
Script to run the Match process.

OPTIONS
--copies, -c
Number of Match copies to be initiated. Default is 3 copies.
ex: --copies=3

--rulefile, -r
Name of the Rule file used by the Match Process.
Default=nucmatch.rul. Ex: -r=nucmatch..rul

--run_id_group_size, -n
Usage. Number of input profiles to be grouped in one run ID in
NP_MATCH_PENDING: Default=2000.2

--help, -h, -?
Usage. Displays the usage of this script.
The script performs the following operations:
Ensures that the Data Import process completed successfully by checking the
NP_DELTA_RECOVER table.
Executes NPMatch pre-process.
Executes NPMatch in normal mode. The script will spawn a specified number of copies for concurrent
processing. The script will wait until each copy has completed before proceeding. The Match process
is tuned to run in a special mode to handle a high volume of data by specifying the -idl option. Use
this option during initial data load. An exit code of zero is returned if the run script completes
successfully; otherwise a non-zero value is returned.

2
This value should be set based upon system capacity. The higher the capacity, the larger the group size
should be.
IMS Health Operations Guide Page 153 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.2.1.3 Run Match Manually


The NPMatch process can be executed by running the script npmatch.
npmatch [-?] -l<filename> -r<filename> [-c<file>] [-d<debug>] [-z] [-x]
[-v] [-V] [-n<num_input_records_per_run_id>] [-s<lowest score>] [-t] [-
e<estimated volume>] [-m] [-q]

Option Description
-? Detailed Help
-l<filename> Specifies log file name (required)
-r<filename> Specifies rule file name (required)
-c<file> Database configuration file (dbcfg.txt is the default file)
-d<debug> Logging level:
=1 Errors only
=2 Terse-default
=3 Verbose
=4 Detail. Example usage : -d4
-z Pre-process
-x Run Pre-process in non-cache mode
-v Version Information
-V Extended Version Information (internal)
- Number of input profiles to be grouped in one run ID in
n<num_input_records_per_run_id NP_MATCH_PENDING. Min=1, Max=20000, Default=1000
> (optional). This option can only be used with -z.
-s<lowest score> Match will only produce records with scores greater than this lowest
score. Default = 40
-q Loads all the Plug-Ins (DLLs) from the configuration table and
displays summary information of supported algorithms. Only details
for active Plug-Ins are reported. The -c option is the only valid
option for -q.
Note: This option is only available in the Win32 version of this
process
-t Write out match trace information. This information is written to the
NP_MATCH_COMPARE_TRACE table.
-m Complete match (pre-match and match). Use this option to execute
the pre-process and the Match process in a single step.
Executing the Match utility is a two-step process pre-process and execution. Use the m option to run
the pre-process and the Match process in a single step. Optionally the pre-process can be executed
separately using the z option in troubleshooting mode or in a controlled environment.

IMS Health Operations Guide Page 154 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

The pre-process does the following:


Note: Before beginning, make sure the NPHash process has successfully completed.
The profiles waiting to be matched are found in the NP_MATCH_PENDING table. One of the tasks of
pre-process is to refresh the NP_MATCH_CANDIDATES and
NP_MATCH_HARDLINK_CANDIDATES tables, filling them up with all the probable candidates found
in the database for all the profile IDs in NUC_MATCH_PENDING.
It then assigns RUN IDS (a number) to a group of profile IDs (the group size is based on the n
option) having the same PROFILE_TYPE_CD in the NP_MATCH_PENDING table. The RUN_IDs
generated are also saved into the NP_MATCH_RUN table. Entries in the NP_MATCH_RUN table will
be the basis of execution for the second step.
Command Line Example for Step 1
Execute NPMatch in the pre-process mode using the z option as follows:
$ npmatch lmatch_preproc.log z-eR
Notes:
The NPMatch pre-process should not be run in a concurrent mode. Only a single copy of the
process should be executed at one time. The pre-process has no impact on the number of copies that
can be executed for the normal Match (NPMU) process.
This step also executes pkg_db_maintenance.process_maintenance(30); internally. This analyzes
the NP_MATCH_CANDIDATES table for efficiency.
Command Line Example for Step 2
Execute NPMatch in normal mode, spawning the required number of multiple copies. The following
example spawns three copies of the match running concurrently:
$ start npmatch lmatch1.log rnucmatch.rul eR
$ start npmatch lmatch2.log rnucmatch.rul eR
$ start npmatch lmatch3.log rnucmatch.rul eR
In normal mode, the Match utility performs matching and produces results in the NP_MATCH_OUTPUT
table.
Note that the Match utility is a memory intensive process. The number of concurrent copies to run should
be based on the system (both Database and the Server on which npmatch.exe runs) capacity to achieve
optimal performance.

IMS Health Operations Guide Page 155 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.3 Running the Match Process Using ONE Point Application


Launch the Match Pre-process using the ONE Point configuration Manual Process Management.
Select Match Pre-process from the list of processes. Modify the options if required by selecting from the
drop down box or by entering the required value.

Launch the Match process using the ONE Point configuration Manual Process Management. Select
Match from the list of processes. Modify the options if required by selecting from the drop down box or by
entering the required value.

IMS Health Operations Guide Page 156 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.4 Analyze the Results

13.4.1 Viewing Log Files


View the log files listed for the Match process. Search for any occurrence of the phrases Fail, Exception,
and Error. If any errors are found, contact your support team to report the problem and do not continue
with the next process.
Note: Invalid Input records and Invalid Candidate records do not denote errors.

13.4.1.1 Log Message Descriptions


Match Pre-process Sample Log Message:

Following are descriptions of log messages for the Match Pre-process:


In the log messages under Candidates generation started in cache mode and Match custom
candidates generation started in cache mode, Total rows written is the total number of candidate
records inserted into the NP_MATCH_CANDIDATES table for each selection method.
The log message Total professional run groups created denotes the count of distinct run IDs
created in the NP_MATCH_PENDING table for professional profiles in this run.
The log message Total organization run groups created denotes the count of distinct run IDs
created in the NP_MATCH_PENDING table for organization profiles in this run.

IMS Health Operations Guide Page 157 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Match Process Sample Log Message:

Following are descriptions of log messages for the Match process (these are available in the match.log
file):
Input Profiles processed denotes the number of input profiles processed by the match process as
per the NP_MATCH_PENDING table.
Professional Profiles processed denotes the number of profiles of type Professional that were
processed.
Invalid Professional Input Records not processed denotes the number of Professional input
profile records that are not processed, either because they did not satisfy the conditions configured in
the NP_CFG_NMU_DATA_GRP_VALIDATION table or because their addresses were inactivated.
This second scenario is likely to happen if a profile is sent for match and its addresses are inactivated
before the process is executed.
Professional Candidate Records not processed represents the number of professional target
profile records that are not processed, either because they did not satisfy the conditions configured in
the NP_CFG_NMU_DATA_GRP_VALIDATION table or because their addresses were inactivated.
This second scenario is likely to happen if a profile is sent for match and its addresses are inactivated
before the process is executed.
Organization Profiles processed denotes the number of profiles of type Organization that were
processed.
Invalid Organization Input Records not processed denotes the number of input organization
profile records that are not processed, either because they did not satisfy the conditions configured in
the NP_CFG_NMU_DATA_GRP_VALIDATION table or because their addresses were inactivated.
This second scenario is likely to happen if a profile is sent for match and its addresses are
inactivated before the process is executed.
Invalid Organization Candidate Records not processed denotes the number of organization target
profiles that are not processed, either because they did not satisfy the conditions configured in the
NP_CFG_NMU_DATA_GRP_VALIDATION table or their address was inactivated. This last scenario
is likely to happen if a profile is sent for match and its addresses are inactivated before the process is
executed.

IMS Health Operations Guide Page 158 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Records Sent for Manual Resolution denotes the number of records that are sent to the
NUC_RESOLUTION_PENDING table to be resolved from the GUI using the ID Assign process. Note
that these profiles are put into the NP_MATCH_OUPUT table initially and then moved directly to the
NUC_RESOLUTION_PENDING table by ID Assign.
Candidate Profiles processed denotes the number of candidate profiles processed by Match.
Input Profiles Hard linked denotes the number of input profiles in the
NP_MATCH_HARDLINK_CANDIDATES table that are processed.
Total Hardlink Matches denotes the number of input profiles that are matched based on the Hard
link rules.
Input Profiles Without Any Valid Candidates denotes the number of input profiles processed that
did not had a valid target profile pair identified.

13.4.2 Debugging Using the -d Option


The NPMatch process has a d option for debugging and tracing. If scores for individual fields are to be
reviewed for each input/target profile ID, specify d as part of the run line. The log file will now contain
scores for the standard individual fields as shown here.
================================================================================
Match Score = 21.8255
TYPE================== TARGET ===========INPUT===============EDIT DIST========
PROFILE_ID = 48357 32949
ADDRESS_ID = 79921 54283
STD_FIRST_NM = DARLENE DOV 30
STD_MIDDLE_NM = J ALEXANDER 35
STD_LAST_NM = GOLDSTEIN GOLDSTEIN 0
PRIM_RANGE = 1 30 20
PRIM_NM = WASHINGTON DORISON 19.0909
STD_CITY = MORRISTOWN SHORT HILLS 40.9091
STD_STATE_CODE = NJ NJ N/A
STD_POSTAL_CODE = 07960 07078 3
STD_ADDRESS_LINE1 = 1 WASHINGTON AVE APT 18-5A
INPUT _LINE1 = 30 DORISON DR
STD_ADDRESS_LINE2 =
INPUT _LINE2 =
================================================================================

13.5 Analyze Table


After the Match process has successfully completed, the database maintenance package should be run
to rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID 114 of the
ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(114)"

IMS Health Operations Guide Page 159 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.6 Monitoring the Status of Match Utility


While the Match Pre-process is running, the following queries will provide details about its progress.
Execute the following query to get the number of candidates created by Match Pre-process. If the
query is done while the preprocess is running, this count will show the progress of the process.
SQL> select count(0) from NP_MATCH_CANDIDATES;
Execute this query to find out the number of input profiles for which candidates have not yet been
generated while the pre-process is running. Note that some profiles may never be inserted into the
NP_MATCH_CANDIDATES table; those are profiles that have no candidates.
SQL> select count (PROFILEID) from
(
select distinct profile_id PROFILEID from NP_MATCH_PENDING nmp
minus
select distinct input_profile_id PROFILEID from NP_MATCH_CANDIDATES nmc
);
When all the candidates for the input profiles have been inserted into the NP_MATCH_CANDIDATES
table, the pre-process starts to search for the hard-link profiles. Execute the following query to return
the number of hard-link candidates created.
SQL> select count(0) from NP_MATCH_HARDLINK_CANDIDATES;

While the Match process is running, the following queries will provide details about its progress.
Execute the following query to get the number of Run IDs pending to get processed by Match
process.
SQL> Select count(0) From NP_MATCH_RUN where STATUS_CD = 503500;
Execute the following query to get the number of Run IDs that Match is currently processing.
SQL> select count(0)From NP_MATCH_RUN where STATUS_CD = 503501;
Execute the following query to get the number of Run IDs that Match has processed.
SQL> select count(0)From NP_MATCH_RUN where STATUS_CD = 503502;
Once a copy of the Match utility is finished processing, it removes the RUN IDs entries from the
NP_MATCH_RUN table and deletes the corresponding profiles from the NP_MATCH_PENDING table.
Execute the following query to get the number of distinct profiles left to be processed by ID Assign.
Profiles with send_to_client_ind = 1 will automatically be moved to the
NUC_RESOLUTION_PENDING table by ID Assign.
SQL> select count(distinct input_profile_id) from np_match_output where
send_to_client_ind = 0;

IMS Health Operations Guide Page 160 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.7 Troubleshooting

13.7.1 Process Slows Down


Failure Description
The process has slowed down after some hours of processing and runs for a considerably long time.
Failure Condition
Sometimes Oracle is not able to decide or gather proper statistics and hence prepares a wrong execution
plan. This leads to performance degradation.
Solution
If you find that NPMatch has slowed down considerably after some hours of processing, analyze the
NP_MATCH_OUTPUT table as shown.
SQL>exec
dbms_stats.gather_table_stats(ownname=>'<database_user>',cascade=>true,tabname
=>'NP_MATCH_OUTPUT');

13.7.2 Pre-process mode does not support the following options [-r,-s,-q,-t, -m]
Failure Description
Pre-process mode does not support the following options [-r,-s,-q,-t, -m]
Failure Condition
Match Pre-process and Match are run through the same executable but with different arguments. The
argument -z that runs the Match Pre-process cannot run with the the options -r, -s, -q, -t and -m.
So this error occurs when the Match Pre-process is run with the -z option along with one or more of the
above mentioned options.
Solution
Provide valid arguments or combinations of arguments while running the Match process. Refer to section
13.2.1.3 for the correct command line parameters.

13.7.3 The Logging option is required.


Failure Condition
The logging option l is a mandatory option that must be passed while running the process.
Solution
Pass the logging option l and log file name to run the process. Refer to section 13.2.1.3 for the
command line parameters.

IMS Health Operations Guide Page 161 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.7.4 The Rule File option is required.


Failure Condition
The rule file option -r is mandatory for running the Match process. This error occurs when the rule file
option is not passed.
Solution
Pass the rule file option -r with valid rule file name while running the Match process. Refer to section
13.2.1.3 for the correct command line parameters.

13.7.5 The Estimated Volume (-e) option argument is required.


Failure Condition
The estimated volume option -e is mandatory for running the Match process. This error occurs when the
estimated volume option is not passed.
Solution
Pass the estimated volume option -e with valid value while running the Match process. Refer to section
13.2.1.3 for the correct command line parameters.

13.8 Restarting Match Utility

13.8.1 Restarting the Match Pre-process


If the Match Pre-process fails, identify the reason for the failure and resolve it before restarting the
process.

13.8.1.1 Manual Mode


Follow these steps to restart the Match Pre-process if it failed when it was run in manual mode. Log on to
SQL Plus and execute the following statements from the SQL prompt
1. Remove all records from NP_MATCH_RUN table.
SQL> truncate table NP_MATCH_RUN;
2. Remove all records from NP_MATCH_CUSTOM_CANDIDATE table.
SQL> truncate table NP_MATCH_CUSTOM_CANDIDATE;
3. Reset the MATCH_RUN_ID column to NULL in NP_MATCH_PENDING table.
SQL> Update NP_MATCH_PENDING set MATCH_RUN_ID = NULL;
4. Commit and Exit.
SQL> COMMIT;
SQL> EXIT
5. Restart the Match pre-process in manual mode.

13.8.1.2 Real-time Mode


In real-time mode, the Match Pre-process is executed as part of the Match process. Refer to section
13.8.2.

IMS Health Operations Guide Page 162 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

13.8.2 Restarting the Match Process


The only way to restart the Match process is by re-processing all profiles that are submitted for matching.

13.8.2.1 Restarting Match for All STG_IMPORTED_PROFILE Records (Real Time)


1. Stop the Real Time Data Processing Services loop in ONE Point if the error occurred while the
Match phase was running.
2. Log on to SQL Plus and execute the following statements from the SQL prompt.
Remove all profiles from NP_MATCH_OUTPUT.
SQL> truncate table np_match_output;
Remove all profiles from NP_MATCH_RUN table.
SQL> truncate table np_match_run;
Remove all profiles from NP_MATCH_PENDING.
SQL> truncate table np_match_pending;
Remove all records from NP_MATCH_CUSTOM_CANDIDATE table
SQL> truncate table NP_MATCH_CUSTOM_CANDIDATE;
Commit.
SQL> Commit;
3. Restart the Real Time Data Processing Services configuration. This will re-process all records from
the STG_IMPORTED_PROFILE table even for some of the processes that are executed before
Match, such as Data Quality, Hash, and Pre-Match.

13.8.2.2 Restarting Match for Pending Records Only (Manual)


1. Stop the Real Time Data Processing Services loop if this is where the error occurred while
executing the Match process.
2. Log on onto SQL Plus and execute following statements from the SQL prompt.
Remove all profiles from NP_MATCH_OUTPUT.
SQL> truncate table np_match_output;
Reset the NP_MATCH_RUN table.
SQL> UPDATE NP_MATCH_RUN SET STATUS_CD = 503500, LOG_RUN_ID = NULL, PROCESS_ID
= NULL, MACHINE_NODE = NULL, USER_INFO = NULL;
Commit.
SQL> Commit;
3. Run Match manually (from ONE Point, start the Match task in the Manual - Process Management
configuration) using the same options that were used when it stopped. If Match was stopped during
Real Time Data Processing Services, the Estimated Volume option needs to be set to Ongoing /
Low Volume Load (R).
4. After Match has finished, execute the post-Match processes manually using the Manual - Process
Management configuration. Run the following processes in the order specified here:
a. Group Match Output

IMS Health Operations Guide Page 163 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

b. Pre ID Assign DB Maintenance


c. ID Assign
d. Post ID Assign DB Maintenance
e. Reverse Link Creator
f. All tasks for Reverse Data Monitor (e.g., Suffix, ME Number, IMS Number, AOA Number)
g. All tasks for Merge (e.g., ePharma Professional Profile, ePharma Professional Address)
h. Validation Status Export
i. Unlock and Delete Staging Profiles
5. Restart the Real Time Data Processing Services loop if desired.

13.9 Tables Modified by Match Utility

13.9.1 Tables Modified by Match Pre-process


NP_MATCH_CANDIDATES
NP_MATCH_HARDLINK_CANDIDATES
NP_MATCH_CUSTOM_CANDIDATE
NP_NMC_XREF
NP_MATCH_RUN
NP_MATCH_PENDING
NP_MATCH_OUTPUT
NUC_RESOLUTION_PENDING
CUS_CUSTOMER
CUS_CUSTOMER_INFO

13.9.2 Tables Modified by Match


NP_MATCH_OUTPUT
NP_MATCH_PENDING
NP_MATCH_RUN
NP_MATCH_CUSTOM_CANDIDATE

IMS Health Operations Guide Page 164 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

14. ID ASSIGN PROCESS

14.1 Overview
At this point, data has been imported to the Nucleus 360 database, and new and updated profiles have
been matched against all the Nucleus 360 profile data. The ID Assign process takes the match scores
and attempts to assign NUCLEUS IDs for the submitted profiles. ID Assign sets aside the profiles that it
cannot resolve automatically. These unresolved profiles must then be manually resolved using the
Customer Resolution application. Like Match, ID Assign has a pre-process mode and a main mode.
ID Assign Pre-process (Group Match Output): The ID Assign pre-process mode assigns Group IDs to
profiles in the NP_MATCH_OUTPUT table. The pre-process is implemented in a PL/SQL package
NPProfileGrouping. Each Group ID represents a logical collection of unresolved pairs in the
NP_MATCH_OUTPUT table. The logical relationship of all the input/target profiles is based on a transitive
relationship among them. For example:
The following unresolved pairs exist in the NUC_RESOLUTION_PENDING table:
Input Profile Target Profile
A B
B C
D E
D G
Due to the transitive relationship, the pairs will be grouped as follows:
Pair Group Description
A,B 1 Initial Group
B,C 1 Assigned Group ID 1, as B already exists in a previously assigned Group 1.
D,E 2 D and E do not belong to any group, so a new Group ID is generated.
D,G 2 Assigned Group ID 2, as D already exists in a previously assigned Group 2.
Records from the unresolved queue (NUC_RESOLUTION_PENDING table) are moved to the
NP_MATCH_OUTPUT table if the unresolved input profile is a target in the NP_MATCH_OUTPUT table.
Records that are sent to the unresolved queue by the Reverse Data Monitor process (RDM) will not be
moved to the NP_MATCH_OUTPUT table. The pre-process also does a cleanup of inactive input profiles
from the NP_MATCH_OUTPUT table.
Note: The ID Assign pre-process must be completed successfully before executing the ID Assign
process. It is not an optional step.

14.1.1 What ID Assign Does


ID Assign analyzes every input profile in the NP_MATCH_OUTPUT table to see if it can assign a
NUCLEUS ID.
1. It marks all non-permissible candidate matches according to the business rules and sends them for
manual resolution (Data source rules violation).
2. For all the remaining candidates, it determines whether the input profile can be automatically
assigned a NUCLEUS ID or if it needs to be forwarded to Customer Resolution for manual resolution.
IMS Health Operations Guide Page 165 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. ID Assign performs one of the following tasks:


Assigns a NUCLEUS ID to the input profile by inserting a row in the CUS_CUSTOMER
table and moving the entries from NP_MATCH_OUTPUT to
NUC_RESOLUTION_PENDING_HISTORY if the input profile has no other low scoring targets. It
also modifies the CUS_CUSTOMER_INFO table such that a new record is inserted if the
NUCLEUS ID is new; otherwise, the record is updated.
Sets the SEND_TO_CLIENT_IND in NUC_RESOLUTION_PENDING to one (1). This
indicates that the Customer Resolution application should handle the profile. The profile is also
copied to the NUC_RESOLUTION_GUI_QUEUE table.

14.2 The Run Script run_idassign.exe


run_idassign.exe is a run script that encapsulates the command line arguments of the npidassign.exe to
simplify various execution options of the ID Assign process. For each execution of the ID Assign process,
the run script creates a log file in the DRTE_NP_LOGS directory. The format of the log file name is
npidassign_<YYYYMMDDHHMMSS.>log. An exit code of zero 0 is returned from the run script if the
ID Assign process completes successfully; otherwise a non-zero value is returned.

14.3 Command Line Parameters


npidassign.exe [-?] [-v] [-V] -l<filename> -m<mode> [-c<filename>] [-
d<debug>] [-r] [-i<Commit Interval>] [-s<Profile ID>] [-n] [-g<Group ID>]
[-t<Thread Number>] [-z<middle-tier>] [-p<Profile Grouping Package>]

Run Script Application Description


Parameter Parameter
(run_idassign.exe) (npidassign.exe)
-? -? Detailed Help
N/A -v Version Information
N/A -V Extended Version Information (IMS Health Internal)
N/A -l<filename> Log file name <filename>. This is a required parameter
N/A -c<filename> Database configuration file name <filename>
-n -n Specifies that the algorithm should NOT use the memory
cache. It is not recommended to use this option as it may
cause serious performance degradation. In cache mode the
entire NP_MATCH_OUTPUT table is cached by the process
in its memory to optimize the database access for each
profile. The maximum process memory that an application is
allowed to use on a 32-bit Windows environment is 2GB.
-b -i Specifies the number of graphs per database commit

IMS Health Operations Guide Page 166 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Run Script Application Description


Parameter Parameter
(run_idassign.exe) (npidassign.exe)
N/A -d Logging level
=1 Errors only
=2 Terse (default)
=3 Verbose
=4 Detail. Example usage : -d4
N/A -r Specifies Dry Run (changes to database are not applied)
N/A -s<Profile ID> Specifies processing only the defined profile ID (optional,
Profile mode, and Pre-process Groups only)
-g -m<G, P> Specifies the mode to run (-mG for Group mode, -mP for
Profile mode).
Note: These are advanced options for internal use only; the
process should be always run in Group mode, the default.
N/A -g<Group ID> Specifies processing only the specified group ID (optional,
Group mode only)
N/A -p <Profile Run the Profile Grouping Package before executing ID
Grouping Assign
Package>
N/A -t Specifies the number of threads (optional, group mode only).
The maximum number of threads is 4
N/A -z Developer's debug mode to resolve profiles the middle-tier
way. DO NOT use this option in production environment.
-zProfileId,DataSrcCd,[NucleusId -1],[LinkType -1],[DeLink 0],
[CascadeDeLink 0]
-s N/A Skip executing the Profile Grouping package before
executing ID Assign

14.4 Running ID Assign


ID Assign can be invoked either using an automated run script, or manually by executing each step
required to complete the operation. The following sections outline the minimum number of steps required
to run the process in either automatic or manual mode.

14.4.1 Running ID Assign Using the Run Script


To process all records from the NP_MATCH_OUTPUT table.
ID Assign can be executed by invoking the run_idassign.exe script. The ID Assign pre-process is
executed automatically before the ID Assign process is launched. The process is executed with
default options, as shown here.
$ cd %DRTE_NP_BIN%
$ run_idassign.exe

IMS Health Operations Guide Page 167 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

To process all records from NP_MATCH_OUTPUT table without running the ID Assign preprocess.
Note: The pre-process should have been completed successfully before executing ID Assign. The -s
option should be used only when the ID Assign process fails after successfully completing the pre-
process.
$ cd %DRTE_NP_BIN%
$ run_idassign.exe s

14.4.2 Running ID Assign Manually


To process all profiles in NP_MATCH_OUTPUT table. The p option is selected to run the ID Assign
pre-process before executing ID Assign.
$ cd %DRTE_NP_BIN%
$ npidassign.exe lidassign.log mP -p
To process all profiles in NP_MATCH_OUTPUT table without executing the ID Assign pre-process
(Note that the pre-process should have completed successfully before executing ID Assign).
$ cd %DRTE_NP_BIN%
$ npidassign.exe lidassign.log mP
To run the process in non-cache mode:
Note: ID Assign is successfully volume tested in cache mode with approximately 28 million rows in
the NP_MATCH_OUTPUT table. It is always recommended to run it in cache mode. Non-cache mode
should be used only if the total process memory exceeds 2GB and the application crashes for that
reason. (Running ID Assign Process in Non-cache mode is not recommended, as it may cause
serious performance degradation.)
$ cd %DRTE_NP_BIN%
$ npidassign.exe lidassign.log n mP -p
To resolve a single profile (1234567):
$ cd %DRTE_NP_BIN%
$ npidassign.exe lidassign.log s1234567 mP -p

14.4.3 Running the Pre-process Manually


To run the pre-process manually for all records in the NP_MATCH_OUTPUT table, execute the
following command after substituting <UserID> with a valid User Id from FND_SYS_USER table.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPProfileGrouping.preProcess(<UserID>,0)"
The pre-process can be optionally run in a dry run mode to populate the
NUC_RESOLUTION_GROUP table with the logically related group of profiles identified from the
NP_MATCH_OUTPUT table. The pre-process should be run in the regular mode (non dry-run) before
executing the ID Assign process. Execute the following command after substituting <UserID> with a
valid User Id from FND_SYS_USER table.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPProfileGrouping.preProcess(<UserID>,2)"

IMS Health Operations Guide Page 168 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

14.5 Running ID Assign Process Using ONE Point Application


The ID Assign process can be launched using the ONE Point configuration Manual Process
Management. Execute the ID Assign Pre-process before executing ID Assign (Group Match Output).
Select ID Assign from the list of processes. Modify the options if required by selecting from the drop down
box.

14.6 Analyze Table


After the ID Assign process has successfully completed, the database maintenance package should be
run to rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID 17 of
the ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(17)"

14.7 Monitoring ID Assign Progress


While ID Assign Pre-process is running, the following query will provide details about its progress (i.e., the
number of profiles that are yet to be assigned a Group ID). This count will decrease as the ID Assign Pre-
process progresses.
SELECT COUNT(0)PENDING_RECORD_COUNT FROM NP_MATCH_OUTPUT WHERE NRP_GROUP_ID IS
NULL;
While ID Assign is running, the following query will give you details about its progress (specifically, the
number of distinct profiles left to be resolved).
SQL> select count(distinct input_profile_id) from np_match_output;
This number should decrease steadily throughout the process.

14.8 Analyzing the Results

14.8.1 Viewing the Log File


View the log file idassign.log generated by the process. Search for any occurrence of the phrases Fail
and Data Exception. If either phrase is found, do not continue with the next process. Contact your support
team to report the problem.

IMS Health Operations Guide Page 169 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

14.8.1.1 Log Message Descriptions

14.8.1.1.1 ID Assign Pre-process Sample Log Message (Group Match Output Process)

NRP groups triggered for re-evaluation: This count denotes the total groups that are moved from
the NUC_RESOLUTION_PENDING table to the NP_MATCH_OUTPUT table for re-processing.
Total Group IDs synchronized: This count denotes the total groups that are synchronized to have
the same NRP_GROUP_ID between the NP_MATCH_OUTPUT table and the
NUC_RESOLUTION_PENDING table. If a target profile in NP_MATCH_OUTPUT table is found in the
NUC_RESOLUTION_PENDING table as an input or a target, then the NRP_GROUP_ID of the
NUC_RESOLUTION_PENDING table is updated with the NRP_GROUP_ID of the
NP_MATCH_OUTPUT table.
Total NMO groups moved to NRP: This count denotes the total groups that are moved from the
NP_MATCH_OUTPUT table to the NUC_RESOLUTION_PENDING table for manual resolution.
These groups are triggered directly by the Match process for manual resolution.

14.8.1.1.2 ID Assign Sample Log Message


Customer resolution algorithm : Optimized
Nucleus IDs created : 819
Profiles resolved automatically : 2914
Unique profiles sent for manual resolution : 52
Profiles sent to GUI queue : 34
Profiles resolved with no targets : 0
Input-Target pair resolved with score below low threshold : 0
Groups processed : 812
Overridden match scores due to link rule : 0
Overridden match scores due to threshold link rule : 0
Overridden match scores due to delink rule : 0
Link rules ignored due to low threshold score : 0
Overridden match scores due to hardlink merge rule : 0
Profiles auto-assigned due to merge hardlink rule : 0
Profiles auto-moved due to merge hardlink rule : 0
Merge hardlinks ignored due to low overridden score : 0
Profiles auto-assigned due to multiple customer resolution: 0
Profiles auto-moved due to multiple customer resolution : 0

IMS Health Operations Guide Page 170 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Customer resolution algorithm: Algorithm that is used to resolve customers in this run.
Nucleus IDs created: Count of new NUCLEUS IDs that are created in this run.
Profiles resolved automatically: Count of profiles that are automatically resolved in this run.
Unique profiles sent for manual resolution: Count of unique profiles that are sent for manual
resolution in this run.
Profiles sent to GUI queue: Count of unique profiles that are written to the
NUC_RESOLUTION_GUI_QUEUE table.
Profiles resolved with no targets: Count of unique input profiles with no targets.
Input-Target pair resolved with score below low threshold: Count of input-target profile pairs
having match score less than the low threshold defined in the NUC_CFG_ASSIGN table.
Groups processed: Count of unique groups processed when the process is run in group mode.
Overridden match scores due to link rule: Count of records in which the match score is overridden
due to a link rule created in the CUS_MANUAL_RESOLUTION_HISTORY table
(RESOLUTION_TYPE_CD = 505100).
Overridden match scores due to threshold link rule: Count of records in which the match score is
overridden due to a condition link rule created in the CUS_MANUAL_RESOLUTION_HISTORY table
(RESOLUTION_TYPE_CD = 505101).
Overridden match scores due to delink rule: Count of records in which the match score is
overridden due to a de-link rule created in the CUS_MANUAL_RESOLUTION_HISTORY table
(RESOLUTION_TYPE_CD = 505102).
Link rules ignored due to low threshold score: Count of records in which the match score is not
overridden even though a condition link rule existed in the CUS_MANUAL_RESOLUTION_HISTORY
table (RESOLUTION_TYPE_CD 505101), but the match score was less than the low threshold as
configured in NUC_CFG_ASSIGN table.
Overridden match scores due to hardlink merge rule: Count of records in which the match score
is overridden due to the hard-link merge setting in the NP_CFG_NMU_ID_LINK table (MERGE_IND =
1).
Profiles auto-assigned due to merge hardlink rule: Count of profiles that were not assigned a
NUCLEUS_ID but were assigned the NUCLEUS_ID of a profile in this run due to the hard-link merge
rule defined in the NP_CFG_NMU_ID_LINK table (MERGE_IND = 1).
Profiles auto-moved due to merge hardlink rule: Count of profiles that were already assigned a
NUCLEUS_ID but were moved to a different NUCLEUS_ID of a profile in this run due to the hard-link
merge rule defined in NP_CFG_NMU_ID_LINK table (MERGE_IND = 1).
Merge hardlinks ignored due to low overridden score: Count of records in which the merge hard-
link setting is ignored due to a de-link rule created in the CUS_MANUAL_RESOLUTION_HISTORY
table (RESOLUTION_TYPE_CD 505102).
Profiles auto-assigned due to multiple customer resolution: Count of profiles that were not
assigned a NUCLEUS_ID but were assigned a NUCLEUS ID in this run due to a multiple customer
merge.
Profiles auto-moved due to multiple customer resolution: Count of profiles that were already
assigned a NUCLEUS_ID but were moved to a different NUCLEUS ID in this run due to multiple
customer merge.

IMS Health Operations Guide Page 171 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

14.8.2 Verify Successful Completion


This is a critical step to verify that ID Assign has been successful. After ID Assign completes, run the
following query:
SQL> select count(0) from np_match_output;
If this returns any value other than zero, an abnormal condition has occurred. Do not continue with the
next process. Contact your support team to report the problem.

14.9 Troubleshooting

14.9.1 not enough memory


Failure Condition
The process by default uses memory cache. This error occurs when there is not enough free memory left.
Solution
Use the no memory cache option, n or Group mode while running the process. This way the process will
not use memory cache. If some profiles have not been resolved in Group mode, check if group IDs have
been created for these profiles. Refer to section 14.4.2 to run the process in non-cache mode.

14.9.2 The Logging option is required. A proper file name must be passed.
Failure Description
Exception Error Code = 0
Exception Error Type = 4
Exception Short Description = The Logging option is required. A proper file name must be passed.
Exception Description = The Logging option is required. A proper file name must be passed.
Failure Condition
The logging option l is a mandatory option which must be passed while running the process.
Solution
Pass the logging option l and log file name to run the process. Refer to section 14.4.2 for the command
line parameter used by ID Assign to run the process.

14.9.3 The Mode option is required. A proper mode name must be passed.
Failure Description
Exception Error Code = 0
Exception Error Type = 4
Exception Short Description = The Mode option is required. A proper mode name must be passed.
Exception Description = The Mode option is required. A proper mode name must be passed.
Failure Condition
The mode option m is a mandatory option which must be passed while running the process.

IMS Health Operations Guide Page 172 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Pass the mode option m with valid mode to run the process. Refer to section 14.4.2 for the command
line parameter used by ID Assign to run the process.

14.10 Maintaining Manual Resolution History


This release of Nucleus 360 does not offer a user interface to maintain manual resolutions saved in the
CUS_MANUAL_RESOLUTION_HISTORY table. The following SQL scripts can be used to clean up
manual resolutions. This method of cleanup must be performed only by an Admin user who has a clear
understanding of the consequences.
To remove all DeLink information created for a profile:
SQL> delete from cus_manual_resolution_history where resolution_type_cd =
505102 and profile_id = <profile_id>;
To remove specific DeLink information created for a profile with a customer:
SQL> delete from cus_manual_resolution_history where resolution_type_cd =
505102 and profile_id = <profile_id> and nucleus_id = <nucleus_id>;
To remove the current Link information created for a profile with its customer:
SQL> delete from cus_manual_resolution_history where resolution_type_cd in
(505100, 505101) and profile_id = <profile_id>;

14.11 Restarting the ID Assign Pre-process (Group Match Output)


Before re-starting the ID Assign Pre-process in Manual mode, verify the log file to identify the cause for
the failure and resolve it before restarting the pre-process. Then restart the pre-process using the ONE
Point configuration Manual Process Management Group Match Output.
Note:
This restart procedure is not applicable for real-time mode in which the pre-process is executed as part of
ID Assign.

14.12 Restarting ID Assign


The ID Assign process should always be restarted manually even if it fails in real-time mode. If it was run
in real-time mode, verify the log file to confirm whether the pre-process had completed successfully. The
log file will have the following statements to indicate the start and end of the pre-process.
<Time stamp>::Begin Profile Grouping Package

<Time stamp>::End Profile Grouping Package


If there are no error messages between these two statements, the pre-process completed successfully. If
there are error messages, identify the cause for the failure and resolve it. Then execute the ID Assign
Pre-process using the ONE Point configuration Manual Process Management Group Match Output.
The processes that need to be run manually (in the order specified following) are:
1. Pre ID Assign DB Maintenance
2. ID Assign

IMS Health Operations Guide Page 173 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. Post ID Assign DB Maintenance


4. Reverse Link Creator
5. All tasks for Reverse Data Monitor (e.g. Suffix, ME Number, IMS Number, AOA Number)
6. All tasks for Merge (e.g. EPharma Professional Profile, ePharma Professional Address)
7. Validation Status Export
8. Unlock and Delete Staging Profiles
9. If desired, restart the Real Time Data Processing Services loop

14.13 EXT_MODIFIED_FLG
The following table lists all values and their meaning for the EXT_MODIFIED_FLG column in the
NUC_RESOLUTION_PENDING table.
Equivalent
EXCEPTION_CONDITION_CD
EXT_MODIFIED_FLG Description
from NP_MATCH_OUTPUT
table
0 504400 Regular name and address match
2 504401 Hard Link match
3 504402 No candidates found for the input profile
4 504403 Invalid input profile. One or more required
fields for matching are empty.
5 504404 Merge Hard Link match
6 N/A RDM record. Input and the target profile are
sent for manual resolution without
automatically splitting them to different
NUCLEUS ID.
7 N/A RDM record. Input and the target profile are
already split to different NUCLEUS IDs and
it is sent for manual confirmation.

14.14 ID Assign Resolution Descriptions


When ID Assign resolves a profile, it either moves the profile to the
NUC_RESOLUTION_PENDING_HISTORY table if the profile is automatically resolved, or to the
NUC_RESOLUTION_PENDING table for a Customer Resolution user to resolve it manually. In either
case, it sets a description in the IDASSIGN_DESC column with the details of the resolution action taken
by the process. The following table provides a complete list of descriptions that are set by the ID Assign
batch process.
Note: A record in NUC_RESOLUTION_PENDING or NUC_RESOLUTION_PENDING_HISTORY may
have one or more descriptions appended to it.
No. IDASSIGN_DESC Description
1. Definite graph. All profiles in a graph (Group) are connected with a score greater than
the high threshold.

IMS Health Operations Guide Page 174 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

No. IDASSIGN_DESC Description


2. Mixed graph. Some or all profiles in a graph are connected with a score less than the
high threshold.
3. Assignment rules Automatic resolution of this graph leads to a data source rules violation.
violation.
4. Param 3080 cleanup. An unresolved input profile matches with a score greater than the high
threshold only to a single customer (NUCLEUS_ID).
Since this parameter is enabled, other target profiles having gray area
scores against the unresolved input profile were also deleted from
NUC_RESOLUTION_PENDING, and for the removed pairs this is the
description that is put in the IDASSIGN_DESC field.
5. Param 3079 cleanup. Input profile matches with a score greater than the high threshold only
to its peer profiles and might match to other profiles but not with a score
greater than the High threshold.
Since this parameter is enabled, other target profiles having gray area
scores against the input profile were deleted from
NUC_RESOLUTION_PENDING, and for the removed pairs this is the
description that is put in the IDASSIGN_DESC field.
6. <n> customer(s). The current processing graph has n number of NUCLEUS_IDs. This
explains they type of graph (Group) this pair belongs to.
7. Manual de-link. Low This pair was moved to NUC_RESOLUTION_PENDING_HISTORY
threshold cleanup. table as the OVERRIDE_SCORE is less than the LOW_THRES
defined in NUC_CFG_ASSIGN table.
8. Low threshold cleanup. This pair was moved to NUC_RESOLUTION_PENDING_HISTORY
table as the MATCH_SCORE is less than the LOW_THRES defined in
NUC_CFG_ASSIGN table.
9. DeLinked. A de-link rule exist in CUS_MANUAL_RESOLUTION_HISTORY table
for this input-target profile pair.
10. DeLink history Profiles in the current graph matches high to multiple customers so
prevented multiple they are potential candidates for a merge, but one or more profiles in
customer merge. this graph (group) have de-link rules with potential merge customers.
11. Input profile matches to Input profile matches high to n different customers.
<n> customers.
12. No customer. The current processing graph has no NUCLEUS_ID.
13. Input profile assigned. Input profile is assigned a NUCLEUS_ID.
14. No change in Input profile is already assigned to a NUCLEUS_ID and the current
NUCLEUS Id. resolution did not change it.
15. Multiple customer Profiles in the current graph matches high to multiple customers, but
merge is not enabled. the parameter (3071) to merge multiple customers is disabled.
Informational message.
16. Weak graph. All profiles in a graph are connected with a score less than the low
threshold.
17. Datasource rules Automatic resolution of this graph leads to a Data source rules
violation. violation.
IMS Health Operations Guide Page 175 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

No. IDASSIGN_DESC Description


18. Subset sent to GUI. A subset of a mixed-graph is sent for manual resolution.
19. Largest subset The largest subset of a mixed-graph is resolved automatically and all
resolved. other subsets are sent for manual resolution.
20. Peer profile low score Profiles in a NUCLEUS_ID match to each other with a score less than
match [3069] the HIGH_THRES.
21. Profiles already All profiles in the current processing graph are already resolved to the
resolved to a same same customer.
customer.

14.15 Tables Modified by the Pre-process and the ID Assign Process


Table Name Pre-process ID Assign
NP_MATCH_OUTPUT Yes Yes
NUC_RESOLUTION_PENDING Yes Yes
NUC_RESOLUTION_GUI_QUEUE No Yes
NUC_RESOLUTION_PENDING_HISTORY No Yes
CUS_CUSTOMER No Yes
CUS_CUSTOMER_INFO No Yes
CUS_CUSTOMER_HISTORY No Yes
CUS_MANUAL_RESOLUTION_HISTORY No Yes
NUC_RESOLUTION_GROUP Yes No

IMS Health Operations Guide Page 176 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

15. THE REVERSE LINK CREATOR

15.1 Overview
This process inserts reverse links (opposite pairs of input-target profile IDs) in the
NUC_RESOLUTION_PENDING table. These are required for the Customer Resolution application. If the
NUC_RESOLUTION_PENDING table has profile A and B as unresolved, and profile A has a potential
match with B, then B is implicitly a potential match of A. Sometimes this second relationship, or reverse
link, is not present in the NUC_RESOLUTION_PENDING table because profile B may not have come for
matching at the same time as profile A. The absence of such relationships causes the Customer
Resolution application to produce an incomplete picture of the unresolved queue. To avoid such issues,
this process makes sure such relationships are created.

15.2 Running Reverse Link Creator

15.2.1 Running the Process


The Reverse Link Creator process is implemented in a PLSQL procedure NP_REVERSELINKCREATOR
and it is executed using the runstoredproc utility. A new log file is created for each execution of the
process. An exit code of zero is returned if the process completes successfully; otherwise a non-zero
value is returned.
$cd%DRTE_NP_BIN%
$ runstoredprocs"NP_REVERSELINKCREATOR"

15.2.2 Output Generation


The output of the batch run would be generated in a log file. If the log file has been specified with the -l
option, it will be generated in the specified file name. If the log file is not mentioned, it would be generated
in a file called NP_REVERSELINKCREATOR_YYYYMMDD_HHMISS>.log.
The information in the log file would look like the following:
Start Time: 02:45:04 07/07/2008
End Time: 02:45:04 07/07/2008

PL/SQL procedure successfully completed.


Note: If the log file mentioned in the -l option exists with some information, then the new log information
would be appended to it.

15.3 Analyze Table


After a successful completion of the Reverse Link Creator, the database maintenance package should be
run to rebuild the indexes (optional) and to analyze the tables as specified against PROCESS_ID 16 of
ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database maintenance
package. An exit code of zero 0 is returned if the maintenance package completes successfully;
otherwise a non-zero value is returned.

IMS Health Operations Guide Page 177 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(16)"

15.3.1 Analyze Results


The log file should contain all the information about the records that have been processed. To evaluate
the details in the log file, start the SQL session.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>
Before running the Reverse Link Creator process, you can check the number of records to be processed.
SELECT COUNT(0)
FROM NUC_RESOLUTION_PENDING NRP, CUS_CUSTOMER C
WHERE NRP.TARGET_PROFILE_ID = C.PROFILE_ID(+)
AND C.NUCLEUS_ID IS NULL
AND NRP.SEND_TO_CLIENT_IND = 1
AND NRP.TARGET_PROFILE_ID IS NOT NULL
AND NRP.PROCESS_DT >
(SELECT DATE_VALUE FROM FND_PARAMETER_VALUE WHERE
PARAMETER_ID = 1309)
AND NOT EXISTS
(SELECT INPUT_PROFILE_ID
FROM NUC_RESOLUTION_PENDING NRP2
WHERE NRP2.INPUT_PROFILE_ID = NRP.TARGET_PROFILE_ID
AND NRP2.TARGET_PROFILE_ID =
NRP.INPUT_PROFILE_ID);
The above query can also be used to provide the status of the Reverse Link Creator process while its
running. If the Reverse Link Creator process has no errors and the query returns a value of 0, then the
Reverse Link Creator process is done.
Note: Commit is done after each missing reverse link is inserted.

15.4 Running Reverse Link Creator Process Using ONE Point


Application
The Reverse Link Creator process can be launched using the ONE Point configuration Manual
Process Management. Select Reverse Link Creator from the list of processes and start the process.

15.5 Troubleshooting

15.5.1 When the system parameter 1309 with last run date has not been created
Failure Description
Start Time: 04:21:17 05/07/2015
Aborting, system parameter 1309 (last run dt) does not exist

PL/SQL procedure successfully completed.

IMS Health Operations Guide Page 178 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Failure condition
This condition would occur when the system parameter 1309 has not been created in the system.
Solution
Contact your support team to report the problem.

15.5.2 When any database package is invalid =>


Failure Description
BEGIN NP_REVERSELINKCREATOR; END;
*
ERROR at line 1:
ORA-04068: existing state of packages has been discarded
ORA-04063: package body " NP_REVERSELINKCREATOR " has errors
ORA-06508: PL/SQL: could not find program unit being called
ORA-06512: at line 1
Failure condition
This condition would occur when one of the packages is invalid. The name of the invalid package can be
seen in the error message.
Solution
Recompile the specified package.

15.5.3 Restart Reverse Link Creator


Restart the reverse link creator by following the instructions in section 15.2.

15.6 Restarting the Process


In the event of a failure, the reason for the failure should be identified and resolved first. The Reverse Link
Creator process should always be restarted manually even if it fails in real-mode.
The following processes need to be run manually for the rerun (in the order specified):
1. Reverse Link Creator
2. All tasks for Reverse Data Monitor (e.g. Suffix, ME Number, IMS Number, AOA Number)
3. All tasks for Merge (e.g. ePharma Professional Profile, ePharma Professional Address)
4. Validation Status Export
5. Unlock/Delete Staging Profiles
6. Restart the Real Time Data Processing Services loop if desired

15.7 Tables Modified by Reverse Link Creator Process


NUC_RESOLUTION_PENDING
NUC_RESOLUTION_GUI_QUEUE
IMS Health Operations Guide Page 179 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

16. REVERSE DATA MONITOR (RDM)

16.1 Overview
Profiles that are resolved by the ID Assign process are assigned a NUCLEUS ID. The RDM process
(which can be run anytime after the ID Assign process is completed) detects profiles with conflicting data
conditions in a column (examples: Professional Suffix Mismatch, ME Number Mismatch, IMS Number
Mismatch, AOA Number Mismatch, Organization Type Mismatch, and Organization Subtype Mismatch)
for all profiles that belong to the same customer (NUCLEUS ID).The process is implemented in an Oracle
PL/SQL package NPReverseDataMonitor, which exposes a procedure ReverseCheck to execute it in
Refresh and Incremental modes.

16.1.1 What RDM Does


RDM is used to identify customers (NUCLEUS IDs) that have profiles with conflicting data conditions.
Conflicting profiles can either be resolved to a new customer or sent for manual resolution. As an
example, customers having profiles with different IMS Physician numbers can be detected and resolved
using RDM.

16.1.2 What RDM Requires


The RDM process requires a database configuration that defines the profile conflicting condition. The
following configuration tables are used by the process
NP_CFG_RDM: Parent configuration table for the RDM process. Each configuration in this table
defines a data conflicting scenario and the action to be taken on the affected profiles.
NP_CFG_RDM_CONDITION: Optional configuration table, which is used to trigger a mismatch
between profiles when a NULL or Blank data is compared with a Non-Empty data.
NP_CFG_RDM_DATA_SRC: Optional configuration table, which is used to check profiles within a set
of data sources.
NP_RDM_RUN: Used to execute an RDM configuration in incremental mode by storing the last
execution date of each RDM configuration.
For further information on the configuration tables, please refer to the Configuration Guide.

16.1.3 What Data is Processed by RDM


RDM processes NUCLEUS_IDs that have active profiles with a conflicting data condition as per the RDM
configuration. These NUCLEUS_IDs will be selected for processing if one of the following conditions is
true.
The NUCLEUS_ID has changed since the last run for this configuration. This condition is checked
using the LAST_UPD_DT of the CUS_CUSTOMER_INFO table. This date will be updated when a
profile is added or removed from a NUCLEUS_ID.
At least one active profile in the NUCLEUS_ID has changed since the last run for this configuration.
This condition is checked using the LAST_UPD_DT of the table that is configured to identify
conflicting profiles. As an example, the LAST_UPD_DT field of the CUS_PROFESSIONAL_PROFILE
table is checked if the RDM configuration is created to identify conflicting professional name suffix.

IMS Health Operations Guide Page 180 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

If the process is run in refresh mode, all NUCLEUS_IDs that have active profiles with conflicting data
condition as the RDM configuration being checked will be selected for processing.

16.2 ReverseCheck Procedure


This procedure is used to execute the process for an RDM configuration in either refresh or incremental
mode.
NPReverseDataMonitor.ReverseCheck (configId number,
processingMode number := 0,
dryRun number := 0,
nStartNucleusId number := 0,
nEndNucleusId number := 0);

16.2.1 ReverseCheck Procedure Arguments


Parameter Name Description Type
configId RDM Configuration ID. This should be a valid value from the NUMBER
NP_CFG_RDM table (RDM_CONFIGURATION_ID).
processingMode The parameter has two valid values: (defaulted to 0) NUMBER
1 => Refresh Mode. In this mode all NUCLEUS_IDs are evaluated
for the current RDM configuration being run.
0 => Incremental Mode. In this mode, NUCLEUS_IDs or profiles that
have changed since the last execution of the RDM configuration are
evaluated.
dryRun The parameter has two valid values: (defaulted to 0) NUMBER
1 => Dry run Mode. In this mode conflicting profiles are identified and
populated into CUS_RDM_DRYRUN table. This mode can be used
to perform a test run.
0 => Regular Mode. In this mode conflicting profiles are identified
and appropriate resolution action will be taken as per the RDM
configuration.
nStartNucleusId Specify the start NUCLEUS ID to run the process for a range of NUMBER
customers. This option is valid only when the nEndNucleusId
parameter is used
nEndNucleusId Specify the end NUCLEUS ID to run the process for a range of NUMBER
customers. This option is valid only when the nStartNucleusId
parameter is used.

16.3 Running the Process Using runstoredproc.exe


A new log file will be created each time the process is executed and the file name format is
NPReverseDataMonitor.ReverseCheck_YYYYMMDDHHMISS.log. An exit code of zero 0 is returned by
runstoredproc.exe if the RDM process completes successfully; otherwise a non-zero value is returned.
In the following sample command lines, we have considered a value 2 as the configId argument.
Replace this value with the actual configuration ID when running the RDM process manually through a
command prompt.

IMS Health Operations Guide Page 181 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

To execute the process for configuration ID 2 in incremental mode.


$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPReverseDataMonitor.REVERSECHECK(2)"
To execute the process for configuration ID 2 in refresh mode.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPReverseDataMonitor.REVERSECHECK(2,1)"
To execute the process for configuration ID 2 in incremental dry run mode.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPReverseDataMonitor.REVERSECHECK(2,0,0)"
To execute the process for configuration ID 2 in refresh dry run mode.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPReverseDataMonitor.REVERSECHECK(2,1,0)"
To execute the process for configuration ID 2 in incremental mode for a range of customer 100 and
200.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -s"NPReverseDataMonitor.REVERSECHECK(2,0,0,100,200)"

16.4 Running the Process Using ONE Point


The RDM process can be launched using the ONE Point configuration Manual Process Management
> Reverse Data Monitor. The process can be run by selecting a RDM configuration, either in a refresh
mode or incremental mode. The RDM configurations are also included in the Real Time - Data
Processing Services configurations to enable automatic execution when processing data in real time
mode.

16.4.1 Refresh and Incremental Mode


All active resolved profiles are evaluated in the refresh mode. In the incremental mode, active resolved
profiles that are modified since the last run of the RDM process, or customers that are modified since the
last run of the RDM process are evaluated.

IMS Health Operations Guide Page 182 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

16.4.1.1 Analyzing the Log File


The following process metrics are logged to the log file in a dry run mode.
Process Start Time : 06-08-2006 04:21:31
NUCLEUS IDs Processed : 1000
Profiles Processed : 5560
NUCLEUS IDs Ignored due to Link Rules: 0
New NUCLEUS IDs Created : 200
Profiles Moved to a New Customer : 5500
Profiles sent for Manual Resolution : 0
Process End Time : 06-08-2006 04:25:31
The New Customers Created metrics indicates the number of new NUCLEUS IDs created.
The Profiles Moved to a New Customer metrics indicates the number of profiles that are moved to new
NUCLEUS ID.
The Profiles Sent for Manual Resolution metrics indicates the number of profiles that are sent for manual
resolution by the Customer Resolution GUI user.
The Customers Ignored due to Link Rules metrics indicates the count of NUCLEUS IDs that are skipped
from processing as its profiles are linked to the NUCLEUS ID by the GUI user.

16.4.2 Dry Run


The process can be run in a dry run mode in which the RDM results are saved to the
CUS_RDM_DRYRUN table. They dry run option is used to analyze the results before they are applied to
the core tables.

16.4.2.1 Analyzing the Log File


The following process metrics are logged to the log file in a dry run mode
Process Start Time : 06-08-2006 04:21:31
NUCLEUS IDs Processed : 1000
Profiles Processed : 5560
NUCLEUS IDs Ignored due to Link Rules: 0
New NUCLEUS IDs Created : 200
Profiles Moved to a New Customer : 5500
Profiles sent for Manual Resolution : 0
Process End Time : 06-08-2006 04:25:31
The Potential New Customers metrics indicates the number of new NUCLEUS IDs that would be created
if the process is run in regular mode.
The Impacted Profiles metrics indicates the number of profiles that will be moved to new NUCLEUS ID if
the process is run in regular mode.

16.4.3 Range of Customers


The process can be run for a specific range of customers by specifying the starting and ending NUCLEUS
ID. This option is used to analyze a single customer by specifying a same start and end NUCLEUS ID.

16.5 Analyze Table


After a successful completion of the Reverse Data Monitor, the database maintenance package should be
run to rebuild (rebuilding index is optional) the indexes and to analyze the tables as specified against
PROCESS_ID 17 of ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database
maintenance package. An exit code of zero 0 is returned if the maintenance package completes
successfully; otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%

IMS Health Operations Guide Page 183 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

$runstoredproc -s"pkg_db_maintenance.process_maintenance(17)"

16.5.1 Dry Run Mode


Core tables are not modified in the dry run mode. The results are stored in CUS_RDM_DRYRUN table.

16.6 RDM Resolution Descriptions


When RDM sends a profile for manual resolution it populates the IDASSIGN_DESC column of
NUC_RESOLUTION_PENDING table with the Configuration ID and the Description of the RDM rule. A
complete list of all the descriptions that are set by the RDM process is documented in the table given
below.
No. IDASSIGN_DESC Comments
1. RDM (<ConfigurationID>) Insert. This record in the NUC_RESOLUTION_PENDING table is
<Description> inserted by the RDM process. ConfigurationID and
Description will be substituted with the
RDM_CONFIGURATION_ID and DESCRIPTION read
from NP_CFG_RDM table.
2. RDM (<ConfigurationID>) Update. The reverse combination (Target-Input) of this record in
<Description> the NUC_RESOLUTION_PENDING table was originally
inserted by ID Assign and now it is updated by the RDM
process. ConfigurationID and Description will be
substituted with the RDM_CONFIGURATION_ID and
DESCRIPTION read from NP_CFG_RDM table.
3. RDM (<ConfigurationID>) I-Update. This record in the NUC_RESOLUTION_PENDING table
<Description> was originally inserted by ID Assign/RDM and now it is
updated by the RDM process. ConfigurationID and
Description will be substituted with the
RDM_CONFIGURATION_ID and DESCRIPTION read
from NP_CFG_RDM table.

16.7 Auditing RDM Resolutions


1. Profiles that are sent to the unresolved queue by the RDM process without creating new NUCLEUS
IDs.

select * from nuc_resolution_pending n where n.processed_by_id = 114 and ext_modified_flg =


6;

2. Profiles that are sent to the unresolved queue by the RDM process after assigning a new NUCLEUS
ID for the conflicting profile.

select * from nuc_resolution_pending n where n.processed_by_id = 114 and ext_modified_flg =


7;

3. Total NUCLEUS IDs created by the RDM process.

select count(0) from cus_customer_info c where c.crtn_id = 114;

4. The following query can be used to compare the data of a profile that was assigned a NUCLEUS ID
by the RDM process to profiles in its previous (original) NUCLEUS_ID. This query is applicable only

IMS Health Operations Guide Page 184 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

for customer of type Professionals. Substitute the yellow highlighted ProfileID with the actual profile id
that was moved out by the RDM process.
Note: The Select clause can be modified to include the columns desired.

select distinct
old_dqt.profile_id old_peer_profile_id, new_dqt.profile_id profile_id,
old_dqt.std_suffix old_peer_suffix, new_dqt.std_suffix suffix,
old_dqt.me_num old_peer_me#, new_dqt.me_num me#,
old_dqt.ims_num old_peer_ims#, new_dqt.ims_num ims#,
old_dqt.aoa_num old_peer_aoa#, new_dqt.aoa_num aoa#,
cmrh.notes
from cus_customer new_cc,
cus_customer_history cch,
cus_customer old_cc,
cus_manual_resolution_history cmrh,
dqt_professional_profile old_dqt,
dqt_professional_profile new_dqt
where new_cc.profile_id = :ProfileID
and new_cc.crtn_id = 114
and new_cc.profile_id = cch.profile_id
and old_cc.nucleus_id = cch.old_nucleus_id
and old_dqt.profile_id = old_cc.profile_id
and new_dqt.profile_id = new_cc.profile_id
and cmrh.profile_id = new_cc.profile_id
and cmrh.crtn_id = 114
and cmrh.resolution_type_cd = 505102
and cmrh.nucleus_id = old_cc.nucleus_id;

5. The following query can be used to compare the data of a profile that was assigned a NUCLEUS ID
by the RDM process to profiles in its previous (original) NUCLEUS_ID. This query is applicable only
for customer of type Organizations. Substitute the yellow highlighted ProfileID with the actual profile id
that was moved out by the RDM process.
Note: The Select clause can be modified to include the columns desired.

select distinct
old_dqt.profile_id old_peer_profile_id, new_dqt.profile_id profile_id,
old_dqt.org_type_cd old_peer_org_type_cd, new_dqt.org_type_cd org_type_cd,
old_dqt.org_subtype_cd old_peer_org_subype_cd, new_dqt.org_subtype_cd org_subtype_cd,
cmrh.notes
from cus_customer new_cc,
cus_customer_history cch,
cus_customer old_cc,
cus_manual_resolution_history cmrh,
dqt_organization_profile old_dqt,
dqt_organization_profile new_dqt
where new_cc.profile_id = :ProfileID
and new_cc.crtn_id = 114
and new_cc.profile_id = cch.profile_id
and old_cc.nucleus_id = cch.old_nucleus_id
and old_dqt.profile_id = old_cc.profile_id
and new_dqt.profile_id = new_cc.profile_id
and cmrh.profile_id = new_cc.profile_id
and cmrh.crtn_id = 114
and cmrh.resolution_type_cd = 505102
and cmrh.nucleus_id = old_cc.nucleus_id;

16.8 Restarting the Process


In the event of a failure, the reason for the failure should be identified and resolved first. The RDM
process should always be restarted manually even if it fails in real-mode.
The processes that need to be run manually (in the same order and with the same options as specified
below) are:
All tasks for Reverse Data Monitor (e.g. Suffix, ME Number, IMS Number, AOA Number)
All tasks for Merge (e.g. EPharma Professional Profile, ePharma Professional Address)
IMS Health Operations Guide Page 185 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Validation Status Export


Unlock/Delete Staging Profiles
Restart the Real Time Data Processing Services loop if desired

16.9 Tables Modified by RDM Process


This section explains the tables that are affected by the RDM process in various processing modes.
Table Name Description Automatic Send for Resolve
Resolution Manual automatically and
Resolution Send for Manual
Resolution
CUS_CUSTOMER Profiles that are moved YES NO YES
to a new customers are
created in this table
CUS_CUSTOMER_INFO New customers are YES NO YES
created in this table
CUS_CUSTOMER_HISTORY Profiles that are moved YES NO YES
to the new customers
are audited in this table
by the Old NUCLEUS
ID
CUS_MANUAL_RESOLUTION_HI Existing link rules for YES NO YES
STORY the profiles that are
moved to a new
customer are cleaned
up from this table. New
de-link will be created
as per the configuration.
NUC_RESOLUTION_PENDING Conflicting profiles are NO YES YES
entered in this table with
a score of 98
NUC_RESOLUTION_GUI_QUEUE The queue table is NO YES YES
synchronized to include
the conflicting profiles
NP_MATCH_PENDING Profiles to be re- YES NO YES
matched are created
here. Re-matching is
RDM configuration
specific.
NP_RDM_RUN This table is updated YES YES YES
with the last execution
date of a RDM
configuration. Each
RDM configuration will
have one entry in this
table.

IMS Health Operations Guide Page 186 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

17. THE STANDARDIZER

17.1 Overview
The Standardizer is a standalone process that should be run exclusively in manual mode to re-
standardize the data that has already been processed in the Nucleus 360 system. This encompasses
Professional name, Organization name, Addresses, Secondary ID data, and Communication data. This
process is not embedded in any other application.
Note: This process should not be run when the Data Import process runs in batch (third party data source
import) or in real-time mode (SFA real-time XML message import).

17.1.1 What Standardizer Does


Using this system, individual entities like professional names, organization name, Addresses, Secondary
ID data, and Communication data can be reprocessed separately depending on the requirements. This
process uses the data existing in the raw fields of core tables for each entity and updates the STD fields
with newly generated standard values. Note that since the process uses existing raw data to derive
standard values, it should be used only for data sources and entities that are solely standardized bad on
available database based raw fields. Some times virtual fields are created while loading data sources or a
combination of columns is used, such conditions cannot be accounted for by this process.

17.1.2 What Standardizer Requires


The Standardizer process requires data in core tables for re-standardizing the data using the modified
pattern sets and IACE configuration files. This process will not update the database values if it finds no
difference between the new and the existing standardized data. The standardized data can also be stored
in the below temporary tables and can be used to update the core tables later. Following are the
temporary tables.
Temporary Table Name Contents Description
STG_RESTD_PROFESSIONAL Professional details such as Name, Prefix, Suffix, and Job title
STG_RESTD_PROFESSIONAL_ Professional degree that appears in the name
DEGREE
STG_RESTD_ADDRESS Professional/Organization address
STG_RESTD_ORGANIZATION Organization Name and Plan details
STG_RESTD_SECONDARY Secondary Details
STG_RESTD_COMMUNICATION Communication details

17.2 Command Line Parameters/Usage


npstandardize [-?] [-v] [-V] -l<file> [-c<file>] [-d<level>] [-n] [-
p<profileid>] [-r] [-P] [-O] [-A] [-S] [-C] [-t] [-q<file>] [-x] [-
m<mapping id>]

IMS Health Operations Guide Page 187 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Option Description
-? Help
-v Version Information
-V Extended Version Information
-c Database configuration file
-d Debug Level, 0 to 4. Default is 1 (Log Errors Only).
-P Standardize professional names
-O Standardize organization names
-A Standardize addresses
-C Standardize Communication
-S Standardize Secondary
-r Triggers re-matching if standardized values are different
-t Saves the results in temporary tables
-l Saves the results in a log file with the name indicated (you must also specify a name for the
log file)
-x Applies standardized professional data from the temporary table to
CUS_PROFESSIONAL_PROFILE table
-p Standardizes one profile (you must also include the Profile ID)
-q Query File
-n Dry Run. Do not commit transactions
-m Mapping ID

17.3 Running the Standardizer


The following options can be specified:
To standardize all Professional names and trigger re-matching if values are different:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log P r m10
To standardize Addresses and trigger re-matching if values are different:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log A r
To standardize Organization and Plan names and trigger re-matching if values are different:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log O r m10
To standardize Secondary and trigger re-matching if values are different:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log S r m10

IMS Health Operations Guide Page 188 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

To standardize Communication and trigger re-matching if values are different:


$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log C r m10
To standardize Professionals and Addresses and save the results in the temporary tables:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log P -A t m10
To apply standardized Professional data from the temporary table to
CUS_PROFESSIONAL_PROFILE table:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log P x
To standardize one profile, use the -p option along with the profile ID:
$ cd %DRTE_NP_BIN%
$ npstandardize lstandardize.log P -p10 m10

17.3.1 Output
Standardization metrics are logged in the log file named using the -l option. If the -t option is used, and
then the standardized output will be saved in the appropriate temporary tables.

17.4 Running Standardizer Using ONE Point Application


The Standardizer process can be launched using the ONE Point configuration, Manual Process
Management. Select Re-Standardizer from the list of processes as shown below. Mapping ID need to be
passed and from the drop down box, the values can be changed as required.

IMS Health Operations Guide Page 189 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

17.5 Analyze Tables


After the Standardizer process is done, analyze the tables it updated as follows:
$ cd %DRTE_NP_BIN%
$ runstoredproc -s"pkg_db_maintenance.process_maintenance(107)"

17.6 Troubleshooting
Refer to Appendix B for any database-related error messages.
Refer to Appendix E for ACE/IACE errors.

17.6.1 Printing Results on Screen Using the -N Option


This option can be used to verify the results before applying them to the database.
Cd %DRTE_NP_BIN%
npstandardize -lrestd.log -n -p10 A

Raw Address
Profile Id :10
Address Id :12
Address Line1 :2510 CALDWELL AVE S APT K2
Address Line2 :
Address Line3 :
City :BIRMINGHAM
State code :AL
Postal code :35205
Postal code ext:2520

Standardized Address
Address Line1 :2510 CALDWELL AVE S APT K2
Address Line2 :
Address Line3 :
City :BIRMINGHAM
Mailing City :BIRMINGHAM
State code :AL
Postal code :35205
Postal code ext:2520
Firm name :
ACE status code:S00000
ACE error code :

Restandardized Address
Address Line1 :2510 CALDWELL AVE S APT K2
Address Line2 :
Address Line3 :
City :BIRMINGHAM
Mailing City :BIRMINGHAM
State code :AL
Postal code :35205
Postal code ext:2520
Firm name :
ACE status code:S00000

IMS Health Operations Guide Page 190 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

ACE error code :

17.6.2 Standardize Prof/Org task is not found


Failure Description
NPStandardizerApp::run()| Standardize Prof/Org task is not found. This task is required to re-standardize
professional/organization profiles.
Failure Condition
This error occurs when there is no standardize Prof/Org task defined for the mapping and Re-
Standardizer is run. Re-Standardizer does not support multi-input standardization task.
Solution
Re-Standardizer is not applicable for this mapping. Or create standardize Prof/Org task as required and
then try running Re-Standardizer.

17.6.3 Standardization type required.


Failure Description
Standardization type like P (Professional), -O (Organization), -A (Address), -S (Secondary) or C
(Communication) is a mandatory option.
Failure Condition
This error occurs when no standardization type as mentioned above is passed while running the process.
Solution
Pass one of the standardization types as required while running the process. Refer to section 17.2 for the
command line parameter used by Standardizer to run the process.

17.6.4 The Log file name is required


Failure Condition
This error occurs when the log file name is not passed which is a mandatory option.
Solution
Provide the logging option l with the log file name. Refer to section standardize Prof/Org task defined
for the mapping and Re-Standardizer is run. Re-Standardizer does not support multi-input standardization
task.
Solution
for the command line parameter used by Standardizer to run the process.

17.7 Restarting the Process


In the event of a process failure, the cause for the failure should be identified and resolved first. Restart
the Standardizer process.

IMS Health Operations Guide Page 191 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

17.8 Tables Modified by Standardizer Process


This section explains the tables that are affected by the Standardizer process for each entity.
Table Name Description Entity Name
Core table which holds Professional
CUS_PROFESSIONAL_PROFILE details such as Name, Prefix, Suffix, and Professional
Job title
Core table which holds
CUS_ADDRESS Address
Professional/Organization address
Core table which holds Organization
CUS_ORGANIZATION_PROFILE Organization
Name and Plan details
Secondary
CUS_SECONDARY_ID_XREF Core table which holds Secondary Details
Identifiers
Core table which holds Communication
CUS_COMMUNICATION_PROFILE Communication
details
Temporary staging table to store the
STG_RESTD_ADDRESS Address
standardized address data for review.
Temporary staging table to store the
STG_RESTD_COMMUNICATION standardized communication data for Communication
review.

Temporary staging table to store the


STG_RESTD_ORGANIZATION standardized organization details data for Organization
review.

Temporary staging table to store the


STG_RESTD_PROFESSIONAL standardized professional details data for Professional
review.
Temporary staging table to store the
STG_RESTD_PROFESSIONAL_D
standardized professional degree data for Degree
EGREE
review.
Temporary staging table to store the
Secondary
STG_RESTD_SECONDARY standardized secondary identifier data for
Identifiers
review.

IMS Health Operations Guide Page 192 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18. PRACTITIONER VERIFICATION


Practitioner Verification batch processes are composed of the following modules:
Export of practitioners to validation vendor.
Import of practitioners from validation vendor.
Export of practitioners to an external system (such as Sample Guardian).
Import of authorization forms from an external system (such as Sample Guardian).
Import of state eligibility rules from an external system (such as Sample Guardian).
Mid-level authorization form validation.
Application of state eligibility status rule changes.
Internal re-verification of practitioners.

Figure 11. Practitioner Verification batch process modules

18.1 Exporting Practitioner to Validation Vendor


Practitioner Verification Export business rules packages are executed first to identify practitioners for
extraction. Identified practitioners are created in a file, which is sent to the validation vendor.
The Export Business rules package executes the following tasks:
1. Runs the annual re-verification process to populate the CUS_STG_BP_VERIFICATION_QUEUE
table.
2. Runs the reconciliation process to aggregate practitioners from the following staging queue tables:
CUS_STG_UI_VERIFICATION_QUEUE
CUS_STG_BP_VERIFICATION_QUEUE
CUS_STG_DL_VERIFICATION_QUEUE
3. Applies client-specific rules to exclude practitioners from the extract. Practitioners that do not comply
with the extract rules are rejected and are stored in the CUS_STG_VERIFICATION_ERROR table.
IMS Health Operations Guide Page 193 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

4. Populates practitioner details that are to be sent to the verification vendor into the
STG_VERIFICATION_EXPORT table.
Creating the practitioner file for validation vendor
A file is created from practitioner details that are stored in the STG_VERFICATION_EXPORT table. Once
a profile is successfully exported to the validation vendor, it is moved to the table
CUS_VERIFICATION_PROFILE using the package NPPracVerStgMaint.

18.1.1 Running the Practitioner Verification Export

$ cd %DRTE_NP_BIN%
$ run_pracver -export -file=<file name>

Executing the command displays the name of the log file


$ Logging to $DRTE_NP_LOGS/pv_export_YYYYMMDD_HHMISS.log

18.1.2 Populating CUS_VERIFICATION_PROFILE Table


After the export process completes, verify whether the practitioner file has been created successfully.
Upon successful creation of the file, practitioner records that are sent for verification must be moved to
the CUS_VERIFICATION_PROFILE table.

$ cd %DRTE_NP_BIN%
$ run_pracver --stgexp-to-vfxn

18.1.3 Executing the Export Business Rule Packages


The Practitioner Verification Export process can be run without creating the file. This option will run only
the business rule packages.

$ cd %DRTE_NP_BIN%
$ run_pracver --export --skip-file-processing

18.1.4 Creating the Practitioner File for Validation Vendor


The Practitioner file for the validation vendor can be created without executing the business rule
packages. This option can be used if the file creation was not successful or if the file creation option was
skipped during export.

$ cd %DRTE_NP_BIN%
$ run_pracver --create-file -file=<file>

IMS Health Operations Guide Page 194 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18.1.5 Creating the Practitioner File using NPImportExport


The script encapsulates numerous tasks associated with generating the Practitioner Verification file for
the validation vendor. To strictly generate the file for a verification vendor using a simple command-line
process, execute the following command:

$npimportexport -lLogResults.log -p1 -fpracver_export.cfg -t1


-opracver_export_data.txt -SNUCLEUSPHARMA -F1000
-bBadRecFile.bad -d4

18.2 Importing Practitioners from Validation Vendor


The import module performs the following tasks:
1. Loads the practitioner file into STG_VERIFICATION_IMPORT table.
Practitioner file from the validation vendor is loaded into the
STG_VERIFICATION_IMPORT table.
2. Executes Import business rules packages.
Moves records from STG_VERIFICATION_IMPORT table to
CUS_VERIFICATION_PROFILE table.
Derives sampling status for imported practitioners.
Populates Sample eligibility tables, SAM_PROFILE_SAMPLE_ELIGIBILITY and
SAM_PROFILE_DEA_SAMPLE_ELIGIB.

18.2.1 Executing Practitioner Verification Import


This option imports a practitioner file from the validation vendor into the Nucleus 360 system and
validates the imported practitioners by executing the Import business rule packages.

$ cd %DRTE_NP_BIN%
$ run_pracver --import --file=file.txt

Executing the command displays the name of the log file


$ Logging to %DRTE_NP_LOGS%\pv_import_YYYYMMDD_HHMISS.log

18.2.2 Executing Practitioner Verification Import Business Rule Packages


This option can be used to process practitioners that are already loaded from the file but are not
validated. This will not load the practitioner file.

$ cd %DRTE_NP_BIN%
$ run_pracver --import --skip-file-processing

IMS Health Operations Guide Page 195 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18.2.3 Loading the Practitioner File from Validation Vendor


This option is used to load to the practitioner file into the STG_VERIFICATION_IMPORT table. Import
business rule packages are not executed.

$ cd %DRTE_NP_BIN%
$ run_pracver --load-file -file=<file name>

18.2.4 Loading the Practitioner File Using NPImportExport


To load the practitioner file from the validation vendor using a simple command-line process, the following
command can be executed:

$ npimportexport -lLogResults.log p0 fpracver_import.cfg


-t1 -SNUCLEUSPHARMA -F1000 -bbadrecfile.bad -d4

1. After this process is completed, analyze the table to gather various statistics that are used by Oracle
to perform data fetching more efficiently. Execute the following command:
$ cd %DRTE_NP_BIN%
$ runstoredproc -spkg_db_maintenance.process_maintenance(38)

18.2.5 Verifying Mid-level Practitioners with Restricted Status


Mid-level practitioners are validated only after validating the authorizing physicians. The Import process
defers verifying mid-level practitioners by storing them in the re-verification queue-table,
CUS_STG_REVERIFICATION_QUEUE. After successful completion of the import process, type the
following command to validate for mid-level practitioners that have a Restricted status.

$ cd %DRTE_NP_BIN%
$ run_pracver --reverification

Executing the command displays the name of the log file


$ Logging to %DRTE_NP_LOGS%\pv_reverification_YYYYMMDD_HHMISS.log

18.3 Practitioner Export to an External System (such as Sample


Guardian)
The Practitioner Verification export process is used to export practitioners that have been validated based
on the rules defined in the Practitioner Verification system. Two options exist for exporting practitioners:
(a) full refresh of the entire universe or (b) export of selected practitioners based on records defined in a
queue table.
In the Selected Practitioners mode, only selected practitioners are exported automatically based on
practitioners that have been added or changed since the last time the process was executed. In the Full
Refresh mode, the last run date is not taken into consideration. Extra precautions should be taken when
executing the process in different modes.

IMS Health Operations Guide Page 196 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18.3.1 Practitioner Verification Full Refresh Export


Executing the process in this mode will extract all validated practitioners that are present in the Nucleus
360 system.
The export process is executed in two steps as follows:
1. Generate an export file for all practitioners that meet the export criteria.
$ npimportexport -llogfile.log -p1
-fpractitioner_verification_full_refresh.cfg -t0
-oprac_ver_full_refresh_output.txt-SAVNP -F5000 -bbadrecfile.bad -d4
2. Calculate and add a header record to the output file to ensure data integrity.
$ write_header -f=prac_ver_full_refresh_output.txt

18.3.2 Queue-based Practitioner Verification Export


Executing the process in this mode will export only those practitioners that are present in the
STG_VALIDATION_PROF_EXT_QUEUE table. Prior to the actual export, the
PKG_VALIDATION_PROF_EXT_QUEUE package is executed to populate
STG_VALIDATION_PROF_EXT_QUEUE table with any practitioners that have been added (or validated)
since the last time this process was executed.
The export process is executed in two steps as follows:
1. Generate an export file for all practitioners that meet the export criteria.
$ npimportexport -llogfile.log -p1
-fpractitioner_verification_queue_based_update.cfg -t0
-oprac_ver_queue_based_output.txt -SAVNP -F5000 -babcd.bad -d4
2. Calculate and add a header record to the output file to ensure data integrity.
$ write_header -f=prac_ver_queue_based_output.txt

18.4 Authorization Form Import


This process will import only those authorization forms from an external systems (such as Sample
Guardian) SAM_AUTHORIZATION_FORM table that are present in the staging table
STG_AUTHORIZATION_FORM since the last time this process was executed.
$ npimportexport -lLogResults.log -p2 -fsignature_auth_form.cfg -t1
-SSAMPLEGUARDIAN -DAVNP -F1000 -bBadRecFile.bad -d4

18.5 State Eligibility Rules Import from an External System


This process will import state eligibility rules from external systems (such as Sample Guardian)
SAM_STATE_ELIGIBILITY_RULE table.
$ npimportexport -lLogResults.log -p2 -fsam_state_ell_rule.cfg -t1
-SSAMPLEGUARDIAN -DAVNP -F1000 -bBadRecFile.bad -d4

IMS Health Operations Guide Page 197 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18.6 Authorization Form Validation


This process performs the following tasks:
1. Internally re-verifies mid-level practitioners, whose sampling status is Active but the authorization
form has expired.
2. Internally re-verifies mid-level practitioners, whose sampling status is Active but the authorizing
physicians status is Inactive.
$ cd %DRTE_NP_BIN%
$ run_pracver --validate-authform

18.7 Apply State Eligibility Status Changes


This process identifies the state eligibility status changes and triggers practitioners for internal/external re-
verification. Any change to the state eligibility status is recorded in the
STG_STATE_ELIGIBILITY_SUMMARY table.
$ cd %DRTE_NP_BIN%
$ run_pracver --apply-state-eligib-changes

18.8 Internal Re-verification


Practitioners sampling statuses can be re-verified internally by populating them in the
CUS_STG_REVERIFICATION_QUEUE table. Execute following command after populating the re-
verification queue table:
$ cd %DRTE_NP_BIN%
$ run_pracver --reverification

18.9 Verification Status Batch Export


Practitioner sampling and DEA statuses are published to the Integration Server using a PL/SQL stored
procedure, NPCMCustVerStatusExport.exportStatus. This procedure runs in an incremental mode to
publish the status changes since the last execution. The last execution date is stored in the
FND_EXTRACT_RUN_LOG table.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe sNPCMCustVerStatusExport.exportStatus

18.10 Troubleshooting

18.10.1 TNS:could not resolve service name


Failure Description
ORA-12154: TNS:could not resolve service name
Failure Condition
Invalid HOSTID in the dbcfg.txt file
Solution
Check the HOSTID in the dbcfg.txt file and run the process again
IMS Health Operations Guide Page 198 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

18.10.2 invalid username/password; logon denied


Failure Description
ORA-01017: invalid username/password; logon denied
Failure Condition
Invalid USERNAME/PASSWORD in the dbcfg.txt file
Solution
Check the USERNAME/PASSWORD in the dbcfg.txt file and run the process again

18.10.3 Process failure during PV export


Failure Description
The PV export process may fail due to unexpected errors such as network failure, stopped database and
so on.
Failure Condition
The exact nature and condition of such failures cannot be predicted.
Solution
Check the process log file to see in which step the process failed and restart the export process again.
Check section 18.11 for restarting the practitioner verification export process.

18.10.4 Process failure during PV import


Failure Description
The PV import process may fail due to unexpected errors such as network failure, stopped database and
so on.
Failure Condition
The exact nature and condition of such failures cannot be predicted.
Solution
Check the process log file to see in which step the process failed and restart the import process again.
Check section 18.12 for restarting the practitioner verification import process.

18.11 Restarting Practitioner Verification Export Process


The following are the steps to be followed to restart the practitioner verification export process in case of
failure.
1. Check the process log file to see in which step the process failed.
2. If the export process has failed before or after the npimportexport process, go to step 6.
3. Otherwise, if the export process has failed in the npimportexport process, then from SQL Plus,
execute the following query:
SQL> select count(0) from stg_verification_export where transaction_type <>
'E';
4. If the above query returns a count 0, the extract file has already been generated; go to step 6

IMS Health Operations Guide Page 199 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

5. If the query returns a count other than 0, it means either of the following:
a. The process failed before generating the file, go to step 6
b. The process failed while generating the file, go to step 7
2. Re-run the complete Export cycle.
3. For scenario 5.b:
a. A partially generated file will be present in %DRTE_THIRD_PARTY%\np\out\validation
b. Re-run the complete Export cycle and merge the newly generated file with the one in the previous
step using the following commands
$ cd %DRTE_THIRD_PARTY%\np\out\validation
$ copy /B <7a>.out + <7b>.out <merged>.out

18.12 Restarting Practitioner Verification Import Process


The following are the steps to be followed to restart the practitioner verification import process in case of
failure.
1. Check the process log file to see in which step the process failed.
2. If the import process has failed before or during the npimportexport process, then execute the
following query in SQL plus and re-run the complete Import cycle.
SQL> DELETE FROM STG_VERIFICATION_IMPORT WHERE EXT_VERIFICATION_TRANS_ID NOT
IN
(SELECT CSVE.EXT_VERIFICATION_TRANS_ID FROM CUS_STG_VERIFICATION_ERROR CSVE,
STG_VERIFICATION_IMPORT SVI WHERE
CSVE.EXT_VERIFICATION_TRANS_ID = SVI.EXT_VERIFICATION_TRANS_ID
AND TO_CHAR(SVI.PROCESS_DT,'MM/DD/YYYY HH24:MI:SS') BETWEEN
TO_CHAR(TO_DATE('<START_DATE>', 'MM-DD-YYYY HH24:MI:SS'),'MM/DD/YYYY
HH24:MI:SS') AND
TO_CHAR(TO_DATE('<END_DATE>', 'MM/DD/YYYY HH24:MI:SS') ,'MM/DD/YYYY
HH24:MI:SS'));
SQL> commit;
<START_DATE> : The Start Date : MM-DD-YYYY HH24:MI:SS logged for process
name : npimportexport process in pv_import_timestamp.log file created by
pracver import process is the date to be replaced for <START_DATE> in the
above query.

<END_DATE> : The End Date : MM-DD-YYYY HH24:MI:SS logged for process


name : npimportexport process in pv_import_timestamp.log file created by
pracver import process is the date to be replaced for <END_DATE> in the
above query.

Note 1: Executing the above query will delete only the profiles that were failing to get imported into the
cus_verification_profile during the last pracver import process leaving behind the other profiles in the
stg_verfication_import table.
Note 2: The import process can also be restarted without executing the above query. But to avoid re-
processing the records accumulated in the staging table (SVI) to CVP, it is necessary to run the above
delete query before restarting the import process.

IMS Health Operations Guide Page 200 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

1. If the import process has failed after the npimportexport process, execute the following query to get
the total number of records failed during this process:
SELECT COUNT(0)
FROM CUS_STG_VERIFICATION_ERROR CSVE, STG_VERIFICATION_IMPORT SVI WHERE
CSVE.EXT_VERIFICATION_TRANS_ID = SVI.EXT_VERIFICATION_TRANS_ID
AND TO_CHAR(SVI.PROCESS_DT,'MM/DD/YYYY HH24:MI:SS') BETWEEN
TO_CHAR(TO_DATE('<Start Date>' , 'MM-DD-YYYY HH24:MI:SS'),'MM/DD/YYYY
HH24:MI:SS') AND
TO_CHAR(TO_DATE('<End Date>' , 'MM-DD-YYYY HH24:MI:SS'),'MM/DD/YYYY
HH24:MI:SS')
Note:
<Start Date> - In pv_import_timestamp.log file created during the pracver
import process the date logged for the message PracVer custom staging table
maint process start is the start date to be provided in the above query for
<Start Date>

<End Date> - pv_import_timestamp.log file created during the pracver import


process the date logged for the message PracVer custom staging table maint
process end is the date to be provided in the above query for <End Date>

2. Now execute the following command to process the failed records from
STG_VERIFICATION_IMPORT table:
$ cd %DRTE_NP_BIN%
$ run_pracver --import --skip-file-processing
Note: Zipping and archiving of the import file cannot be done in this scenario since the input file would
have already been deleted even though the process failed midway.

18.13 Restarting Annual Re-Verification Process


If the Annual Re-verification process fails or crashes in the middle of its execution, the reason for the
failure should be identified and resolved first. After resolving the cause for the failure, the process can be
restarted from the beginning using the command line or ONE Point interface.

IMS Health Operations Guide Page 201 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

19. PRACTITIONER VERIFICATION (PRACVER) REAL-TIME MODE


Practitioners are verified in a real-time mode by publishing the practitioner data to the output message
queue NP_PV_OUT_Q. Verified data is received back from the verification vendor through the input
message queue NP_PV_IN_Q.
Export Service NPPracVarXtPublisher
Import Service NPPracverDataImport

19.1 Starting PracVer Services


Xtelligent services are used to publish and read messages from PracVer queues. These services are
configured in ONE Point Console under the Real Time PracVer Services configuration. To start the
services, right-click the configuration and click the Start option. The service icon turns green after the
service is started successfully.

19.2 Stopping PracVer Services


To stop the services, right-click the configuration and click the Stop option. The service icon turns gray
after the service is stopped successfully.

19.3 Troubleshooting

19.3.1 Unable to Stop Service


If ONE Point Console is not able to stop the service or if the console is closed before stopping the service,
then active services can be stopped using Windows Services window.
1. Click the Windows Start button, and select Settings and then select Control Panel to open the
Windows Control Panel.
2. On the Control Panel window, double-click Administrative Tools.
3. On the Administrative window, double-click Services to open the Services window.
4. Right-click the service name and then click the Stop option.

19.3.2 Export data not moved from XTTRANSACTION_TABLE_1 to NP_PV_OUT_Q


Queue
Failure Description
Check XT_LOGS table for the failure description. The description would be:
Failed to configure queue processor
Failure Condition
This could happen when Practitioner Verification Queues are not installed or the NPPracVarXtPublisher
configuration file is not configured properly.
Failure Solution
Follow the server layer instructions to create Practitioner Verification queues and configure the
NPPracVarXtPublisher configuration file.
IMS Health Operations Guide Page 202 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20. CONSOLIDATED CUSTOMER VIEW (CCV)

20.1 Overview
Consolidated Customer View represents the Best Customer view that is generated from the customer
details that are available through different data sources for a NUCLEUS ID. Nominees for the Best
Customer are configured and prioritized in the Nucleus 360 configuration tables. Records and fields can
also be excluded from the process by defining them in the exclusion tables. The exclusion rules
supersede all the inclusion rules. Field-level exclusion is supported only for customer details such as
Name, Suffix, or Prefix. This package exposes methods to process a single customer and to process all
customers.
The CCV process can run from either the Customer Maintenance GUI for a particular customer or from
the batch process for a range of customers.
During CCV process, data generated for CCV can be exported to other systems. There are many
methods of exporting this data as flat file and also also different purposes of exporting.
1. Standard delimeted flat file export (Complete CCV data)
2. AggregateSpend360 export.
3. Mobile Intelligence export.
4. Data is exported to Xtelligent tables for COM export queue system.

20.2 Enabling Standard delimeted export


Logon to Config assistant tool and navigate to system configuration CCV configuration, here under
Professional/Organization configuration properties you can find the Standard delimeted export
configuration checkbox. To enable this configuration this should be checked.

IMS Health Operations Guide Page 203 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20.3 Enabling AggregateSpend360 Data Export


Open CCV configuration in Config Assistant tool, you can find the AggregateSpend360 Export checkbox
under Professional/Organization configuration properties. This should be checked to enable
AggregateSpend360 Export.

20.4 Enabling Mobile-Intelligence Data Export


Open CCV configuration in Config Assistant tool, you can find the Mobile Intelligence Export checkbox
under Professional/Organization configuration properties. This should be checked to enable Mobile
Intelligence Export.

20.5 Running CCV

20.5.1 NPBestCustomer.IdentifyNucleusIDs for incremental processing


Procedure IdentifyNucleusIDs is to identify NUCLEUS_IDs for CCV incremental processing. This
procedure populates the STG_CUS_CUSTOMER table with the NUCLEUS_IDs for which the CCVs
should be reprocessed.
NUCLEUS IDs that satisfy any of the following conditions will be selected by this procedure for CCV
processing.
1) A profile is added to the NUCLEUS_ID group after the CCV was last processed.

IMS Health Operations Guide Page 204 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2) A profile is updated to the NUCLEUS_ID group after the CCV was last processed.
3) A profile is moved out of the NUCLEUS_ID group after the CCV was last processed.
4) A profile received validation response from external system after the CCV was last processed.

Procedure parameters
nOrgConfigId CCV Organization configuration ID
nProfConfigId CCV professional configuration ID
NumberOfOrgGroups Total number of organization groups to be created. GroupID starts from 1
NumberOfProfGroups Total number of professional groups to be created GroupID starts from 11

20.5.2 RunCCV.exe
RunCCV.exe is a windows application to invoke the CCV process in multiple threads, one thread per
NUCLEUS_ID. Number of concurrent threads is configurable via command line.
STG_CUS_CUSTOMER table should be populated with NUCLEUS_IDs before running CCV. CCV will be
computed only for these NUCLEUS IDs. NUCLEUS_IDs in STG_CUS_CUSTOMER should be divided
into groups. Minimum of 3 groups for professional and 3 groups for organization is recommended.
NUCLEUS_IDs in a group should be of either of type professional or organization. A single group should
not include both professional and organization type of customers.
NOTE: The NPBestCustomer.IdentifyNucleusIDs method can be used to populate the
STG_CUS_CUSTOMER table with processed_ind 0.

20.5.2.1 run_ccv.exe
A new run script is created to instantiate multiple copies of the RunCCV.exe process, by assigning each
instance a specific Group ID from STG_CUS_CUSTOMER table. This script should be run once for CCV
organizations and then for professionals.
$ cd %DRTE_NP_BIN%
$ run_ccv.exe p=<Profile_Type> -c=<Configuration_ID> -t=<No. of threads>
Once a NUCLEUS_ID is processed, PROCESSED_IND in STG_CUS_CUSTOMER table will be set with
indicator 1.

20.5.3 Structure of NPBestCustomer.RealTimeProcess()


Realtime process writes the CCV data for the incremental profiles which got inserted/updated recently or
the profiles which received the response from external system after the last CCV run .
FND_EXTRACT_RUN_LOG table maintains the last run ccv date for each CCV configurations.

(tUserId NPDataTypes.t_UserId,
nBuffersize PLS_INTEGER DEFAULT 100,
nConfigID Npdatatypes.t_ConfigurationId Npdatatypes.t_ConfigurationId

IMS Health Operations Guide Page 205 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20.5.4 Structure of NPBestCustomer.batchProcess()


PROCEDURE batchProcess is used to refresh the CCV data for specific range NucleusIDs which is
passed in the parameter.

(tUserId NPDataTypes.t_UserId,
nRefresh NPDataTypes.t_Indicator DEFAULT 0,
nBuffersize PLS_INTEGER DEFAULT 100,
nStartNucId NPDataTypes.t_NucleusId DEFAULT NULL,
nEndNucId NPDataTypes.t_NucleusId DEFAULT NULL
nProcessAllComponents NPDataTypes.t_Indicator DEFAULT 0
nConfigID Npdatatypes.t_ConfigurationId DEFAULT 0
nGroupID NUMBER

Parameter Name Description Type


TuserId User ID. The User details can be found NPDataTypes.t_UserID or NUMBER(5)
in fnd_sys_user table.
Nrefresh If a value of 1, then perform CCV NPDataTypes.t_Indicator or NUMBER(1)
processing unconditionally.
If a value of 0, then process CCV only
if a non-CCV profile has been changed
since last run.
Note: It has a default value of 0
nBufferSize Commit interval. PLS_INTEGER
Note: It has a default value of 1000
NstartNucId Specify NUCLEUS_ID range. If no NPDataTypes.t_nucleus_ID or
values are passed, then it will process NUMBER(9)
NendNucId
for all the customers. Different
NUCLEUS_IDs can be found in
cus_customer_info table.
nProcessAllComp Default value 0, to process the NPDataTypes.t_Indicator or NUMBER(1)
onents components that are configured in the
CCV configuration.
Set this value to 1 to process all the
components unconditionally.
nConfigID CCV_Configuration_ID Npdatatypes.t_ConfigurationId
nGroupID Group ID for the Nucleus_ids in the NUMBER
STG_CUS_CUSTOMER table

IMS Health Operations Guide Page 206 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20.5.5 Analyze the Tables


Before running the NPBestCustomer.batchProcess procedure, analyze the tables to gather various
statistics that are used by Oracle to perform data fetching more efficiently. Execute the following
command:
$ cd $DRTE_NP_BIN
$ runstoredproc -spkg_db_maintenance.process_maintenance(31)

20.5.6 Running in Incremental Mode


Run_bob.exe is the run script that is used to execute the CCV process. The run script returns an exit
code of zero if the process completes successfully; otherwise a non-zero value is returned. In incremental
mode, new customers and customers that are updated since the last run are processed.
$ cd %DRTE_NP_BIN%
$ run_bob

20.5.7 Running in Refresh Mode


In this mode all customers are processed.
$ cd %DRTE_NP_BIN%
$ run_bob --refresh

20.5.8 To Process all the Components Unconditionally


By default the components that are configured in the CCV configuration are processed when CCV profiles
are generated. Execute the script with the following option to process all the components even if it is not
configured.
$ run_bob --all_components
Use this option if a component is completely removed from a configuration that was used to generate
CCV profiles. The following sample scenario explains the use of this option:
If the CCV process was run for all the components.
And subsequently the configuration is changed to remove the Secondary ID component.
If the expected output is to delete all the Secondary IDs that were generated for the CCV profiles,
then use the --all_components option. In the default mode, Secondary IDs will not be deleted as this
component is not included in the processing.

20.5.9 Running for a Range of Customers


Start and End NUCLEUS IDs are used to process a range of customers.
$ cd $DRTE_NP_BIN
$ run_bob s=<start_nucleus_id> -e=<end_nucleus_id>

20.5.10 Running Multiple Copies of the Process in Parallel


$ cd %DRTE_NP_BIN%
$ run_bob --copies=2

IMS Health Operations Guide Page 207 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

run_bob --affiliation

20.5.11 Affiliation Batch Export to Identify Activity Status Change


The CCV Export process publishes future, current, and past affiliations. The process does not publish
messages automatically when a future affiliation becomes current or a current affiliation becomes past. A
batch PL/SQL stored procedure, NPCustAffilBatchProcess.processAffilRecord, is used to identify
such transactions and publish them to the Integration Server.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe s"NPCustAffilBatchProcess.processAffilRecord"
This procedure is also scheduled to run nightly in the ONE Point Console Real-time Data Processing
Services configuration.

20.5.12 Output Generation


The output is stored in a log file in the %DRTE_NP_LOGS% directory, and the log file name is of the
following format: run_bob_<YYYYMMDDHHMISS>.log.
The information in the log file would look as follows:
********************** S T A R T **********************
Start Date: 09-19-2002 10:06:47
User Id: 38
Configuration Id: 1
**********
STATISTICS
**********
Total records evaluated are 1000
Total records ignored are 1000
Total records processed are 0
Total records inserted are 0
Total records updated are 0
Total records inactivated are 0
Total records reactivated are 0
Total records where no action is performed are 0
Total errors detected are 0
Total seconds taken was 2.73
Total minutes taken was .0455
Total hours taken was .000758333333333333333333333333333333333333
**************
END STATISTICS
**************
End Date: 09-19-2002 10:06:50

PL/SQL procedure successfully completed.


Note: If the log file mentioned in the -l option exists with some information, then the new log information
would be appended to it.

IMS Health Operations Guide Page 208 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20.5.13 Analyze Results


The log file should contain all the information about the records that have been processed. To evaluate
the details in the log file, start the SQL session.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>

20.5.13.1 Total Eecords Wvaluated


If the parameters StartNucId and EndNucId of NPBestCustomer.batchProcess are not specified, then
the total number of records evaluated should be equal to the count returned by the following query.
SELECT count(nucleus_id) FROM cus_customer_info where delete_ind = 0

If the parameters StartNucId and EndNucId of NPBestCustomer.batchProcess are specified, then the
total number of records evaluated should be equal to the count returned by the following query.
SELECT count(nucleus_id) FROM cus_customer_info where delete_ind = 0 AND
nucleus_id BETWEEN <nStartNucId> AND <nEndNucId>

20.5.13.2 Total Eecords Inserted


If a CCV record does not exist for a customer, then perform an Insert process.
Note: The count may not be accurate if the total errors detected are not 0. In addition, it may vary based
on the configuration and exclusion information.

20.5.13.3 Total Eecords Updated


The following conditions need to be satisfied to increase the count of the records updated:
An active CCV profile must exist for a customer.
The other input tables must contain information for that CCV record.
Note: The count may not be accurate if the total errors detected are not 0. In addition, it may vary based
on the configuration and exclusion information.

20.5.13.4 Total records Inactivated


The following conditions need to be satisfied to increase the count of the records inactivated:
An active CCV profile must exist for a customer.
The other input tables must not contain any information for that CCV record.
Note: The count may not be accurate if the total errors detected are not 0. In addition, it may vary based
on the configuration and exclusion information.

20.5.13.5 Total Records Reactivated


Reactivation means activating an inactive CCV profile and then updating it with new information. The
following conditions need to be satisfied to increase the count of the records reactivated:
An inactive CCV profile must exist for a customer.
The other input tables must contain information for that CCV record.
Note: The count may not be accurate if the total errors detected are not 0. In addition, it may vary based
on the configuration and exclusion information.

IMS Health Operations Guide Page 209 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

20.5.13.6 Total Records Processed


Tot. Records processed = Tot. Records (Inserted + Updated + Inactivated + Reactivated + No Action)

20.5.13.7 Total Records Ignored


This indicates that no CCV processing was done on the customers for the parameter. RefreshIndwas
set to 0, and none of the customer details have been updated/inserted.
The number of records should be equal to:
Tot. Records (Inserted + Updated + Inactivated + Reactivated + No Action) - Tot. Records evaluated

20.5.13.8 Total Errors Detected


This indicates the number of errors detected. Details about the possible errors are found in section 20.9.

20.5.13.9 Total Records Exported


When data export functionality is enabled, exported transactions are published to
XTTRANSACTION_TABLE_1. Execute the following SQL statement to check the total transactions
exported.
SELECT count(distinct DBMSTRANSACTION_ID) FROM XTTRANSACTION_TABLE_1

20.6 Running the CCV Process Using ONE Point Application


The CCV process can be launched using the ONE Point configuration, Manual Process Management.
Select Consolidated Customer View from the list of processes as shown below. From the drop down box,
the values can be changed as required. Also the start and end NUCLEUS ID can be passed if CCV is
required to run for a range of profiles.

20.7 Analyze Table


After the CCV process has successfully completed, the database maintenance package should be run to
rebuild (rebuilding index is optional) the indexes and to analyze the tables as specified against
PROCESS_ID 51 of ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database
maintenance package. An exit code of zero 0 is returned if the maintenance package completes
successfully; otherwise a non-zero value is returned.

IMS Health Operations Guide Page 210 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(51)"

20.8 Restarting the CCV Process


If the process fails in the middle of its execution, first identify and resolve the cause of the failure and then
restart the CCV process.

20.9 Troubleshooting

20.9.1 When the Parameters Are Not Passed Correctly


Failure Description
BEGIN NPBestCustomer.batchProcess(38,1,1000,60000,50000,Null,3,Null); END;

*
ERROR at line 1:
ORA-20215: The nStartNucId and nEndNucId parameters are invalid
ORA-06512: at NPBESTCUSTOMER, line 605
ORA-06512: at line 1
Failure Condition
This could happen when the values to parameter nStartNucId and nEndNucId are not passed correctly.
Solution
Values for nStartNucId or nEndNucId cannot be NULL when run for a range of profiles, and
nStartNucId must be greater than nEndNucId. Refer to section 20.5.4 for parameters that are used by
the CCV process.

20.9.2 When Any Database Package Is Invalid


Failure Description
BEGIN NPBestCustomer.batchProcess(38,1,1000,60000,50000,Null,366,Null); END;
*
ERROR at line 1:
ORA-04068: existing state of packages has been discarded
ORA-04063: package body NPBESTCUSTOMER has errors
ORA-06508: PL/SQL: could not find program unit being called
ORA-06512: at line 1
Failure Condition
This condition would occur when one of the packages is invalid. The name of the invalid package can be
seen in the error message.

IMS Health Operations Guide Page 211 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Run the following query at the SQL prompt in order to determine which packages are invalid.
select substr(object_name,1,30) object_name,
object_type,
status,
SUBSTR(TO_CHAR(CREATED,DD-MON-YYYY HH24:MI:SS), 1, 24) created_on,
SUBSTR(TO_CHAR(LAST_DDL_TIME,DD-MON-YYYY HH24:MI:SS), 1, 24)
updated_on
from user_objects
where (object_type LIKE PACKAGE% OR object_type LIKE PROCEDURE% or
object_type LIKE TYPE% )
and (object_name LIKE NP% OR object_name LIKE %DENORM_POPULATE%)
order by 3, 1;
This query displays a list of packages and package statuses.
For example:
OBJECT_NAME OBJECT_TYPE STATUS CREATED_ON UPDATED_ON
NPBESTCUSTOMER PACKAGE INVALID 9/9/02 12:35 9/12/02 17:56
NPBESTCUSTOMER PACKAGE BODY VALID 9/9/02 12:35 9/20/02 11:33
NPCCVTRANSACTIONS PACKAGE VALID 9/9/02 12:34 9/12/02 17:56
NPCCVTRANSACTIONS PACKAGE BODY VALID 9/9/02 12:35 9/10/02 9:34
NPCCVUNIQUE PACKAGE VALID 9/9/02 12:35 9/12/02 17:56
NPCCVUNIQUE PACKAGE BODY VALID 9/9/02 12:35 9/10/02 9:34
NPCOMPARE PACKAGE VALID 9/9/02 12:34 9/12/02 17:56
NPCOMPARE PACKAGE BODY VALID 9/9/02 12:34 9/10/02 9:33
NPCOMPONENTFILTER PACKAGE VALID 9/9/02 12:34 9/12/02 17:56
NPCOMPONENTFILTER PACKAGE BODY VALID 9/9/02 12:34 9/10/02 9:34
NPCUSTCONFIGMAINT PACKAGE VALID 9/9/02 12:41 9/12/02 17:56
NPCUSTCONFIGMAINT PACKAGE BODY VALID 9/9/02 12:41 9/10/02 9:35
NPCUSTCONFIGURATION PACKAGE VALID 9/9/02 12:34 9/12/02 17:56
Once the INVALID packages have been identified, they need to be recompiled.

20.9.3 When the Error Message Range Is Between ORA-20000 and ORA-20999
Failure Description
Aborting Process!!!
NUCLEUS Id: 38179
Error msg: ORA-20207: Duplicate CCVs exist for customer 38179 occurred in
isCustomerUpdated
********************** S T A R T **********************

IMS Health Operations Guide Page 212 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Start Date: 09-20-2002 01:49:24


User Id: 38
Configuration Id: 1
**********
STATISTICS
**********
Total records evaluated are 1
Total records ignored are 1
Total records processed are 0
Total records inserted are 0
Total records updated are 0
Total records inactivated are 0
Total records reactivated are 0
Total records where no action is performed are 0
Total errors detected are 1
Total seconds taken was .25
Total minutes taken was .00416
Total hours taken was .000069
**************
END STATISTICS
**************
End Date: 09-20-2002 01:49:25
PL/SQL procedure successfully completed.
Failure condition
This kind of condition would generally arise when there is a data error.
Solution
The error message should be self-explanatory for the error range of -20000 and -20999. In the previous
case, the error message clearly says that there are two CCV records for a customer, which should not be
the case.

20.9.4 When the Error Message Range Is Not Between ORA-20000 and ORA-20999
Failure Description
The error message is not between ORA-20000 and ORA-20999.
Failure condition
This is a database-generated error message.

IMS Health Operations Guide Page 213 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Based on the Error Number generated, look at the Oracle document to find the Description, Cause, and
Action for that particular error message

20.9.5 Failure to Export Data through Xtelligent Service


Failure Description
The STATUS_CD column in XTTRANSACTION_TABLE_1 is set to 5 when customer data that is
published for export is rejected by Xtelligent.
Failure Condition
For each rejected record the reason for failure is recorded in XTL_LOGS.
Solution
Take necessary action by analyzing the reason for failure from the XTL_LOGS table.

IMS Health Operations Guide Page 214 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

21. DATA EXPORT REAL-TIME MODE


Customer data in Nucleus 360 can be exported in a real-time mode by publishing them to the export
output queue NP.TO.WBI.QL. Customer data is written to the XTTRANSACTION_TABLE_1 table if real-
time export parameters are enabled. The Xtelligent service NPTransactionPublisher is used to read and
publish data from XTTRANSACTION_TABLE_1 table to the output message queue.
The current configuration has been set up to continuously poll for records with
XTTRANSACTION_TABLE_1.STATUS in (0, 5), where:
0 represent pending or not processed transactions.
5 represent failed transactions.
The failed transactions are repeatedly processed until they are successfully exported (Status = 4).
Output from the following processes can be written to XTTRANSACTION_TABLE_1 table in real-time
mode for export:
Data Import Process Standardized data. This export is enabled by creating the Object Specific
Data Export mapping task using Configuration Assistant. In the current configuration this option has
been Enabled for exporting standardized address.
CCV Process (Export Module) Best of Breed Profile. To enable this export, set the
NUMBER_VALUE to 1 for parameter 3055 in FND_PARAMETER_VALUE table. In the current
configuration this option has been Disabled.
ID Assign NUCLEUS ID assignments. To enable this export, set the NUMBER_VALUE to 1 for
parameter 3057 in FND_PARAMETER_VALUE table. In the current configuration this option has
been Disabled.
Merge Process Customer merges. To enable this export, set the NUMBER_VALUE to 1 for
parameter 3059 in FND_PARAMETER_VALUE table. In the current configuration this option has
been Enabled.
Validation Status Export Customer sampling status updates can be exported by executing the
PL/SQL package NPCMCustVerStatusExport_Custom.

21.1 Starting the Export Service


The export service, NPTransactionPublisher, is configured in ONE Point Console under the Real Time
Data Export configuration. To start the service, right-click the configuration and click the Start option.
The service icon turns green after the service is started successfully.

21.2 Stopping the Export Service


To stop the service, right-click the Real Time Data Export configuration and click the Stop option. The
service icon turns gray after the service is stopped successfully.

IMS Health Operations Guide Page 215 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

21.3 Monitoring the Export Service


The data export service can be monitored by executing the following query, which returns the total
number of records that are PENDING / PROCESSED / FAILED and the last processed records date in
each STATUS. Initially when executing this query, the count of all PENDING records will be displayed.
This count will decrease while the service is running and the count of transactions with status
PROCESSED or FAILED will increase. In case of FAILED transactions the failed profile will be
reprocessed repeatedly by the export service till the processing becomes successful. Refer to the
XTL_LOGS table for the error description if a transaction fails.
SQL> SELECT COUNT(0) TOTAL_RECORDS_PROCESSED, DECODE(STATUS,0,
'PENDING',4,'PROCESSED', 5, 'FAILED') TRANSACTION_STATUS, MAX(PROCESSED_DATE)
LAST_PROCESSED_RECORD_DATE FROM XTTRANSACTION_TABLE_1 GROUP BY STATUS
Note: From the output returned from the above query, check the date
(LAST_PROCESSED_RECORD_DATE) on the output row with status (TRANSACTION_STATUS) either
PENDING or FAILED. If the date is recent (approximately +/- 10 minutes from the current time) atleast for
one of the output row then the export service is active and running. If the date is not recent for all the rows
not and if the count is not zero (TOTAL_RECORDS_PROCESSED) then the export service might have
gone to a hang/stall mode. Report this problem to the support team without stopping or restarting the
export service.

21.4 Entity Specific Schema IDs


The data export service handles each entity based on their schema ID. The following are the Schema IDs
which are used by the Transaction Publisher service to identify the entity types:

Schema ID Entity Name

8100 Professional
8200 Organization
8500 Customer_Affiliation
3100 Merge_Request
Each Entity has a list of sub-entities which are specified in the CHILD_TAG field in the
XTTRANSACTION_TABLE_1. The following are the child tags used:
Schema ID Entity Name Child_Tag Child Tag Name
81110 Address
81120 Communication
81130 Customer_Identifier
8100 Professional
81140 Professional_Specialty
81150 Professional_Education
81160 State_License
82110 Address
8200 Organization 82120 Communication
82130 Customer_Identifier

IMS Health Operations Guide Page 216 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Schema ID Entity Name Child_Tag Child Tag Name


8500 Customer_Affiliation 85100 Customer_Affiliation
85120 Affiliation_Role
3100 Merge_Request 31100 Merge_Request

21.5 Status Codes Used by Xtelligent Export Service


The Xtelligent Export service processes each records present in the Xttransction_Table_1 and assigns
them with a STATUS value which is used as a reference for identifying the records by the Xtelligent
Export service. The table below has the STATUS values and their descriptions:
Status Description Occurrence Condition
Any new record that is inserted into XTTransaction_Table_1 is provided with
0 Pending this Status code. The Export service is configured to pick up records with
STATUs 0 for processing.
When a record is successfully processed by the Export Service, the record will
4 Success
be updated to STATUS 4
If a record is unable to be processed by the Export Service, the record is
updated with this STATUS code.
5 Failed
Note: The current configuration of the export service will try to re-process all
records with STATUS 5 till the transaction is successful.

21.6 XTTRANSACTION_TABLE_1 Field Description


The XTTRANSACTION_TABLE_1 is the Xtelligent export table which gets populated by the Nucleus 360
processes based on the current export configurations. For the complete mapping information regarding
each object refer to the appropriate
<NP_INSTALL_ROOT>\np\is\<ENV>\DataInterfaces\Interfaces\Metadata\np_export_metadata_<OBJEC
T>.xml file. The column_name attribute against a tag name defines the source column name from where
the data is fetched.
Following are the field descriptions.
Note: Refer to the following table for abbreviations of the table names used in this section:
Abbreviation Table Name
CPIX CUS_PRIMARY_ID_XREF
COP CUS_ORGANIZATION_PROFILE
CA CUS_ADDRESS
SPSE SAM_PROFILE_SAMPLE_ELIGIBILITY
CVP CUS_VERIFICATION_PROFILE
CPS CUS_PROFESSIONAL_SPECIALTY
XT1 XTTRANSACTION_TABLE_1
CSMS CUS_STG_MERGE_SUMMARY

IMS Health Operations Guide Page 217 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

1 XTTRANSACTION_I Unique sequence value, which gets


D generated when a new record is inserted.
2 SCHEMA_ID Holds the Identifier that corresponds to an
entity in the metadata file.
3 OPERATION Stores one of the below specified operation
codes for a record based on the mode of
operation.
Insert = 1
Update = 0
Delete = -2
Refresh = 3
4 PARENT_TAG Identifies the parent entity for the row in the
metadata file, e.g.:
Parent Tag Entity
-1 Professional
-1 Organization
81100 ProfessionalSub-
Entities
82100 Organization Sub-
Entities

5 CHILD_TAG Identifies the entity for the row. Every object


or sub-object (or complex type node in XML)
is assigned a unique tag number.
The child tag values pertaining to each sub
entity are specified in section 21.4.
6 STATUS Represents the processed status of the
record.
The following Status codes are used:
STATUS Description
0 Pending
4 Success
5 Failure
6 In Doubt

7 TIME_STAMP Stores the time stamp when a record gets


created.
8 DBMSTRANSACTI Populated with the
ON_ID XT1.XTTRANSACTION_ID or a sequence
value based on the entity specific processing.

IMS Health Operations Guide Page 218 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

9 KEY_1 The CPIX.GLOBAL_ID value of the parent Customer_ID


entity is stored in this field.

10 KEY_2 Used to store the key identifier details for


each record.
For ePharma Prof/Org Address entity, the
CA.GLOBAL_ID of the Address Record
is stored in this field.
For all other entities, a system generated
sequence number is stored in this field.

Entity Tag Name


Name
Sample Address_ID
Status
Verification
Export
Sample Customer_Id
Status entifier_ID
Verification
Export
Sample State_Licens
Status e_ID
Verification
Export

11 KEY_3 Currently populated with a default value of -1


12 KEY_4 Currently populated with a default value of -1
13 KEY_5 Currently populated with a default value of -1

IMS Health Operations Guide Page 219 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

14 DATE_1 Populated with date. The following dates are


populated to this field.
SPSE.STATE_LIC_EXP_DATE is
populated in this field by sampling status
validation export process for a state
license record.
CVP. DEA_NUM_EXP_DT is populated
in this field by sampling status validation
export process for an address record. Entity Tag Name
Name
Sample Expiration_
Status Date
Verificatio
n Export
Sample DEA_Expir
Status ation_Date
Verificatio
n Export
15 DATE_2 No mappings defined for this field.
16 DATE_3 No mappings defined for this field.
17 DATE_4 No mappings defined for this field.
18 DATE_5 No mappings defined for this field.
19 NUMBER_BOOLEA
N_1
20 NUMBER_BOOLEA
N_2
21 MONEY_1
22 MONEY_2
23 MONEY_3
24 MONEY_4
25 MONEY_5
26 MONEY_6
27 MONEY_7
28 MONEY_8
29 MONEY_9
30 MONEY_10
31 MONEY_11
32 MONEY_12

IMS Health Operations Guide Page 220 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

33 IDENTIFIER_1 Used for storing identifier information.


For Customer Merge: Stores the
CPIX.PROFILE_ID of winner profile.
For Address Merge: Stores the
CA.ADDRESS_ID of winner profile.
34 IDENTIFIER_2 Used for storing the identifier information.
For Customer Merge: Stores the
CPIX.PROFILE_ID of the loser profile.
For Address Merge: Stores the
CA.ADDRESS_ID of winner profile.
35 IDENTIFIER_3
36 IDENTIFIER_4
37 IDENTIFIER_5
38 IDENTIFIER_6
39 IDENTIFIER_7
40 IDENTIFIER_8
41 IDENTIFIER_9
42 IDENTIFIER_10
43 IDENTIFIER_11
44 IDENTIFIER_12
45 IDENTIFIER_13
46 IDENTIFIER_14
47 IDENTIFIER_15

IMS Health Operations Guide Page 221 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

48 STRING_1 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores
CA.STD_ADDRESS_LINE1 value.
In Customer Merge, populated with the
CPIX.GLOBAL_ID of the winner profile.
In Address Merge, populated with the
Entity Tag Name
CA.GLOBAL_ID of the winner address
Name
record.
ePharma Address_Lin
Stores CVP.ME_NUM value for a Profession e1
professional entity by sampling status al/Organiza
validation export process. tion
Populated by CVP.DEGREE_CODE Customer Winner_Entit
value by the sampling status validation Merge y_ID
export process for a degree record. Address Winner_Entit
Merge y_ID
Populated by SPSE.STATE_LIC_NUM
value by the sampling status validation Sample ID_Value
export process for a state license record. Status
Verification
Export
Sample Degree_Na
Status me
Verification
Export
Sample State_Licens
Status e_Number
Verification
Export

IMS Health Operations Guide Page 222 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

49 STRING_2 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores
CA.STD_ADDRESS_LINE2 value.
In Customer Merge, populated with the
CPIX.GLOBAL_ID of the loser profile.
In Address Merge, populated with the
Entity Tag Name
CA.GLOBAL_ID of the loser address
Name
record.
ePharma Address_Lin
Profession e2
al/Organiza
tion
Customer Loser_Entity
Merge _ID
Address Loser_Entity
Merge _ID

50 STRING_3 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores
CA.STD_ADDRESS_LINE3 value.

Entity Tag Name


Name
ePharma Address_Lin
Profession e3
al/Organiza
tion

IMS Health Operations Guide Page 223 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

51 STRING_4 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores CA.STD_CITY
value.

Entity Tag Name


Name
ePharma City
Profession
al/Organiza
tion

52 STRING_5 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores
CA.STD_POSTAL_CODE value.

Entity Tag Name


Name
ePharma Postal_Area
Profession
al/Organiza
tion

53 STRING_6 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores
CA.STD_POSTAL_CODE_EXT value.

Entity Tag Name


Name
ePharma Postal_Area
Profession _Extension
al/Organiza
tion

IMS Health Operations Guide Page 224 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

54 STRING_7 Used to store any generic information for an


entity.
For ePharma Professional/Organization
Address entity, stores CA.STD_COUNTY
value.

Entity Tag Name


Name
ePharma Geography_
Profession Code1
al/Organiza
tion

55 STRING_8 Used to store any generic information for an


entity.
56 STRING_9 Used to store any generic information for an
entity.
57 STRING_10
58 STRING_11
59 STRING_12
60 STRING_13
61 STRING_14
62 TEXT_1 Used to store any generic information for an
entity.
Merge process uses this field to populate
the Merge Group Key
(CSMS.GROUP_KEY)
63 TEXT_2

IMS Health Operations Guide Page 225 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

64 CODE_1 Used to store the code value specific to an


entity, if mapped.
For ePharma Organization Entity, the
COP.ORG_TYPE_CD is populated in
this field.
CVP.DEGREE_CODE is code translated
and populated in this field by the
sampling status validation export process
for a professional record. Entity Tag Name
Name
For Customer Merge this field is stored
with the Abbreviated description of the ePharma Organization
entity name. In this case the value will be Organizatio _Type
CUST n Address
Export
For Address Merge this field is stored
Customer Merge_Type
with the Abbreviated description of the Merge
entity name. In this case the value will be
ADDR Address Merge_Type
Merge
The professional Type is populated in
this field based on some additional Sample Professional
Status _Type
processing by the sampling validation
Verification
status export process. Export
A constant value ME_NUMBER is Sample ID_Type
populated for a customer identifier record Status
by the sampling status validation export Verification
process. Export

A constant value AMA_SPECIALTY is Sample Specialty_Ty


populated by the sampling status Status pe
Verification
validation export process for a specialty
Export
record.
Sample State
SPSE.STATE_LIC_STATE_CODE Status
information is populated in this field by Verification
the sampling status validation export Export
process.

IMS Health Operations Guide Page 226 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

65 CODE_2 Used to store the code value specific to an


entity, if mapped.
For ePharma Professional/Organization
Address Entity, CA.STD_STATE_CODE
value is stored in this field
In Customer/Address Merge this field is
stored with the External Code
Description of
(CPIX.PROFILE_TYPE_CD) information. Entity Tag Name
Name
This field is populated with the
CPS.SPECIALTY_CD by the sampling ePharma Region
status validation export process. Profession
al/Organiza
Sampling validation status code tion
information is populated in this field by
Customer Customer_T
the sampling status validation export Merge ype
process for a state license record. The
item description of SPSE.STATUS_CD is Address Customer_T
populated. Merge ype
Sample Specialty
Status
Verification
Export
Sample Sampling_V
Status alidation_Sta
Verification tus
Export

66 CODE_3 Used to store the code value specific to an


entity, if mapped.
For ePharma Professional/Organization
Address entity, stores
CA.STD_COUNTRY value.
Merge process populates the
External_Code Value for
(CPIX.DATA_SRC_CD) to this field.
Entity Tag Name
Name
Merge Data_Sour
Process ce

IMS Health Operations Guide Page 227 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

67 CODE_4 Used to store the code value specific to an


entity, if mapped.
Populated with the External_Code
(CVP.PRESCRIBER_STATUS_CD)
value by the sampling status validation
export process.

Entity Tag Name


Name
Sample Prescriber_
Status Status
Verificatio
n Export
68 CODE_5 Used to store the code value specific to an
entity, if mapped.
Following are the Activity Status codes
used currently by the Nucleus 360
processes:
Code
CURR
PAST Entity Tag Name
Populated with the SLN authorization Name
status code Sample Authorization_
(External_Code(CVP.SLN_AUTH_STAT Status Status
US_CD)) for a state license record by the Verificatio
sampling status validation export process n Export

69 CODE_6 Used to store the code value specific to an


entity, if mapped.
Populated with the Reason code
description (SPSE.REASON_CD) for a
state license record by the sampling
status validation export process.

Entity Tag Name


Name
Sample Reason
Status
Verification
Export

70 CODE_7

IMS Health Operations Guide Page 228 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Element/Tag Name in
Col. # Column Name Field Description
Output Message

71 CODE_8 Used to store Activity status code value.


Following are the Activity Status codes used
currently by the Nucleus 360 processes,
Code
CURR
PAST

72 CODE_9 Populated by the Data source Code


description for a professional entity by the
sampling status validation export process.

Entity Tag Name


Name
Profession Data_Source
al

73 CODE_10
74 CODE_11
75 CODE_12
76 CODE_13
77 CODE_14
78 CODE_15
79 PROCESSED_DAT Gets updated with the latest time stamp,
E when the export service processes the
record.

21.7 Troubleshooting

21.7.1 Unable to stop service


Failure Condition
If ONE Point Console is not able to stop the service or if the console is closed before the service is
stopped.
Solution
Active services can be stopped using Windows Services window as explained below.
Click the Windows Start button, and select Settings and then select Control Panel to open the Windows
Control Panel.

IMS Health Operations Guide Page 229 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

1. On the Control Panel window, double-click Administrative Tools.


2. On the Administrative window, double-click Services to open the Services window.
3. Right-click the service name and then click the Stop option.

21.7.2 Failure to export data through Xtelligent service


Failure Description
The STATUS_CD column in XTTRANSACTION_TABLE_1 is set to 5 when customer data that is
published for export is rejected by Xtelligent.
Failure Condition
This error occurs when Transaction Publisher (Export Service) tries to export a record from
XTTRANSACTION_TABLE_1. The cause of the error will be logged in the XTL_LOGS table.
Solution
Use the following query to get the Description of error message from XTL_LOGS table and take
necessary action by analyzing the reason for failure. Contact Support Team, if the error could not be
resolved.
SQL> SELECT * FROM XTL_LOGS ORDER BY PUBLISH_TIME DESC

21.7.3 Failed to configure queue processor


Failure Description
The STATUS_CD column in XTTRANSACTION_TABLE_1 is set to 5 and the description in XTL_LOGS
table is Failed to configure queue processor
Failure Condition
This error could occur when the required queues are not installed or the NPTransactionPublisher
configuration file is not configured properly.
Solution
Follow the server layer instructions to create queues and configure the NPTransactionPublisher
configuration file.

21.8 Restarting the Export Service


If the NPTransactionPublisher service fails or crashes in the middle of its execution, the reason for the
failure should be identified and resolved first. Open Windows Task Manager and click the Processes
tab and search for transactionPublisher.exe in the Image Name column. The failed process will show up
in Task Manager if it is not completely terminated from memory. If the failed process appears in Task
Manager, it should be selected and click the End Process button. The Windows Services panel should
display the status of NPTransactionPublisher service as Stopped. Restart the export service via ONE
Point. A sample Task Manager image with the transactionPublisher.exe selected is given below.

IMS Health Operations Guide Page 230 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

IMS Health Operations Guide Page 231 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

The following sample Windows Services panel screenshot shows the NPTransactionPublisher in stop
mode.

IMS Health Operations Guide Page 232 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

22. AGGREGATESPEND360 DATA EXPORT


Information pertaining to transactional data changes and cross reference information regarding the third
party profiles that make up the CCV can be written out to the CUS_TRANSACTION_EXPORT table (for
transactions) and CUS_TRANSACTION_EXPORT_XREF (for cross reference) table respectively. The
information from the CUS_TRANSACTION_EXPORT and CUS_TRANSACTION_EXPORT_XREF table
is then used to create an extract to a delimited file using the Nucleus 360 Import/Export utility.
This process has been configured in the Nucleus 360 ONE Point console as two different configurations
allowing the user to execute the export processes in Manual and Real time mode.
These extracts enable Nucleus 360 to be interfaced with AggregateSpend360.

22.1 Exporting Data in Manual Mode


Each process that is configured in Manual or Batch process mode can be started and stopped
individually. Each entity in this configuration is independent so that the process can be run in any order as
per requirement. After the completion of the export process for each entity, it is mandatory to run the file
renaming process for each entity. For Example: Start Professional Address file renaming after completion
of Professional Address export process.

IMS Health Operations Guide Page 233 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

22.2 Exporting Data in Real Time Mode


Processes that are configured in this mode can be started only at a configuration level. Once the
configuration is started, all processes are executed continuously in the sequence in which they are
displayed. The default pause period between each iteration of the configuration is set to 10 hours.

22.2.1 Log File


View the log file in <np_root>\ np\log\ folder which was generated by the previous process. Search the log
for the phrases Fail, Data Exception, and Error. If such a phrase is found, do not proceed. Contact your
support team and resolve the problem.

22.2.2 Stopping the Real Time Data Export Configuration


Right-click the configuration and click the Stop option. The configuration stops after the current export
process is completed.

22.3 Check Progress


Each entity in the above configuration is represented by table_id. The status of the records to be exported
can be checked using this table ID. The following table contains table IDs associated with a process.
Process Description Table ID
Professional 14
Professional Address 1
Professional Communication 5

IMS Health Operations Guide Page 234 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Process Description Table ID


Professional State License 16
Organization 11
Organization Address 1
Organization Communication 5
Managed Care 11
Managed Care Address 1
Customer Affiliation 4
The following queries will give the count of pending records that have not been extracted.
SQL> Select count(0) From CUS_TRANSACTION_EXPORT where STATUS_CD = 502900 and
TABLE_ID = <table_id>;
The following queries will give the count of records that are extracted.
SQL> Select count(0) From CUS_TRANSACTION_EXPORT where STATUS_CD = 502901 and
TABLE_ID = <table_id>;

22.4 Archiving the Export Tables

22.4.1 CUS_TRANSACTION_EXPORT Table


Data from CUS_TRANSACTION_EXPORT table can be archived to the
CUS_TRANSACTION_EXPORT_ARCHIVE table after the export module has been completed
Successfully. The archival process can be launched using the ONE Point configuration Manual State
Guardian Data Export > Archive Customer Transaction Export.

22.4.2 CUS_TRANSACTION_EXPORT_XREF Table


Data from CUS_TRANSACTION_EXPORT_XREF table can be archived to the
CUS_TRANSACTION_XREF_ARCHIVE table after the export module has been completed successfully.
The archival process can be launched using the ONE Point configuration Manual State Guardian Data
Export > Archive Customer XREF Transaction Export.

22.4.3 Process Parameters


Parameter Name Description
Number of Days to Keep Default 0 Archive all records that are processed.
Positive Integer N Skip archiving of records that were processed in the last
N number of days.
Cache Size Data selection buffer size, defaulted to 1000.
Commit Interval Database commit frequency, defaulted to commit after each 1000 records.

IMS Health Operations Guide Page 235 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

22.4.4 Analyzing the Log File


The log files for the Customer and Customer XREF archival processes are <np_root>\ np\log\
op_910230.log and op_910240.log. Search the log for the phrases Fail, Data Exception, and Error. If
such a phrase is found, do not proceed. Contact your support team to resolve the problem.

IMS Health Operations Guide Page 236 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

23. MERGE

23.1 Overview
The Merge process is responsible for selecting and identifying merge candidate records based on the
Merge configuration created using the Configuration Assistant GUI. Merge includes Customer Merge and
Address Merge functionality.

23.1.1 What Merge Process Does


It constructs an SQL query statement based on the tables and fields used by the rules.
It retrieves every group from the database. For Customer merge the groups are at a NUCLEUS ID
level, for Address merge the group is as defined by the Address component criteria and other fields, if
desired.
It processes every group and writes the results to the database.
Optionally, merge suggestions can be exported via Xtelligent.
Note: In cases when the record does not satisfy ANY rule and a winner is required, add a rule at the end
having an aggregate function (MAX or MIN). Use IDs as parameters to these functions, such as address
ID or profile ID. In this case, when a Loser TIE/DEADLOCK happens, then the aggregate function will
select a record. The aggregate functions can also be used in cases where the group has a mixture of
Winner and Loser records.

23.2 Running the Process

23.2.1 Command Line Parameters


cd %DRTE_NP_BIN%
npmerge.exe [-?] [-v] [-V] -l<filename> [-c<filename>] [-r] [-s<Sentence Set
ID>] [-i] [-t] [-e]

Option Description
-? Detailed Help
-v Version Information
-V Extended Version Information (IMS Health Internal)
-l<filename> Log file name <filename>. This is a required parameter.
-c<filename> Database configuration file name <filename> (defaulted to dbcfg.txt)
-r Dry Run mode (IMS Health Internal)
-i Run npmerge incrementally. Valid only for customer (Prof/Org) merge.
-t Cleanup mode only. Truncate the output tables.
-e Populate Xtelligent table

IMS Health Operations Guide Page 237 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Option Description
-s<Sentence Set ID> Sentence Set that will be used for merge. It is required in non-cleanup
mode.
Note: npmerge.exe returns an exit code of zero if the process completes successfully; otherwise a non-
zero value is returned.

23.2.1.1 Running in Incremental Mode -- Customer Merges Only


Incremental mode is applicable only for customer merges. Each execution of the merge process makes
an entry to the CUS_STG_MERGE_RUN table for the specific merge configuration identified by the -s
option. When the same configuration is run the next time, only NUCLEUS IDs with
CUS_CUSTOMER_INFO.LAST_UPD_DT greater than the last run date/time from
CUS_STG_MERGE_RUN.CRTN_DT are processed.
cd %DRTE_NP_BIN%
npmerge.exe -s<Sentence Set ID> -l<filename> -i

23.2.1.2 Running in Refresh Mode All Merges


The entire universe of records as defined by the merge configuration will be processed.
cd %DRTE_NP_BIN%
npmerge.exe -s<Sentence Set ID> -l<filename>

23.2.1.3 Running in cleanup mode


The cleanup mode does not suggest merges as it only truncates the following tables populated by the
Merge process.
CUS_STG_MERGE_RUN: This table is also used to run the merge process in incremental mode.
Once this table is emptied, the merge process will run in a refresh mode one time.
CUS_STG_MERGE_SUMMARY
CUS_STG_MERGE_DETAIL
cd %DRTE_NP_BIN%
npmerge.exe -l<filename> -t

23.2.1.4 Populate Xtelligent table


When executed with this option, the process populates the XTTRANSACTION_TABLE_1 table (by calling
the PLSQL procedure NPMergeExtract) in addition to the following standard merge tables.
CUS_STG_MERGE_RUN
CUS_STG_MERGE_SUMMARY
CUS_STG_MERGE_DETAIL
The XTTRANSACTION_TABLE_1 can be queried on SCHEMA_ID = 3100 for searching merge records.
cd %DRTE_NP_BIN%
npmerge.exe -l<filename> -s<Sentence Set ID> -e

IMS Health Operations Guide Page 238 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

23.2.2 Merge Run Script Parameters


Run_merge_extract.exe is a run script that encapsulates the command line options of npmerge.exe for
the commonly used run line options with defaults for the log file parameter and always populating the
XTTRANSACTION_TABLE_1 table. The script also lists the current merge configurations by type that are
stored in the database. The run script returns an exit code of zero if the Merge process completes
successfully; otherwise a non-zero value is returned.
cd %DRTE_NP_BIN%
run_merge_extract.exe

SYNOPSIS
run_merge_extract.exe -r=<ruleid>
run_merge_extract.exe -c

DESCRIPTION
Script to run the Merge Extract.

OPTIONS
--rule, -r
Rule ID. Its a required parameter in non-cleanup mode.

--all, -a
This option will enable the process to run for all records. If this
option is not specified the Merge process runs in incremental mode.
Incremental mode will process only those records that are modified
since the last merge run. Incremental mode is Not Valid for Merge
of type Address.

--clean, -c
Cleanup mode only. Truncate the merge staging tables.

--help, -h, -?
Usage. Displays the usage of this script.

23.2.2.1 Running in Incremental Mode


Refer to section 23.2.1.1 for details regarding Incremental Mode.
cd %DRTE_NP_BIN%
run_merge_extract --rule=<rule_id>
Where:
--rule Rule ID (same as Sentence Set ID). To get the valid Rule IDs, execute the following
command at the prompt:
run_merge_extract -?

23.2.2.2 Running in Refresh Mode


Refer to section 23.2.1.1 for details regarding Refresh Mode.
IMS Health Operations Guide Page 239 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

cd %DRTE_NP_BIN%
run_merge_extract --rule=<rule_id> --all

23.2.2.3 Running in cleanup mode


Refer to section 23.2.1.3 for details regarding Cleanup Mode.
cd %DRTE_NP_BIN%
run_merge_extract --clean

23.3 Monitoring Merge Process


Execute the query given below to find the total number of customers (NUCLEUS_IDs) that will be
evaluated in case of a customer merge after substituting MERGE_RULE_ID with the actual RULE_ID
from the NP_RULE table. Note that the query returns the total count of NUCLEUS_IDs that will be
evaluated, not the actual count of customers that are potential merge candidates. This query is not
applicable for Address type of merges. Address merge configurations are always run in full refresh mode,
in which all the addresses are re-evaluated eachtime.
SELECT COUNT(0)
FROM CUS_CUSTOMER_INFO
WHERE CUS_CUSTOMER_INFO.LAST_UPD_DT > (
SELECT NVL(MAX(CRTN_DT),ADD_MONTHS(SYSDATE,-400))
FROM CUS_STG_MERGE_RUN
WHERE SENTENCE_SET_ID = MERGE_RULE_ID);
While the Merge process is running, the following query will give you details about its progress
(specifically, the number of records processed).
SQL> SELECT COUNT(0) FROM CUS_STG_MERGE_DETAIL
where merge_run_id =
(SELECT MAX(merge_run_id) FROM CUS_STG_MERGE_RUN);
This number should increase steadily throughout the process.
The following query will return the number of merge groups processed.
SQL> SELECT COUNT(0) FROM CUS_STG_MERGE_SUMMARY
where merge_run_id =
(SELECT MAX(merge_run_id) FROM CUS_STG_MERGE_RUN);

23.3.1 Analyze the Tables


After a successful completion of the Merge process, database maintenance package should be run to
rebuild (rebuilding index is optional) the indexes and to analyze the tables as specified against
PROCESS_ID 108 of ADM_SAI_PROCESS_TABLE. runstoredproc.exe is used to execute the database
maintenance package. An exit code of zero 0 is returned if the maintenance package completes
successfully; otherwise a non-zero value is returned.
$cd %DRTE_NP_BIN%
$runstoredproc -s"pkg_db_maintenance.process_maintenance(108)"

IMS Health Operations Guide Page 240 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

23.4 Analyzing the Results

23.4.1 View the Log File


View the log file generated by the process. Search for any occurrence of the Error. If the word is found, do
not continue with the next process. Contact your support team to report the problem. Otherwise, the
process completes successfully.

23.4.2 Log Message Explanations


This section explains the messages generated in the log file by the merge process.
Sample Log Message
Tue Aug 07 11:37:32 2007::********************** S T A R T ****************
Tue Aug 07 11:37:32 2007::Start Statistics
Tue Aug 07 11:37:32 2007::Start Date : 08-07-2007 11:37:32
Tue Aug 07 11:37:32 2007::Process Name: Merge - Customer
Tue Aug 07 11:37:32 2007::Args :
Tue Aug 07 11:37:32 2007::Process ID : 3276
Tue Aug 07 11:37:32 2007::Started By : NP_PROCESS
Tue Aug 07 11:37:32 2007::***
Tue Aug 07 11:37:32 2007::Process Arguments
Tue Aug 07 11:37:32 2007::*****************
Tue Aug 07 11:37:32 2007::Customer Merge Rule, s : 1001
Tue Aug 07 11:37:32 2007::Incremental Mode, i :
Tue Aug 07 11:37:32 2007::Populate Xtelligent table for XML export, e:
Tue Aug 07 11:37:33 2007::Records processed : 2
Tue Aug 07 11:37:33 2007::Groups processed : 2
Tue Aug 07 11:37:33 2007::Skipped single record groups: 2
Tue Aug 07 11:37:33 2007::Performance (avg. time to process a group) : Days 0,
Hours 0, Minutes 0, Seconds 0
Tue Aug 07 11:37:33 2007::Write Time: Days 0, Hours 0, Minutes 0, Seconds 0
Tue Aug 07 11:37:33 2007::Rule processing time: Days 0, Hours 0, Minutes 0,
Seconds 0
Tue Aug 07 11:37:33 2007::***
Tue Aug 07 11:37:33 2007::Extract started at: 08-07-2007 11:32:59
Tue Aug 07 11:37:33 2007::Total merge groups inserted: 0
Tue Aug 07 11:37:33 2007::Extract completed at: 08-07-2007 11:32:59
Tue Aug 07 11:37:33 2007::***
Tue Aug 07 11:37:33 2007::***
Tue Aug 07 11:37:33 2007::End Statistics
Tue Aug 07 11:37:33 2007::Process Name : Merge - Customer
Tue Aug 07 11:37:33 2007::End Date : 08-07-2007 11:37:33
Tue Aug 07 11:37:33 2007::Total Run Time : Days 0, Hours 0, Minutes 0, Seconds
1
Tue Aug 07 11:37:33 2007::************************ E N D ************

IMS Health Operations Guide Page 241 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Description
In the above sample message, the descriptions for the highlighted messages are explained below.
Records processed:
This count denotes the total number of records selected for processing, based on the merge rule defined
for the specific entity.
Groups processed:
This count denotes the total number of groups that are processed to identify potential merges.
In the case of a customer merge, profiles that have the same NUCLEUS_IDs are grouped together and
the group key is the NUCLEUS_ID. In the case of an address merge, a group is created based on the
fields specified in the Field Selection property of a merge configuration. Address records having the
same values for the fields specified in the Field Selection will be grouped together and a group key is
created by concatenating the field values. A screenshot taken from the Configuration Assistant GUI is
provided here as an example for Address Merge Field Selection (Group Key Selection).

Note: When merge records are exported to XTTRANSACTION_TABLE_1 for publishing, the group key
value is written to the TEXT_1 column for internal debugging purpose. This value is not published in the
outgoing XML message.
Skipped single record groups:
This count denotes the total number of groups having a single record associated with it.
Total merge groups inserted:
This count denotes the count of Groups processed minus the count of Skipped single record groups.

23.5 Restarting the Merge Process


If the process fails in the middle of its execution, the reason for the failure should be identified and
resolved first. After resolving the issue, restart the Merge process.

IMS Health Operations Guide Page 242 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

23.6 Tables Modified by Merge Process


Following are the tables that are populated by the merge process. The process reads data from the tables
and fields configured using the Configuration Assistant application:
Table Name
CUS_STG_MERGE_RUN
CUS_STG_MERGE_DETAIL
CUS_STG_MERGE_SUMMARY
XTTRANSACTION_TABLE_1

IMS Health Operations Guide Page 243 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

24. RUNSTOREDPROC UTILITY

24.1 Overview
The purpose of this utility is to invoke Oracle Stored Procedures and functions from the operations work
environment. The database user name, password, and instance name are obtained from the dbcfg.txt
configuration file. An exit code of zero 0 will be returned if the process completes successfully; otherwise
a non-zero value will be returned. DBMS Output generated by the procedure/function that is being
invoked is captured and logged to the log file.

24.2 Command Line Parameters


runstoredproc.exe [-?] [-v] [-V] [-s<procedure>] [-f<function>] [-
a<anonymousblock>] [-p<pool>] [-c<file>] [-l<filename>]

Parameter Description
-l Log file name
-s Stored procedure command line
-f Stored function command line
-a File that contains anonymous PLSQL block
-c Database configuration file from which the connection details are read, default is dbcfg.txt
-p Database configuration file Block/Pool Name, default is NUCLEUSPHARMA
-? Display command line options
-v Version Information
-V Extended Version Information

24.3 To Execute a Stored Procedure


Substitute <PackageName> with the stored package name. Do not provide the package name in order to
execute a stand along procedure. Substitue <ProcedureName> with the procedure name. Substitute
<Parameters> with the parameters of the procedure.
$cd %DRTE_NP_BIN%
runstoredproc.exe -s"<PackageName>.<ProcedureName>(<Parameters>)"
A sample command line instruction is given below to execute the database maintenance procedure.
$cd %DRTE_NP_BIN%
runstoredproc.exe -s"pkg_db_maintenance.process_maintenance(32)"

IMS Health Operations Guide Page 244 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

24.4 To Execute a Stored Function


Substitute <PackageName> with the stored package name. Do not provide the package name in order to
execute a stand alone function. Substitute <FunctionName> with the function name. Substitute
<Parameters> with the parameters of the function.
Note: The total size of the data returned by the function should not exceed 2000 bytes.
$cd %DRTE_NP_BIN%
runstoredproc.exe -f"<PackageName>.<FunctionName>(<Parameters>)"
A sample command line instruction is given below to execute the function to process records in the
STG_IMPORTED_PROFILE table.
$ cd %DRTE_NP_BIN%
$ runstoredproc.exe -f"PKG_Denorm_Populate.ProcessImportedProfiles(1)"

24.5 To Execute a SQL file That Contains An Anonymous PL/SQL


Block
Runstoredproc can also be used to execute a SQL file that has an anonymous PLSQL block. There
should not be any SQL Plus command in the SQL file. Substitute <File> with the SQL file name.
$cd %DRTE_NP_BIN%
runstoredproc.exe -a"<File>"

24.6 Restarting the Process


If the process fails in the middle of its execution, the reason for the failure should be identified and
resolved first. After resolving the issue, restart the process.

IMS Health Operations Guide Page 245 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

25. ZIP INFORMATION EXTRACT UTILITY

25.1 Overview
This utility extracts the ZIP (Zone Improvement Plan) codes and their associated information from
Firstlogics USPS data files. Currently only zip code information pertaining to the U.S. is extracted. The
extract can be done to the console, file, or a database table. This process should be run after every
update for Firstlogics USPS data files is received so that the latest USPS data is used. The process does
not maintain any history; inactive zip codes will not be returned by the extract.

25.2 Command Line Parameters/Usage


npzipinfo [-?] [-v] [-V] -l<filename> [-f<filename>] [-t] [-c] [-
d<V><v><H><h>] [-s<ZipCode>] [-e<ZipCode>] [-b<Block Name>]
This extract process will provide the following fields:
STATE CODE Zip Code
POSTAL CODE State Code
CITY PLACE City Name
CITY ABBR City Abbr (if length (city) > 13 chars long)
FIPS CODE FIPS Code
GEO BLK Block Number
GEO LAT Latitude
GEO LNG Longitude
GEO MSA MSA Code
COUNTY County Number
COUNTYNAME County Name
CR SORT ZN Carrier route Sort zone
LAST LINE Last Line
MOVED STATUS =T(Zip realigned by USPS) =F(Not affected)
FINANCE CODE Mother or Finance Zip Code
Valid parameter combinations are:
-t , -s, -e Refresh Table with [optional zip code (or range)]
-c , -s, -e , -d Console with [optional zip code (or range)]
-f , -s, -e , -d File with [optional zip code (or range)]
To run for a single zip code, specify the -s option only.
Option Description
-v Version Information
-V Extended Version Information (IMS Health Internal)
-l<filename> Log file name <filename>. This is a required parameter.
-f<filename> Extract zip information to <filename>

IMS Health Operations Guide Page 246 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Option Description
-t Extract zip information into FND_POSTAL_CODE. Note that the complete table will
be refreshed.
-c Extract zip information to Console
-d<V><v><H><h> Display zip information in extract <H>orizontally or <V>ertically. Default is horizontal.
-s<ZipCode> Extract zip information Starting from Zip <5 digit zip>
-e<ZipCode> Extract zip information Ending at Zip <5 digit zip>. If -e is not specified, only single
zip is extracted.
-b<Block Name> Ace Block Name
Common usage examples:
To refresh the FND_POSTAL_CODE table in the database:
$ npzipinfo lzipextract.log t -bIACE_USA
To get information for a single zip on the console, horizontally pipe-delimited:
$ npzipinfo lzipextract.log c s07828 dH -bIACE_USA
To get information for a zip range on the console, vertically column-prefixed:
$ npzipinfo lzipextract.log c s07828 e07856 dV -bIACE_USA
To get information for all the zip codes to a file, horizontally pipe-delimited:
$ npzipinfo lzipextract.log fzipextract.txt dH -bIACE_USA

25.3 Running npzipinfo


To refresh the FND_POSTAL_CODE table in the database:
$ npzipinfo lzipextract.log t bIACE_USA

25.4 Monitoring the Progress


npzipinfo.exe returns an exit code of zero if the process completes successfully; otherwise a non-zero
value is returned. Once the process has completed, verify that the count in the log file matches that of the
output. For the t option, check the count on the table using the following command:
SQL> select count(0) from FND_POSTAL_CODE

25.5 Troubleshooting
Refer to Appendix E for ACE/IACE errors.

25.5.1 Missing Zip Codes


There is a known issue with the IACE libraries that are used to extract the zip information out in which
data for zip codes of type UNIQUE are not extracted.
A unique ZIP code is assigned to a company, government agency, or entity with sufficient mail volume,
based on average daily volume of letter-size mail received, availability of ZIP code numbers in the postal
area, and USPS cost-benefit analysis.

IMS Health Operations Guide Page 247 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

25.5.2 The Logging option argument is required.


Failure Description
Invalid Arguments.
The Logging option argument is required.
Failure Condition
This error occurs when log file name option is not passed which is a mandatory option.
Solution
Pass a valid log file name with -l option. Refer to section 25.2 for valid options or combination of options
for running the process.

25.5.3 Ace Block Name is required.


Failure Description
Invalid Arguments.
Ace Block Name is required.
Failure Condition
This error occurs when ACE/IACE block name option is not passed which is a mandatory option.
Solution
Pass a valid ACE/IACE block name with -b option. Refer to section 25.2 for valid options or combination
of options for running the process. For example, IACE_USA is a valid ACE block name.

25.5.4 Pls specify the destination of the extract using -f, -t or -c.
Failure Description
Invalid Arguments.
Please specify the destination of the extract using -f, -t or -c.
Failure Condition
This error occurs when the destination of the output is nor specified.
Solution
Provide a valid option for output of the extract. The valid options are f(file), -t(FND_POSTAL_CODE
table) and c(console). Refer to section 25.2 for valid options or combination of options for running the
process. E.g. IACE_USA is a valid ACE block name.

25.6 Restarting the Process


If the process fails in the middle of its execution, the reason for the failure should be identified and
resolved first. After resolving the issue, restart the Merge process using the same command.

IMS Health Operations Guide Page 248 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

26. NUCLEUS 360 IMPORT/EXPORT UTILITY

26.1 Overview
The NPImportExport process is a configuration-file-based general-purpose utility for accomplishing the
following tasks:
Export data from a database table to a single file.
Import data from a file to a single database table.
Copy data from one database to another database using SQL statements.
The data transfer is made possible based on a configuration file. The process supports delimited and
fixed-length file formats for I/O files.
Note: Nucleus 360 import/export utility creates user specified log file and bad file when process starts. On
successful execution of this process the bad file will be automatically cleaned up by the process. In case
of failure the failed record will be written to the bad file and its not deleted. If the utility stops
unconditionally due to an unhandled error, the bad file created by the process may not be cleaned up.

26.2 Running the NPImportExport Process


$ cd %DRTE_NP_BIN%

$ npimportexport [-?] [-v] [-V] [-c<db-config-file-name>] -l<log-file-


name> [-n] [-d<debug>] [-i<input-file-name>] -p<process-type> -f<format-
file-name> [-o<output-file-name>] [-t<file-type>] [-S<source-block-name>]
[-D<destination-block-name>] [-F<commit-frequency>] -b<bad-record-file-name>

The following options can be specified to run the process:
Option Description
-? Help
-v Version Information
-V Extended Version Information (IMS Health Internal)
-c<db-configuration-file-name> Database configuration file name. Default is dbcfg.txt.
-l<log-file-name> Log file name
-n Dry Run. Changes will not be applied to the database.
-d<debug> To run the process in debug mode. Different logging levels are
(1)Errors Only, (2)Terse-default, (3)Verbose, (4)Detail.
-i <input-file-name> Input file name
-p<process-type> Process type (0-import, 1-Export, 2-Copy)
-f <format-file-name> Format file name
-o<output-file-name> Output file name
-t<file-type> I/O file type (0-Delimited, 1-Fixed length file, default is 0)

IMS Health Operations Guide Page 249 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Option Description
-S<source-block-name> Source database configuration block name. Default for export process
is NUCLEUSPHARMA.
-D<destination-block-name> Destination database configuration block name. Default for import
process is NUCLEUSPHARMA.
-F<commit-frequency> Commit frequency. Default value is 1000.
-b<bad-record-file-name> Bad records file name

Use of the utility is based on the different sets of configuration files as follows:
Data Export
For example: To extract data from the DQT_PROFESSIONAL_PROFILE table to an output file,
prac_ver_full_refresh_output.txt, the following syntax may be used:
$ npimportexport -llogfile.log -p1
-fpractitioner_verification_full_refresh.cfg -t0
-oprac_ver_full_refresh_output.txt SAVNP -F5000 -bbadrecfile.bad -d4
Data Import
For example: To import data from the pracver_import_data.txt file to STG_VERIFICATION_IMPORT
table, use the following command:
$ npimportexport -llogresults.log -p0 -fpracver_import.cfg
-ipracver_import_data.txt -t1 -DNUCLEUSPHARMA -F1000
-bbadRecFile.bad -d4
Data Copy
For example: To copy data from SAM_AUTHORIZATION_FORM (Sample Guardian) to
SAM_AUTHORIZATION_FORM (Nucleus 360), use the following command:
$ npimportexport -llogresults.log -p2 -fsignature_auth_form.cfg -t1
-SSAMPLEGUARDIAN -DAVNP -F1000 -bbadrecfile.bad -d4

IMS Health Operations Guide Page 250 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

26.3 Running the NPImportExport Process Using ONE Point


Application
The NPImportExport process can be launched using the ONE Point configuration, Manual Process
Management. Select Import/Export Utility from the list of processes as shown here. From the dropdown
box, the values can be changed as required. Some other values to the input fields need to be passed
manually for which there is no dropdown list like format file, input file, etc.

26.4 Analyze the Results


The npimportexport.exe returns an exit code of zero if the process completes successfully; otherwise a
non-zero value is returned.

26.4.1 Viewing the Log File


All failed records are logged into a .bad file. DML and main SQL statements are synchronized. For
example, if any INSERT statement execution fails, then the corresponding DML statement is not
executed. All INSERT/UPDATE/DELETE and DML statements are executed in bulk using data binding. If
for any reason a statement in bulk fails, then all the statements in bulk are executed one by one and the
failed statement is logged to the bad file.
Note: The bulk size is decided by the F command line parameter value.

IMS Health Operations Guide Page 251 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

26.4.2 Debugging Using the -d Option


The NPImportExport process has a d option for debugging/tracing. To enable verbose debug output,
execute the process by specifying d4 as part of the run line. The log file will have detailed information as
shown in the following example.
Reading configuration file ended at:06/05/2015 19:29:19
*-*-*-*-*-*-*
Importing data begun at:06/05/2015 19:29:19
*-*-*-*-*-*-*
Number of records so far written to table STG_VERIFICATION_IMPORT: 10
Number of records so far written to table STG_VERIFICATION_IMPORT: 20
Total number of records written to table STG_VERIFICATION_IMPORT: 23
*-*-*-*-*-*-*
Total Number of records written to database: 23
Total Number of Bad records :0
Importing data ended at:06/05/2015 19:29:19
*-*-*-*-*-*-*
***

26.5 Troubleshooting
This section provides information about certain error messages.

26.5.1 Log file option argument is required


Failure Description
Log file option argument is required
Failure condition
This error occurs when log file name option is not passed which is a mandatory option.
Solution
Pass the log file name option -l with a valid file name. Refer to section 26.2 for the command line
parameter used by the NPImportExport process to run the process with valid parameters.

26.5.2 Process type argument value (Import/Export/Copy) is required.


Failure Description
Process type argument value (Import/Export/Copy) is required.
Failure condition
This error occurs when process type option is not passed which is a mandatory option.

IMS Health Operations Guide Page 252 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Pass the process type option -p with a valid value (0, 1 or 2) for Import, Export and Copy. Refer to
section 26.2 for the command line parameter used by the NPImportExport process to run the process with
valid parameters.

26.5.3 Invalid Process mode


Failure Description
Invalid Process mode, Valid values are 0 (Import), 1 (Export) and 2 (Copy)
Failure condition
This error occurs when process type option p is passed with some invalid type.
Solution
Pass the process type option -p with a valid value (0, 1 or 2) for Import, Export and Copy. Refer to
section 26.2 for the command line parameter used by the NPImportExport process to run the process with
valid parameters.

26.5.4 Input file name is required for Import process.


Failure Description
Input file name is required for Import process.
Failure condition
This error occurs when the process is run for Import type and no input file is passed.
Solution
Provide a valid input file and pass the file name with input file name option -i. Refer to section 26.2 for
the command line parameter used by the NPImportExport process to run the process with valid
parameters.

26.5.5 Bad Record file name is required.


Failure Description
Bad Record file name is required.
Failure condition
This error occurs when the process is run without passing bad record file name.
Solution
Provide a valid bad record file name with -b option. Refer to section 26.2 for the command line
parameter used by the NPImportExport process to run the process with valid parameters.

26.5.6 Format file name argument value is required.


Failure Description
Format file name argument value is required.
Failure condition
This error occurs when the process is run without passing format file name option.

IMS Health Operations Guide Page 253 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Provide a valid format file and pass the file name with -f option. Refer to section 26.2 for the command
line parameter used by the NPImportExport process to run the process with valid parameters.

26.5.7 Cannot open Format File


Failure Description
Cannot open Format file
Failure condition
This error occurs when the format file is not present in the specified path.
Solution
Make sure that the format file passed is present in the specified path.

26.5.8 Output file name is required for Export process.


Failure Description
Output file name is required for Export process.
Failure condition
This error occurs when the process is run for Export type and no output file name is passed.
Solution
Provide a valid output file name with option -o. Refer to section 26.2 for the command line parameter
used by the NPImportExport process to run the process with valid parameters.

26.5.9 Destination database connection block name is required.


Failure Description
Destination database connection block name is required.
Failure condition
This error occurs when the process is run for Copy type and no destination connection block name is
passed.
Solution
Provide destination connection block name as specified in database configuration file (dbcfg.txt) with -D
option. Refer to section 26.2 for the command line parameter used by the NPImportExport process to run
the process with valid parameters.

26.5.10 Source database connection block name is required.


Failure Description
Source database connection block name is required.
Failure condition
This error occurs when the process is run for Copy type and no source connection block name is passed.

IMS Health Operations Guide Page 254 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Provide destination connection block name as specified in database configuration file (dbcfg.txt) with -S
option. Refer to section 26.2 for the command line parameter used by the NPImportExport process to run
the process with valid parameters.

26.6 Restarting the Process


If the process fails in the middle of its execution, the reason for the failure should be identified and
resolved first. If the process fails while creating an extract file, delete the incomplete file and restart the
process. If the process fails while populating a database table, restore the table to its initial state and
restart the process.

IMS Health Operations Guide Page 255 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

27. DATA EXTRACT

27.1 Overview
Customer (Professional/Organization), Profile (Professional/Organization), or Address data in the Nucleus
360 database can be extracted to XML-formatted files. Using a two-step process, data from Nucleus 360
database core tables is copied to intermediate staging tables (Oracle Nested objects) and step, XML files
are generated from the staged data via IMS Healths Xtelligent.

27.1.1 Address Extract


Address data is aggregated from the Nucleus 360 database core tables (listed below) and is copied
into the intermediate nested objects table, CUS_STG_EXT_STD_ADDRESS.

27.2 Professional Profile Extract


Professional profile data is aggregated from Nucleus 360 database core tables (listed below) and is
copied into the intermediate nested objects table, CUS_STG_EXT_PROF_PROFILE.
CUS_PROFESSIONAL_PROFILE
CUS_ADDRESS
CUS_ADDRESS_COMPONENT
CUS_CUSTOMER
CUS_PROFESSIONAL_DEGREE
CUS_COMMUNICATION_PROFILE
CUS_PROFESSIONAL_SPECIALTY
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF

27.3 Organization Profile Extract


Organization profile data is aggregated from Nucleus 360 database core tables (listed below) and is
copied into the intermediate nested objects table, CUS_STG_EXT_ORG_PROFILE.
CUS_ORGANIZATION_PROFILE
CUS_ADDRESS
CUS_ADDRESS_COMPONENT
CUS_CUSTOMER
CUS_COMMUNICATION_PROFILE
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF

IMS Health Operations Guide Page 256 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

27.4 Professional Customer Extract


Professional customer data is aggregated from Nucleus 360 database core tables (listed below) and is
copied into intermediate the nested objects table, CUS_STG_EXT_CUST_PROF_PROFILE.
CUS_PROFESSIONAL_PROFILE
CUS_ADDRESS
CUS_ADDRESS_COMPONENT
CUS_CUSTOMER
CUS_PROFESSIONAL_DEGREE
CUS_COMMUNICATION_PROFILE
CUS_PROFESSIONAL_SPECIALTY
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF

27.5 Organization Customer Extract


Organization customer data is aggregated from Nucleus 360 database core tables (listed below) and is
copied into the intermediate nested objects table, CUS_STG_EXT_CUST_ORG_PROFILE. The mapping
between the source tables and the intermediate object tables is explained in the table given below.
CUS_ORGANIZATION_PROFILE
CUS_ADDRESS
CUS_ADDRESS_COMPONENT
CUS_CUSTOMER
CUS_COMMUNICATION_PROFILE
CUS_PRIMARY_ID_XREF
CUS_SECONDARY_ID_XREF

27.6 Extracting Data

27.6.1 Command Line Parameters/Usage


run_extract
Each of the command line parameters is described below:
Parameter Description
--type, -t Type of extract to run. Valid values are profile | customer | stdaddress.
For example: --type=profile
--skip_candidates, -s Candidates are generated prior to executing the extract, which can be
disabled by using the --skip_candidates option
This option does not generate candidates but runs the extract process

IMS Health Operations Guide Page 257 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Parameter Description
directly.
--candidates, -c Generates candidates to extract. This option does not run the extract
process after generating candidates.
--create_file Number of extract processes to run in parallel. Defaulted to 1. This option is
not valid for standardized address extract and for generating candidates.
--cleanup Option to clean up extract object tables or queue tables.
--commit_frequency Database commit interval, defaulted to 1000.
--help, -h, -? Usage. Displays the usage of this script.
--version, -v Displays version information.
--copies Number of extract processes to run in parallel. Defaulted to 1. This option is
not valid for standardized address extract and for generating candidates
The process can be run for customer (Professional/Organization), Profile (Professional/Organization), or
Address data extracts.

27.6.2 Analyze the Tables


Before running the extract process, analyze the tables to gather various statistics that are used by Oracle
to perform data fetching more efficiently. Tables would be analyzed after the Data Import process has
been completed. Analyze the tables only if they were updated following the analysis performed after data
import (for example, CUS_CUSTOMER).
Execute the following command to analyze the tables.
$ cd %DRTE_NP_BIN%
$ runstoredproc -spkg_db_maintenance.process_maintenance(6)

27.6.3 Execute the Data Extract Process

27.6.3.1 Run for Address data extract pre-process:


C:\> run_extract t=stdaddress -c

27.6.3.2 Run for Address data extract process:


C:\> run_extract t=stdaddress -s

27.6.3.3 Run for Professional/Organization Profile data extract pre-process:


C:\> run_extract t=profile -c

27.6.3.4 Run for Professional/Organization Profile data extract process:


C:\> run_extract t=profile -s

27.6.3.5 Run for Professional/Organization customer data extract pre-process:


C:\> run_extract t=customer -c

IMS Health Operations Guide Page 258 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

27.6.3.6 Run for Professional/Organization customer data extract process:


C:\> run_extract t=customer -s
To extract the data from the intermediate nested table, run the appropriate Xtelligent-based service.

27.6.3.7 Address Extract to XML file:


Run the service AddressExtract. Refer to Appendix G for details on executing a service.

27.6.3.8 Professional profile data extract to XML file:


Run the service ProfessionalProfileExtract. Refer to Appendix G for details on executing a service.

27.6.3.9 Organization profile data extract to XML file:


Run the service OrganizationProfileExtract. Refer to Appendix G for details on executing a service.

27.6.3.10 Professional profile data extract to XML file:


Run the service CustomerProfExtract. Refer to Appendix G for details on executing a service.

27.6.3.11 Organization profile data extract to XML file:


Run the service CustomerOrgExtract. Refer to Appendix G for details on executing a service.

27.6.3.12 Truncate object tables


The object tables are not truncated automatically after the extract XML file is generated. Execute the
following command to truncate the tables manually:
C:\> run_extract t=customer --cleanup=object

27.6.3.13 Truncate queue tables


The queue tables populated by the pre-process are not truncated automatically after the extract XML file
is generated. Execute the following command to truncate the tables manually:
C:\> run_extract t=profile --cleanup=queue

27.7 Troubleshooting

27.7.1 Service dies without generating the output file

27.7.1.1 Explanation
This problem occurs if the configuration file is not modified properly.

27.7.1.2 Solution
Make sure that the placeholders in configuration files such as DATABASE_USER_PASSWORD,
DATABASE_USER, DATABASE_INSTANCE, DATABASE_SERVER_IP,
EXTRACT_OUTPUT_FILE_PATH, ODBC_SYSTEM_DSN, and %DRTE_NP_DEFS% are replaced by
appropriate values.
IMS Health Operations Guide Page 259 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

28. MIGRATION UTILITY


The NUCLEUS ID created during the ID Assign process can be exported from one Nucleus 360 version to
another using the XML file or delimited flat file method.

28.1 Export of NUCLEUS ID


Export of the NUCLEUS ID is done using two methods:
1. Querying from the core tables (CUS_CUSTOMER and CUS_PRIMARY_ID_XREF table).
2. STG_NUC_ID_EXPORT_QUEUE is populated with NUCLEUS_ID and its PROFILE_ID for export.
These NUCLEUS_IDs are loaded in an intermediate staging table
STG_NUC_ID_ASSIGNMENT_EXPORT and later written to an XML or flat file by the Migration utility.
This file is written to a UTL file directory folder in Oracle which should have all permissions (read and
write).

28.2 Import of NUCLEUS ID


In this case, the file in the specified UTL directory is first loaded into an intermediate staging table,
STG_NUC_ID_ASSIGNMENT_IMPORT. Then, as per the business rules, it is loaded into the
NP_MATCH_OUTPUT and NUC_RESOLUTION_PENDING tables.

28.3 Process Parameters

28.3.1 Export Process


NP_MA_Export.StartExportProcess(
nDataProcess in number,
vUtlFileDir in varchar2,
VUtlFileName in varchar2,
nFileFormat in number DEFAULT K_PIPE_DELIMITED,
nCodeTranslation in number DEFAULT K_CODE_ITEM,
nCacheSize in number DEFAULT 1000,
nCommitInterval in number DEFAULT 1000);

Parameter Name Description Type


nDataProcess Enter the data process method: (0) Extract from CORE tables, NUMBER
(1) Extract from Queue table.
vUtlFileDir UTL directory path (complete path) VARCHAR2
vUtlFileName Enter the file name VARCHAR2
nFileFormat Enter the file format: (0) for flat file, (1) for XML file. NUMBER
nCodeTranslation Code Translation: (0) No, (1) Yes. NUMBER
Default: 0

IMS Health Operations Guide Page 260 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Parameter Name Description Type


nCacheSize Cache size NUMBER
Default: 1000
nCommitInterval Commit Interval NUMBER
Default: 1000

28.3.2 Running Migration Utility Export Manually


cd %DRTE_NP_BIN%
$ runstoredproc -sNP_MA_EXPORT.STARTEXPORTPROCESS(0,'/opt/oracle/admin
/aedb010d/utils','test1.txt',0,0,1000,1000)
Running the above command, test1.txt file is created in /opt/oracle/admin/aedb010d/utils folder of the
database server. This was the path to which the permissions were set.
NOTE: For older versions (Prior to 3.1) of Nucleus 360 if runstoredproc.exe does not exist, run the
export package in sql prompt.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>

SQL> exec NP_MA_EXPORT.STARTEXPORTPROCESS(0,'/opt/oracle/admin


/aedb010d/utils','test1.txt',0,0,1000,1000)

28.3.2.1 Logging
The log output of the export run is stored in a log file in the DRTE_NP_LOGS directory, and the log file
name is of the following format:
NP_MA_EXPORT.STARTEXPORTPROCESS_<YYYYMMDDHHMISS>.log. If running in sql prompt log
file is not generated.

28.3.3 Running Export in Default Mode


The following command exports data with default parameters.
C:\> run_npmigration -e -d=<directory path> -f=<file_name>

28.3.4 Analyze Results


The log file should contain all the information about the number of records that are exported. To evaluate
the details in the log file, start the SQL session.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>
After running the export process, check the number of records to be exported by running the following
query.
Full Refresh Mode:
select count(0)
from cus_customer cc,
cus_primary_id_xref cpix
where cc.profile_id = cpix.profile_id
and cpix.delete_ind = 0
IMS Health Operations Guide Page 261 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

and cpix.data_src_cd not in (200088, 200087);


Queue Based Mode:
select count(0)
from cus_customer cc,
cus_primary_id_xref cpix,
stg_nuc_id_export_queue seq
where cc.profile_id = cpix.profile_id
and seq.profile_id = cpix.profile_id
and cpix.delete_ind = 0
and cpix.data_src_cd not in (200088, 200087);
Query returns the count of records to be exported, verify this value with the log file for both profiles
extracted and profiles written.

28.3.5 Import Process


NP_MA_Export.StartExportProcess (
vUtlFileDir IN varchar2,
vUtlFileName IN varchar2,
nFileFormat IN NUMBER DEFAULT K_PIPE_DELIMITED,
nForceArchive IN NUMBER DEFAULT K_NOT_ARCHIVED,
nCacheSize IN NUMBER DEFAULT 1000,
CommitInterval IN NUMBER DEFAULT 1000);

Parameter Name Description Type


vUtlFileDir UTL directory path (complete path) NUMBER
vUtlFileName Enter the file name VARCHAR2
nFileFormat Enter the file format: (0) for flat file, (1) for XML file. VARCHAR2
nForceArchive Archive imported nucleus_id and profile_id NUMBER
(0) archive processed records (1) archive All Records
Default 0
nCacheSize Cache size NUMBER
Default: 1000
CommitInterval Commit Interval NUMBER
Default: 1000

28.3.6 Running Migration Utility Import Manually


$ cd %DRTE_NP_BIN%
$ runstoredproc -sNP_MA_IMPORT.NP_MA_IMPORT.STARTIMPORTPROCESS(
'/opt/oracle/admin/aedb010d/utils','test11.xml',0,0,1000,1000)
Running the above command, test1.txt file is exported into STG_NUC_ID_ASSIGNMENT_IMPORT.
Then, as per the business rules, it is loaded into the NP_MATCH_OUTPUT and
NUC_RESOLUTION_PENDING tables.

IMS Health Operations Guide Page 262 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Alternate method running the above command for versions prior to 3.1:
sqlplus <DBUserId>/<DBPassword>@<ConnectString>

SQL> exec
NP_MA_IMPORT.NP_MA_IMPORT.STARTIMPORTPROCESS( '/opt/oracle/adm
in/aedb010d/utils','test11.xml',0,0,1000,1000)

28.3.7 Logging
The output of the batch run is stored in a log file in the DRTE_NP_LOGS directory, and the log file name
is of the following format: NP_MA_IMPORT.STARTIMPORTPROCESS_<YYYYMMDDHHMISS>.log. If
running in sql prompt, the log file is not generated

28.3.8 Running Import in Default Mode


The following command imports data with default parameters.
C:\> run_npmigration -i -d=<directory path> -f=<file_name>

28.3.9 Analyze Results


The log file should contain all the information about the number of records that are imported. To evaluate
the details in the log file, start the SQL session.
sqlplus <DBUserId>/<DBPassword>@<ConnectString>
Run the following query, which retrieves the count of the imported profiles
select count(0)from STG_NUC_ID_ASSIGNMENT_IMPORT ;
Query returns the count of records to be imported, verify this value with the log file for profiles imported.

28.3.10 Troubleshooting

28.3.10.1 Invalid Directory Path


ORA-20502: ORA-20502: ORA-20502: ORA-29280: INVALID DIRECTORY PATH: FILE
LOCATION OR FILENAME WAS INVALID OCCURRED IN FLUSHTOFLATFILE OCCURRED IN
STARTEXPORTFILEGENERATION occurred in startExportProcess

28.3.10.1.1 Explanation
This occurs if the directory path specified is not valid.

28.3.10.1.2 Solution
1. Create a folder in db-server and make sure files can be read and written in this folder.
2. Set the UTL_FILE_DIR = * in the database parameter file. After setting this parameter, the database
should restart.
Note: Consult the database administrator (DBA) for creating the directory and setting the parameter
value.

IMS Health Operations Guide Page 263 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

29. ONE POINT APPLICATION

29.1 Overview
The ONE Point application is a process manager for Nucleus 360 processes/services. It provides a single
entry point to execute the processes in real-time mode and batch mode. Processes that are managed by
the ONE Point application are configured in rt_config.xml file in XML format.
To launch the application:
1. Open a Windows command prompt.
2. Execute np_env.bat file from the installation root directory.
3. Type nponepoint.exe and press Enter from the installation BIN directory.
<install_root_dir>np_env.bat
<install_root_dir>cd np\bin
<install_root_dir\np\bin>nponepoint.exe
Note: The ONE Point application will not validate the arguments passed to it. This application passes the
values as is to the corresponding application assuming the values passed are valid.
To launch the application using a custom configuration file:
The default configuration file used by ONE Point is rt_config.xml. In order to use a different configuration
file, launch the application from the command prompt by specifying the configuration file name.
1. Open a Windows command prompt.
2. Execute np_env.bat file from the installation root directory.
3. Type nponepoint.exe followed by the configuration file name and press Enter from the installation
BIN directory. Substitute <custom_file.xml> with the actual file name.
<install_root_dir>np_env.bat
<install_root_dir>cd np\bin
<install_root_dir\np\bin>nponepoint.exe <custom_file.xml>

29.2 Running Processes from nponepoint.exe and Batch


The nponepoint.exe can be used to launch the data import for various data sources. It should never be
used to load data via a file or queue, in parallel if they have the same data source.
The application facilitates running other processes, such as Data Quality, Denorm, Hash, and Match, in a
continuous loop. While running these processes, the batch run scripts should not be launched in parallel
to do the same operation. Close the nponepoint.exe if run scripts must be executed.

IMS Health Operations Guide Page 264 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

29.3 Convention

29.3.1 Configuration Type Icon Conventions


Manual or Batch process management. Each process that is configured in this mode can be started
and stopped individually.
Real-time or Continuous process management. Processes that are configured in this mode can be
started only at a configuration level. Once the configuration is started, all processes are executed
continuously in the sequence in which they are displayed.

29.3.2 Process Status Icon Conventions


Process has not been executed even once and is in stop mode
Process is currently active and running
Process failed during its last execution
Process was run at least once in real-time mode and it is currently paused
Process is waiting on an exclusive key lock
Process is scheduled to run at a future time

29.4 Operation

29.4.1 Real-time Configuration Start and Stop


To execute a real-time configuration, right-click the configuration and then click start on the pop-up
menu. Processes are executed sequentially in the order that is displayed. Scheduled processes are
skipped if they are not due for execution.
To stop a real-time configuration, right-click the configuration and then click stop on the pop-up menu.
The configuration will stop only after the currently executing process in that configuration completes
execution itself.
When a process fails during execution, the user is prompted to decide whether the execution should
continue with the next process in the configuration or to abort further execution.

29.4.2 Batch Configuration Start and Stop


To execute a batch process, right-click the process and then click start on the pop-up menu.
Scheduled processes are paused if they are not due for execution.
Batch processes stop automatically only after the process completes.

29.4.3 Exclusive Share Key


Exclusive keys are defined using the exclusiveKey attribute of the Entity element. It is defined at the
configuration level for real-time processes and at the entity level for batch processes. Exclusive keys are
defined for the following reasons:
To pause a real-time process when a batch process is started, if they are mutually exclusive from an
execution perspective and should not be run in parallel.

IMS Health Operations Guide Page 265 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

To pause a batch process when another batch process is running, if they are mutually exclusive from
an execution perspective and should not be run in parallel.
To warn the user when two real-time configurations are started simultaneously.
Refer to the rt_config.xml file the for Data Import process, which is configured in real-time and batch
mode using the exclusive key option.

29.4.4 Auto Pause Real-time Configuration


Real-time configuration can be configured to pause operations when a batch process is started that is
mutually exclusive from an execution perspective. The real-time configuration will resume execution after
the batch process is completed.
1. Define the same exclusive share key, exclusiveKey, for the real-time configuration and the batch
process.
2. Set the onRestart attribute to 1 to the real-time process, because this needs to be restarted after the
batch process completes.
Note: When processes need to be restarted from a paused state, the onRestart attribute should be
set for them. This causes the process to run again on receiving the restart signal. For example: The
Data Import process is paused due to an execution of a batch process. As soon as the batch process
completes, it posts a restart signal to the configuration that shares the exclusive key. This restart
signal will be received by the Data Import process and will cause it to restart.
Set the onStopPause attribute to 1 to the process in the real-time configuration that should
execute when a stop (or an internal pause is initiated due to the start of the dependent
configuration/process) is sent due to start of the batch process.
Note: Some processes cannot be stopped by issuing a stop signal to them directly. A separate
process needs to be executed. For example, Data Import can only be stopped elegantly using the
npprocessctrl.exe. In this case, the onStopPause needs to be set to 1 for the
npprocessctrl.exe process.
The following example shows how to configure the Data Import process to be paused and
restarted.
<Entity id="100020" type="syscmd" name="start /min npdataimport.exe"
displayName="Import Message Queue"
logFile="..\log\op_100020.log" onRestart="1" iterations="1">
<Argument name="Data Queue" option="-q" value="NP_IN_Q"/>
<Argument name="Exception Queue" option="-e" value="NP_X_Q"/>
<Argument name="Mappings Configuration" option="-C"
value="config.xml"/>
<Argument name="Queue Polling Frequency" option="-F" value="10"/>
<Argument name="Log File" option="-l"
value="..\log\op_100020.log"/>
</Entity>

<Entity id="100050" type="syscmd" name="npprocessctrl.exe"


displayName="Shutdown Message Import"
logFile="..\log\op_100050.log" onStopPause="1">
<Argument name="Operation" option="-o" value="SHUTDOWN"/>
</Entity>

IMS Health Operations Guide Page 266 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

29.4.5 Wait between Executions


After executing all the processes in a real-time configuration, a wait time can be specified before starting
the next iteration. This is achieved by specifying the wait time in seconds to the delay attribute of the
Configuration element. To define a wait time of three hours, the sample configuration is:
<Configuration id="1000"
type="continuous"
name="Real Time - Data Import"
dbcfgBlock="NUCLEUSPHARMA"
delay="10800"
exclusiveKey="Exclusive Real Time Execute">

29.4.6 Configuring a Database-stored Procedure Call


Database-stored procedures are defined by creating an entity of type db_procedure. DBMS output
generated by the procedure is captured and logged to a log file. The following example invokes the real-
time API of the CCV process.
<Entity id="300100" type="db_procedure"
name="NPBestCustomer.realtimeProcess"
displayName="Consolidated Customer View"
logFile="..\log\op_300100.log">

<Argument name="User ID" option="tUserId" value="109"/>

</Entity>

29.4.7 Configuring a Database-stored Function Call


Database-stored functions are defined by creating an entity of type db_function. DBMS output
generated by the function is captured and logged to a log file. The following example invokes the real-time
API of the Data Quality engine.
<Entity id="300100" type="db_function"
name="NP_Data_Quality_Engine.ProcessImportedProfiles"
displayName="Data Quality"
logFile="..\log\op_300100.log">

<Argument name="Commit Interval" option="nCommitInterval" value="5000"/>

</Entity>

29.4.8 Configuring a Batch Command or an Executable


Launching the batch command in wait mode:
In order to execute batch scripts and executables in a wait mode specify the entity type as syscmd. In
this mode, ONE Point will wait for the batch command to complete after launching it. After the command
completes, it will proceed with the next process in the configuration. The following example invokes the
mqtest.exe utility to clear the control queue.
<Entity id="100020" type="syscmd" name="mqtest.exe" displayName="Clear
Control Queue"
logFile="..\log\op_100020.log">
<Argument name="Operation" option="-o" value="PURGE"/>
<Argument name="Control Queue Name" option="-d" value="NP_CTRL_Q"/>

IMS Health Operations Guide Page 267 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

<Argument name="Process Name" option="-r" value="NP_APP_SL_XML_IMPORT"/>


<ReturnCodeList>
<Code value="0" action="Continue"/>
</ReturnCodeList>
</Entity>
Launching the batch command in no-wait mode:
In order to execute batch scripts and executables in a no-wait mode specify the entity type as
syscmd_nohup. In this mode, ONE Point will not wait for the batch command to complete after
launching it. It will proceed with the next process in the configuration. The following example invokes the
Data Import process to process XML messages from the input queue.
<Entity id="100020" type="syscmd_nohup" name="npdataimport.exe"
displayName="Import Message Queue"
logFile="..\log\op_100020.log" onRestart="1" iterations="1">
<Argument name="Data Queue" option="-q" value="WBI.TO.NP.QL"/>
<Argument name="Exception Queue" option="-e" value="NP.X.QL"/>
<Argument name="Mappings Configuration" option="-C"
value="config.xml"/>
<Argument name="Queue Polling Frequency" option="-F" value="10"/>
<Argument name="Log File" option="-l" value="..\log\op_100020.log"/>
<ReturnCodeList>
<Code value="0" action="Continue"/>
</ReturnCodeList>
</Entity>

29.5 Configuration Elements


ONE Point application configurations are read from rt_config.xml, which is located in the BIN directory.
The following is an example of rt_config.xml file structure:
<NPProcessConsole dbcfgFile="dbcfg.txt" user="NP_PROCESS">

<Configuration id="1000"
type="continuous"
name="Real Time - Data Import"
dbcfgBlock="NUCLEUSPHARMA"
delay="10"
exclusiveKey="Exclusive Real Time Execute">

<Entity id="100010" type="syscmd" name="mqtest.exe"


displayName="Clear Control Queue"
logFile="..\log\op_100010.log" onRestart="1" iterations="1">
<Argument name="Operation" option="-o" value="DELETE"/>
<Argument name="Control Queue Name" option="-d" value="NP_CTRL_Q"/>
</Entity>

</Configuration>

<Configuration id="5000"
type="request"
name="Manual - Process Management"
dbcfgBlock="NUCLEUSPHARMA">
<Entity id="500020" type="db_procedure"
name="NP_Data_Quality_Engine.main"
displayName="Data Quality" logFile="..\log\op_500020.log"
IMS Health Operations Guide Page 268 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

exclusiveKey="Exclusive Real Time Execute">


<Argument name="Components Processed" option="nComponentType"
type="lookup"
value="NP_Data_Qlty_Rules_Const.k_component_all">
<LookupList>
<ListItem value="NP_Data_Qlty_Rules_Const.k_component_all"
description="All Components"/>
<ListItem
value="NP_Data_Qlty_Rules_Const.k_component_prof_details"
description="Professional Details"/>
</LookupList>
</Argument>
</Entity>
</Configuration>

29.5.1 NPProcessConsole Element


This is the root element and must be defined only once. Valid attributes for this element are:
Attribute Name Description Default Value
dbcfgFile Database configuration file to get the Oracle connection dbcfg.txt
information
user External user name that runs the application. The user must NP_PROCESS
be active and defined in FND_SYS_USER table.
dbcfgBlock Default Block/Pool name that is used to read database NUCLEUSPHARMA
connection details from the dbcfgFile file. Individual
configurations can override this value by redefining it at a
configuration level. Connection details specified in this block
will be displayed in the TITLE of the ONE Point application.

29.5.2 Configuration Element


This element is used to define a real-time or batch configuration. Multiple configurations are allowed
within the NPProcessConsole element. Valid attributes are:
Attribute Description Valid Values Default Value
Name
Id Unique configuration identifier. The value Positive numeric
must be unique across the configuration. value
type Specifies the type of configuration to run continuous Real-
the processes in real-time or batch mode time mode
request Batch
mode
name Configuration name to be displayed
dbcfgBlock Block name that is used to read database NUCLEUSPHARMA
connection information from the
dbcfgFile file

IMS Health Operations Guide Page 269 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Attribute Description Valid Values Default Value


Name
delay Valid only for continuous type Positive numeric
configuration. Number of seconds to wait value
before the next execution cycle starts.
iterations Valid only for continuous type Positive numeric
configuration. Specify this option to limit value
the total number of executions.
exclusiveKey Valid only for continuous type
configuration. Used to pause a real-time
process when a batch process is
launched that has the same exclusive
share key.
pauseAtEnd Valid only for continuous type 1
configuration. Used to pause a real-time
configuration after executing all the
processes in the loop when a batch
process is launched that has the same
exclusive share key. This will make sure
that the configuration cannot be paused in
the middle of iteration after it starts
execution.

29.5.3 Entity Element


Processes that are executed as part of the configuration are defined using the Entity element. Valid entity
attributes are:
Attribute Description Valid Values Default Value
Name
Id Unique entity identifier. The value Positive numeric value
must be unique across the
configuration.
type Type of process that is defined in this app_lib Static linked
entity. libraries
db_procedure Oracle
Stored procedure
db_function Oracle Stored
function
db_sql Oracle SQL query
that selects a single column
syscmd Windows
Command
service Windows Services

IMS Health Operations Guide Page 270 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Attribute Description Valid Values Default Value


Name
Name Entity name app_lib nphash, npmatch,
npidassign, npmerge
db_procedure Oracle
Stored procedure name
db_function Oracle Stored
function name
db_sql Oracle SQL query
that selects a single column
syscmd Windows
Command in wait mode.
syscmd_nohup Windows
Command in no-wait mode.
service Windows Service
Name
displayName Entity name that displayed in the ONE
Point configuration tree
logFile Log file name
iterations Valid only for continuous type
configuration. Specify this option to
limit the total number of executions.
exclusiveKey Valid only for request type
configuration. Used to pause a real-
time process when a batch process is
launched that has the same exclusive
share key.
schedule Option to schedule the process Schedule time format is:
execution for a future time Day,Hour:Minute.
Day 1 (Monday) to 7
(Sunday)
Hour 0 to 23
Minute 0 to 59
onStop Valid only for continuous type 1
configuration. Processes that are
configured with the onStop attribute
are executed only when the
configuration is stopped.

IMS Health Operations Guide Page 271 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Attribute Description Valid Values Default Value


Name
onPause Valid only for continuous type 1
configuration. Processes that are
configured with the onPause attribute
are executed only when a pause
signal is issued by the batch process.
Pause signals are sent by batch
processes to real-time configuration
when the same exclusive key is
shared.
onStopPause Valid only for continuous type 1
configuration. Processes that are
configured with the onStopPause
attribute are executed only when the
configuration is stopped or a pause
signal is received.
onRestart Valid only for continuous type 1
configuration. Processes that are
configured with the onRestart
attribute are executed when the
configuration is started initially or after
the pause operation.

29.5.4 Argument Element


Process arguments are configured using Argument element
Attribute Description Valid Values Default
Name Value
name Argument name that is displayed in the
ONE Point Configuration tab.
type Valid only for batch mode processes. text An edit box is
Argument type is used to capture user displayed to capture user
input when a batch process is launched. input.
lookup A combo box is
displayed with predefined
argument values.
option Argument name that is passed to the
process.
value Argument value that is passed to the
process.
readOnly Valid only for batch mode processes. 1
When this is specified, the user cannot
modify the argument value.

IMS Health Operations Guide Page 272 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

29.5.5 ListItemElement
This element is valid only for arguments of type lookup. ListItem is a child element of LookupList and is
used to define values that are displayed in a drop-down list to the user.
Attribute Name Description Valid Values Default Value
value Argument value
description Argument value description that is
displayed to the user in a drop-down list.

29.5.6 ReturnCodeList Element


The exit status or return code of a process that is of type syscmd/syscmd_nohup can be captured and
verified using the ReturnCodeList element. A ReturnCodeList can have one or more child elements called
Code. Each Code element defines a single return code value and the action that should be taken by ONE
Point. Attributes of a Code element is listed in the table given below.
Attribute Description Valid Values Default Value
Name
value The return code value is defined using Integer value
this attribute
action Action to be taken by the ONE Point Continue The return code
application based on the return code indicates a successful
value completion of the process,
thus continue with the next
process
Stop The return code
indicates that the launched
process completed with
errors. Prompt the user for
confirmation.

29.6 Restarting ONE Point


If the ONE Point application fails or crashes in the middle of its execution, the reason for the failure should
be identified and resolved first. Open Windows Task Manager and click the Processes tab and search
for nponepoint.exe in the Image Name column. The failed process will show up in Task Manager if it is
not completely terminated from memory. If the failed process appears in Task Manager, it should be
selected and click the End Process button. Then restart nponepoint.exe. A sample Task Manager image
with the nponepoint.exe selected is given below.

IMS Health Operations Guide Page 273 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

IMS Health Operations Guide Page 274 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

30. MAPPING CONFIGURATION GENERATOR

30.1 Overview
Mapping Configuration Generator is used to extract data source elements such as mappings, pattern
sets, patterns, merge rules, and lists from the configuration tables of a Nucleus 360 database.
Configuration Assistant facilitates extraction of these data source elements in XML format, whereas the
Mapping Configuration Generator extracts these data source elements in SQL format.
A configuration file, mapping_config.cfg, is used by this application. It contains a list of all the
configuration tables that need to be extracted as SQL SELECT statements.
Following is the list of current configuration tables that are set up in the mapping_config.cfg file.
Tables Tables
np_cfg_mapping np_cfg_pattern_def_component
np_cfg_map_source_type np_cfg_pattern
np_cfg_map_parameter_value np_cfg_pattern_def_element
np_cfg_fld np_cfg_pattern_variable
np_cfg_task np_cfg_pattern_variable_def
np_cfg_task_properties np_cfg_pattern_variable_output
np_cfg_map_field_class_dtl np_cfg_pattern_function
np_cfg_map_code_parser np_cfg_pattern_function_config
np_cfg_list np_cfg_pattern_set_function
np_cfg_list_item np_cfg_pattern_set_func_config
np_cfg_pattern_set np_rule
np_cfg_data_src_pattern_set np_rule_detail
np_cfg_pattern_def_parameter np_rule_detail_execution
np_cfg_pattern_set_pattern np_rule_detail_implementation

30.2 Running the Process


cd %DRTE_NP_BIN%
np_configuration_generator.exe [-?] [-v] [-V] [-c<db-config-file-name>]
-l<log-file-name> [-n] [-C<config-file-name>]

30.2.1 Command Line Parameters


Option Description
-? Detailed Help
-v Version Information

IMS Health Operations Guide Page 275 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Option Description
-V Extended Version Information (IMS Health Internal)
-c<db-config-file- Database configuration file. Default is dbcfg.txt
name>
-l<log-file-name> Log file
-n Dry Run. Changes will not be applied to the database.
-C<config-file- Configuration file name
name>

30.2.2 Output
Mapping Configuration Generator generates INSERT scripts for all the configuration tables listed in
mapping_config.cfg. These SQL scripts should be placed in folder <root
directory>\np\datasource\Mapping_Configuration to be executed when database configuration is
done. Refer to the Nucleus 360 Configuration Check List for details on using this application.

30.3 Troubleshooting

30.3.1 Log file option argument is required


Failure Description
Log file option argument is required
Failure Condition
Log file name is not passed while running the process which is a mandatory option.
Solution
Pass a valid log file name with the logging option -l.

30.3.2 Configuration file name is required.


Failure Description
Configuration file name is required.
Failure Condition
Configuration file name is not passed while running the process which is a mandatory option.
Solution
Pass a valid configuration file name with the option -C.

30.3.3 Cannot open Format file


Failure Description
Cannot open Format file
Failure Condition
Configuration file name is not present in the specified path.

IMS Health Operations Guide Page 276 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Solution
Make sure that the configuration file name and path are passed correctly and the file is present at the
specified path.

30.4 Restarting the Process


If the process fails in the middle of its execution, the cause for the failure should be identified and
resolved first. Delete all output files generated by the process and then restart it.

IMS Health Operations Guide Page 277 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

31. CUSTOMER IDENTIFIER XREF EXPORT


The Customer Identifier Xref interface is used to capture multiple identifiers for customers from customer
master database system. This utility first populates a staging table
CUS_TRANSACTION_EXPORT_XREF that exports all the external id values for a customer (i.e.
NUCLEUS_ID). After that customer records corresponding to the rows in
CUS_TRANSACTION_EXPORT_XREF are exported to a flat file.

31.1 Enabling XREF Export


Customer Identifier Xref export is enabled or disabled through the database system parameter 3073. The
NUMBER_VALUE column of FND_PARAMETER_VALUE table associated with this parameter is set to 1
by default which means it is enabled. Set NUMBER_VALUE to 0 to disable export.
Logon on to SQL Prompt and run the following script
UPDATE FND_PARAMETER_VALUE
SET NUMBER_VALUE = 1
WHERE PARAMETER_ID = 3073;

31.2 Running Customer Identifier XREF Export


There are two stages for Customer Identifier XREF data to be exported to a data file:
1. Staging table CUS_TRANSACTION_EXPORT_XREF is populated.
2. Customer data corresponding to staging table rows is exported to a flat file.

31.2.1 Exporting Data to Staging Table


This is a PL/SQL module that identifies data to be exported and populates the staging table accordingly.
This process is configured in the ONE Point application.

31.2.1.1 Process Parameters


NPCCV_CUSTOMERXREFEXPORT.MAIN
(USERID,
PROCESSINGMODE,
COMMITFREQUENCY)

Parameter Name Description Type


USERID User ID. The User details can be found in NPDataTypes.t
FND_SYS_USER table. _UserID or
NUMBER(5)
PROCESSINGMODE Processing mode. This value must be one of the PLS_INTEGER
following constant values from
k_ProcessingMode_Incremental
k_ProcessingMode_Refresh

IMS Health Operations Guide Page 278 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Parameter Name Description Type


COMMITFREQUENCY Commit interval. PLS_INTEGER
Note: The default value is 10000.

31.2.1.2 Running Process


In the ONE Point application, select the Manual Process Management configuration. Right-click State
Guardian Customer XREF Export as shown here and click the Start option. Choose appropriate
parameters and start the process. The icon turns green after the service is started successfully.

31.2.1.3 Log File


View the log file, <np_root>\ np\log\ op_500117.log is generated by the previous process. Search the log
for the phrases Fail, Data Exception, and Error. If such a phrase is found, do not proceed. Contact your
support team and resolve the problem.

31.2.2 Exporting Data to Flat File


Nucleus 360 Import Export Utility is used to export data from staging table to flat file. In the ONE Point
application, this process is already configured with the required parameters. Manual and real time are two
modes of running this process.

31.2.2.1 Starting Export Service in Manual Mode


Each process that is configured in Manual or Batch process management mode can be started and
stopped individually. After successfully completing the Customer Identifier Xref process, you must run the
file Customer Identifier renaming process.

31.2.2.2 Log File


View the log file in <np_root>\ np\log\ folder which was generated by the previous process. Search the log
for the phrases Fail, Data Exception, and Error. If such a phrase is found, do not proceed. Contact your
support team and resolve the problem.

31.2.2.3 Starting Export Service in Real-time Mode


Processes that are configured in this mode can be started only at a configuration level. Once the
configuration is started, all processes are executed continuously in the sequence in which they are
displayed.

IMS Health Operations Guide Page 279 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

31.2.2.4 Log file


View the log file in <np_root>\ np\log\ folder which was generated by the previous process. Search the log
for the phrases Fail, Data Exception, and Error. If such a phrase is found, do not proceed. Contact your
support team and resolve the problem.

31.3 Check Progress


The following queries will give the count of pending records that have not been extracted.
SQL> Select count(0) From CUS_TRANSACTION_EXPORT_XREF where STATUS_CD = 502900

Following queries will give the count of records that are extracted.
SQL> Select count(0) From CUS_TRANSACTION_EXPORT_XREF where STATUS_CD = 502901

31.4 Archiving CUS_TRANSACTION_EXPORT_XREF table


This is a PL/SQL module to archive/delete staging table CUS_TRANSACTION_EXPORT_XREF table
after the export module has executed successfully. This process should be run in the manual mode.

31.4.1 Process Parameters


NP_TRANSACTION_EXPORT_ARCHIVER.ARCHIVETRANSACTIONEXPORTXREF
(
NLASTTENDAYSONLY,
NCACHESIZE,
NCOMMITINTERVAL
)

Parameter Name Description Type


NLASTTENDAYSONLY If value 1, archive only processed records for last NUMBER
10 days.
Default value is 0
nCacheSize Cache Size NUMBER
DEFAULT 1000
nCommitInterval Commit Interval NUMBER
DEFAULT 1000

31.4.2 Starting Archival Process in Manual Mode


Select the ManualState Guardian Data Export configuration in the ONE Point application. Right-click
Archive Customer XREF Transaction Export as shown here and click Start. Specify the value for the
input parameters as per the requirements. Then click OK to start the process. The service icon turns
green after it is started successfully.

IMS Health Operations Guide Page 280 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

31.4.3 Log File


View the log file in <np_root>\ np\log\ op_910240.log, which was generated by the previous process.
Search the log for the phrases Fail, Data Exception, and Error. If you find such a phrase, do not proceed.
Contact your support team and resolve the problem.

31.5 Troubleshooting

31.5.1 Unable to stop service


If the ONE Point application is not able to stop the service or if it is closed before the service is stopped,
active services can be stopped using Windows Services window.
1. Click the Windows Start button, and select Settings, and then select Control Panel to open the
Windows Control Panel.
2. On the Control Panel window, double-click Administrative Tools.
3. On the Administrative window, double-click Services to open the Services window.
4. Right-click the service name and then click the Stop option.

IMS Health Operations Guide Page 281 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

32. MAPPING CONFIGURATION GENERATOR

32.1 Overview
Mapping Configuration Generator is used to extract data source elements such as mappings, pattern
sets, patterns, merge rules, and lists from the configuration tables of a Nucleus 360 database.
Configuration Assistant facilitates extraction of these data source elements in XML format, whereas the
Mapping Configuration Generator extracts these data source elements in SQL format.
A configuration file, mapping_config.cfg, is used by this application. It contains a list of all the
configuration tables that need to be extracted as SQL SELECT statements.
Following is the list of current configuration tables that are set up in the mapping_config.cfg file.
Tables Tables
np_cfg_mapping np_cfg_pattern_def_component
np_cfg_map_source_type np_cfg_pattern
np_cfg_map_parameter_value np_cfg_pattern_def_element
np_cfg_fld np_cfg_pattern_variable
np_cfg_task np_cfg_pattern_variable_def
np_cfg_task_properties np_cfg_pattern_variable_output
np_cfg_map_field_class_dtl np_cfg_pattern_function
np_cfg_map_code_parser np_cfg_pattern_function_config
np_cfg_list np_cfg_pattern_set_function
np_cfg_list_item np_cfg_pattern_set_func_config
np_cfg_pattern_set np_rule
np_cfg_data_src_pattern_set np_rule_detail
np_cfg_pattern_def_parameter np_rule_detail_execution
np_cfg_pattern_set_pattern np_rule_detail_implementation

32.2 Running the Process


cd %DRTE_NP_BIN%
np_configuration_generator.exe [-?] [-v] [-V] [-c<db-config-file-name>]
-l<log-file-name> [-n] [-C<config-file-name>]

IMS Health Operations Guide Page 282 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

32.2.1 Command Line Parameters


Option Description
-? Detailed Help
-v Version Information
-V Extended Version Information (IMS Health Internal)
-c<db-config-file-name> Database configuration file. Default is dbcfg.txt
-l<log-file-name> Log file
-n Dry Run. Changes will not be applied to the database.
-C<config-file-name> Configuration file name

32.2.2 Output
Mapping Configuration Generator generates INSERT scripts for all the configuration tables listed in
mapping_config.cfg. These SQL scripts should be placed in folder <root
directory>\np\datasource\Mapping_Configuration to be executed when database configuration is
done. Refer to the Nucleus 360 Configuration Check List for details on using this application.

32.3 Troubleshooting

32.3.1 Log file option argument is required


Failure Description
Log file option argument is required
Failure Condition
Log file name is not passed while running the process which is a mandatory option.
Solution
Pass a valid log file name with the logging option -l.

32.3.2 Configuration file name is required.


Failure Description
Configuration file name is required.
Failure Condition
Configuration file name is not passed while running the process which is a mandatory option.
Solution
Pass a valid configuration file name with the option -C.

32.3.3 Cannot open Format file


Failure Description
Cannot open Format file

IMS Health Operations Guide Page 283 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Failure Condition
Configuration file name is not present in the specified path.
Solution
Make sure that the configuration file name and path are passed correctly and the file is present at the
specified path.

32.4 Restarting the Process


If the process fails in the middle of its execution, the cause for the failure should be identified and
resolved first. Delete all output files generated by the process and then restart it.

IMS Health Operations Guide Page 284 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

33. MQTEST UTILITY

33.1 Overview
mqtest.exe is a utility program that is used to test the real-time message queue configuration for server
layer processes.

33.2 Command Line Parameters


mqtest.exe [-?] [-v] [-V] [-c<file>] -s<source> -d<destination>
-o<operation> [-m<msgid>] [-f<file>] [-r<name>]

Parameter Description
-d Destination queue name
-o Operation [ READ | WRITE | DELETE | LISTEN | COPY | COUNT | PURGE ]
Note: LISTEN operation is applicable only for Oracle Advanced Queuing. Not
applicable for TIBCO and WebSphere MQ.
-m Message Id
-f Import data from file to destination
-s Source queue name. Valid only for COPY operation.
-c Database configuration file from which the message queue connection details are
read, default is dbcfg.txt
-r Message recipient or consumer name, defaulted to NP_APP_SL_MQTEST.
Applicable only for Oracle Advanced Queuing. Not applicable for TIBCO and
WebSphere MQ.
-? Display command line options
-v Version Information
-V Extended Version Information

33.3 Running mqtest.exe

33.3.1 To read all messages from a queue (e.g. WBI.TO.NP.QL)


$cd %DRTE_NP_BIN%
mqtest -oREAD -dWBI.TO.NP.QL

33.3.2 To delete all messages from a queue (e.g. WBI.TO.NP.QL)


$cd %DRTE_NP_BIN%
mqtest -oDELETE -dWBI.TO.NP.QL

IMS Health Operations Guide Page 285 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

33.3.3 To delete all messages from a queue without displaying them on the screen
(e.g. WBI.TO.NP.QL)
$cd %DRTE_NP_BIN%
mqtest -oPURGE -dWBI.TO.NP.QL

33.3.4 To get a count of messages from a queue (e.g. WBI.TO.NP.QL)


$cd %DRTE_NP_BIN%
mqtest -oCOUNT -dWBI.TO.NP.QL

33.3.5 To push a XML message file contents (e.g. test.xml) to the queue (e.g.
WBI.TO.NP.QL)
$cd %DRTE_NP_BIN%
mqtest -oWRITE -dWBI.TO.NP.QL -ftest.xml

IMS Health Operations Guide Page 286 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

34. UNIQUEIDGENERATOR UTILTIY

34.1 Overview
Unique_ID_Generator.exe is a utility program that is used to generate unique keys for each distinct
address. To configure Unique key for a entity, refer to configuration guide (NUC_5.2.0_CG_R1.doc).

34.2 Configuration File


Find the database connection string in Unique_ID_Generator.exe.config file and update it with a valid
database connection details.
Find the database connection string in unique_entity.dll.config file and update it with a valid database
connection details. Ideally unique_entity.dll.config and Unique_ID_Generator.exe.config files are
located at <NP_ROOT>\np\bin folder.

34.3 Command Line Parameters


Unique_ID_Generator.exe [-?] e=<entity_id> -m=<mode> [-r=<record_id>]
l=<log_file>

Parameter Description
-? Help. Display command line options.
-e Entity ID.
This is required parameter. A valid value should be passed.
318001 (Unique Address Configuration).
-m Mode of Operation. Valid operation modes are
This is a required parameter. A valid value should be passed.
1 - Incremental, 2 - Full Refresh, 3 - Process History Data and 4 - Single
Record.
-r Record ID. When mode of operation is 4, then record id should be passed using
this partameter.
-l Log file name. If file name has 'datetime' string then it will be expanded to
YYYYMMDD_HHMMSS format.
This is a required parameter. A valid value should be passed.

34.3.1 Output
After successful run, Unique ID Generator shows the total number of records processed and total unique
ids generated in the log file.
Unique ID Generator generates a unique key for each distinct address and inserts into
UNIQUE_ADDRESS entity. CUS_ADDRESS.GLOBAL_ID field is updated with these unique keys if not
present.

IMS Health Operations Guide Page 287 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

34.4 Troubleshooting

34.4.1 Connect Failed


Failure Description
Unhandled Exception: Oracle.DataAccess.Client.OracleException: ORA-12545: Connect failed because
target host or object does not exist
Failure Condition
Unique_ID_Generator.exe.config file is not updated with Database connection details.
Solution
Find the connection string in Unique_ID_Generator.exe.config file and update it with valid database
connection details.

34.4.2 Logon Denied


Failure Description
Unhandled Exception: Oracle.DataAccess.Client.OracleException: ORA-1017: invalid
username/password; logon denied
Failure Condition
Unique_ID_Generator.exe.config file is not updated with valid database userid/password.
Solution
Find the connection string in Unique_ID_Generator.exe.config file and update it with valid database
userid/password details.

34.4.3 Connect Failed


Failure Description
D:\5.2SL\np\bin>Unique_ID_Generator.exe -e=318001 -m=1 -l=log.log
2015-05-11 17:49:51 : *******************************************START*******************************************
2015-05-11 17:50:05 : ORA-12545: Connect failed because target host or object does not exist
2015-05-11 17:50:05 : *******************************************END*******************************************
Failure Condition
Unique_entity.dll.config file is not updated with valid database userid/password.
Solution
Find the connection string in Unique_entity.dll.config file and update it with valid database connection
details.

34.4.4 Logon Denied


Failure Description

IMS Health Operations Guide Page 288 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

D:\5.2SL\np\bin>Unique_ID_Generator.exe -e=318001 -m=1 -l=log.log


2015-05-11 17:56:56 : *******************************************START*******************************************
2015-05-11 17:56:56 : ORA-1017: invalid username/password; logon denied
2015-05-11 17:56:56 : *******************************************END*******************************************
Failure Condition
Unique_ID_Generator.exe.config file is not updated with valid database userid/password.
Solution
Find the connection string in Unique_entity.dll.config file and update it with valid database
userid/password details.

IMS Health Operations Guide Page 289 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

35. COMMAND DEFINITIONS FOR SCRIPTS

35.1 runstoredproc Analyzing Tables


Use the runstoredproc executable to analyze tables. Keeping the tables analyzed helps maintain system
performance.

35.1.1 Usage
$ cd %DRTE_NP_BIN%
$ runstoredproc spkg_db_maintenance.process_maintenance(<ID>)
Replace the <ID> with the appropriate value from the following table.
ID Description
5 Foundation Maintenance
6 Post-Delta Process
7 Pre-Match Pre-Process (Post-Hash)
16 Pre-ID Assign Process
17 Post-ID Assign Process
30 Match Pre-Process (Post Match Pre Process)
31 Pre-CCV Process
32 DQT Table Process
33 Pre-Delta Process
34 Staging Verification Queue Population
35 OPScrub Table Maintenance
36 Reconciliation Extract
37 Practitioner Verification Export
38 Practitioner Verification Import
39 Sampling Status Staging Table Population
40 Re-verification Queue Population
50 Match Index Process
100 Pre-Address Extract Pre-Process
101 Pre-Profile Extract Pre-Process
102 Pre-Customer Extract Pre-Process
103 NP Configuration Tables
104 Post-Data Quality
105 Post-Pre-ID Assign

IMS Health Operations Guide Page 290 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

ID Description
106 Pre-Hash
107 Post-Standardizer
108 Post-Merge

IMS Health Operations Guide Page 291 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36. NUCLEUS 360 SERVICES LIST

36.1 List of Services Provided by Nucleus 360


Several services are provided by Nucleus 360 to support various operations and accomplish different
functionalities. Following is a brief listing of the services along with some details to help with ongoing
maintenance.

36.1.1 NUC360Standardizer
Service Type Windows Service
Description This service is used for address standardization. It internally calls the
Nucleus address standardization daemon. It is generally used by
Customer Maintenance to standardize the address while creating
profiles.
Nuc Server Type App Server
Location in Server The Service executable can be located by viewing the properties of the
service. Ideally it is available in the <NP_ROOT>\np\bin folder.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when the app
server boots.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required for launching this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File nuc360standardizer.exe.config
This file will be available at the same place where the service executable
is located.
Log File Log file is an argument to the daemon process. The name and location of
the log file can be found in the configuration file.
Restart Steps This service can be started in two ways.
1. If it is configured in the ONE Point console, it can be restarted
from ONE Point.
2. It can be started or restarted, or stopped, from the Windows
Services console.

IMS Health Operations Guide Page 292 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

User/password The database userid\password to which this service points is configured


configuration in the dbcfg.txt file. The dbcfg.txt file can be found in the
<NP_ROOT>\np\bin folder.
This service can be run by providing specific user account authentication
and is recommended. Right-click the service and click Properties. Go to
the Log On tab, select This account, and then provide the Windows
user ID password or a service account user ID and password as needed.
Note: It is recommended to use the Service account user because the
Windows user password expires at regular intervals, and each time this
service need to be configured to reflect the password change. Service
accounts must be configured for the password to never expire.

36.1.2 Nuc360DataImport
Service Type Windows Service
Description This service is used to manage customers in Nucleus 360. It internally
invokes npdataimport.exe in a port listening mode. Hence any data
pushed to this port in a valid format will be received and responded to.
Nuc Server Type App Server
Location in Server The Service executable can be located by viewing the properties of the
service. Ideally it is available in the <NP_ROOT>\np\bin folder.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when app
server boots.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required for launching this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File nuc360dataimport.exe.config
This file will be available at the same place where the service executable
is located.
Log File Log file is an argument to the dataimport process. The name and location
of the log file can be found in the configuration file.
Restart Steps This service can be started two ways.
1. If it is configured in the ONE Point console, it can be restarted
from ONE Point.
2. It can be started or restarted, or stopped, from the Windows
Services console.
User/password The database userID\password to which this service points is configured
configuration in the dbcfg.txt file. The dbcfg.txt file can be found in the
<NP_ROOT>\np\bin folder.

IMS Health Operations Guide Page 293 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.3 Nuc360PollingSvc
Service Type Windows Service
Description This service is used to keep other services active. When they are not
used for a long time, services such as customer lookup and Customer
manage release connectivity to the database session and free the buffer.
When the services are called the next time, it re-establishes the database
connection and then performs the operation. This takes a longer time and
causes inconvenience to end users. Hence the polling service is used to
make a fake call at regular time intervals to those services to keep them
awake all the time.
Nuc Server Type Web Server
Location in Server The Service executable can be located by viewing the properties of the
service.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when the web
server boots.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required for launching this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File Nuc360PollingSvc.exe.config
This file will be available at the same place where the service executable
is located.
Polling frequency can be configured or changed in the config file. Look
for PollingTimeInSec and provide the required value. This value is in
seconds and the fake service call will be made at this interval.
Log File This service is used for fake service calls and hence no log file is used.
Restart Steps This service can be started two ways.
1. If it is configured in the ONE Point console, it can be restarted
from ONE Point.
2. It can be started or restarted, or stopped, from the Windows
Services console.
User/password This service uses app user name and password, and they are configured
configuration in the configuration file. Look for the string UserName and Password
in the configuration file and make necessary changes to these
arguments.

IMS Health Operations Guide Page 294 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.4 Orbix Daemon


Service Type Windows Service
Description This is a service that keeps the Orbix daemon running in the Middle Tier
servers. All GUI apps communicate to Middle Tier servers via the Orbix
daemon.
Nuc Server Type Middle Tier Server
Location in Server The Service executable can be located by viewing the properties of the
service. Ideally it is available in the C:\iona\bin folder.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when the app
server boots.
Launch Parameters This service launches with default parameters. No parameters are
required to be modified by user.
Config File This service comes with its default configuration files and no modification
is required by user.
Log File This service has its own log file and it does not take any log file
parameter. Ideally it writes to the C:\iona\config\ErrorMsgsfile.
Restart Steps This service can be started two ways.
1. If it is configured in the ONE Point console, it can be restarted
from ONE Point.
2. It can be started or restarted, or stopped, from the Windows
Services console.
User/password This service doesnt use any userID for authentication. It is just a layer to
configuration communicate between Middle Tier servers and client GUI apps.

36.1.5 Apache Tomcat


Service Type Windows Service
Description This is a third party service used by Nucleus 360. This service is used by
the Nucleus 360 Customer Maintenance web app to communicate
between the calling client machine and the CM installed web server.
Nuc Server Type Web Server
Location in Server The Service executable can be located by viewing the properties of the
service. Ideally it is available in the C:\Program Files (x86)\Apache
Software Foundation\Tomcat 5.5\bin folder.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when the web
server boots.
IMS Health Operations Guide Page 295 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Launch Parameters This service launches with default parameters. No parameters are
required to be modified by user.
Config File This service comes with its default configuration files and no modification
is required by user.
Log File This service has its own log file and it does not take any log file
parameter. Ideally it writes to the C:\Program Files (x86)\Apache
Software Foundation\Tomcat 5.5\logs folder.
Restart Steps It can be started or restarted, or stopped, from the Windows Services
console.
User/password This service does not use any userID for authentication. It is just a layer
configuration to communicate between web apps from client and web server.

36.1.6 CustomerLookup
Service Type Web Service
Description This web service is used to look up customers in the Nucleus 360
database.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->CustomerLookup. Right-click CustomerLookup and click
Explore. This opens the CustomerLookup installed folder.
Status IIS Web Site must be running for CustomerLookup to work.
Launch Options IIS by default starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required for launching this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File web.config
This file will be available in the CustomerLookup installed folder.
Log File Log file path is configured in the config file. Look for logFilePath in the
web.config file which points to the log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.

IMS Health Operations Guide Page 296 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.7 CustomerLookup2
Service Type Web Service
Description This web service is used to look up customers in the Nucleus 360
database.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->CustomerLookup2. Right-click CustomerLookup2 and click
Explore. This opens the CustomerLookup2 installed folder.
Status IIS Web Site must be running for CustomerLookup2 to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File web.config
This file will be available at the CustomerLookup2 installed folder.
Log File Log file path is configured in the config file. Look for logFilePath in the
web.config file, which points to the log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user id\password changes.

36.1.8 QuickSearch
Service Type Web Service
Description This web service is used to look up customers in Nuc 360 5.2 portal and
Customer Maintenance by selecting the Quick Search option rather than
searching in the database. This search is performed on index-based files.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->Nuc360QuickSearch5.2. Right-click on Nuc360QuickSearch5.2
and click Explore. This opens the Nuc360QuickSearch5.2 installed
folder.
Status IIS Web Site must be running for Nuc360QuickSearch5.2 to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No

IMS Health Operations Guide Page 297 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

additional parameters are required to launch this service. However, to


change any parameter value, change it in the config file as mentioned
below.
Config File web.config
This file will be available at the Nuc360QuickSearch5.2 installed folder.
Log File Log file path is configured in the config file. Look for logFilePath in the
web.config file which points to the log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information is configured in the web.config configuration
configuration file. Look for NucleusConnectionString in the web.config file to make
any user ID\password changes.
The complete root path of the Nuc 360 webservices folder should be
configured in web.config.

36.1.9 NUC360PingFederateService
Service Type Web Service
Description This is a web service used to authenticate and authorize client users who
log in to Nucleus 360 apps over the internet.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->NUC360PingFederateService. Right-click
NUC360PingFederateService and click Explore. This opens the
NUC360PingFederateService installed folder.
Status IIS Web Site must be running for NUC360PingFederateService to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service.
Config File web.config
Log File This web service does not write to any log file.
Restart Steps Since this is a web service, we canno restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password This service does not use any user ID\password.
configuration

IMS Health Operations Guide Page 298 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.10 Security Service


Service Type Web Service
Description This is a web service used to authenticate and authorize client users who
log in to Nucleus 360 applications.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->NUC360Security5.2. Right-click NUC360Security5.2 and click
Explore. This opens the NUC360Security5.2 installed folder.
Status IIS Web Site must be running for NUC360Security5.2 service to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service.
Config File web.config
Log File This web service does not write to any log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.

36.1.11 ProfileDetailsService
Service Type Web Service
Description This is a web service used to get profile details in the Nuc360 Portal.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->Nuc360ProfileDetails5.2. Right-click Nuc360ProfileDetails5.2
and click Explore. This opens the Nuc360ProfileDetails5.2 installed
folder.
Status IIS Web Site must be running for Nuc360ProfileDetails5.2 service to
work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service.
Config File web.config
Log File This web service does not write to any log file.

IMS Health Operations Guide Page 299 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.

36.1.12 CustomerManage
Service Type Web Service
Description This web service is used to manage customers in the Nucleus 360
database. Managing the customer means adding/editing/deleting
customers for the configured data source. This service internally invokes
npdataimport.exe listening to a port in the Nucleus 360 app server.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site-> CustomerManage. Right-click CustomerManage and click
Explore. This opens the CustomerManage installed folder.
Status IIS Web Site must be running for CustomerManage to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File web.config
This file will be available at the CustomerManage installed folder. If the
app server or the port that is used in the app server is changed for any
reason, the same change should reflect in the configuration file. Look for
HostName and Port in the web.config file and make necessary
changes. Restart Default Web Site.
Log File Log file path is configured in the config file. Look for logFilePath in the
web.config file, which points to the log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for managing
configuration customers is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.

IMS Health Operations Guide Page 300 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.13 Database Search Service


Service Type Web Service
Description This is a web service used to get Nucleus 360 metadata, perform
Validation Request operations, Customer Resolution operations.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->Nuc360DbSearch5.2. Right-click Nuc360DbSearch5.2 and click
Explore. This opens the Nuc360DbSearch5.2 installed folder.
Status IIS Web Site must be running for Nuc360DbSearch5.2 service to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service.
Config File web.config
Log File This web service does not write to any log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.
Referred URLs/Config Files This service refers/uses
Configuration
1. Security web service to authenticate and authorize the user who
access this service. Security service URL should be configured in
the web.config file. Look for Security service URL place holder
in the web.config file to make any security service URL
changes.
2. Customer Manage web service. Customer Manage service URL
should be configured in the web.config file. Look for Customer
Manage Service URL place holder in the web.config file to make
any Customer Manage Service URL changes.
3. VR Meta Data config file. This file location should be configured
in the web.config file. Look for the VR Meta Data config file
place holder in the web.config file to make any VR Meta Data
config file changes.

IMS Health Operations Guide Page 301 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.1.14 Standardizer Service


Service Type Web Service
Description This service is used for address standardization. It internally calls the
Nucleus address standardization daemon. It is generally used by Nuc
360 portal to standardize the address while creating profiles.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->Nuc360Standardizer5.2. Right-click Nuc360Standardizer5.2 and
click Explore. This opens the Nuc360Standardizer5.2 installed folder.
Status IIS Web Site must be running for Nuc360Standardizer5.2 service to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required to launch this service.
Config File web.config
Log File This web service does not write to any log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.
Referred URLs This service refers/uses Security web service to authenticate and
Configuration authorize the user who access this service. Security service URL should
be configured in the web.config file. Look for Security service URL place
holder in the web.config file to make any Security service URL changes.

36.1.15 Unique ID Generator Service


Service Type Web Service
Description This service is used for generating a unique address id for each distinct
address. It is generally used by Nuc 360 portal and Customer
Maintenance applications.
Nuc Server Type Web Server
Location in Server Launch IIS manager by typing inetmgr. Then go to Sites->Default Web
Site->UniqueIDGenerator. Right-click UniqueIDGenerator and click
Explore. This opens the UniqueIDGenerator installed folder.
Status IIS Web Site must be running for UniqueIDGenerator service to work.
Launch Options By default, IIS starts when the web server is booted.
Launch Parameters Default parameters are configured during installation in the config file. No

IMS Health Operations Guide Page 302 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

additional parameters are required to launch this service.


Config File web.config
Log File This web service does not write to any log file.
Restart Steps Since this is a web service, we cannot restart it. However, if this service is
not responding, the Default Web Site can be restarted.
Note: Restarting Default Web Site impacts all the web services hosted
under that.
User/password The database information to which this web service points for customer
configuration search is configured in the web.config configuration file. Look for
connectionStrings in the web.config file to make any
user ID\password changes.

36.1.16 Quick Search Indexer Service


Service Type Windows Service
Description This service is used to add/update the Quick search Lucene Index files
in Nucleus 360. Any new data received from Nuc 360 Portal is pushed to
this service to add/update the existing Lucene Index files.
Nuc Server Type Web Server
Location in Server The Service executable can be located by viewing the properties of the
service. Ideally it is available in the
<Nuc360_5.2>\WebServices\Indexer\Application folder.
Status In the Windows Services console, look for this service. The Status
column shows the current status of this service (whether it is running or
not).
Launch Options This service is by default configured to start automatically when web
server boots.
Launch Parameters Default parameters are configured during installation in the config file. No
additional parameters are required for launching this service. However, to
change any parameter value, change it in the config file as mentioned
below.
Config File QuickSearchIndexerWinService.exe.config
This file will be available at the same place where the service executable
is located.
Log File Log file is an argument to the dataimport process. The name and location
of the log file can be found in the configuration file.
Restart Steps This service can be started or restarted, or stopped, from the Windows
Services console.
User/password The database information to which this web service points for customer
configuration search is configured in the QuickSearchIndexerWinService.exe.config
configuration file. Look for connectionStrings in the
QuickSearchIndexerWinService.exe.config file to make any
user ID\password changes.

IMS Health Operations Guide Page 303 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

36.2 Check if IIS Is Up and Running


1. At the run command, type inetmgr.
2. Click the Default Web Site as shown in the opened console.

3. On the rightmost side of the console, you will see the following. This means Web Site is running. If it
is not, click Start. If the Web Service is still not responding as expected, click Restart, or click Stop
and Start again.

IMS Health Operations Guide Page 304 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

37. ADHOC MATCH

37.1 Overview
Adhoc match process will help identify the corresponding CCV profiles within the Nucleus system for the
pre-defined format input data.

37.2 What Adhoc Match Process Does


As soon as user uploads the input data file in a pre-defined format and naming convention on MoveIT
site AdhocMatchDownload folder, a Komodo job downloads the files to Server layer installed folder
Komodo starts another process which does the following:
o Picks each file at a time and standardizes the input data.
o Creates the corresponding hash keys.
o Runs the match process against already loaded different source profiles.
o Produces two output files and zips both the files:
Match output file Matched data will be output in a match output file.
Cross reference output file For the source profile ID, what is the corresponding CCV Global
ID found details will be present.
o Then the zipped file is uploaded in MoveIT site within the AdhocMatchUpload folder.
o The process picks the next file and starts the process again from first point.
Once all the file processing and uploading is completed, Komodo scheduler process waits until the
next interval. During the processing of current set of files, if the next scheduled interval is passed, as
soon as the current files processing is completed, Komodo process picks the next set of input files
from folder immediately. Otherwise, Komodo scheduler waits until the next scheduled period for
processing next set of data files.

37.3 Running the Adhoc Match Process

37.3.1 Running the Adhoc Match Process Using the Komodo Job Scheduler

37.3.1.1 Verifying the Komodo Services


Open IMS Health Framework Setup as administrator and check whether the Framework, KomodoHost,
KomodoJobmanager, and SchedulerManager services are running under Framework and Services tabs
as shown in the following screenshot.

IMS Health Operations Guide Page 305 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

37.3.1.2 Running the Adhoc Match Process


Log in to the Komodo web site using Tenant user credential.
Note: Do not run any job as Super User.

Scheduler:
1. Right-click on 100_AdhocMatch_Prof_Target job and click on Schedule Job. This goes to
the Schedule page.
Schedule the job by setting the required scheduler parameters.

IMS Health Operations Guide Page 306 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

OR
Click on Scheduler tab.
Select Nucleus360_AdhocMatch project from Project dropdown and
100_AdhocMatch_Prof_Target job from Job dropdown.
Set required parameters as shown in the following screenshot to schedule the job.

IMS Health Operations Guide Page 307 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Recurrence pattern: Daily


Every 1 day
Start Time: Set Start time, for example, 9/3/2014 12:01 AM
End Time: Set End Date, for example, 12/31/2070 (provide long duration)
Tolerance: Set default which is 00:05:00.(job will start after start time + tolerance time)
Interval Unit: select Hours and Set time for re-execution of job, for example, Hour : 23
Mode: Select Until and set time .Until this time job will execute for that day. For example, 23:59:59
(HH:MM:SS).
Example: For the above setting, 1 time job will execute for every day.
Verbosity: Low
Location :Database
NOTE: The Tolerance must be less than Repetition Interval.

2. Right-click on 200_AdhocMatch_Prof job and click on Schedule Job. This goes to the
Schedule page.
Schedule the job by setting up the required scheduler parameters.

IMS Health Operations Guide Page 308 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

OR
Click on Scheduler tab.
Select Nucleus360_AdhocMatch project from Project dropdown and 200_AdhocMatch_Prof
job from Job dropdown.
Set required parameters as shown in the following screenshot to schedule the job.

IMS Health Operations Guide Page 309 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Recurrence pattern: Daily


Every 1 day
Start Time: Set Start time, for example, 9/3/2014 ,4:00 AM
End Time: Set End Date, for example, 12/31/2070 (provide long duration)
Tolerance: Set default which is 00:05:00.(job will start after start time + tolerance time)
Interval Unit: Select Hours and Set time for re-execution of job, for example, Hour : 1
Mode: Select Until and set time .Until This time job will execute for that day. For example, 23:59:59
(HH:MM:SS).
Example: For the above setting, 20 times job will execute for every day means every one hour job
will run.
Verbosity: Low
Location :Database
NOTE: The Tolerance must be less than Repetition Interval.

Logger:
Click on Logger and see the status of the jobs as shown below screen shot.

IMS Health Operations Guide Page 310 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Click on Job (200_Adhoc_Match_Prof) link and see the details of the job status based on Log
Type dropdown value as shown following.

Dashboard:
Click on Dashboard and select a row to see the statistics of that job run flow, as shown in the
following screenshot.

37.3.1.3 To Run The AdhocMatch Jobs Manually


1. Click Designer. Select Project Explorer.
2. Expand Global, expand Nucleus360_AdhocMatch project, and expand Jobs as shown in the
following screenshot.
To generate target output file
1. Double-click on 100_AdhocMatch_Prof_Target job, click on Run_AdhocMatch_Prof_Target_Nstd
task from right side panel, then click on Run Job.
2. Select Verbosity Low and click Submit.

IMS Health Operations Guide Page 311 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

To run adhoc match process for professional


1. Double-click on 200_AdhocMatch_Prof job, click on Download_From_MoveIT_Nstd task from
right side panel, then click on Run Job.
2. Select Verbosity Low and click Submit.

IMS Health Operations Guide Page 312 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

37.3.2 Running the Adhoc Match Manually from Application Server


To run the process manually, from Nucleus360 installed application server, for the small scale files, user
needs to perform the following steps:
1. Copy the Input data files into <NP_ROOT>\third_party\np\in\AdhocMatch
2. Run the AdhocMatch_Prof.ps1 powershell program from the Powershell 4.0 command prompt as
shown below:
PS <drive>:\> cd <NP_ROOT>\np\bin\adhocMatch
PS <NP_ROOT>\np\bin\adhocMatch> AdhocMatch_Prof.ps1 "NP_ROOT" "1"

SYNOPSIS
AdhocMatch_Prof.ps1 "NP_ROOT" "1"
Script will run the Adhoc match process for the input files and cleanup
the intermediate files created for processing each input file.

AdhocMatch_Prof.ps1 "NP_ROOT" "0"


Script will run the Adhoc match process in debug mode (for the input
file do not cleanup the intermediate files during the processing of the
input file).

IMS Health Operations Guide Page 313 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

AdhocMatch_Prof.ps1 "NP_ROOT"
This will also run the Adhoc match process for the input files and
cleanup the intermediate files created for processing the input file.

37.4 Troubleshooting
If Adhoc match process fails during any stage, the user can copy the input data files in
<NP_ROOT>\third_party\np\in\AdhocMatch folder and restart the process. Refer to section Restarting
the Adhoc Match process 37.5 for further details. If user is not sure about the process to produce the
output for the input data, it is recommended to run the Adhoc Match process in Debug mode. Refer to the
previous section for running the process in Debug mode.

37.4.1 Adhoc Match process completes but output files within .zip file are empty

37.4.1.1 Explanation
This problem occurs if the Adhoc Match configuration files are not modified properly.

37.4.1.2 Solution
Perform the following steps:
1. Check the configuration files for correctness
2. Delete the intermediate configuration and output files
3. Delete the entries present in NUC_ADHOC_HASH_KEYS table entry for the last run_id.
4. Copy the input Data file into <NP_ROOT>\third_party\np\in\AdhocMatch folder
5. Restart the Adhoc Match process (refer to section 37.5 for more details).

37.4.2 Errors in matchlog.log File

37.4.2.1 Explanation
Within the matchlog.log file, if user gets the following kind of errors or match completed successfully with
0kb output files.
SocketException: System.Net.Sockets.SocketException (0x80004005): No connection could be made
because the target machine actively refused it <Application Server IP>:<Address Standization application
running Port number>

37.4.2.2 Solution
Perform the following steps:
1. Restart the address and name standardization daemon in Nucleus 360 Application Server.
2. If Adhoc Match process is still running, stop the process.
3. Delete the intermediate configuration and output files.
4. Delete the entries present in NUC_ADHOC_HASH_KEYS table entry for the last run_id.
5. Copy the input Data file into <NP_ROOT>\third_party\np\in\AdhocMatch folder.

IMS Health Operations Guide Page 314 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

6. Restart the Adhoc Match process (refer to section 37.5 for more details).

37.5 Restarting the Adhoc Match Process


If the process fails in the middle for any reason, perform the following steps to re-start the Adhoc Match
process manually from Application Server:
1. If Adhoc Match process is still running, stop the process.
2. Delete the following intermediate files generated (if the Adhoc Match process is run in Debug mode or
the process is forcibily aborted by user or the process aborted by itself for any reasons):
o <NP_ROOT>\np\bin\adhocMatch\adhocmatch_stdprof_<INPUT File Name>.xml
o <NP_ROOT>\np\bin\adhocMatch\adhocmatch_hashprof_<INPUT File Name>.xml
o <NP_ROOT>\np\bin\adhocMatch\adhocmatch_matchprof_<INPUT File Name>.xml
o <NP_ROOT>\np\bin\adhocMatch\adhocmatch_cleanup_<INPUT File Name>.sql
o <NP_ROOT>\third_party\np\out\AdhocMatch\<INPUT File Name>.txt
o <NP_ROOT>\third_party\np\out\AdhocMatch\<INPUT File Name> folder
o <NP_ROOT>\third_party\np\out\AdhocMatch\std_output_bat_<INPUT File Name>.txt
o <NP_ROOT>\third_party\np\out\AdhocMatch\std_output_<INPUT File Name>.txt
o <NP_ROOT>\third_party\np\out\AdhocMatch\<INPUT File Name>.zip
3. Delete the intermediate temporary keys generated from NUC_ADHOC_HASH_KEYS table for the
last Adhoc Match run id.
4. Copy the Input data file in <NP_ROOT>\third_party\np\in\AdhocMatch\<INPUT File Name>.txt
from <NP_ROOT>\third_party\np\in\AdhocMatch\Archive folder.
5. Restart the Adhoc Match process by referring to section 37.3.

IMS Health Operations Guide Page 315 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX A: FREQUENTLY ASKED QUESTIONS


Q: I did not keep track of the process when it ran and I do not know where the logs are stored.
A: All logs are stored in %DRTE_NP_LOGS%. Use the following command to display all the
files in the directory, sorted by date, with the most recently updated files listed at the
bottom.
dir /od $DRTE_NP_LOGS

IMS Health Operations Guide Page 316 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX B: DATABASE ERRORS

LConnectionPool.Init failed. Check database configuration file


Explanation
Dbcfg.txt file contains parameters required for database connectivity.
Solution
If the dbcfg.txt file is not found in the $DRTE_NP_BIN directory, then copy it from the $DRTE_NP_DEFS
directory. If it already exists, make sure that the following database connection pool names are defined
[SYSTEM]
[NUCLEUSPHARMA]
A sample dbcfg.txt file follows:
[SYSTEM]
POOLNAME=SYSTEM
MAXCON=100
LOGON=scott
PWD=pmcav
HOSTID=sample
RDBMS=ORACLE
LOGFILE=system_pool.log
LOGDIRECTORY=.
LOGENABLED=n
LOGSEPARATOR=------
APPMONITORENABLED=n

[NUCLEUSPHARMA]
POOLNAME=NUCLEUSPHARMA
MAXCON=100
LOGON=scott
PWD=pmcav
HOSTID=sample
RDBMS=ORACLE
LOGFILE=np_pool.log
LOGDIRECTORY=.
LOGENABLED=n
LOGSEPARATOR=------
APPMONITORENABLED=n

[NPMS]
LOGON=np_admin
PWD=xxxxxxxx
HOSTID=aenp01
PLUGIN=NPMsgServiceAQ.dll

IMS Health Operations Guide Page 317 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

ORA-01017: invalid username/password; logon denied


Solution
Open the dbcfg.txt file and verify the following:
LOGON parameter should have the Oracle user name.
PWD parameter should have the encrypted Oracle user-password.
[NUCLEUSPHARMA]
POOLNAME=NUCLEUSPHARMA
LOGON=scott
PWD=pmcav


ORA-12154: TNS:could not resolve service name


Solution
Open the dbcfg.txt file and make sure that the HOSTID parameter has the correct database name.
[NUCLEUSPHARMA]
POOLNAME=NUCLEUSPHARMA
HOSTID=sample

Slow performance
Effective use of the Oracle Cost-based Optimizer (CBO)
Execution plan is the series of steps Oracle will perform to retrieve data from the tables. A component of
the database known as the Optimizer decides the execution plan. Oracle supports two types of
optimizers, cost-based optimizer (CBO) and rule-based optimizer (RBO).
To determine the best execution path, the CBO uses database information such as table size, number of
rows, key spread, and so forth, rather than rigid rules. The statistics required for the CBO are available
once an object (table/index) has been analyzed. The frequency of analyzing is dependent on the rate of
change and on the size of the objects. When objects are analyzed, Oracle gathers statistics about the
object. If statistics are missing, then the CBO can only guess what data might be in the table. The
statistics allow the optimizer to determine the most likely size of the result set of rows queried from each
table.
Nucleus 360 processes are designed to take advantage of the CBO. Oracle recommends using the CBO
and the role of the rule-based optimizer will probably diminish over time.
Refer to the process operations instructions for the command for analyzing the objects.

IMS Health Operations Guide Page 318 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Rollback segment error


When a process changes a database value, the updated information is stored in a special area called the
rollback segment. Oracle keeps the updated information here so that it can undo changes if the process
does not want to apply changes it made to the database. The updated information remains in the rollback
segment until the process explicitly issues a database commit command to apply changes permanently
(or) the rollback command to revoke changes.
ORA-01555 snapshot too old: rollback segment number segment number with name segment
name too small
This could happen when running multiple processes concurrently that operate on the same set of data.
Records that are read by one process are overwritten by another process.
ORA-01562 failed to extend rollback segment number segment number
Oracle keeps the database changes made by the process in rollback segments until the process issues a
commit or rollback. When there is no space to store records in the rollback segment, Oracle would try
to extend the size of the rollback segment. If Oracle cannot extend the size, it throws the error.
ORA-0163x max # extents reached
ORA-01631 max # extents number reached in table table name
ORA-01632 max # extents number reached in index index name
When an Oracle table/index is created, the user can specify the maximum size of the object. This
maximum size will be allocated in multiple extents as and when required, based on the current size of the
object. When a table is populated and if there was no space available in the allocated extent, Oracle
would allocate a new extent for the table/index. It the number of extents allocated reaches the maximum
limit defined for that object, Oracle would throw this error the next time there is a request for a new extent.
Contact the Oracle DBA to resolve this issue.
ORA-0165x unable to extend tablespace
ORA-01653 unable to extend table table name by string in tablespace tablespace name
ORA-01654 unable to extend index index name by string in tablespace tablespace name
A database is divided into logical storage units called tablespaces, which group logical structures
together. Oracle allocates new extents for the database objects (index/table) in the tablespace that was
specified when the object was created. The error would occur if the following were true:
The tablespace is full.
The tablespace has no free extent large enough to satisfy the request to extend this particular object.
The required space may exist in the tablespace, but not as a contiguous extent of the required size.
Contact the Oracle DBA to resolve this issue.

IMS Health Operations Guide Page 319 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX C: DATABASE CONFIGURATION FILE -DBCFG.TXT


The configuration file dbcfg.txt is the file that is used to control database settings for the Nucleus 360
server layer processes. This configuration file contains settings that control database connectivity, logging
options, and other options as well. The configuration file is in plain text format and can be viewed/edited
using any standard text editor.
The dbcfg.txt file is laid out in blocks. Two blocks are essential for the server layer processes
SYSTEM block and the NUCLEUSPHARMA block. Each block begins with a line that has the block name
enclosed within brackets, as shown:
[SYSTEM]

[NUCLEUSPHARMA]

The blocks may contain the following settings:
POOLNAME (Required) This string value denotes the name of the database connection pool to be
used by the processes. The value should always be equal to the name of the block.
MAXCON (Required) This is an integer value that specifies the maximum number of database
connections that will be required by the processes. Essentially, it is the number of database
connections that are reserved.
LOGON (Required) This string value denotes the user name that should be used to connect to the
database.
PWD (Required) This string value denotes the password corresponding to the database user name
specified in the LOGON configuration setting. Note: The value specified here must be the encrypted
form of the password.
HOSTID (Required) This string value denotes the name of the database to which to connect, as
specified in the Oracle file tnsnames.ora.
RDBMS (Required) This string value denotes the type of database to which to connect. At this
point, ORACLE is the only valid value for this setting.
LOGFILE (Required) This string value denotes the full path and file name to be used for logging
purposes.
LOGENABLED (Optional) This character value specifies whether logging is enabled. The valid
values are y (enabled) or n (disabled). The default value is n. If the logging option is enabled, all
database operations will be logged in a log file mentioned in the LOGFILE settings. Warning: This
option should be enabled only for debugging purposes as the size of the log file will grow
considerably large.
LOGSHOWDATETIME (Optional) This character value specifies whether each entry generated in
the log file is prefixed with a date/time stamp. The valid values are y (enabled) or n (disabled). The
default value is n.
LOGSEPARATOR (Optional) This string value specifies what the line that separates each entry in
the log file should look like.
LOGDIRECTORY= (Required) This string value denotes the full path to the directory that is to be
used for logging purposes. Note: The last character in this string value should be a slash (/).

IMS Health Operations Guide Page 320 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Following is an example of a SYSTEM and NUCLEUSPHARMA block:


[SYSTEM]
POOLNAME=SYSTEM
MAXCON=10
LOGON=COMMON_USER
PWD=<ENCRYPTED PASSWORD>
HOSTID=SAMPLE_DB
RDBMS=ORACLE
LOGFILE=system_pool.log
LOGENABLED=n
LOGSHOWDATETIME=y
LOGSEPARATOR=---
LOGDIRECTORY=c:\np\log

[NUCLEUSPHARMA]
POOLNAME=NUCLEUSPHARMA
MAXCON=10
LOGON=COMMON_USER
PWD=<ENCRYPTED PASSWORD>
HOSTID=SAMPLE_DB
RDBMS=ORACLE
LOGFILE=np_pool.log
LOGENABLED=n
LOGSHOWDATETIME=y
LOGSEPARATOR=---
LOGDIRECTORY=c:\np\log

[NPMS]
LOGON=np32_1100_admin
PWD=<ENCRYPTED PASSWORD>
HOSTID=aenp01
PLUGIN=NPMsgServiceAQ.dll

IMS Health Operations Guide Page 321 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX D: MISCELLANEOUS ERRORS

User Id: <username> not in NUCLEUS.System_User or inactive


Explanation
Only registered users that are in the Nucleus 360 system can run the process.

Solution
Add the user to the Nucleus 360 database.

Environment variable NP_APP_USER not defined


Explanation
Set the environment variable NP_APP_USER with the user ID that executes the Nucleus 360 processes.

Solution
Add this variable to My Computer | Properties | Environment.

IMS Health Operations Guide Page 322 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX E: CONFIGURATION ASSISTANT TIMEOUT ERRORS

Run Time Errors


This section lists possible errors that can arise when the MT servers shut down or lose connection while
the Configuration Assistant application is still running. Normally this happens when the application is left
running without any activity for an extended periods (longer than the MT server timeout Default MT
timeout is 10 hours).

Exceptions
Following are some variations of the most common errors that you may receive; others may exist.
1. Incomplete forms, empty fields, grids, and dropdown lists

IMS Health Operations Guide Page 323 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

2. Errors opening a screen. Object Required 424, Invalid property array index 381

IMS Health Operations Guide Page 324 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

3. Screens showing item codes (e.g., 100001) where it should display item descriptions (e.g., Female)

4. Errors creating objects (mapping, merge, list, pattern, pattern set). Invalid Key 35603. Object
variable or With block variable not set.

Explanation
The MT servers shut down due to a timeout but the Configuration Assistant Application GUI was still
running. The GUI attempts to restart the MT servers but fails to initialize all objects.

Solution
Close the Configuration Assistant GUI and launch it again, check the issue again. If the issue still exists,
note all relevant information regarding the issue and contact IMS Health.

IMS Health Operations Guide Page 325 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX E: ACE/IACE POSTALSOFT ERRORS

Run Time errors


This section lists possible errors that can arise due to bad/out of date installation of ACE/IACE (Nucleus
360 version 3 and above comes configured with IACE by default libraries).

Exception: open (Engine) failed, check ....


Open (Engine) failed, check paths in configuration file and dir expiration dates. The PWCAS Dictionary
specified is missing or could not be opened. File:
c:\cdis\wkenv\serverapps\nucleuspharma_<..>\aceinterface\src\lace interfaceiace.cpp Line: 151.

Explanation 1
The IACE directories have expired and you are in CERTIFIED mode.

Solution 1
Make sure the latest files from Business Objects (First Logic) have been applied. Refer to section 9.5.2.1
for an alternate solution.

Explanation 2
The path variable in the operating system environment is pointing to a version other than the latest
version (which is the officially supported version).

Solution 2
Check the PATH variable to confirm if the path set is pointing to the correct officially supported version.
For example, if the value is set as,
PATH=c:\pw\v710\iacelib;c:\pw\v710\adm
Whereas the supported version of the Firstlogic libraries is, for example, 7.70c (installed in the
c:\pw\v770C directory). Update the environment variable to point to the correct version, for example:
PATH=c:\pw\v770C\iacelib;c:\pw\v770C\adm

Explanation 3
The error is due to the wrong path in the ace.cfg file or country-specific configuration file.

Solution 3
Make sure the path information in the ace.cfg file and country-specific configuration file is correct. Also
make sure that the DCT file and PATH are specified properly.

Error: DIRECTORY OUT OF DATE


The specified ZIP+4 directory has expired. Exception: ACE_OPEN failed, check paths in ace.cfg and dir
expiration dates. Press return to continue.
Or
Open (Engine) failed, check paths in configuration file and dir expiration dates.
ZIP+4 directory expires in n days.

IMS Health Operations Guide Page 326 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Explanation
The IACE directory files have expired.

Solution
Make sure the latest files from Business Objects (First Logic) have been applied.

Error: Failed to initialize config file : ace.cfg


File:\cdis\wkenv\serverapps\nucleuspharma_x3.1.0.latest\aceinterface\src\lacema
inapp.cpp Line: 192
Explanation
The ace.cfg file is missing from bin directory (as set in the $DRTE_NP_BIN variable).

Solution
A copy of the ace.cfg file should be present in the defs directory. Create a soft link so that the file can be
used from the bin directory.
On Windows 2008:
%DRTE_NP_BIN%> copy %DRTE_NP_DEFS%\ace.cfg ace.cfg

No Address standardization option selected.


NP_EXCLUDE_ADDRESS_STD was set
Explanation
You have the LT version of the Nucleus 360 processes. In the abbreviated version, address
standardization is not enabled.

Solution
If you need the address standardization option enabled, please contact your support team.

Standardization Error Codes


The following is a list of Postalsoft error codes that are recorded in the address table in Nucleus 360 when
an address cannot be standardized using Firstlogic IACE engine.
Error Code Description
F101 Last line is bad.
F214 Bad locality, bad postal code.
F216 Bad postal code; cannot determine which locality to select.
F212 No locality, postal code is bad.
F433 Address conflicts with postal code; different street name exists for input postal code.
F425 Suffix and directional needed, input is wrong or missing.
F427 Post-directional needed; input is wrong or missing.

IMS Health Operations Guide Page 327 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Error Code Description


F437 Multiple match, different directory areas.
F434 Street assignment was possible, there was a duplicate postal code match.
F413 Possible street-name matches are too close to choose one.
F430 Possible address-line matches are too close to choose one.
F432 Address conflicts with postal code, and the same street has a different postal code.
F453 More than one match found for unit, could not choose one.
F429 Bad city, cannot select an address match.
F412 Street name not found in postal directory.
F428 Bad postal code; cannot select an address match.
F302 No primary address line.
F502 Input record entirely blank.
F213 Bad locality, no postal code.
F435 No street assignment, no postal code.
F436 No street assignment, postal code not matched.
F420 Primary range is missing.
F438 Secondary address information is missing.
F431 Puerto Rican urbanization needed; input is wrong or missing.
F503 Postal code is not in area covered by partial postal code directory.
F451 P.O. box missing or out of range.
F452 P.O. box disagrees with postal code.
F422 Pre-directional needed; input is wrong or missing.
F421 Primary range is not valid for the street, route, or building.
F504 Overlapping ranges in postal directory.
F423 Suffix needed; input is wrong or missing.
F600 Undeliverable.
F450 Unit missing or out of range.
F500 Other error
F501 Foreign address

IMS Health Operations Guide Page 328 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX F: IACE CONFIGURATION FILE


There are various configuration files used by the IACE Interface library as given in the following table.
File Name Location Description
ace.cfg %DRTE_NP_BIN% The root configuration file that specifies:
a) directory
b) link to other cfg
iace_usa.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file
contains settings that are specific to U.S.
iace_brazil.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file
contains settings that are specific to Brazil.
iace_uk.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file
contains settings that are specific to U.K.
iace_italy.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file
contains settings that are specific to Italy.
iace_canada.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file
contains settings that are specific to Canada.
iace_international.cfg %DRTE_NP_DEFS%\ace Block-specific IACE configuration file. This file is
meant for any country that uses international
data for standardization. By default, this file
contains settings that are specific to Brazil.

Ace.cfg
The ace.cfg file is a required file for all processes performing address standardization. This configuration
file allows the user to specify the base directory where IACE is installed and which configuration files
need to be used, and how the data should be standardized. It consists of:
1. [ACE_BASE_DIRECTORY] Block This section contains BASE_DIRECTORY, which specifies the
base directory where ACE/IACE is installed.
2. Other Blocks There are other blocks, such as ACE_USA, IACE_USA, IACE_CANADA, IACE_UK,
IACE_BRAZIL, and IACE_ITALY. These blocks contain CONFIG_FILE_NAME, which specifies the
name and path of the configuration file to be used.
3. Contents of ace.cfg are as follows.
;
###########################################################################
############
;## NUCLEUS Pharma(TM) ACE/IACE configuration file.
;## (c) 2003 Dendrite International(R) All rights reserved
;##
;## This file is generated automatically by the configure tool
;##
;## Version "%Z% Release=%R% Frozen=%G%:%U% copied out=%H%:%T% %Z%"
;
###########################################################################
############
IMS Health Operations Guide Page 329 of 364
Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

;Use ace_usa.cfg when using ACE USA engine.


;IACE engine is used for all other countries.
;Please comment out the blocks that are not required.

[ACE_BASE_DIRECTORY]
BASE_DIRECTORY=ACE_IACE_BASE_DIR
;[DEFAULT]
;CONFIG_FILE_NAME=..\defs\ace\iace_international.cfg
;[ACE_USA]
;CONFIG_FILE_NAME=..\defs\ace\ace_usa.cfg
[IACE_USA]
CONFIG_FILE_NAME=..\defs\ace\iace_usa.cfg
;[IACE_CANADA]
;CONFIG_FILE_NAME=..\defs\ace\iace_canada.cfg
;[IACE_UK]
;CONFIG_FILE_NAME=..\defs\ace\iace_uk.cfg
;[IACE_BRAZIL]
;CONFIG_FILE_NAME=..\defs\ace\iace_brazil.cfg
;[IACE_ITALY]
;CONFIG_FILE_NAME=..\defs\ace\iace_italy.cfg

iace_usa.cfg
This file is described here as an example. It contains various blocks as given below:
ACE_FILE_STRUCTURE: This block specifies the directory and files used for standardization. All the
directories are relative to the base IACE installation directory.
ACE_COUNTRY_DETAILS: Country-specific information and the IACE engine to be used are
specified under this block.
DEFAULT_ACE_OPTIONS: This block contains options that control the behavior of IACE address
standardization and can be modified as per user requirements.
ACE_OUTPUT_COMPONENTS_RET_VAL_TYPE, ACE_OUTPUT_COMPONENTS_LENGTH:
These blocks specify the input and output line settings.
EXTERNAL_PARAMETERS_MAPPING: This is a mapping between constants used by AceInterface
library and Postalsoft IACE constants. The user should not modify it.

IMS Health Operations Guide Page 330 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX G: XTELLIGENT - EXECUTING SERVICE MANUALLY


To start an Xtelligent service (Microsoft Windows XP):
1. From the Control Panel, double-click the Performance and Maintenance icon and then double-click
the Administrative Tools icon.
2. From the Administrative Tools folder, double-click the Services icon.
3. Select the required service from the Services dialog box.
4. Click the Start the service button.

To stop an Xtelligent service (Microsoft Windows 2008):


1. From the Control Panel, double-click the Administrative Tools icon and then double-click the
Services icon.
2. Select the required service from the Services dialog box.
3. Click the Start the service button.
4. To stop a service, click the Stop the service button.

IMS Health Operations Guide Page 331 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX H: COMMAND LINE SUPPORT FOR ONE POINT


CONFIGURATION
Processes that are configured in the rt_config.xml file and executed using the ONE Point application can
also be executed from the command line. This appendix documents the command line support of
processes that are configured for ONE Point.
1. Real Time Data Import (ID: 1000)
This configuration imports data from the input queue (WBI.TO.NP.QL) using the Data Import process. The
type of messages that are imported via this configuration includes
Professional message
Organization message and
Affiliations
Dependency
Processes in this real time configuration should not be run if a process that is defined in any of the below
listed configuration is launched.
Manual Process Management (ID: 5000)
Prerequisite IDL Data Import (ID: 5100)
Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution Process Command Line Comments


Sequence

1. Clear the mqtest -oPURGE This will remove any unprocessed SHUTDOWN
Control Queue -dNP_CTRL_Q messages from the control queue before the
(NP_CTRL_Q) Data Import process is launched.
An exit code of
zero 0 is returned
if the control queue
is cleared
successfully;
otherwise a non-
zero value is
returned.

IMS Health Operations Guide Page 332 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Process Command Line Comments


Sequence

2. Launch the run_dataimport.exe


Data Import -q=WBI.TO.NP.QL Option Details
process to -e=NP.X.QL
import data -c=config.xml The input queue name is defaulted
from the Input -q to WBI.TO.NP.QL based on queue
Queue. An exit code of naming convention.
zero 0 is returned
if the Data Import The exception queue name is
process is -e defaulted to NP.X.QL based on
launched queue naming convention.
successfully;
otherwise a non- This should be always set to
zero value is -c config.xml that defines the real-time
returned. data import mappings.

A log file of the name


npdataimport_WBI.TO.NP.QL.log will be
created in the directory that is set in
DRTE_NP_LOGS environment variable.

The Data Import process will continue to run


successfully even if messages are rejected and
sent to the exception queue or to the log file.
The exception queue and the log file should be
checked periodically to identify rejected
messages.

3. Shutdown the npprocessctrl.exe Option Details


Data Import -oSHUTDOWN
process that is -qWBI.TO.NP.QL The input queue name is defaulted
importing data -q to WBI.TO.NP.QL based on queue
from the Input An exit code of naming convention.
Queue. zero 0 is returned
if the Data Import -o Do not change this option value.
process is
shutdown
successfully;
otherwise a non-
zero value is
returned.

2. Real Time Priority Data Import (ID: 1100)


This configuration imports data from the priority queue (WBI.TO.NP.P.QL) using the Data Import process.
The type of messages that are imported via this configuration includes
Professional message
Organization message and
Affiliations

IMS Health Operations Guide Page 333 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Dependency
Processes in this real time configuration should not be run if a process that is defined in any of the below
listed configuration is launched.
Manual Process Management (ID: 5000)
Prerequisite IDL Data Import (ID: 5100)
Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution Process Command Line Comments


Sequence

1. Clear the mqtest -oPURGE This will remove any unprocessed SHUTDOWN
Control Queue -dNP_CTRL_Q messages from the control queue before the Data
(NP_CTRL_Q) Import process is launched.
An exit code of zero
0 is returned if the
control queue is
cleared successfully;
otherwise a non-zero
value is returned.

2. Launch the run_dataimport.exe Option Details


Data Import -q=WBI.TO.NP.P.QL
process to -e=NP.X.QL The priority queue name is
import data -c=config.xml -q defaulted to WBI.TO.NP.P.QL based
from the on queue naming convention.
Priority Queue. An exit code of zero
0 is returned if the The exception queue name is
Data Import process -e defaulted to NP.X.QL based on
is launched queue naming convention.
successfully;
otherwise a non-zero This should be always set to
value is returned. -c config.xml that defines the real-time
data import mappings.

A log file of the name


npdataimport_WBI.TO.NP.P.QL.log will be
created in the directory that is set in
DRTE_NP_LOGS environment variable.

The Data Import process will continue to run


successfully even if messages are rejected and
sent to the exception queue or to the log file. The
exception queue and the log file should be
checked periodically to identify rejected
messages.

IMS Health Operations Guide Page 334 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Process Command Line Comments


Sequence

3. Shutdown the npprocessctrl.exe Option Details


Data Import -oSHUTDOWN
process that is -qWBI.TO.NP.P.QL The priority queue name is
importing data -q defaulted to WBI.TO.NP.P.QL based
from the An exit code of zero on queue naming convention.
Priority Queue. 0 is returned if the
Data Import process -o Do not change this option value.
is shutdown
successfully;
otherwise a non-zero
value is returned.

5. Real Time Data Export (ID: 2000)


This configuration exports data to the output remote queue (NP.TO.WBI.QL) using Xtelligent Services.
The type of messages exported via this service includes
Address Standardization
Merge Request
A response to the refresh request of a standardized address
Sampling status and other details from the verification vendor

Execution Command Line and


Process Comments
Sequence Return Code

1. Launch Transaction net start An exit code of zero 0 is returned if


Publisher Service NPTransactionPublisher the service is started successfully;
(Xtelligent) otherwise a non-zero value is
returned.

2. Shutdown Transaction net stop An exit code of zero 0 is returned if


Publisher Service NPTransactionPublisher the service is stopped successfully;
(Xtelligent) otherwise a non-zero value is
returned.

6. Real Time Refresh Request / Response (ID: 2100)


This configuration imports refresh requests from the input queue (NP.REF.REQ.QL) using Xtelligent
Services.

Execution Process Command Line and Comments


Sequence Return Code

1. Launch Refresh net start An exit code of zero 0 is returned if


Request Service NPRefReqDataImport the service is started successfully;
(Xtelligent) otherwise a non-zero value is returned.

2. Shutdown Refresh net stop An exit code of zero 0 is returned if


Request Service NPRefReqDataImport the service is stopped successfully;
(Xtelligent) otherwise a non-zero value is returned.

IMS Health Operations Guide Page 335 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

7. Real Time Data Processing Services (ID: 3000)


In this is a real-time data processing loop, post data import processes (such as Hash, DQT, Match etc.)
are executed. This loop of processes is executed once every 3 hours. When the loop restarts execution
after a 3 hours delay, it can be paused to launch a dependent process only after executing all the
processes in the loop.
Dependency
Processes in this real time configuration should not be run if a process that is defined in any of the below
listed configuration is launched.
Manual Process Management (ID: 5000)
Prerequisite IDL Data Import (ID: 5100)
Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution
Process Command Line Comments
Sequence

1. Post Data Import DB runstoredproc.exe A log file of the format


Maintenance -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>6)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

2. Lock the staging imported runstoredproc.exe A log file of the format


profile table. -s"NPStgImpProfileMgr.LockProfiles NPStgImpProfileMgr.LockProfi
(STG_IMPORTED_PROFI " les_YYYYMMDD_HHMISS.log
LE) will be created in the directory
Exit code of zero 0 is returned if that is set in DRTE_NP_LOGS
import staging table is locked environment variable.
successfully; otherwise non-zero
value is returned.

3. Run the Data Quality runstoredproc.exe A log file of the format


process for profiles that are -f"NP_Data_Quality_Engine.Process NP_Data_Quality_Engine.Proc
locked in ImportedProfiles" essImportedProfiles_YYYYMM
STG_IMPORTED_PROFIL DD_HHMISS.log will be created
E table Exit code of zero 0 is returned if in the directory that is set in
Data Quality process completes DRTE_NP_LOGS environment
successfully; otherwise a non-zero variable.
value is returned.

IMS Health Operations Guide Page 336 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

4. Post Data Quality DB runstoredproc.exe A log file of the format


Maintenance -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>104)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise a variable.
non-zero value is returned.

5. Delete the existing Hash run_hashcreator.exe A log file of the format


Keys for profiles that are nphash_YYYYMMDD_HHMISS.
locked in Exit code of zero 0 is returned if log will be created in the
STG_IMPORTED_PROFIL Hash process completes directory that is set in
E table and Generate New successfully; otherwise non-zero DRTE_NP_LOGS environment
Hash keys. value is returned. variable.

6. Populate DQT tables for runstoredproc.exe A log file of the format


profiles that are locked in -f"PKG_Denorm_Populate.ProcessI PKG_Denorm_Populate.Proce
STG_IMPORTED_PROFIL mportedProfiles(tUserId=>109,nCac ssImportedProfiles_YYYYMMD
E table. heSize=>300000,nCommitInterval=> D_HHMISS.log will be created in
1000)" the directory that is set in
DRTE_NP_LOGS environment
Exit code of zero 0 is returned if variable.
DQT process completes
successfully otherwise non-zero It is not recommended to change
value is returned. Cache size and Commit interval.

7. Post DQT DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>32)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

8. Pre Match DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>7)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

IMS Health Operations Guide Page 337 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

9. Match Process. run_match.exe c=3 The run script invokes the Match
Pre-process first to generate
Exit code of zero 0 is returned if candidates for
Match process completes NP_MATCH_PENDING profiles.
successfully; otherwise non-zero Only one copy of the pre-process
value is returned.. will be run.

A log file of the format


npmatch_preprocess_YYYYM
MDDHHMISS.log will be created
in the directory that is set in
DRTE_NP_LOGS environment
variable.

If pre-process completes
successfully then three instances
of the match process
(npmatch.exe) will be launched in
parallel.

Number copies to be launched


can be controlled by changing
the value set in -c option.

Separate log files will be created


for each copy of the Match
process in the directory that is
set in DRTE_NP_LOGS
environment variable.

The log files will be of the format


npmatch_copy#_YYYYMMDDH
HMISS.log

10. Pre ID Assign DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>16)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

11. Execute the ID Assign run_idassign.exe A log file of the format


process. npidassign_YYYYMMDDHHMI
Exit code of zero 0 is returned if ID SS.log will be created in the
Assign process completes directory that is set in
successfully; otherwise non-zero DRTE_NP_LOGS environment
value is returned. variable.

IMS Health Operations Guide Page 338 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

12. Post ID Assign DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>17)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

13. Reverse Link Creator runstoredproc.exe A log file of the format


-s"NP_ReverseLinkCreator" NP_ReverseLinkCreator_YYYY
MMDD_HHMISS.log will be
Exit code of zero 0 is returned if created in the directory that is set
Reverse Link Creator process in DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

14. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check Suffix Mismatch. -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
Check(configId=>1,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 1.
RDM process completes NUCLEUS IDs that are changed
successfully; otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

15. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check ME Number -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
Mismatch. Check(configId=>2,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 2.
RDM process completes NUCLEUS IDs that are changed
successfully; otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

IMS Health Operations Guide Page 339 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

16. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check IMS Number -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
Mismatch. Check(configId=>3,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 3.
RDM process completes NUCLEUS IDs that are changed
successfully; otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

17. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check AOA Number -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
Mismatch. Check(configId=>4,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 4.
RDM process completes NUCLEUS IDs that are changed
successfully; otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

18. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check Org Type mismatch. -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
Check(configId=>5,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 5.
RDM process completes NUCLEUS IDs that are changed
successfully; otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

IMS Health Operations Guide Page 340 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

19. Reverse Data Monitor to runstoredproc.exe The default processing mode is


check Org SubType -s"NPReverseDataMonitor.Reverse set to 0 to run the RDM process
mismatch. Check(configId=>6,processingMode incrementally based on the
=>0)" LAST_RUN_DT stored in
NP_RDM_RUN table for
Exit code of zero 0 is returned if RDM_CONFIGURATION_ID 6.
RDM process completes NUCLEUS IDs that are changed
successfully otherwise non-zero after this date will be processed.
value is returned. Do not change this option value.

A log file of the format


NPReverseDataMonitor.Revers
eCheck_YYYYMMDD_HHMISS.
log will be created in the
directory that is set in
DRTE_NP_LOGS environment
variable.

20. Post Reverse Data Monitor runstoredproc.exe A log file of the format
DB Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>17)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

21. To Cleanup the Merge run_merge_extract.exe -c A log file of the format


Staging Tables. npmerge_cleanup_YYYYMMD
Exit code of zero 0 is returned if DHHMISS.log will be created in
Merge Cleanup process completes the directory that is set in
successfully; otherwise non-zero DRTE_NP_LOGS environment
value is returned. variable.

This process is scheduled to run


every Friday at 10:30 PM. (ONE
Point setting is 5,22:30)

In ONE Point, day is represented


by a decimal number 0 6.
Sunday is 0.

22. Post Merge DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Process_ PKG_Db_Maintenance.Proces
Maintenance(PROCESS_ID=>108)" s_Maintenance_YYYYMMDD_
HHMISS.log will be created in
Exit code of zero 0 is returned if the directory that is set in
database maintenance process DRTE_NP_LOGS environment
completes successfully; otherwise variable.
non-zero value is returned.

IMS Health Operations Guide Page 341 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

23. Unlock Profiles that are runstoredproc.exe A log file of the format
locked in the -s"NPStgImpProfileMgr.DeleteLocke NPStgImpProfileMgr.DeleteLoc
STG_IMPORTED_PROFIL dProfiles" kedProfiles_YYYYMMDD_HHM
E table. ISS.log will be created in the
Exit code of zero 0 is returned if directory that is set in
staging table profiles are unlocked DRTE_NP_LOGS environment
successfully; otherwise non-zero variable.
value is returned.

24. Full Schema DB runstoredproc.exe A log file of the format


Maintenance -s"PKG_Db_Maintenance.Analyze_ PKG_Db_Maintenance.Analyze
Schema (estimate_percent=>NULL, _Schema_YYYYMMDD_HHMIS
indexed_columns=>TRUE, S.log will be created in the
rebuild_indexes=>TRUE)" directory that is set in
DRTE_NP_LOGS environment
Exit code of zero 0 is returned if variable.
database maintenance process
completes successfully; otherwise Process is scheduled to run
non-zero value is returned. every Saturday at 11:30 PM.
(ONE Point setting is 6,23:30). In
ONE Point, day is represented by
a decimal number 0 6. Sunday
is 0.

8. Real Time Standardization Service (ID: 3100)


This real-time configuration launches the address standardization service used by the Customer
Maintenance application.

Execution
Process Command Line Comments
Sequence

1. Launch the run_stddaemon.exe l A log file of the name


Standardization np_stddaemon_YYYYMMDDHHMISS.log
Server An exit code of non-zero will be created in the directory that is set in
is returned if the DRTE_NP_LOGS environment variable.
standardization daemon
process fails to launch
successfully.

2. Shut down the run_stddaemon.exe s A log file of the name


Standardization np_stddaemon_YYYYMMDDHHMISS.log
Server An exit code of zero is will be created in the directory that is set in
returned if the DRTE_NP_LOGS environment variable.
standardization daemon
process shuts down
successfully; otherwise a
non-zero value is
returned.

9. Manual Process Management (ID: 5000)


This configuration defines all the post Data Import processes such as (Hash, DQT, and Match etc.) that
needs to be after the profiles are imported.

IMS Health Operations Guide Page 342 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Dependency
Processes in this configuration should not be run in parallel. Processes in this configuration should not be
run if a process that is defined in any of the below listed configuration is launched.
Real Time Data Import (ID: 1000)
Real Time Priority Data Import (ID: 1100)
Real Time Data Processing Services (ID: 3000)
Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution
Process Command Line Comments
Sequence

1. Lock the staging runstoredproc.exe A log file of the format


imported profile table. -s"NPStgImpProfileMgr.LockProfil NPStgImpProfileMgr.Lock
(STG_IMPORTED_PR es" Profiles_YYYYMMDD_HH
OFILE) MISS.log will be created in
An exit code of zero 0 is the directory that is set in
returned if the import staging DRTE_NP_LOGS
table is locked successfully; environment variable.
otherwise a non-zero value is
returned.

2. Run the Data Quality runstoredproc.exe A log file of the format


process for profiles that -s"NP_Data_Quality_Engine.main NP_Data_Quality_Engine.
are locked in " main_YYYYMMDD_HHMI
STG_IMPORTED_PRO SS.log will be created in
FILE table An exit code of zero 0 is the directory that is set in
returned if the Data Quality DRTE_NP_LOGS
process completes successfully; environment variable.
otherwise a non-zero value is
returned.

3. Post Data Quality DB runstoredproc.exe A log file of the format


Maintenance -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
104)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

IMS Health Operations Guide Page 343 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

4. Delete the existing run_hashcreator.exe A log file of the format


Hash Keys for profiles nphash_YYYYMMDDHHM
that are locked in An exit code of zero 0 is ISS.log will be created in
STG_IMPORTED_PRO returned if the Hash process the directory that is set in
FILE table and completes successfully; otherwise DRTE_NP_LOGS
Generate New Hash a non-zero value is returned. environment variable.
keys.

5. Populate DQT tables runstoredproc.exe A log file of the format


for profiles that are -s"PKG_Denorm_Populate.main( PKG_Denorm_Populate.
locked in nProcessMode=>1)" main_YYYYMMDD_HHMI
STG_IMPORTED_PRO SS.log will be created in
FILE table. An exit code of zero 0 is the directory that is set in
returned if the DQT process DRTE_NP_LOGS
completes successfully; otherwise environment variable.
a non-zero value is returned.
It is not recommended to
change the Cache size and
the Commit interval.

6. Post DQT DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
32)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

7. Pre Match DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
7)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

IMS Health Operations Guide Page 344 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

8. Match Process. run_match.exe c=3 The run script invokes the


Match Pre-process first to
An exit code of zero 0 is generate candidates for the
returned if the Match process NP_MATCH_PENDING
completes successfully; otherwise profiles. Only one copy of
a non-zero value is returned.. the pre-process will be run.

A log file of the format


npmatch_preprocess_YY
YYMMDDHHMISS.log will
be created in the directory
that is set in
DRTE_NP_LOGS
environment variable.

If the pre-process
completes successfully then
three instances of the
match process
(npmatch.exe) will be
launched in parallel.

Number copies to be
launched can be controlled
by changing the value set in
-c option.

Separate log files will be


created for each copy of the
Match process in the
directory that is set in
DRTE_NP_LOGS
environment variable.

The log files will be of the


format
npmatch_copy#_YYYYM
MDDHHMISS.log

9. Pre ID Assign DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
16)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

IMS Health Operations Guide Page 345 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

10. ID Assign process. run_idassign.exe A log file of the format


npidassign_YYYYMMDDH
An exit code of zero 0 is HMISS.log will be created
returned if the ID Assign process in the directory that is set in
completes successfully; otherwise DRTE_NP_LOGS
a non-zero value is returned. environment variable.

11. Post ID Assign DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
17)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

12. Reverse Link Creator runstoredproc.exe A log file of the format


-s"NP_ReverseLinkCreator" NP_ReverseLinkCreator_
YYYYMMDD_HHMISS.log
An exit code of zero 0 is will be created in the
returned if the Reverse Link directory that is set in
Creator process completes DRTE_NP_LOGS
successfully; otherwise a non- environment variable.
zero value is returned.

13. Reverse Data Monitor runstoredproc.exe The default processing


-s"NPReverseDataMonitor.Rever mode is set to 0 to run the
seCheck(configId=><n>,processi RDM process incrementally
ngMode=>0)" based on the
LAST_RUN_DT stored in
Substitute <n> with the RDM NP_RDM_RUN table for
configuration ID stored in the RDM configuration
NP_CFG_RDM table. being run.

An exit code of zero 0 is A log file of the format


returned if the RDM process NPReverseDataMonitor.R
completes successfully; otherwise everseCheck_YYYYMMD
a non-zero value is returned. D_HHMISS.log will be
created in the directory that
is set in DRTE_NP_LOGS
environment variable.

IMS Health Operations Guide Page 346 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

14. Post Reverse Data runstoredproc.exe A log file of the format


Monitor DB -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
Maintenance. s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
17)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

15. To Cleanup the Merge run_merge_extract.exe -c A log file of the format


Staging Tables. npmerge_cleanup_YYYY
An exit code of zero 0 is MMDDHHMISS.log will be
returned if the Merge Cleanup created in the directory that
process completes successfully; is set in DRTE_NP_LOGS
otherwise a non-zero value is environment variable.
returned.

16. Launch the Merge run_merge_extract.exe -r=<n> A log file of the format
process to identify npmerge_<MergeType>_<
Customer merges. Substitute <n> with the Merge n>_YYYYMMDDHHMISS.l
Rule ID stored in NP_RULE table. og will be created in the
directory that is set in
An exit code of zero 0 is DRTE_NP_LOGS
returned if the Merge process environment variable.
completes successfully; otherwise
a non-zero value is returned.

17. Launch the Merge run_merge_extract.exe -r=<n> -a A log file of the format
process to identify npmerge_<MergeType>_<
Address merges. Substitute <n> with the Merge n>_YYYYMMDDHHMISS.l
Rule ID stored in NP_RULE table. og will be created in the
directory that is set in
An exit code of zero 0 is DRTE_NP_LOGS
returned if the Merge process environment variable.
completes successfully; otherwise
a non-zero value is returned.

18. Post Merge DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
108)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

IMS Health Operations Guide Page 347 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

19. Validation Status Export runstoredproc.exe -s" A log file of the format
NPCMCustVerStatusExport_Cust NPCMCustVerStatusExpo
om.main" rt_Custom.main_YYYYM
MDD_HHMISS.log will be
An exit code of zero 0 is created in the directory that
returned if the export process is set in DRTE_NP_LOGS
completes successfully; otherwise environment variable.
a non-zero value is returned.

20. Consolidated Customer run_bob.exe A log file of the format


View (CCV) generation. run_bob_YYYYMMDD_HH
An exit code of zero 0 is MISS_x_y.log will be
returned if the export process created in the directory that
completes successfully; otherwise is set in DRTE_NP_LOGS
a non-zero value is returned. environment variable.

Where x and y in the log file


name represents the
minimum and maximum
NUCLEUS_ID found in
CUS_CUSTOMER_INFO
table.

21. Post CCV DB runstoredproc.exe A log file of the format


Maintenance. -s"PKG_Db_Maintenance.Proces PKG_Db_Maintenance.Pr
s_Maintenance(PROCESS_ID=> ocess_Maintenance_YYY
51)" YMMDD_HHMISS.log will
be created in the directory
An exit code of zero 0 is that is set in
returned if the database DRTE_NP_LOGS
maintenance process completes environment variable.
successfully; otherwise a non-
zero value is returned.

22. Unlock Profiles that are runstoredproc.exe A log file of the format
locked in the -s"NPStgImpProfileMgr.DeleteLoc NPStgImpProfileMgr.Dele
STG_IMPORTED_PRO kedProfiles" teLockedProfiles_YYYYM
FILE table. MDD_HHMISS.log will be
An exit code of zero 0 is created in the directory that
returned if the staging table is set in DRTE_NP_LOGS
profiles are unlocked environment variable.
successfully; otherwise a non-
zero value is returned.

IMS Health Operations Guide Page 348 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line Comments
Sequence

23. Zip Info Utility npzipinfo.exe -l A log file zipinfo.log will be


%DRTE_NP_LOGS%\zipinfo.log created in the directory that
-bIACE_USA t is set in DRTE_NP_LOGS
environment variable.
An exit code of zero 0 is
returned if the
FND_POSTAL_CODE table is
populated successfully; otherwise
a non-zero value is returned.

24. Re-Standardizer Refer to section 17 for details.

25. Import/Export Utility Refer to the Import/Export Utility


section for details.

10. Prerequisite IDL Data Import (ID: 5100)


This configuration defines an optimization step that can be used only for IDL third party data import. It
drops all the core table indexes that are not used by the Data Import process to speed up the import.
Dependency
Processes in this configuration should not be run in parallel. Processes in this configuration should not be
run if a process that is defined in any of the below listed configuration is launched.
Real Time Data Import (ID: 1000)
Real Time Priority Data Import (ID: 1100)
Real Time Data Processing Services (ID: 3000)
Manual Process Management (ID: 5000)
Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution Command Line and Return


Process Comments
Sequence Code

1. Drop runstoredproc.exe A log file of the format


Indexes -s"PKG_Db_Maintenance.Dro PKG_Db_Maintenance.Drop_Process_In
p_Process_Indexes(PROCES dexes_HHMISS.log will be created in the
S_ID=>112)" directory that is set in DRTE_NP_LOGS
environment variable.
An exit code of zero 0 is
returned if the indexes are
dropped successfully;
otherwise a non-zero value is
returned.

IMS Health Operations Guide Page 349 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Command Line and Return


Process Comments
Sequence Code

2. Create runstoredproc.exe A log file of the format


Indexes -s"PKG_Db_Maintenance.Cre PKG_Db_Maintenance.Create_Process_
ate_Process_Indexes(PROCE Indexes_HHMISS.log will be created in
SS_ID=>112)" the directory that is set in
DRTE_NP_LOGS environment variable.
An exit code of zero 0 is
returned if the indexes are
created successfully;
otherwise a non-zero value is
returned.

11. Manual Data Import (ID: 6000)


This configuration defines the Data Import process for all the third party data sources.
Dependency
Processes in this configuration should not be run if a process that is defined in any of the below listed
configuration is launched.
Real Time Data Import (ID: 1000)
Real Time Priority Data Import (ID: 1100)
Real Time Data Processing Services (ID: 3000)
Manual Process Management (ID: 5000)
Prerequisite IDL Data Import (ID: 5100)
Manual DQT Index Maintenance (ID: 7000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

IMS Health Operations Guide Page 350 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Process Command Line Comments


Sequence

1. DEA Data run_dataimport.exe Option Details


Import -m=1012 -a z
1012 is the core DEA mapping ID.
An exit code of zero 0
is returned if the Data -m Change this value only if a custom
Import process mapping is created to import the
completes successfully; DEA file.
otherwise a non-zero
value is returned. Auto Mode.
In this mode the data files (new and
old) are automatically selected from
the third party data directory based
on the predefined file naming
convention.
-a
New File:
%DRTE_THIRD_PARTY
%\np\in\dea\DEA<*>.new

Old File:
%DRTE_THIRD_PARTY
%\np\in\dea\DEA<*>.old

Execute the Post Data Import DB


-z Maintenance if the import process
completes successfully.

A log file of the name npdataimport_DEA.log will be


created in the directory that is set in
DRTE_NP_LOGS environment variable.

The Data Import process will complete successfully


with a zero return code even if records are rejected
and written to a bad file. The log file and the bad file
should be checked for rejected records.

IMS Health Operations Guide Page 351 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Process Command Line Comments


Sequence

2. AMA Data run_dataimport.exe Optio Details


Import -m=1010 -a z n

An exit code of zero 0 1010 is the core AMA mapping ID.


is returned if the Data
Import process -m Change this value only if a custom
completes successfully; mapping is created to import the AMA
otherwise a non-zero file.
value is returned.
Auto Mode.

In this mode the data files (new and old)


are automatically selected from the third
party data directory based on the
predefined file naming convention.
-a
New File:
%DRTE_THIRD_PARTY
%\np\in\ama\AMA<*>.new

Old File:
%DRTE_THIRD_PARTY
%\np\in\ama\AMA<*>.old

Execute the Post Data Import DB


-z Maintenance if the import process
completes successfully.

A log file of the name npdataimport_AMA.log will


be created in the directory that is set in
DRTE_NP_LOGS environment variable.

The Data Import process will complete successfully


with a zero return code even if records are rejected
and written to a bad file. The log file and the bad file
should be checked for rejected records.

IMS Health Operations Guide Page 352 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution Process Command Line Comments


Sequence

3. AOA Data run_dataimport.exe Optio Details


Import -m=1011 -a z n

An exit code of zero 0 1011 is the core AOA mapping ID.


is returned if the Data
Import process -m Change this value only if a custom
completes successfully; mapping is created to import the AOA
otherwise a non-zero file.
value is returned.
Auto Mode.

In this mode the data files (new and old)


are automatically selected from the third
party data directory based on the
predefined file naming convention.
-a
New File:
%DRTE_THIRD_PARTY
%\np\in\aoa\AOA<*>.new

Old File:
%DRTE_THIRD_PARTY
%\np\in\aoa\AOA<*>.old

Execute the Post Data Import DB


-z Maintenance if the import process
completes successfully.

A log file of the name npdataimport_AOA.log will


be created in the directory that is set in
DRTE_NP_LOGS environment variable.

The Data Import process will complete successfully


with a zero return code even if records are rejected
and written to a bad file. The log file and the bad file
should be checked for rejected records.

4. Post Data runstoredproc.exe This step is optional if the DB Maintenance is


Import DB -s"PKG_Db_Maintenanc executed as part of the Data Import via the -z
Maintenance e.Process_Maintenance option.
(PROCESS_ID=>6)"
A log file of the format
An exit code of zero 0 PKG_Db_Maintenance.Process_Maintenance_YY
is returned if the YYMMDD_HHMISS.log will be created in the
database maintenance directory that is set in DRTE_NP_LOGS environment
process completes variable.
successfully; otherwise
a non-zero value is
returned.

IMS Health Operations Guide Page 353 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

12. Manual DQT Index Maintenance (ID: 7000)


This configuration defines an optimization step that can be used when the DQT process is run in refresh
mode. It drops all the DQT table indexes that are not used during the refresh run. It is not recommended
to use the Customer Resolution application while the indexes are dropped.
Dependency
Processes in this configuration should not be run if a process that is defined in any of the below listed
configuration is launched.
Real Time Data Import (ID: 1000)
Real Time Priority Data Import (ID: 1100)
Real Time Data Processing Services (ID: 3000)
Manual Process Management (ID: 5000)
Prerequisite IDL Data Import (ID: 5100)
Manual Data Import (ID: 6000)
Manual Database Maintenance (ID: 8000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution
Process Command Line and Return Code Comments
Sequence

1. Drop runstoredproc.exe A log file of the format


Indexes -s"PKG_Db_Maintenance.Drop_Proce PKG_Db_Maintenance.Drop_Proc
ss_Indexes(PROCESS_ID=>32)" ess_Indexes_HHMISS.log will be
created in the directory that is set in
An exit code of zero 0 is returned if DRTE_NP_LOGS environment
the indexes are dropped successfully; variable.
otherwise a non-zero value is returned.

2. Create runstoredproc.exe A log file of the format


Indexes -s"PKG_Db_Maintenance.Create_Proc PKG_Db_Maintenance.Create_Pro
ess_Indexes(PROCESS_ID=>32)" cess_Indexes_HHMISS.log will be
created in the directory that is set in
An exit code of zero 0 is returned if DRTE_NP_LOGS environment
the indexes are created successfully; variable.
otherwise a non-zero value is returned.

13. Manual Database Maintenance (ID: 8000)


This configuration defines various database maintenance processes.
Dependency
Processes in this configuration should not be run if a process that is defined in any of the below listed
configuration is launched.
Real Time Data Import (ID: 1000)
Real Time Priority Data Import (ID: 1100)
Real Time Data Processing Services (ID: 3000)
Manual Process Management (ID: 5000)

IMS Health Operations Guide Page 354 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Prerequisite IDL Data Import (ID: 5100)


Manual Data Import (ID: 6000)
Manual DQT Index Maintenance (ID: 7000)
Manual - Practitioner Verification Processes (ID: 13000)

Execution
Process Command Line and Return Code Comments
Sequence

1. Foundatio runstoredproc.exe A log file of the format


n Tables -s"PKG_Db_Maintenance.Process_Mai PKG_Db_Maintenance.Process_M
ntenance(PROCESS_ID=>5)" aintenance_YYYYMMDD_HHMISS.l
og will be created in the directory that
An exit code of zero 0 is returned if the is set in DRTE_NP_LOGS
database maintenance process environment variable.
completes successfully; otherwise a
non-zero value is returned.

2. NP runstoredproc.exe A log file of the format


Configurat -s"PKG_Db_Maintenance.Process_Mai PKG_Db_Maintenance.Process_M
ion Tables ntenance(PROCESS_ID=>103)" aintenance_YYYYMMDD_HHMISS.l
og will be created in the directory that
An exit code of zero 0 is returned if the is set in DRTE_NP_LOGS
database maintenance process environment variable.
completes successfully; otherwise a
non-zero value is returned.

3. CCV runstoredproc.exe A log file of the format


Configurat -s"PKG_Db_Maintenance.Process_Mai PKG_Db_Maintenance.Process_M
ion Tables ntenance(PROCESS_ID=>31)" aintenance_YYYYMMDD_HHMISS.l
og will be created in the directory that
An exit code of zero 0 is returned if the is set in DRTE_NP_LOGS
database maintenance process environment variable.
completes successfully; otherwise a
non-zero value is returned.

4. Post Data runstoredproc.exe A log file of the format


Import -s"PKG_Db_Maintenance.Process_Mai PKG_Db_Maintenance.Process_M
ntenance(PROCESS_ID=>6)" aintenance_YYYYMMDD_HHMISS.l
og will be created in the directory that
An exit code of zero 0 is returned if the is set in DRTE_NP_LOGS
database maintenance process environment variable.
completes successfully; otherwise a
non-zero value is returned.

IMS Health Operations Guide Page 355 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line and Return Code Comments
Sequence

5. Post runstoredproc.exe A log file of the format


Match -s"PKG_Db_Maintenance.Process_Mai PKG_Db_Maintenance.Process_M
Pre- ntenance(PROCESS_ID=>30)" aintenance_YYYYMMDD_HHMISS.l
process og will be created in the directory that
An exit code of zero 0 is returned if the is set in DRTE_NP_LOGS
database maintenance process environment variable.
completes successfully; otherwise a
non-zero value is returned.

6. Full runstoredproc.exe A log file of the format


Schema -s"PKG_Db_Maintenance.Analyze_Sch PKG_Db_Maintenance.Analyze_Sc
Analyze ema (estimate_percent=>NULL, hema_YYYYMMDD_HHMISS.log
indexed_columns=>TRUE, will be created in the directory that is
rebuild_indexes=>TRUE)" set in DRTE_NP_LOGS environment
variable.
An exit code of zero 0 is returned if the
database maintenance process
completes successfully; otherwise a
non-zero value is returned.

7. Table runstoredproc.exe A log file of the format


Analyze -s"PKG_Db_Maintenance.Table_Mainte PKG_Db_Maintenance.Table_Maint
nance(table_name=>'<NP_TABLE_NA enance_YYYYMMDD_HHMISS.log
ME>', index_analyze=>TRUE, will be created in the directory that is
index_rebuild=>TRUE)" set in DRTE_NP_LOGS environment
variable.
Substitute <NP_TABLE_NAME> with
the actual table name and it should be
single quoted.

An exit code of zero 0 is returned if the


database maintenance process
completes successfully; otherwise a
non-zero value is returned.

14. System Parameters (ID: 11000)


This configuration defines a query that can be used to list all the system parameters that are defined at a
process level.

IMS Health Operations Guide Page 356 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

Execution
Process Command Line and Return Code Comments
Sequence

1. Query COF_DBConnect.exe -q"select


Applicati rpad(parameter_id,13)||rpad(value,15)||description
on as data from ( select 0, 'Parameter ID' as
Paramet parameter_id, 'Value' as value, 'Description' as
ers description from dual union select 1, '------------',
'-----', '-----------' from dual union select 2,
parameter_id, value, description from (select
to_char(c.parameter_id) as parameter_id,
substr(c.prompt_txt,1,length(c.prompt_txt))
description, decode(d.number_value, null,
decode(d.character_value, null,
to_char(date_value,'MM-DD-YYYY HH24:MI:SS'),
d.character_value), d.number_value) value from
fnd_sai_app a, fnd_parameter_app b,
fnd_system_parameter c, fnd_parameter_value d
where a.sai_app_id = b.sai_app_id and
b.parameter_id = c.parameter_id and
c.parameter_id = d.parameter_id and sysdate
between d.effective_dt and nvl(d.end_dt,sysdate)
An exit code of zero 0 is
and a.sai_app_id = __SAI_APP_ID__ ) where
returned if the query
value is not null)"
completes successfully;
otherwise a non-zero value
Substitute __SAI_APP_ID__ with
is returned.
5 Global Parameters
7 Security - GUI
20 Common Server - GUI
75 Customer Maintenance - GUI
77 Configuration Assistant - GUI
10 Customer Resolution - GUI
12 Code Table Maintenance - GUI
69 Practitioner Verification - GUI
76 Address and Name Verification Daemon
50 Data Import - Server Layer
79 Hash - Server Layer
52 Match - Server Layer
51 ID Assign - Server Layer
81 Merge - Server Layer
87 Pattern Standardizer - Server Layer
83 Practitioner Verification - Server Layer
62 Database Maintenance
61 Archive Process
82 Extract Process
15. Real Time Validation Status Export (ID: 12000)
This is real-time configuration to run the Sampling status export once every 30 minutes. This is used to
publish status changes that are made via the Practitioner Verification GUI.
Dependency
Processes in this configuration should not be run in parallel. Processes in this configuration should not be
run if a process that is defined in any of the below listed configurations is launched.

IMS Health Operations Guide Page 357 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

1. Manual - Practitioner Verification Processes (ID: 13000)

Execution
Process Command Line and Return Code Comments
Sequence

o PV GUI runstoredproc.exe A log file of the format


Validation -s"NPCMCustVerStatusExport_Cust NPCMCustVerStatusExport_Custom.
Status om.main" main_YYYYMMDD_HHMISS.log will be
Export created in the directory that is set in
An exit code of zero 0 is returned if DRTE_NP_LOGS environment variable.
the query completes successfully;
otherwise a non-zero value is This process is scheduled to run every
returned. 30 minutes via ONE Point.

IMS Health Operations Guide Page 358 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX I: UPDATING THE XTELLIGENT ADAPTER CONFIGURATIONS


FOR REAL TIME DATA IMPORT AND EXPORT PROCESS
1. Updating dbcfg.txt file for changes in WebSphere MQ server Connection Details
This section explains about configuring the dbcfg.txt file for any changes made to the WebSphere MQ
Server Machine Name, Queue Manager and Channel Name.
Shutdown the nponepoint.exe application and any active jobs managed by it before making any changes.
The changes will take effect only after restarting the nponepoint.exe application.
Locate and open for editing the dbcfg.txt file in the <np_root>\np\bin folder. In the NPMS block, the new
connection information regarding the WebSphere MQ server must be provided. Replace the values in
angular brackets with the appropriate information. The LOGON and PWD attributes should be initialized
with period ..
The port number needs to be specified along with the Websphere MQ Sever Machine Name within
circular braces, if more than one queue manager exists in the Web sphere server. For default queue
manager, port number is not required to be specified explicitly.
The highlighted placeholders in the following section need to be updated with actual values in dbcfg.txt
file.
[NPMS]
LOGON=.
PWD=.
HOSTID=tcp://<WebSphere MQ Server Machine
Name>(PortNumber):<QueueManager>:<Channel>
PLUGIN=NPMsgServiceWSMQ.dll
Note: The HOSTID value is case sensitive.
2. Updating rt_config.xml file for changes in Input and Exception Queues
This section explains about configuring the rt_config.xml file for changes in the Data Queue and
Exception Queue Names.
Shutdown the nponepoint.exe application and any active jobs managed by it before making any changes.
The changes will take effect only after restarting the nponepoint.exe application.
Locate and open the rt_config.xml file in the <np_root>\np\bin folder. In the Real Time - Data Import
Node, search for Import Message Queue entity and modify the value attribute for the argument,
Data Queue with the new input queue name, by default set to WBI.TO.NP.QL
Exception Queue argument with the new exception queue name, by default set to NP.X.QL
The highlighted placeholders in the following section need to be updated with actual values in
rt_config.xml file.
<Entity id="100020" type="syscmd" name="start /min npdataimport.exe"
displayName="Import Message Queue"
logFile="..\log\op_100020.log" onRestart="1" iterations="1">
<Argument name="Data Queue" option="-q" value="<INPUT QUEUE>"/>
<Argument name="Exception Queue" option="-e" value="<EXCEPTION QUEUE>"/>

IMS Health Operations Guide Page 359 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

<Argument name="Mappings Configuration" option="-C" value="config.xml"/>


<Argument name="Queue Polling Frequency" option="-F" value="10"/>
<Argument name="Log File" option="-l" value="..\log\op_100020.log"/>
</Entity>

3. Updating the Xtelligent Export Adapter configuration file for changes in Output
Queue Name and WebSphere MQ server connection details
Locate the np_is_export_config.xml configuration file in the <np_root>\np\<Adapter Deployment
Directory>\< Deployment Environment >\DataInterfaces\Interfaces\Configuration folder.
Example: <np_root>\np\is\prod\DataInterfaces\Interfaces\Configuration
Shut down the nponepoint.exe application and any active jobs managed by it before making any changes.
The changes will take effect only after restarting the nponepoint.exe application.
Locate the <MQ> node in the file. Under the <MQ> node change the value of
<Owner> attribute with the new QueueManager Name
<mqchanneldefinition> attribute with the new channel name and the WebSphere Server IP Address
with the Port Number within circular braces
<Queue qid="WSMQ_OUT_Q"> attribute for changes in the Output Queue Name.
The highlighted placeholders in the following section need to be updated with actual values in
np_is_export_config.xml file.
Note : For default queue manager, port number is not required to be specified explicitly.
<MQ>
<QProcessor>MQListener.QProcessor</QProcessor>
<Owner>QueueManager</Owner>
<mqchanneldefinition>Channel Name/TCP/<WebSphere MQ Server IP Address
(PortNumber)</mqchanneldefinition>
<MessageType/>
<QueueNames>
<Queue qid="WSMQ_OUT_Q">Output Queue</Queue>
</QueueNames>
</MQ>

IMS Health Operations Guide Page 360 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

4. Updating the Xtelligent Import Adapter configuration file for changes in Refresh
Request, Exception queue names and Websphere MQ Server connection details
Locate the np_is_import_config.xml configuration file in the configuration file in the
<np_root>\np\<Adapter Deployment Directory>\< Deployment Environment
>\DataInterfaces\Interfaces\Configuration folder.
Example: <np_root>\np\is\prod\DataInterfaces\Interfaces\Configuration
Shut down the nponepoint.exe application and any active jobs managed by it before making any changes.
The changes will take effect only after restarting the nponepoint.exe application.
Locate the <MQ> node in the file. Under the <MQ> node change the value of
<Owner> attribute with the new QueueManager Name
<mqchanneldefinition> attribute with the new channel name and WebSphere Server IP Address
with the Port Number within circular braces.
<Queue qid="WSMQ_REF_REQ_QUEUE_ID"> attribute for changes in the Refresh Request Queue
Name
<Queue qid="WSMQ_X_QUEUE_ID"> attribute for changes in the Exception Queue Name.
The highlighted placeholders in the following node need to be updated with actual values in
np_is_import_config.xml file.
Note: For default queue manager, port number is not required to be specified explicitly.
<MQ>
<QProcessor>MQListener.QProcessor</QProcessor>
<Owner>QueueManager</Owner>
<mqchanneldefinition>Channel Name/TCP/<WebSphere MQ Server IP Address
(PortNumber)</mqchanneldefinition>
<MessageType/>
<QueueNames>
<Queue qid="WSMQ_REF_REQ_QUEUE_ID">Refresh Request Queue</Queue>
<Queue qid="WSMQ_X_QUEUE_ID">Exception Queue</Queue>
</QueueNames>
</MQ>

IMS Health Operations Guide Page 361 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX J: FND_EXTRACT_RUN_LOG TABLE


The FND_EXTRACT_RUN_LOG table is used by some of the Server Layer processes to store the last
execution timestamp of the process. This will later be used by the process to run in an incremental mode,
based on the last execution of the date. Processes that use this table are assigned a unique code
(RUN_CODE). The unique code values are self-maintained by the processes and are not stored in a
metadata table or by a GUI application.
Care should be taken to assign a unique code when a new process starts using this table. This appendix
should be modified to include the new process and its unique code value. The table below lists all the
processes that use the FND_EXTRACT_RUN_LOG table and their code values.
RUN_CODE Process Process Type Reference Section
1 Custom Process N/A N/A
2 Custom Process N/A N/A
3 Custom Process N/A N/A
4 SP_DELTA_MULTI_ADDR_CHECK Procedure. N/A
20 Custom Process N/A N/A
50 pkg_validation_prof_ext_queue PL/SQL package N/A
51 NPProfileGrouping PL/SQL package 14.2
97 Custom Process N/A N/A
98 Custom Process N/A N/A
99 NPBestCustomer PL/SQL package 20.5
100 NPCustAffilBatchProcess PL/SQL package 20.5.11
101 NPCCV_CustomerXrefExport PL/SQL package N/A

IMS Health Operations Guide Page 362 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPENDIX K: PROCESSES THAT ARE INTERNAL TO IMS HEALTH


Processes that are used internally only by IMS Health in its development environment are listed in the
following table. These processes should not be used by the client team or client in its test or production
environment.
Sequence
Process Comments
Number
run_dataimpor.exe is modified to archive third party data
1. archive_data_file.exe
files using WinZip command line utility.
This script was used internally by IMS Health to sort data
files and it is not supported anymore. Third party data
2. npsort.exe
files are expected to be sorted in the key order prior to
using them in Data Import.
This script was used internally by IMS Health to read data
3. rdr.exe
files and it is not supported anymore.
This script was used internally by IMS Health to execute
4. run_extract.exe
custom extracts and it is not supported anymore.
This script was used internally by IMS Health to extract
5. run_stdaddr_extract.exe
standardized addresses and it is not supported anymore.
This script was used internally by IMS Health to pre-
6. validation_file_preprocess.exe process the data file received from the external
verification vendor and it is not supported anymore.
Script to monitor the progress of the Match process. Not
7. watch_match.exe
supported any more.
Script to write a header record to a file which is extracted
8. write_header.exe to an earlier version of Sample Guardian. Not supported
any more.
Script to run the NUCLEUS ID migration utility. Not
9. run_npmigration.exe
supported any more.

IMS Health Operations Guide Page 363 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information
Nucleus 360 Version 5.2.0
Operation Instructions

APPROVALS
Your signature indicates this document was reviewed and verified for accuracy and thoroughness and
that you approve the contents of the document.
Your electronic record of approval indicates this document was reviewed and verified for accuracy and
thoroughness and that you approve the contents of the document.
Title and Name
Senior Development Manager, Technology Solutions
Shankar Kanagaraj

IMS Health Operations Guide Page 364 of 364


Rev. 1 October 1, 2015 371339087.doc
2015 IMS Health, Proprietary and Confidential Information

S-ar putea să vă placă și