User manual BUSINESS OBJECTS MATCH-CONSOLIDATE 8.00C CUSTOM PROGRAMMERS REFERENCE

[. . . ] Match/Consolidate Custom Programmer's Reference Match/Consolidate 8. 00c April 2009 Copyright information © 2009 SAP® BusinessObjectsTM. SAP BusinessObjects and its logos, BusinessObjects, Crystal Reports®, SAP BusinessObjects Rapid MartTM, SAP BusinessObjects Data InsightTM, SAP BusinessObjects Desktop IntelligenceTM, SAP BusinessObjects Rapid Marts®, SAP BusinessObjects Watchlist SecurityTM, SAP BusinessObjects Web Intelligence®, and Xcelsius® are trademarks or registered trademarks of Business Objects, an SAP company and/or affiliated companies in the United States and/or other countries. SAP® is a registered trademark of SAP AG in Germany and/or other countries. All other names mentioned herein may be trademarks of their respective owners. 2 Match/Consolidate Custom Programmer's Reference Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Chapter 1: Introduction to Match/Consolidate Custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [. . . ] Get the original data or key data. mpc_get_db_field() mpc_get_pw_field() mpc_get_key_field() mpc_put_db_field() mpc_put_key_field() mpc_set_ap_field() Put data into database fields or key fields. For example you might set a value in one of the parse-status fields: MPG_AP_NAME_ERROR, MPG_AP_FIRM_ERROR, MPG_AP_ADDR_ERROR, or MPG_AP_LL_ERROR. Do not call ACE or TrueName Do not call either ACE Library or TrueName Library from this parse exit. If either of those programs is initiated in the parse exit, their functions will conflict with Match/Consolidate's use of those same functions. If you feel you need to call either ACE or TrueName from the parse exit, consider using the extended parsing settings in the Match Options block of your Match/ Consolidate job, instead. You should be able to get the results you want through that approach. Chapter 2: Writing exit functions 25 Table of exit-support functions by exit point The following table shows which exit-support functions you can call from each type of exit function. Exit support function input_ proc comp_ before comp_ after_ dupe Exit function comp_ after_ nondupe dupe_ group dupe_ group_ post output _proc parse mpc_get_ap_field() mpc_get_db_field() mpc_get_error_info() mpc_get_exit_type() mpc_get_info_in_field() mpc_get_info_in_file() mpc_get_info_key_field() mpc_get_info_out_field() mpc_get_info_out_file() mpc_get_info_pw_field() mpc_get_job_step() mpc_get_key_field() mpc_get_num_current_rec() mpc_get_num_in_files() mpc_get_num_recs() mpc_get_pw_field() mpc_get_pw_field_id() mpc_get_record() mpc_put_db_field() mpc_put_key_field() mpc_put_record() mpc_set_ap_field() mpc_set_current_rec() mpc_set_dupes() mpc_set_gpst_result() mpc_set_group_pos() mpc_set_process() mpc_set_unique() simscore() P P Yes Yes Yes Yes Yes No No Yes Yes No 1 Yes 1 P P P P No P No 1 No No No P P Yes P P Yes Yes Yes Yes Yes No No Yes Yes P P Yes 2 P P P No No No No P P No No No No Yes P P Yes Yes Yes Yes Yes No No Yes Yes P P Yes 2 P P P No No No No P P No No No No Yes P P Yes Yes Yes Yes Yes No No Yes Yes P P Yes 2 P P P No No No No P P No No No No Yes P P Yes Yes Yes Yes Yes No No Yes Yes No P Yes P P P P No No No No P No No P No No Yes P P Yes Yes Yes Yes Yes No No Yes Yes No P Yes P P P P P No P No P No P No No No Yes P P Yes Yes Yes Yes Yes P P Yes Yes No P Yes 2 P P P P No P No P No No No P No Yes P P Yes Yes Yes Yes Yes P P Yes Yes No P Yes 1 P P P P P Yes P P No No No P No Yes Yes = You can call this support function when the exit function is in any of the three states. P = You can call this support function only when the exit function is in the process state. 1 = You can call this support function, but it will always return a 1. 2 = You can call this support function, but it will always return a 2. 26 Match/Consolidate Custom Programmer's Reference Chapter 3: Group posting This chapter explains the available options for performing group posting in Match/Consolidate Custom. Chapter 3: Group posting 27 Group posting options You may perform group posting by any of three methods: Method Description Internal You may perform group posting entirely within the normal Match/Consolidate job, by using Group Posting blocks in your job file. You may perform group posting entirely outside of normal Match/Consolidate processing. That is, the user may set up operations through the job file, and then your exit function may perform postprocessing or additional operations. External Both 28 Match/Consolidate Custom Programmer's Reference Setting up external operations You may perform group posting entirely outside of normal Match/Consolidate processing. We will call this an external group-posting operation. Job file Under this method, no Group Posting blocks are used in the job file. However, the job file should include a block for the group-posting report. And in the blocks for output file or purge, the Do Group Posting parameter must be set to Yes. To set up external operations, your main program (not an exit function) should call three functions in the Match/Consolidate Custom library: Call mpc_set_gpst_num_ops() to set the number of external operations to be performed. This call has the same effect as the parameter Group Post Name in the Group Posting block. The name that you set is used on the group-posting report, simply to identify each operation. Make sure that your exit function will be called at least in the process state, and perhaps in the init and term states as well. To repeat, your exit function will be called only if the user has set the Do Group Posting parameter in the Execution block of the job file to Yes. In the process state, the entire dupe group will be presented to your exit function for processing. In the master dupe, you may perform any transfer or manipulation of data that you desire. Remember that the format of the source and destination records (subordinate and master dupes) are their format from the input file. The format of your output file does not matter, because group posting is performed before the output record is assembled. Match/Consolidate Custom setup calls Chapter 3: Group posting 29 Setting up double operations You may perform group posting both internally and externally. [. . . ] This may range from 1 to the number of members in the dupe group; to find that number, call mpc_get_num_recs(). Please note that we are using a long integer here, instead of the character designations used in the Match/Consolidate application field AP. Group_Rank. The mpc_set_group_pos() function should only be called from the dupe_group() exit function in the process state. After mpc_set_group_pos() returns, the same record is still the current record, but it has a new position in the dupe group, so mpc_get_num_current_rec() would yield a different result. Returns Returns MPC_OK if successful. [. . . ]