ICE Components for Prophet 21 version 12.10
ICE Components for Prophet 21 This manual contains information about software products from Epicor Software Corporation. The software described in this manual and the manual itself are furnished under the terms and conditions of a license agreement. The software consists of software options that are separately licensed. It is against the law to copy the software on any medium, or to enable any software options, except as specifically permitted under the license agreement. In addition, no part of this manual may be copied or transmitted in any form or by any means without the prior written permission of Epicor Software Corporation. From time to time, Epicor Software Corporation makes changes to its software products. Therefore, information in this manual is subject to change, and the illustrations and screens that appear in the manual may differ somewhat from the version of the software provided to you. Created by: Yardley Technical Communication 2011, Epicor Software Corporation. All rights reserved. Epicor and the Epicor logo are registered trademarks and Epicor Prophet 21 is a trademark of the Epicor Software Corporation. All other company or product names are the trademarks or registered trademarks of their respective companies. Epicor Software Corporation 7683 Southfront Road Livermore, CA 94551 Version 12.10 Publication Date: 10/1/2012-2 -
ICE Components for Prophet 21 Table of Contents 1 User Defined Drills for External Calls 4 Default Drills 4 User Defined Drills 4 Creating a User-Defined Drill 5 Testing a User-Defined Drill 6 Setup 7 Requirements 7 Installation 7 2 URL Handler Installation 8 Setup 8-3 -
Default Drills ICE Components for Prophet 21 1 User Defined Drills for External Calls Prophet 21 v12.10 adds the ability to open a Prophet 21 window from a browser and pass a data element to it. This facilitates the integration of Prophet 21 with Epicor Enterprise Search. It also allows you to open a Prophet 21 window from an external program and/or a business rule using DynaChange Rules. Default Drills The URL structure for default drills is: pxxiurlhandler://source/sourcefield?id=<data Element> By default, Prophet 21 navigates to the window associated with the default drill for the SourceField. For example, the URL shown below opens Customer Master Inquiry, then passes 100026 into the customer_id field: pxxiurlhandler://enterprisesearch/customer_id?id=100026 Note: When using the default drills, Prophet 21 ignores the Source region of the URL. When invoking Prophet 21 from a browser, if there is an open Prophet 21 session, it will be used to satisfy the request. If there is no open session, a new session starts. In this case, you are required to enter the login credentials. User Defined Drills To create a drill that opens a window other than the default is a two step process: 1. Use a business rule to call a URL with the desired Prophet 21 window as the target. 2. Use DynaChange TM Navigator to link to that URL. Example: You add a button to the Order Entry screen using DynaChange TM Designer. When you click the button, the system opens the Customer Maintenance window (rather than CMI) with the Customer ID on the order already populated. - 4 -
User Defined Drills ICE Components for Prophet 21 1. In your business rule, call the URL. Provide a unique Source & SourceField combination because you want to navigate to a different place than the default (CMI). Pxxiurlhandler://MyBusinessRule/CustomerID?ID =10001 2. In DynaChange TM Navigator, create a drill which correlates the URL your business rule is using with the target window. In this case, correlate MyBusinessRule / CustomerID with Customer Maintenance / Customer ID field. Creating a User-Defined Drill 1. Open Customer Maintenance. 2. Open the RMB from the Customer ID field. 3. Select DynaChange TM. 4. Select DynaChange Navigator TM. 5. Select Make Field a Drill Target. 6. Open the RMB in the popup window. 7. Select Add. 8. Enter the Source and SourceField in the blank row that appears. 9. Check the Selected checkbox for that row. 10. Provide an annotation in the Description field if desired. 11. Click Save. - 5 -
User Defined Drills ICE Components for Prophet 21 Testing a User-Defined Drill From your business rule or the browser, try testing the URL. Note: All browser testing has been done with Internet Explorer. Cursory testing has shown that FireFox should work; Chrome will not. - 6 -
Setup ICE Components for Prophet 21 Setup Requirements Make sure you are on Prophet 21 v12.10 or higher. Installation You will need to install the Prophet 21 Message Receiver application on each machine on which Prophet 21 is installed. This installation is available from the customer web-site. The installation: creates a custom URL protocol (http://msdn.microsoft.com/en-us/library/aa767914(v=vs.85).aspx) installs an application (pxxiexternalmessagereceiver.exe) updates a config file (pxxiexternalmessagereceiver.exe.config) with the path to your Prophet 21 executable files Important! The URL protocol needs to be on the same machine as Prophet 21. - 7 -
Setup ICE Components for Prophet 21 2 URL Handler Installation This process installs a small application and a registry setting that allow Prophet 21 to communicate with the Enterprise Search application. Setup Run the file: Epicor.PXIXIUrlHandler.Install.exe and follow the wizard prompts. - 8 -
Setup ICE Components for Prophet 21 This will all create a registry setting in HKEY_CLASSES_ROOT\PXXIURLHandler. - 9 -