Advanced Service Connect9
Advanced Service Connect9
Advanced Service Connect9
Disclaimer
This document is for informational purposes only and is subject to change without notice. This document and its contents, including the viewpoints, dates and functional content expressed herein are believed to be accurate as of its date of publication. However, Epicor Software Corporation makes no guarantee, representations or warranties with regard to the enclosed information and specifically disclaims any applicable implied warranties, such as fitness for a particular purpose, merchantability, satisfactory quality or reasonable skill and care. As each user of Epicor software is likely to be unique in their requirements in the use of such software and their business processes, users of this document are always advised to discuss the content of this document with their Epicor account manager. All information contained herein is subject to change without notice and changes to this document since printing and other important information about the software product are made or published in release notes, and you are urged to obtain the current release notes for the software product. We welcome user comments and reserve the right to revise this publication and/or make improvements or changes to the products or programs described in this publication at any time, without notice. The usage of any Epicor software shall be pursuant to an Epicor end user license agreement and the performance of any consulting services by Epicor personnel shall be pursuant to Epicor's standard services terms and conditions. Usage of the solution(s) described in this document with other Epicor software or third party products may require the purchase of licenses for such other products. Where any software is expressed to be compliant with local laws or requirements in this document, such compliance is not a warranty and is based solely on Epicor's current understanding of such laws and requirements. All laws and requirements are subject to varying interpretations as well as to change and accordingly Epicor cannot guarantee that the software will be compliant and up to date with such changes. All statements of platform and product compatibility in this document shall be considered individually in relation to the products referred to in the relevant statement, i.e., where any Epicor software is stated to be compatible with one product and also stated to be compatible with another product, it should not be interpreted that such Epicor software is compatible with both of the products running at the same time on the same platform or environment. Additionally platform or product compatibility may require the application of Epicor or third-party updates, patches and/or service packs and Epicor has no responsibility for compatibility issues which may be caused by updates, patches and/or service packs released by third parties after the date of publication of this document. Epicor is a registered trademark and/or trademark of Epicor Software Corporation in the United States, certain other countries and/or the EU. All other trademarks mentioned are the property of their respective owners. Copyright Epicor Software Corporation 2011. All rights reserved. No part of this publication may be reproduced in any form without the prior written consent of Epicor Software Corporation.
ED902905 90521-905-8799-583606 9.05.606 Revision: July 13, 2011 9:39 a.m. Total pages: 64 course.ditaval
Contents
Contents
Advanced Epicor Service Connect 9.05 for Epicor ERP Course............................................6 Before You Begin....................................................................................................................7
Audience.........................................................................................................................................................7 Prerequisites....................................................................................................................................................7 Environment Setup..........................................................................................................................................7 Workshop Constraints..............................................................................................................................9
Overview...............................................................................................................................10
Epicor Service Connect Solutions....................................................................................................................10 Epicor Service Connect Installation.................................................................................................................10 IIS Server Status......................................................................................................................................10 Licensed Functionalities...........................................................................................................................11 Task Service Properties............................................................................................................................11 Document Tracking Properties................................................................................................................11 DES Service Properties.............................................................................................................................12 .NET Call Performance............................................................................................................................12 Communication Manager Property.........................................................................................................12 Mass Update of Workflows.....................................................................................................................12 Web Methods to .NET Calls Converter....................................................................................................13
Process...................................................................................................................................14
Test .NET References......................................................................................................................................14 Workshop - Test a .NET Reference..........................................................................................................14 Import a .NET Reference..................................................................................................................14 Test a .NET Method.........................................................................................................................15 Web Service Enhancements 3.0 Server Policy..................................................................................................16 Workshop - Apply WSE 3.0 Server Policy.................................................................................................16 Install Services.................................................................................................................................16 Create a Configuration File..............................................................................................................17 Apply WSE 3.0 Server Policy............................................................................................................18 Test the Part Service........................................................................................................................19 Database Operations......................................................................................................................................21 Workshop - Create a Workflow..............................................................................................................21 Create a CSV File.............................................................................................................................21 Add a Sender..................................................................................................................................22 Add a Message Type.......................................................................................................................22 Add an Input Channel.....................................................................................................................22 Generate a Schema.........................................................................................................................23 Create a Workflow..........................................................................................................................24 Define the Conversion.....................................................................................................................24 Edit the Conversion.........................................................................................................................25 Define a .NET Call............................................................................................................................26
Contents
Add a Message Map........................................................................................................................26 Run the Workflow...........................................................................................................................27 Verify the Results.............................................................................................................................27 Workshop - Use a Database Operation...................................................................................................27 Add an Output Channel..................................................................................................................27 Modify the Workflow......................................................................................................................28 Define the DBOperation..................................................................................................................28 Build the Statement.........................................................................................................................30 Define the Poster.............................................................................................................................31 Modify the CSV File.........................................................................................................................31 Run the Workflow...........................................................................................................................31 Verify the Results.............................................................................................................................31 Workshop - Use the Database Lookup Functoid......................................................................................32 Modify the Conversion Element.......................................................................................................32 Create a Query................................................................................................................................33 Create a Where Expression..............................................................................................................33 Run the Workflow...........................................................................................................................34 Verify the Results.............................................................................................................................35 Channel Info Tag...........................................................................................................................................35 Workshop - Expose the Channel Info Tag...............................................................................................35 Create a Message Extension............................................................................................................35 Modify the Conversion Element.......................................................................................................36 Modify the Output Channel.............................................................................................................37 Run the Workflow...........................................................................................................................37 Verify the Results.............................................................................................................................37 Batch Execution.............................................................................................................................................38 Workshop - Test Batch Execution of Sub-Workflows...............................................................................38 Download Files................................................................................................................................38 Restore Connectivity Settings...........................................................................................................39 Re-import the Service Reference......................................................................................................40 Prepare the Workflow.....................................................................................................................40 Enable Channels..............................................................................................................................41 Trigger the Workflow......................................................................................................................41 Verify the Results.............................................................................................................................42 Enable a Batch Execution.................................................................................................................42 Trigger the Workflow......................................................................................................................43 Verify the Results.............................................................................................................................43 Break Cycle....................................................................................................................................................43 Workshop - Break a Cycled Sub-Workflow..............................................................................................44 Disable Batch Execution...................................................................................................................44 Modify a Sub-Workflow..................................................................................................................44 Edit the Choice Item........................................................................................................................45 Configure the First Connection........................................................................................................45 Configure the Second Connection...................................................................................................46 Run the Workflow...........................................................................................................................47
Contents
Edit the Break Cycle Conversion......................................................................................................48 Run the Workflow...........................................................................................................................48 Service Connect and Business Process Management.......................................................................................50 Workshop - Create Demand...................................................................................................................50 Create a Demand Contract..............................................................................................................50 Create New Demand.......................................................................................................................51 Explore Business Objects..................................................................................................................51 Workshop - Create the Workflow...........................................................................................................53 Add a Service Reference..................................................................................................................53 Create the Workflow.......................................................................................................................53 Edit the First Conversion..................................................................................................................54 Edit the First Web Method...............................................................................................................55 Edit the Second Conversion.............................................................................................................55 Modify the Demand Record.............................................................................................................56 Edit the Second Web Method..........................................................................................................57 Workshop - Create a Method Directive...................................................................................................58 Add a Method Code........................................................................................................................58 Add a Pre-Processing Directive.........................................................................................................58 Add a Condition..............................................................................................................................58 Add an Action.................................................................................................................................59 Workshop - Test BPM Execution.............................................................................................................60 Modify Part Information..................................................................................................................60 Test the Result.................................................................................................................................60 Customized View...........................................................................................................................................61 Workshop - Create a Customized View...................................................................................................61 Create a View..................................................................................................................................61 Apply a Filter...................................................................................................................................62
Conclusion.............................................................................................................................63
Audience
Specific audiences will benefit from this course. Engineer System Administrator IT/Technical Staff
Prerequisites
In order to complete the workshops in this course, all necessary modules must be licensed and operating in your training environment. For more information on the modules available, contact your Epicor Customer Account Manager [email protected]. It is also important that you understand the prerequisite knowledge contained in other valuable courses. Navigation Course - This course introduces navigational aspects of the Epicor application's user interface. Designed for a hands-on environment, general navigation principles and techniques are available at each of the interface levels in the Epicor application - system, module, and program. Workshops focus on each of these levels and guide you through each navigational principle introduced. Database Concepts Course - This course reviews the table and field name identification process using Field Help, Customization Tools, and the Data Dictionary Viewer functionality. It also describes table linking procedures and requirements, Dataset Relationships Tracker features, and join type definitions and specifications. Business Process Management Course - This course focuses on the Business Process Management. BPM allows you to modify the flow of business processes through the application. This allows individual companies to tailor the business flow to their specific requirements. Epicor Service Connect 9.05 for Epicor 9 Course - This course focuses on the main features of Epicor Service Connect and how to integrate it with the Epicor application. Service Connect is a powerful development tool that allows you to build workflows which can automate processes within an application or connect different business entities, applications, or users. It harnesses the power of XML and other open standards.
Environment Setup
The environment setup steps and potential workshop constraints must be reviewed in order to successfully complete the workshops in this course. Your Epicor training environment, in which the Epicor demonstration database is found, enables you to experience Epicor functionality in action but does not affect data in your live, production environment. The following steps must be taken to successfully complete the workshops in this course.
1.
Verify the following or ask your system administrator to verify for you: Your Epicor training icon (or web address if you are using Epicor Web Access) points to your Epicor training environment with the Epicor demonstration database installed. Do not complete the course workshops in your live, production environment. Note It is recommended that multiple Epicor demonstration databases are installed. Contact Support or Systems Consulting for billable assistance. The Epicor demonstration database is at the same service pack and patch as the Epicor application. Epicor's education team updates the Epicor demonstration database for each service pack and patch. If your system administrator upgrades your Epicor application to a new service pack or patch, he or she must also download the corresponding Epicor demonstration database from EPICweb > Support > Epicor > Downloads and install it. If this is not performed, unexpected results can occur when completing the course workshops. Your system administrator restored (refreshed) the Epicor demonstration database prior to starting this course. The Epicor demonstration database comes standard with parts, customers, sales orders, and so on, already defined. If the Epicor demonstration database is shared with multiple users (that is, the database is located on a server and users access the same data, much like your live, production environment) and is not periodically refreshed, unexpected results can occur. For example, if a course workshop requires you to ship a sales order that came standard in the Epicor demonstration database, but a different user already completed this workshop and the Epicor demonstration database was not restored (refreshed), then you will not be able to ship the sales order. Epicor's education team has written the course workshops to minimize situations like this from occurring, but Epicor cannot prevent users from manipulating the data in your installation of the Epicor demonstration database.
2.
Log in to the training environment using the credentials manager/manager. If you are logged in to your training environment as a different user, from the Options menu, select Change User. From the Main menu, select the company Epicor Education (EPIC06). From the Main menu, select the Main Plant. Epicor Service Connect 9.05 must be installed in your environment. To perform the Workshop - Apply WSE 3.0 Server Policy, Web Services Enhancements (WSE) 3.0 (Administrator mode) must be installed. To perform the Workshop - Use Database Operation, ODBC driver to your Epicor application must be established. Example Microsoft OLE DB Provider for ODBC Drivers or Microsoft OLE DB Provider for SQL Server.
3. 4. 5. 6.
7.
8.
To perform the Workshop - Call Service Connect Using Business Process Management, Business Layer Tester must be installed in your environment. To locate the installer of this tool, navigate to the Utilities folder of your Epicor 905 installation, for example c:\Program Files\epicor\Epicor905\Utilities\BL-Tester. For more information, contact your system administrator.
Workshop Constraints
The following workshops or topics should only be performed once in your Epicor Service Connect environment. Workshop - Test a .NET Reference - Import a .NET Reference Workshop - Apply WSE 3.0 Server Policy Workshop - Test Batch Execution of Sub-Workflows Workshop - Break a Cycled Sub-Workflow Workshop - Create a Method Directive
Overview
Overview
The Epicor Service Connect environment consists of various server files, tools, and Windows services that are managed, for the most part, by a Microsoft Management Console (MMC) snap-in called the Epicor Service Connect Administration Console. The Service Connect design environment consists of an application called the Workflow Designer that allows users to create and modify workflows. The Service Connect server can be on a different machine than the applications with which it interacts, or it can be on the same machine.
10
Overview
resolved into the IP address of your Service Connect server, and an internet connection is configured properly to validate .xml schemas. The hosts file is a plain text file an operating system uses to map to IP addresses. In Microsoft Windows environments, the file is located in the %SystemRoot%\system32\drivers\etc\ folder. In the following example, scshost is resolved to the local IP address. 127.0.0.1 127.0.0.1 localhost scshost
During the Task Monitor installation, 'http://scshost' is added to Local Intranet sites. In Internet Information Services (IIS) Server Manager, navigate to the Sites node and verify the host site is running. You can access this feature from the Start > Administrative Tools menu. Within the scshost site, navigate to the Schemas node, right-click any schema, and select Browse. If any proxy server is used in your environment, you must select Bypass proxy server for local addresses option for the correct schema resolution. In the Microsoft Internet Explorer environment, use the Tools > Internet Options > Connection Settings > LAN settings > Proxy server section to access this option.
Licensed Functionalities
Before you start to use Epicor Service Connect, verify your license is valid and view the list of all licensed functionalities. In Epicor Service Connect Admin Console, navigate to the Licenses > Features node to view licensed Business and System functionalities and their license file. In the Value field, the True value confirms you can use the functionality or a number displays the amount of users allowed to work with the functionality. To view the identification number of the license file and the directory where it is located, right-click any folder in the Licences node and select Properties.
11
Overview
12
Overview
13
Process
Process
This section reviews advanced Service Connect techniques and contains workshops that guide you through the process.
1. Navigate to Connectivity > .NET References. 2. Right-click .NET References and select Add Reference. The Add .NET reference wizard displays. 3. Click Next. 4. Next to the Assembly path field, click the ... (browse) button. The Select Assembly window displays. 5. Navigate to the client folder on the server, for example C:\Epicor\Epicor905\client Note Contact your system administrator for help, if necessary.
6. In the Reference name field, enter PartUpdate. 7. In the File type field, select Epicor .NET Assemblies (Epicor.Mfg.BO.*.dll). 8. In the Select Assembly window, select Epicor.Mfg.BO.Part.dll and click OK. This is the business object that holds parts information.
14
Process
9. In the Add .NET Reference window, in the Assembly type field, select Epicor assembly. 10. In the Add .NET Reference window, click Next. The Logon to Epicor section displays. 11. Enter the following information: Field AppServer Port User Password Company Plant Data Enter your server name. Enter your application port number, for example, 9001. Enter a valid user, for example, manager. Enter a valid password for the user, for example, manager. Enter a company, for example, EPIC06. Enter a plant name, for example, MfgSys.
12. In the Add .NET Reference window, click Next. 13. Verify the information and click Next. The import process begins and may take a while. 14. Once the All methods of .NET assembly are imported information displays, click Next. 15. In the Add .NET Reference window, view the information and click Finish.
15
Process
8. Click Close.
Install Services
On your Epicor application server, install Web Services used in this course. 1. Use Windows Explorer to navigate to the folder where the Epicor application web services installer is located. Example C:\Program Files\Epicor Software\Epicor905\WebServices or C:\Prog ram Files (x86)\Epicor Software\Epicor905\WebServices
2. Double-click the WS-Configuration (.NET 2.0 Edition).exe. 3. If an Install Warning window displays, click OK. The warning indicates you must run the web service installer on the same machine where you plan to install the services. Optionally, you can select the Do not show this message again check box. The WS-Configuration (.NET 2.0 Edition) window displays. 4. In the Progress Server field, enter your progress server name. The Progress Server field represents the name of the server on which your Progress application server is running. If the progress application server is on the same machine you are installing the services on, then localhost is a valid entry here; otherwise, enter your Epicor application server name. 5. In the Port field, enter the port number that the Epicor application server uses. Example The default port number is set to 9001.
6. In the Available Services section, select Part Service and DemandEntryService. 7. Click the right arrow button to add the services to the Services to be Installed pane. 8. In the Virtual Directory field, verify EpicorServices displays.
16
Process
9. Click the Update Site button. 10. To the Installation Complete message, click OK. Notice the installed services display in the Installed Items pane in the lower left part of the window. 11. Exit the WS-Configuration (.NET 2.0 Edition) window.
1. On the General sheet, select the Enable this project for Web Service Enhancements check box. 2. Navigate to the Policy sheet. 3. Select the Enable Policy check box. 4. Click the Add button. The Add or Modify Policy Friendly Name window displays. 5. In the name field, enter Test-XXX (where XXX are your initials) and click OK. The WSE Security Settings Wizard window displays. 6. Click Next. 7. For the Choose Client Authentication Method option, select Username. 8. Click Next. 9. Clear the Specify Username Token in code check box. 10. For the Username and Password, enter the credentials you use to connect to the Epicor application. Example Use manager/manager.
11. Click Next. 12. Clear the Enable WS-Security 1.1 Extensions check box. 13. Click Next. 14. Click Finish. 15. Form the File menu, select Save As. The Save As window displays. 16. Navigate to the folder you created.
17
Process
For example, c:\Test. 17. In the File name field, enter Test-XXX (where XXX are your initials) and click Save. 18. Exit the WSE 3.0 Configuration Tool.
5. In the Reference name field, enter PartService. 6. In the Service Reference Type field, select Generic Web Service. Note You must select this option in order to access WSE 3.0 configuration settings in future dialogs.
7. Click Next. 8. Verify the Integrated Windows Security check box is selected. 9. Click Next. 10. In the Policy settings window, select Custom. 11. In the Type field, select WSE 3.0. 12. On your local machine, navigate to the folder you created. Example c:\Test
13. Use an xml editor to open the ws3policyCache.config file and copy the content. Tip You can use Notepad to perform this operation.
18
Process
15. In Epicor Service Connect Administration Console, paste the policy file content into the Custom section. Example <policies xmlns="http://schemas.microsoft.com/wse/2005/06/policy"> <extensions> <extension name="usernameOverTransportSecurity" type="Microsoft.Web .Services3.Design.UsernameOverTransportAssertion, Microsoft.Web.Service s3, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" /> <extension name="username" type="Microsoft.Web.Services3.Design.Use rnameTokenProvider, Microsoft.Web.Services3, Version=3.0.0.0, Culture=n eutral, PublicKeyToken=31bf3856ad364e35" /> <extension name="requireActionHeader" type="Microsoft.Web.Services3 .Design.RequireActionHeaderAssertion, Microsoft.Web.Services3, Version= 3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" /> </extensions> <policy name="Test-XXX"> <usernameOverTransportSecurity> <clientToken> <username username="manager" password="manager" /> </clientToken> </usernameOverTransportSecurity> <requireActionHeader /> </policy> </policies>
16. In the Policy name field, enter Test-XXX (where XXX are your initials). 17. Click Next until you finish importing the service. The service reference is now using the created policy. 18. Review the import log and click Next. 19. Click Finish to exit the wizard.
19
Process
8. Click Close.
20
Process
Database Operations
The DBOperation workflow element allows you to run one or several SQL statements (SELECT, INSERT, DELETE, UPDATE, EXEC) against one or several databases. SQL statements can use part of an XML document to update or select database data. The result of the SELECT statement can be put into an XML document for further workflow processing. You can use DBOperation to perform the following actions: Read, write, and update third party databases during workflow execution; this is required for data synchronization. Read values from application databases "on the fly"; this can be useful if one or several fields are not returned by the standard Business Object methods. Read additional Business Object values from custom user tables. To enhance the process, use the DB Lookup functoid, which uses specified selection criteria to perform database lookup. This functoid is found on the Special sheet in the Functoid Palette window. When you execute SQL statements, the DB Operation element logs each SQL statement and connection string that executes against a database into the ESC Events log.
3. From the File menu, select New. 4. Enter the following information (where XXX are your initials). PartNum,SearchWord,PartDescription 9001-XXX,P9001,Part9001 9002-XXX,P9002,Part9002 9003-XXX,P9003,Part9003 5. From the File menu, select Save As. 6. Navigate to c:\channels\input. 7. In the Save as type field, select All Files.
21
Process
8. In the File name field, enter part_update_XXX.csv (where XXX are your initials). 9. Click Save. 10. Exit Notepad.
Add a Sender
1. In Epicor Service Connectivity Administration Console, navigate to Connectivity > Message attributes. 2. Right-click Senders and select Add New Sender. The Add New Sender window displays. 3. In the Sender name and Sender description fields, enter csv_sender_XXX (where XXX are your initials). 4. In the Add New Sender window, click OK.
22
Process
The Channel configuration window displays. 7. Verify the Message properties sheet displays and select the following information. Field SenderName MsgType Action Value csv_sender_XXX (where XXX are your initials) csv_import_XXX update
8. Navigate to the Communicator properties sheet and enter the following information. Tip In many of these fields, there is a button to open a window where you can edit or select a value.
9. In the Channel Configuration and Channel properties windows, click OK. The folder you entered in the File path field is now hot, which means that Service Connect consumes any .csv file you add to it. You cannot retrieve a file once it is consumed.
Generate a Schema
1. Navigate to Connectivity > Workflow packages. 2. Right-click Workflow packages and select New package. 3. In the Package name field, enter csv_package_XXX (where XXX are your initials) and click OK. 4. Within the Workflow packages node, right-click the newly created csv_package_XXX package and select New. Epicor Service Connect Workflow Designer displays. You must first generate a schema for the .csv input file you created. 5. In ESC Workflow Designer, from the Tools menu, select Schema Utility. The Schema Utility window displays. 6. From the File menu, select Generate Schema. The Load Sample File window displays. 7. Navigate to the c:\channels\input folder. 8. Select part_update.csv. 9. Click Open.
23
Process
10. In the Select Conversion Plug-in window, select csv2xml.dll and click OK. The Schema Generation window displays. 11. To the Would you like to import generated schema to SC message, click Yes. The Select Schema window displays. 12. In the File name field, enter csv_schema_XXX.xsd (where XXX are your initials) and click OK. 13. Exit Schema Utility.
Create a Workflow
1. On the Items toolbar, click the Conversion button. 2. To the right of the Start button, click in the workflow design area. The Properties window displays. 3. In the Properties window, click OK. 4. On the Items toolbar, click the .NET Call button. 5. To the right of the Conversion button, click in the workflow design area. The Properties window displays. 6. In the Properties window, click OK. 7. On the Items toolbar, click the Connection button. 8. Make the following connections: Start to Conversion Conversion to NetCall NetCall to Finish 9. Click Save. 10. To the validation message, click Yes. The Save New Workflow window displays. 11. In the Save workflow as field, enter csv_workflow_XXX (where XXX are your initials) and click Save.
24
Process
4. In the left pane, select User Schemas. 5. Select csv_schema_XXX.xsd (where XXX are your initials). 6. Click Next. 7. Click Finish. 8. Next to the Output schema field, click the Browse button. The Select a schema window displays. 9. In the left pane, select .NET Reference Schemas. 10. Double-click the PartService folder. 11. Select Epicor_Mfg_BO_Part_UpdateExt_Request.xsd. 12. Click Next. 13. Click Finish. 14. Remain in the Properties window.
5. Set the following literal values for the fields on the right: Tip To set a literal value, right-click a node and select Set Literal value. Enter a value and click OK.
25
Process
6. Click Save. 7. In the Save Transformation File window, click OK. 8. Exit the NewTransformation window. 9. In the Properties window, click OK. 10. Click Save.
26
Process
27
Process
28
Process
9. Click the Add button. The SQL Statement window displays. 10. Under the Connection string section, click the ... (browse) button. The Data Link Properties window displays. 11. In the Provider sheet, select the OLE DB Provider you use to connect to the application database. Example Microsoft OLE DB Provider for ODBC Drivers or Microsoft OLE DB Provider for SQL Server
12. Click Next. 13. In the Connection sheet, enter the data required to set up a connection to the application database. Example For an SQL Server database connection, enter the following data: Select your server name. Enter a user name and password to connect to the server or use the Windows NT Integrated security option. To connect to a database that requires a username and password, select the Allow saving password check box. Select the appropriate database. Example For a Progress database connection, enter the following data: Select your data source name. Enter a user name and password to connect to the server, for example, sysprogress/sysprogress. To connect to a database that requires a username and password, select the Allow saving password check box. Select the appropriate database.
14. Click the Test Connection button. 15. If the connection is successful, to the Test connection succeeded message, click OK. 16. In the Datalink Properties window, click OK. 17. If a Warning message displays, click OK. 18. View the Connection string created based on your ODBC parameters. Important Make a copy of the Connection string. For example, copy and paste the content to Notepad. You need the Connection string to define the DB Lookup functoid parameters in the following workshop. Example The following is an example of a Progress Connection string: Provider=MSDASQL.1;Password=sysprogress;Persist Security Info=True;User ID=sysprogress;Data Source=Epicor905;Initial Catalog=MFGSYS
29
Process
30
Process
31
Process
Address any issues, if necessary. You can also verify the new parts exist in the Epicor application. 3. Navigate to the C:\channels\out folder. 4. View the xml file that contains the database output. Notice the file only contains information for the three parts you created.
32
Process
15. In the Primary expression window, click OK. 16. Remain in the Functoid Properties window.
Create a Query
1. In the Functoid Properties window, double-click the select row. The Primary expression window displays. 2. In the Type field, verify Literal displays. 3. In the Value field, enter PartNum. 4. In the Primary expression window, click OK. 5. Double-click the from row. The Primary expression window displays. 6. In the Type field, verify Literal displays. 7. In the Value field, enter Part. Important When you build a query against a Progress database, enter mfgsys.pub.part.
8. In the Primary expression window, click OK. 9. In the Functoid Properties window, click OK.
33
Process
7. In the Value field, enter the following. PartNum=' 8. In the Primary expression window, click OK. 9. In the Functoid Properties window, click OK. 10. Map the PartNum on the left to the str2 = <empty> row. Now you must complete the created expression. 11. Double-click the concat functoid. The Functoid Properties window displays. 12. Double click the [str?] row. The Primary expression window displays. 13. In the Type field, verify Literal displays. 14. In the Value field, enter and apostrophe to finish the expression ('). 15. In the Primary expression window, click OK. 16. In the Functoid Properties window, click OK. 17. In the concat functoid header, click the word concat and drag the cursor to the [where?] row in the dbLookup functoid. This maps the result of the concat functoid to the where expression of the dbLookup functoid. 18. In the dbLookup functoid header, click the word dbLookup and drag the cursor to the PartDescription node of the target document. 19. In the Conversion Type window, click Save. The two functoids will search the database for a PartNumber number provided by the csv file and will supply the value to the PartDescription node of the target document. 20. Exit the Conversion Type window. 21. In the Properties window, click OK. 22. Click Save.
34
Process
35
Process
The Process properties window displays. Tip Another way to access the window is to right-click in the empty workflow area and select Process Properties.
2. Navigate to the Message Extensions sheet. 3. Right-click msg:usr and select Add Container. The Add Container window displays. 4. In the Name field, enter ChannelInfo. 5. Next to the Schema field, click the browse button. The Select a schema window displays. 6. Click User Schemas. 7. Navigate to the Standard > ChannelInfo folder. 8. Select ChannelInfoFile.xsd. 9. Click Next. 10. Click Finish. 11. In the Add Container window, click OK. 12. In the Process properties window, click OK. The Message Extension is now available.
36
Process
37
Process
2. Verify the Processing status of the latest activity is Complete. Address any issues, if necessary. 3. Navigate to the C:\channels\out folder. 4. Notice the new name of the created output file. 5. View the xml file that contains the database output. 6. View the MfgComment field that contains the channel info tag. The information is available for further processing.
Batch Execution
Use the batch execution to run sub-workflows as parallel threads, to improve the performance of business processes. Use the Sub-Workflow Properties window to set up a batch execution. This option is available only if you select Execute synchronously on the General sheet. System administrators can elect whether to use this feature as it depends on the underlying business process and hardware configuration. On the Cycling sheet, select the Run cycles simultaneously in several threads check box. Important You cannot use this option if the sub-workflow contains Task elements. When a workflow executes a sub-workflow and there are several cycles, Service Connect uses all available threads from the number of Threads count set in the Epicor Service Connect Administration Console > Connectivity node to execute sub-workflow cycles. The main workflow waits until the last sub-workflow cycle finishes.
Download Files
The first step is to download the zipped file linked in this course to your local machine. The link at the bottom of this page contains a connectivity settings backup, window batch file, and .xml file that triggers the workflow execution. 1. In the embedded version of this course, click the Backup link at the bottom of the page. 2. Save the BatchExecution.zip file to the c:\channels\input folder on your machine. 3. Extract the zipped file.
38
Process
4. The following are extracted in the input folder. batch_backup.scs WSERequest.xm xx.bat
6. Verify the Run Re-import Service References wizard upon restore completion check box is selected. After you import a Web Service reference, you must use parameters specified during the first import to regenerate it. This task is necessary when a Web Service changes its interface. Use this option to automatically re-import a service reference. Important If you are on a previous version than Epicor Service Connect 9.05.605, this option is not available and you have to re-import the service reference manually using the next task - Re-import the Service Reference. Tip You may use the Copy button to copy the list of restored items to a clipboard. Use the information to keep track of restored items within your service connect installation.
7. Select the Create folders for the file channels check box. 8. Click Next. The list of all restored items displays. 9. Click Finish. 10. View the list of all restored settings and click Finish. The Re-import Service References wizard displays. Notice the service reference is automatically selected. 11. Click Next.
Epicor ERP | 9.05.606 39
Process
12. When the Web Service import successfully finished message displays, click Finish.
40
Process
Enable Channels
After you import channels, you must enable them before you can use them. Navigate to Epicor Service Connect Administration Console. 1. Navigate to Connectivity > Communication Setup > your server name > Channels > Input Channels. 2. Double-click the batch_in channel. The Channel properties window displays. 3. Select the Enable channel check box. 4. Click Configure. The Channel configuration window displays. 5. Navigate to the Communicator properties sheet. Notice the channel expects there to be an .xml file in the c:\channels\in\batch folder. This folder structure should be created during the connectivity settings restore process. If necessary, create this folder structure on your machine. 6. In the Channel configuration window, click OK. 7. In the Channel properties window, click OK. 8. Navigate to Connectivity > Communication Setup > your server name > Channels > Output Channels. 9. Right-click the SubWFTest channel and select Enable.
41
Process
8. In the command line, enter the following and press Enter. cd\channels\in\batch 9. To execute the batch file, enter the following and press Enter. xx.bat WSERequest.xm After the batch file executes, it replicates the WSERequest.xm file that serves as a parameter. The code first puts in order numbers 00, 01 and so on up to 29 and then adds the .xml extension to all the replicated files. As a result, 30 .xml files are dropped in the directory the input channel monitors. Notice the files disappear from the batch folder. 10. Minimize the command prompt window.
6. Right-click the Test pool and select Reset statistics. 7. To the warning message, click OK.
42
Process
3. Select the Run cycles simultaneously in several threads option. 4. In the Threads count field, enter 5. 5. In the Properties window, click OK. 6. Click Save.
Break Cycle
Use the break cycle functionality to break a cycled sub-workflow. It is necessary to break a sub-workflow execution in some cases. Example You import a complex sales order with many lines. Each line is individually processed in a sub-workflow. If an error occurs in any of the lines, you want the sub-workflow to stop looping instead of processing the remaining lines.
Epicor ERP | 9.05.606 43
Process
Use the <BreakSubWFLooping> node within the <wfl> section to break the execution. The main workflow can change how to call a sub-workflow in three ways: 1. 2. 3. Looping is interrupted and the trace status is set to Complete. Looping is interrupted and the trace status is set to In Progress. Looping is interrupted and the trace status is set to Abortive.
Modify a Sub-Workflow
1. In the Properties window, navigate to the General sheet. 2. Clear the Pass msg:usr section check box. 3. Next to the Workflow field, click the Edit button. The sub-workflow displays for editing. 4. In the Properties window, click OK. 5. Delete the connection between the Start and the Conversion elements. 6. On the Items toolbar, click the Choice button. 7. To the left of the Conversion item, click in the workflow design area. The Properties window displays. 8. In the Properties window, click OK. 9. On the Items toolbar, click the Conversion button.
44
Process
10. Above the Choice item, click in the workflow design area. The Properties window displays. 11. Navigate to the Appearance sheet. 12. In the Caption field, enter Break Cycle. 13. Click OK. 14. Make the following connections: Start to Choice Choice to Conversion Choice to Break Cycle Break Cycle to Finish 15. Click Save. 16. To the confirmation message, click Yes.
45
Process
4. Expand the following nodes: msg > req > dta > Part. 5. To create a condition based on a part number, in the right pane, right-click and select Show Functoid Palette. The Functoid Palette window displays. 6. Navigate to the Operators sheet. 7. Drag and drop the Equals functoid (first from the left) to the right pane. 8. Map the PartNum from the left to the param1=<empty> node in the functoid. 9. Double-click the functoid. The Functoid Properties window displays. 10. Double-click the param2 row. The Primary expression window displays. 11. In the Type field, verify Literal displays. 12. In the Value field, enter 100011. 13. Click OK. 14. In the Functoid Properties window, click Close. 15. Close the Functoid Palette window. 16. In the Functoid header, click the equals sign and drag it to the XPath mark. 17. At the bottom of the Rule Assistant window, in the Admit Value field, select False. 18. Navigate to the XPath expression sheet. 19. Select and copy the expression. You will use the same expression to build the condition for the second connection. 20. In the Rule Assistant window, click OK. Remain in the Properties window.
46
Process
5. In the Admit Value field, verify True displays. This means the process will be routed to the Break Cycle conversion once the PartNum = 100011 condition is met. Otherwise, the workflow will take the original path. 6. In the Rule Assistant window, click OK. 7. In the Properties window, click OK. 8. Click Save. 9. To the warning message, click Yes.
3. View the part information that will be processed. Recall the Choice item should change the sub-workflow path once part number 100011 is processed. 4. Exit the XML editor. 5. Click the WSERequest.xm file and change the extension to WSERequest.xml. Notice the file is consumed by an input channel. 6. Navigate to the Epicor Service Connect Administration Console. 7. Navigate to the Document Tracking > Inbound Messages. 8. Double-click the related activity. Double-click a process where the execution point is batch_in and the Processing status is Complete. Tip If the process is still in progress, press F5 to refresh the information and wait until the process finishes. The Activity Progress window displays. 9. The below are the expected results: All iterations except iteration #11, take the original path. In iteration #11, the condition defined in the Choice item is satisfied and the sub-workflow takes the new path. Address any issues, if necessary. In the following steps, you will modify the sub-workflow to stop looping once the condition is met.
47
Process
48
Process
The Activity Progress window displays. 9. The below are the expected results: Iterations #1 - #10 take the original path Iteration #11 satisfies the condition defined in the Choice item and takes the new path - Break Cycle Conversion and Finish Looping is stopped, no more iterations are processed Address any issues, if necessary.
49
Process
50
Process
51
Process
In this task, explore the demand entry business object and locate the <DemandContractNum> value the application assigns to the contract number you created. Obtaining this number is required for correct workflow execution in the following tasks. Tip Use this tool when you build your Epicor Service Connect workflow to check the business object structure and to see any if errors originate from the business layer or the user interface. Navigate to ICE 2.0.5 Business Logic Tester. 1. From the Tools menu, select Options. The BL Tester - Options window displays. 2. Verify the Appserver, Log on information, and Business Objects Directory is set up correctly. Example The following is an example of the Business Objects Directory. C:\Epicor\Epicor905\Client
3. Click Update. 4. From the File menu, select Open. 5. In the Open window, select Epicor.Mfg.BO.DemandEntry.dll. 6. Click Open. 7. In the Tester Method Viewer window, accept all defaults and click Invoke. 8. In the Results sheet, click the XML button. The content of the business object displays in XML format. 9. Search for the record that contains the following attributes. Tip You can copy the content to an XML editor for easier navigation through the output. Company - Epic06 CustNum - 9 (Dalton) PONum - Purchase order number you assigned in a previous task Example <DemandHeadList> <Company>EPIC06</Company> <DemandContractNum>13</DemandContractNum> <DemandHeadSeq>1</DemandHeadSeq> <OrderNum>0</OrderNum> <CustNum>9</CustNum> <PONum>6789</PONum>
10. Once you obtain the information, note the DemandContractNum and DemandHeadSeq values. 11. Exit ICE 2.0.5 Business Logic Tester.
52
Process
53
Process
4. Click Save. 5. To the warning message, click Yes. 6. In the Save New Workflow window, click New. The Create Package window displays. 7. In the Package name field, enter bpm_XXX (where XXX are your initials) and click OK. 8. In the Save workflow as field, enter bpm_workflow_XXX (where XXX are your initials). 9. Click Save. 10. To the warning message, click Yes.
54
Process
6. Click Finish. 7. Next to the Conversion field, click the Edit button. The New Transformation - Conversion type window displays. 8. In the New Transformation window, on the right, expand the following nodes: msg > req > dta > GetByIDRequest. 9. Enter the following literal values. CompanyID - Enter EPIC06. demandContractNum - Enter the contract number gained from Business Logic Tester, for example, 13. demandHeadSeq - Enter the sequence number gained from Business Logic Tester, for example, 1. 10. Click Save. 11. In the Save Transformation File window, click OK. 12. Exit the New Transformation - Conversion type window. 13. In the Properties window, click OK.
55
Process
5. Click Next. 6. Click Finish. 7. Next to the Output Schema field, click the Browse button. 8. In the Select a schema window, in the left pane, select Web-Services schemas. 9. Double-click DemandEntryService and select UpdateRequest.xsd. 10. Click Next. 11. Click Finish. 12. Next to the Conversion field, click the Edit button. The New Transformation - Conversion type window displays. 13. In the New Transformation window, on the left, expand the following nodes: msg > req > dta > GetByIDResponse > result > DemandEntryDataSet. 14. On the right, expand the following nodes: msg > req > dta > UpdateRequest > DemandEntryData > DemandEntryDataSet. 15. Hold Ctrl and map the followings nodes: DemandHead to DemandHead DemandDetail to DemandDetail 16. Remain in the New Transformation - Conversion type window.
56
Process
6. Click the Current Date Time icon (second from the left), drag the cursor to the center pane of the window, and release the mouse button. 7. Exit the Functoid pallete window. 8. Map the functoid to the Character02 node on the right. 9. Click Save. 10. In the Save Transformation File window, click OK. 11. Exit the Conversion type window. 12. In the Properties window, click OK. 13. On the Standard toolbar, click Save.
57
Process
4. Click Save.
Add a Condition
1. In the Method Directives window, click the Conditions button.
58
Process
2. Click the Add Line icon. 3. In the User Text field, select the specified field of the changed row is equal to the specified expression. 4. Click the first specified. 5. In the Table field, select ttPart. 6. Select the PartNum check box. 7. Click OK. 8. At the end of the User Text field, click specified. 9. In the Editor text box, enter "DSS-1010". 10. Click the Check Syntax button. Note If your query is correct, the Syntax is OK message displays. If you do not receive this message, verify you entered everything exactly as it appears above. You can also remove all hard carriage returns in the text box (the text should be one string).
11. In the Specify an expression window, click OK. 12. In the Conditions window, click OK.
Add an Action
1. In the Method Directives window, click the Actions button. 2. Click the Add Line icon. 3. In the User Text field, select call the specified Epicor Service Connect Workflow asynchronously. 4. Click the word asynchronously. Notice synchronous execution is now set. 5. Click the word specified. The Logon to Service Connect window displays. 6. In the Server field, select the server where Epicor Service Connect is installed. Notice the scshost value defaults. When the Epicor application is installed on the same server as Epicor Service Connect, scshost is a valid option. 7. Enter the User Name and Password, for example, admin / no password. 8. Click OK. The Select Workflow window displays. 9. Expand the bpm_XXX node and select bpm_workflow_XXX (where XXX are your initials).
59
Process
10. In the Select Workflow window, click OK. 11. In the Actions window, click OK. 12. Select the Enabled check box. 13. Click Save. 14. Exit Method Directives.
1. In the Part field, enter DSS-1010 and press Tab. 2. In the Description field, enter a description. 3. Click Save. This triggers the method directive that calls the Epicor Service Connect workflow. 4. Exit Part Maintenance.
60
Process
8. Navigate to Events > All logs. 9. View the BPM process information. Optionally, modify a different part to test the method directive. This action will not trigger the workflow execution. Once done testing, navigate to the Method Directives program and disable the directive.
Customized View
Use the Document Tracking node to track documents as they move through various stages of the business process and resume interrupted document processing. During processing, a message that contains the document passes through various Service Connect components, such as input and output Channels, Workflows (Processes), Tasks, and so on. Each Service Connect component can change the message somehow when it performs a certain activity. Use Document Tracking to do the following: Trace messages - View traces of a message passing through Service Connect components. Trace activities - Trace facts of performing some work by Service Connect components. Activity traces contain metadata that relates to the activity they represent. The following terms are used in the Document Tracking interface: Execution Point - Also called an executor, this is an identifiable object that performs observable activity. It can be, for example, Service Connect, as a system installed on a set of servers or a Service Connect component. Time Flow - An execution point can perform several operations simultaneously and all of them should be observed separately. For each such operation there is a separate sequence of time slices, which is called a time flow. Time slices in different time flows can intersect. Activity - This is a set of actions an execution point (a Service Connect component or a system) performs. Activities are hierarchical; one activity can represent a piece of the progress of its parent activity. Inbound Message - This is a message the Epicor Service Connect system receives. Trace - This is a fact fixed by the Document Tracking system. There are two types of traces - activity traces and message traces. Start Message of Activity - This is a message that starts an activity. In general, the start message is not the same as an inbound message because it can be generated inside the system (for example, by a business event) and still be an input to an activity. Custom Views You can create child views to display filtered traces that correspond to certain criteria in a separate view.
Create a View
Navigate to the Epicor Service Connect Administration Console. 1. Right-click the Document Tracking node and select New View. The View Properties window displays.
61
Process
2. In the Name field, enter Today-XXX (where XXX are your initials). 3. In the Search type window, verify <Any messages> displays. Note If you create a child view, the Search type field fills automatically with a value it inherits from the parent view.
4. Click the Columns button. The Show Columns window displays. 5. In the Selected columns section, hold the Ctrl key and select the Document Type and First business attribute columns. 6. Click the Remove button to remove the columns from the list. 7. In the Show Columns window, click OK. Remain in the View Properties window.
Apply a Filter
1. In the View Properties window, click the Filter button. The Filter window displays. Tip Use the Documents sheet to display documents that contain certain business information. In the Document type field, select a document type from the list of pre-defined types. In the Document filter grid, set selection criteria for business attributes available for the selected document type.
2. Navigate to the Advanced sheet. 3. Click Field and select Timestamp. 4. In the Value field, select today. 5. Click the Add to list button to activate the entered expression. 6. In the Filter window, click OK. 7. In the View Properties window, click OK. 8. Click the Today-XXX (where XXX are your initials) view. Verify the view only displays today's processes. If necessary, press F5 to refresh the information.
62
Conclusion
Conclusion
Congratulations! You have completed the course. Please take a moment to let Epicor know how to serve you better by completing a course evaluation at http://www.keysurvey.com/survey/191084/2e21/ or by clicking the Course Evaluation link below. Your feedback provides the guidelines for the future direction of Epicor education.
63
Additional information is available at the Education and Documentation areas of the EPICweb Customer Portal. To access this site, you need a Site ID and an EPICweb account. To create an account, go to http://support.epicor.com.