Epicor Information Worker Admin

Epicor ERPEpicor Information Worker Administration for Epicor ERP Course 10.0.700.2 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 2014. All rights reserved. No part of this publication may be reproduced in any form without the prior written consent of Epicor Software Corporation. ED840905 90521-10-9242-58310702 10.0.700.2 Revision: July 25, 2014 2:08 a.m. Total pages: 21 course.ditaval .......................................................................................................................................................................................................................Create a Menu Item.............................................................0......................................17 Workshop ..................................................................................................................5 Audience................................13 Workshop ....Add a Business Entity......................................................................8 Benefits of Configuration Manager...................................................................................................................................................13 Workshop ...........11 Create and Deploy an Information Worker Configuration..........14 Workshop .........................................................................................................15 Workshop ...............................................Test the Business Entity in Microsoft Outlook.....................................................20 Epicor ERP | 10.........................................................................Epicor Information Worker Administration for Epicor ERP Course Contents Contents Epicor Information Worker Administration for Epicor ERP Course.............19 Conclusion......................Export an Epicor BAQ................................................................................................16 Workshop ..4 Before You Begin..................................................................................................................................................................................................................................................................................................................................................................................5 Environment Setup.........................14 Workshop ..................................Create a Configuration..................................................2 3 .................................................................................................10 Configuration Manager Overview.................5 Prerequisites............................................................................................................9 Starting Configuration Manager.....................................5 Overview.......................................................17 Troubleshooting.......................................700.........................................................................Deploy the Configuration.....................................7 Security Configuration.......................................Import an Epicor BAQ............................................... However. Epicor Information Worker is a desktop productivity application that allows people who use Microsoft® Office® to view and update data from applications configured to work with Epicor Information Worker.0. followed by a section on troubleshooting data synchronization issues. • Deploy a modified configuration. • Modify Information Worker configuration settings. you will be able to: • Understand Information Worker administration and the implications of different configurations.2 . This helps increase productivity and improve real-time decision-making by offering easy access to data stored in applications. The Epicor Information Worker Configuration Manager is an application that configures Epicor application business activity queries (BAQs) so people who use Epicor Information Worker can access data in Microsoft Office applications via the Epicor menus and commands. There are shipping configurations that come with Epicor Information Worker. an organization may want to create their own views and want them accessible in the Epicor Information Worker menu structure. The Epicor Information Worker Configuration Manager allows you to create a new configuration file which you can deploy to your Information Worker server. The majority of the course explains the Epicor Information Worker Configuration Manager.Epicor Information Worker Administration for Epicor ERP Course Epicor Information Worker Administration for Epicor ERP Course Epicor Information Worker Administration for Epicor ERP Course This course reviews the Epicor Information Worker administrative side. Upon successful completion of this course.700. • Use Information Worker Configuration Manager. This course reviews required administrative configuration. 4 Epicor ERP | 10. 05 for Epicor 9. The following steps must be taken to successfully complete the workshops in this course. you must install the IW server components on a different server in order to do this course without affecting the production IW installation. Audience Specific audiences will benefit from this course. Contact Support or Systems Consulting for billable assistance. Epicor's education team updates the Epicor demonstration database for each service pack and patch.05 course. • Complete the Epicor Information Worker 9.Epicor Information Worker Administration for Epicor ERP Course Before You Begin Before You Begin Read this topic for information you should know in order to successfully complete this course.700.2 5 . in which the Epicor demonstration database is found. production environment. 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. • The Epicor demonstration database is at the same service pack and patch as the Epicor application. the following prerequisites must be met. Your Epicor training environment. If your system administrator upgrades your Epicor application to a new service pack or patch. Environment Setup The environment setup steps and potential workshop constraints must be reviewed in order to successfully complete the workshops in this course. Do not complete the course workshops in your live. he or she must also download the corresponding Epicor demonstration database from EPICweb > Support Epicor ERP | 10.0. • System Administrator • IT/Technical Staff Prerequisites In order to successfully complete this course. enables you to experience Epicor functionality in action but does not affect data in your live. • Experience with Epicor business activity queries (BAQs). production environment. If IW is already in production use. Note It is recommended that multiple Epicor demonstration databases are installed. but Epicor cannot prevent users from manipulating the data in your installation of the Epicor demonstration database. For example. • Your system administrator restored (refreshed) the Epicor demonstration database prior to starting this course. From a computer with Microsoft Office 2007 or above.0. and so on. but a different user already completed this workshop and the Epicor demonstration database was not restored (refreshed). sales orders. b.700. customers. 5. unexpected results can occur when completing the course workshops. the database is located on a server and users access the same data. Install the Information Worker server using the procedures in the Epicor Installation Guide.2 . Click File > Save. On the Details sheet. type your Windows user name and domain name. 6 4. unexpected results can occur. If the Epicor demonstration database is shared with multiple users (that is. In the Domain and Domain User ID fields. then you will not be able to ship the sales order.Before You Begin Epicor Information Worker Administration for Epicor ERP Course > Epicor > Downloads and install it. already defined. d. Navigate to System Management > Company Maintenance > User to open the User Account Maintenance program. These credentials allow you the administrative rights needed for this task. For User name and Password. It takes approximately five minutes for your change to be activated. Epicor's education team has written the course workshops to minimize situations like this from occurring. type manager in the User ID field and press Tab to display the settings for the manager user account. c. Assign your Windows user credentials to the manager account in your Epicor application. 3. if a course workshop requires you to ship a sales order that came standard in the Epicor demonstration database. Epicor ERP | 10. If this is not performed. a. much like your live. Follow the instructions on the client download page to download and install the Information Worker client. Log into your Epicor application. The Epicor demonstration database comes standard with parts. 2. e. open a web browser and go to http://yourIWservername/informationworker replacing yourIWservername with your Information Worker server computer name. production environment) and is not periodically refreshed. use epicor and epicor . which includes Information Worker clients. and the Epicor server that provides application data to the Information Worker clients.2 7 . Epicor ERP | 10.0. the Information Worker server with its Information Worker Configuration Manager utility.700. The following diagram shows an overview of an Information Worker installation.Epicor Information Worker Administration for Epicor ERP Course Overview Overview Use Epicor Information Worker Configuration Manager to configure Epicor application business activity queries (BAQs) so people who use Epicor Information Worker can access data in Microsoft Office applications via the Epicor menus and commands. you do not need to select the Require single-sign on check box for each user account record. Each user must be set up as a user in the Epicor application with single sign-on capability. but the Domain and Domain User ID fields must be set with the Windows credentials of each user. In the Epicor application User Account Maintenance program.700. refer to the application online help for User Account Maintenance. Note For more information on setting up users with single sign-on. IW users are granted same access to Epicor data as they are granted when using the regular Epicor client. 8 Epicor ERP | 10.2 .Security Configuration Epicor Information Worker Administration for Epicor ERP Course Security Configuration Security in Epicor Information Worker is controlled by the Epicor ERP application.0. • Unique BAQs exist and you want to make the them available to Information Worker as business entities. customer ID. The Epicor Information Worker installation package contains default configuration program files that include a list of business entities that match the Epicor Information Worker BAQs. you view the column data in a form. and territory.0. For example. the Epicor application-specific menu items are added to the Office applications.2 9 . Customers is an Epicor application business entity.700. • You want to display BAQ parameters that were not visible before to Information Worker users. Word and Excel.Epicor Information Worker Administration for Epicor ERP Course Benefits of Configuration Manager Benefits of Configuration Manager Epicor Information Worker is used to access Epicor application data in Microsoft Outlook. Most menu items are related to business entities. The shipped configuration files are created by Epicor developers using the Configuration Manager. The BAQs used by Epicor Information Worker are shipped as a part of the standard system BAQs. When you import the Customers business entity into Microsoft Outlook. credit hold. Business entities are a class (type) of record whose columns are determined by an Epicor business activity query (BAQ). Epicor ERP | 10. When the Epicor Information Worker client is installed on a computer that also has Microsoft Office. The shipped configurations are applied during the Epicor Information Worker installation. When and why would an Epicor Information Worker installation administrator create and deploy different Information Worker configurations using Configuration Manager? The following are reasons for using Configuration Manager: • The Configuration Manager is always used for initial configuration of the Information Worker installation. A Customers record has columns such as address. Starting Configuration Manager Epicor Information Worker Administration for Epicor ERP Course Starting Configuration Manager Starting Configuration Manager Navigate to the Information Worker Configuration Manager application from your Epicor Information Worker server. Path: Start > Programs > Administrative Tools > Information Worker Configuration Manager. From the Help menu. The Configuration Manager is a Microsoft Management Console (MMC) application. expand the Information Worker Configuration Manager book and browse through the topics. 10 Epicor ERP | 10. The MMC tree hierarchy organization may look familiar from using other MMC applications.700.0. When the online Help file opens. In the Configuration Manager.2 . There also is a section explaining the Microsoft Management Console. select Help Topics. press F1 to access help related topics on a particular form or node. Icons This node specifies the icons used in the Information Worker menus.Office add-in. Business Entities Under Business Entities are the configuration links to the Epicor BAQs that determine the data records synchronized by IW. Word and Excel These nodes configure the menus and other technical workings of the Information Worker . This is an area in which you would be working if you were customizing your IW installation. Help Files This node is where you specify the Information Worker online help files to be included in the IW installation. Select a menu or toolbar to edit it. In general. Adapters Adapters are code libraries that enable Epicor business activity queries BAQs to display in Microsoft applications. Menus and Toolbars The menus and toolbars node displays the current menus and toolbars in use for the configuration.700. Commands are assigned to menu items. Assign the List command to new views in the menu editors. Do not use the Epicor ERP specific adapters for entities based on BAQs you create or select an adapter to view or select which business entities are associated with it.0. Commands Commands call to application code that start a specific action and are part of the Configuration Manager because that is where they are created. you use the generic adapter for business entities you create (for Outlook). In that case you may use the Appointment. you can find your deployed configuration files here: C:\Program Files (x86)\Common Files\Epicor Software Corporation\Information Worker\versionnumber\Configuration Files\Custom Configurations.2 11 . You can search for these requirements in the online Help. Generally end-users only work with the menu nodes. Configuration Manager is a user interface for creating configuration files used by IW. or from the Action menu. Contact or Task adapters. Configuration Manager is used by Epicor developers and therefore show some elements that end users do not use.Epicor Information Worker Administration for Epicor ERP Course Configuration Manager Overview Configuration Manager Overview There are several nodes found in the Configuration Manager you can use to modify an Epicor Information Worker installation. unless you create a business entity that meets the requirements listed in the Advanced Requirements for Information Worker BAQs. The addition of new commands is only supported for Epicor developers. select New to create a new one. Epicor ERP | 10. Let us look at and describe some of the configuration nodes from the top going down Data Source This node is where you configure the connection from IW to your Epicor server. Outlook. If you are interested in looking at the main configuration file. Note The synchronization setting is only available for Microsoft Outlook. If you change the settings. or from the Action menu. select a current one to edit. it sets initial synchronization settings for everyone. Validation Results Every time you select Validate from the Action menu for configuration items that support validation.2 . Data Explorer Context Menu The Data Explorer context menu displays the current menu being used for Microsoft Word® and Excel® for documents and business entities.0.700. 12 Epicor ERP | 10. select New to create a new menu. If the configuration already has menus or toolbars. all informational or warning items are listed under Validation Results.Configuration Manager Overview Epicor Information Worker Administration for Epicor ERP Course Synchronization Setting You can establish whether you synchronize automatically (without having to click a Synchronize button) and the length of the synchronization interval. In the console tree. In the Configurations node. 2. right-click the Epicor node and select Create Copy. Select the Copy of Epicor node. Navigate to Information Worker Configuration Manager.700. In the Connection details pane. Workshop . If an error displays: a. 1. right-click the XXX_Configuration node (where XXX are your initials) and select Save. In the Configurations node. 4. 5. you will work with a copy of an existing Epicor business activity query (BAQ) rather than creating a new one. In the Name field. contact your system administrator for help in determining cause of the disconnection. The Configuration Details pane displays.Epicor Information Worker Administration for Epicor ERP Course Create and Deploy an Information Worker Configuration Create and Deploy an Information Worker Configuration In these workshops. If your login credentials are correctly set up. Menu Path: Start > Programs > Administrative Tools > Information Worker Configuration Manager. Information Worker configurations are located under this node. A new Copy of Epicor node displays. 6. c.0. Since this course focuses on using the Information Worker Configuration Manager. and then deploy the configuration to make a new business entity available on the Epicor Import menu in Microsoft Outlook. you will use the Information Worker Configuration Manager to create an Information Worker configuration. enter XXX_Configuration (where XXX are your initials). b. Ensure that your Windows user credentials are correctly mapped to the manager user in your Epicor application. 7. In the renamed XXX_Configuration node (where XXX are your initials) select the Data Source node The Connection details pane displays. Verify that the Use default login credentials option is NOT selected if you are logged onto the machine where you are working using Windows user credentials other than those that you mapped to the manager user in your Epicor application. expand the Information Worker Configuration Manager > Configurations node. create the Information Worker configuration that will be used in the other workshops. There are other Epicor University courses available that cover designing and creating BAQs. Epicor ERP | 10.Create a Configuration In this workshop. 3. click Test Connection. Requirements for BAQs that are run through Information Worker are detailed in the Information Worker online help.2 13 . click Close. select Import BAQ. search for and select zIWCustomer. When the export is complete. 1. 3. Click Open.700. 7. A file/folder selection window displays. 4. Workshop . select Export BAQ. 5. 2. From the Actions menu. Workshop . In the File name field. import a BAQ.2 . Search for and select the XXX_Customers file (where XXX are your initials) that you created in the previous workshop. click Export. 14 Epicor ERP | 10. Click Save. Click Export to File. navigate to the Business Activity Query Designer.Export an Epicor BAQ In this workshop. When the export is complete. In your Epicor client. using the import action to create copy. Remain in the Business Activity Query Designer for the next workshop. The export process begins. A file/folder selection window displays.Import an Epicor BAQ In this workshop. Menu Path: System Management > Business Activity Queries > Business Activity Query Important This program is not available in the Epicor Web Access. In the Business Activity Query Designer. The Import Business Activity Query window displays. 4. The Export Business Activity Query window displays. In the Export Business Activity Query window.Create and Deploy an Information Worker Configuration Epicor Information Worker Administration for Epicor ERP Course 8. The exported BAQ will be used in the next exercise to create a copy. 2. Exit Information Worker Configuration Manager. 1. Click Import File. 6. 3. enter XXX_Customers (where XXX are your initials). 8.0. a message displays in the Export process messages pane. export a BAQ. In the Query ID field. from the Actions menu. enter XXX_IWCustomers (where XXX are your initials). select Customer. This would typically happen if you are logged onto the machine where you are working using Windows credentials other than those that you mapped to the manager user in your Epicor application at the time that you set up the training environment. Information Worker configurations are located under this node. Workshop . Note You may first be prompted for user credentials. a message displays in the Import process messages pane. Epicor ERP | 10. 7. Navigate to Information Worker Configuration Manager. The New Query ID field displays the new BAQ name. Search for and select the XXX_IWCustomers BAQ (where XXX are your initials). In the console tree. b. verify Generic Adapter displays. Click Select to import the BAQ and create the business entity. When prompted. 7. Start > Programs > Administrative Tools > Information Worker Configuration Manager 1. 2.Add a Business Entity In this workshop. The import process begins. enter the Windows user credentials that you have mapped to the Epicor manager user. Exit the Business Activity Query Designer. In the Configurations node. 6. which is XXX_IWCustomers in this example (where XXX are your initials). When the import is complete. 4. expand the Information Worker Configuration Manager > Configurations node. 3. 8. When the import is complete. 9. from the XXX_Configuration > Data Source > Business Entities node. Select Show in Designer. In the Display Column field. In the New Query ID field. click Close. add a new business entity to your Information Worker configuration. 5. In the Business Entity pane. The new XXX_IWCustomers business entity (where XXX are your initials) is added to the Business Entities node.0. select XXX_IWCustomers (where XXX are your initials) to display its Business Entity pane. make the following adjustments to the configuration details: a. Click Import. In the XXX_Configuration > Data Source node.2 15 . 6.700. right-click the Business Entities node and select New. In the Adapter field.Epicor Information Worker Administration for Epicor ERP Course Create and Deploy an Information Worker Configuration 5. Working in the console tree. The Select a Definition For Your Business Entity window displays. expand the XXX_Configuration > Data Source node (where XXX are your initials). 13. In the Operation field. c. The LobID parameter is added to the list in the Parameters pane. In the Primary key field. e. select LobId.Create a Menu Item In this workshop. b. In the Parameter Properties window. Again. select LobVersion displays. c.Create and Deploy an Information Worker Configuration Epicor Information Worker Administration for Epicor ERP Course c. Remain in Information Worker Configuration Manager for the next workshop. In the Default value field. Select Visible to users .2 . In the Display name field. 8. The Customer. add the new business entity as an Outlook 2007 toolbar menu item in the Information Worker configuration. enter * (an asterisk). 10. In the Column field. The Parameter Properties window displays. select Customer. select Customer. 11. select In. select Begins. Right-click the Parameters node. define the new parameter: a. 12. and select New. Expand the XXX_Configuration > Data Source > Business Entities > XXX_IWCustomers node (where XXX are your initials). In the Sync Filter Column field. enter CustomerName. d. The Parameter Properties window displays.Name parameter is added to the list in the Parameters pane. define the new parameter: a.700. Do this workshop only if you are deploying Information Worker in Outlook 2007. 9. enter LobID. In the Display name field. d.0. Click OK. d. In the Operation field. and select New.Name. e. b. In the Parameter Properties window. The new business entity will be added automatically to the Import menu on the Epicor tab in Outlook 2010 or 2013 ribbon. or if your deployment includes both Outlook 2007 and 2010 or 2013. right-click the Parameters node.SysRowID. Workshop . You can skip this workshop if you are deploying Information Worker only on Outlook 2010 or 2013. In the Column field. 16 Epicor ERP | 10. Click OK. 4. enter XXX_IWCustomers (where XXX are your initials). expand the Import node. click OK. expand the Information Worker Configuration Manager > Configurations node. run a test import of the new business entity in your Microsoft Outlook application. Workshop . select your new entity XXX_IWCustomers (where XXX are your initials). Remain in Information Worker Configuration Manager for the next workshop. In the Command list. 1. 10. 8. 1. Open Microsoft Outlook. In the menu editor's tree.0. Exit Information Worker Configuration Manager. select Import Data.Epicor Information Worker Administration for Epicor ERP Course Create and Deploy an Information Worker Configuration 1. deploy the new Information Worker configuration to make your new business entity available in Microsoft Outlook. right-click the XXX_Configuration node (where XXX are your initials)and select Deploy. 2. In the Configurations node. In the console tree. Information Worker configurations are located under this node. In the console tree. 9. In the Configurations node. Workshop . Epicor ERP | 10. Click Insert and select Insert Business Entity Element. In the Caption field. 4. 7.700.Test the Business Entity in Microsoft Outlook In this workshop. The menu editor pane displays. expand the Information Worker Configuration Manager > Configurations node. 2. select Epicor. In the Configuration deployed successfully message. 6. select Customers. 3.2 17 . Information Worker configurations are located under this node. From the Toolbars node. expand the XXX_Configuration > Outlook > Toolbars node (where XXX are your initials) 3.Deploy the Configuration In this workshop. Important Close and re-open Outlook if it was already running when you deployed your Information Worker configuration in the previous exercise. In the Business Entity field. 5. From the Import node. A blank menu item is added below the Customers node. 2 .0.Create and Deploy an Information Worker Configuration Epicor Information Worker Administration for Epicor ERP Course 2. under the Epicor folder. In the Mail pane. click Import and select the XXX_IWCustomers menu item (where XXX are your initials). In the criteria window. 6. in the Import column. the imported customer data displays. the XXX_IWCustomer folder displays (where XXX are your initials).700. The Information Worker Explorer . A list of customers displays.XXX_IWCustomers window displays (where XXX are your initials). 18 Epicor ERP | 10. 3. 4. Exit Microsoft Outlook. select the check box next to any customer and click Finish. To test your new business entity. 5. Select the XXX_IWCustomers folder (where XXX are your initials). In the right pane. leave criteria blank and click Next. From the Epicor tab (Outlook 2010 or 2013) or Epicor Information Worker toolbar (Outlook 2007). The default location for the InfoWorker. Try manually importing a single record. For example. You can also include all the content in the Information Worker Configuration Manager directory in your nightly network back-up process.0. such as Notepad.DOMAIN\Local Settings\Temp" is a good path for the Windows® Vista® operating application.log file is in the root of the client folder. select Show Synchronization Log to review messages in the log and open records affected by error warnings. and set the various property values to 4 to receive the most logging. These are located in the Information Worker Outlook Client program directory (default path is C:\Program Files (x86)\Common Files\Epicor Software Corporation\Information Worker\version#).log" setting.Depending on the state of the Information Worker synchronization (success/failed). Correct the errors listed and attempt the synchronization process again. As you deploy additional content.dll. Open the configuration files. Epicor ERP | 10. If it displays in the Epicor client. right-click in the Information Worker Configuration Manager. Epicor.config. and select Create Copy. 2.700.Epicor Information Worker Administration for Epicor ERP Course Troubleshooting Troubleshooting If issues with the Microsoft applications occur during data synchronization. Check the Business Activity Query (BAQ) in the Epicor client If information does not appear. If you right-click the synchronization icon in the success state.2 19 . You may have to correct data issues.Outlook. using a text editor.config. check the BAQ and security for the user. For each of the add-ins there is a configuration file: Epicor. proceed to the next step.dll. the Synchronization Errors form displays and lists the issues encountered.Excel. The errors listed determine the troubleshooting required. The following describes how to determine the source of the issue when data is not synchronizing. initializeData="C:\Documents and Settings\username. the most likely cause is synchronization of selected records. there are a few types of logging available.Infoworker. You can change this location by changing the initializeData="InfoWorker. 1. • Back up the configuration file . Check in Epicor Information Worker If the data does not display in Information Worker.To copy the configuration file. situations occur where the data does not display as expected once you deploy it to the Information Worker client.config. and Epicor. • Enable Information Worker logging .Infoworker.dll. enable logging for Epicor Information Worker to help locate the issues.Infoworker.Word. If you click the synchronization icon in the failed state. 0.700. 20 Epicor ERP | 10.2 .Conclusion Epicor Information Worker Administration for Epicor ERP Course Conclusion Congratulations! You have just completed the Epicor Information Worker Administration course. epicor.Additional information is available at the Education and Documentation areas of the EPICweb Customer Portal.com. go to http://support. To create an account. To access this site. you need a Site ID and an EPICweb account. .