epicor information worker admin

8/19/2019 Epicor Information Worker Admin

1/21


2/21

Disclaimer

This document is for informational purposes only and is subject to change without notice. This document and itscontents, including the viewpoints, dates and functional content expressed herein are believed to be accurate as of itsdate 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 aparticular purpose, merchantability, satisfactory quality or reasonable skill and care. As each user of Epicor software islikely to be unique in their requirements in the use of such software and their business processes, users of this documentare always advised to discuss the content of this document with their Epicor account manager. All information containedherein is subject to change without notice and changes to this document since printing and other important informationabout the software product are made or published in release notes, and you are urged to obtain the current releasenotes for the software product. We welcome user comments and reserve the right to revise this publication and/ormake 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 ofany consulting services by Epicor personnel shall be pursuant to Epicor's standard services terms and conditions. Usageof the solution(s) described in this document with other Epicor software or third party products may require the purchaseof licenses for such other products. Where any software is expressed to be compliant with local laws or requirementsin 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 accordinglyEpicor cannot guarantee that the software will be compliant and up to date with such changes. All statements ofplatform and product compatibility in this document shall be considered individually in relation to the products referredto in the relevant statement, i.e., where any Epicor software is stated to be compatible with one product and alsostated to be compatible with another product, it should not be interpreted that such Epicor software is compatiblewith both of the products running at the same time on the same platform or environment. Additionally platform orproduct compatibility may require the application of Epicor or third-party updates, patches and/or service packs andEpicor has no responsibility for compatibility issues which may be caused by updates, patches and/or service packsreleased by third parties after the date of publication of this document. Epicor® is a registered trademark and/ortrademark of Epicor Software Corporation in the United States, certain other countries and/or the EU. All othertrademarks 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


3/21

Contents

Epicor Information Worker Administration for Epicor ERP Course.....................................4

Before You Begin....................................................................................................................5

Audience.........................................................................................................................................................5

Prerequisites....................................................................................................................................................5

Environment Setup..........................................................................................................................................5

Overview.................................................................................................................................7

Security Configuration...........................................................................................................8

Benefits of Configuration Manager......................................................................................9

Starting Configuration Manager.........................................................................................10

Configuration Manager Overview......................................................................................11

Create and Deploy an Information Worker Configuration...............................................13

Workshop - Create a Configuration...............................................................................................................13Workshop - Export an Epicor BAQ..................................................................................................................14

Workshop - Import an Epicor BAQ.................................................................................................................14

Workshop - Add a Business Entity..................................................................................................................15

Workshop - Create a Menu Item....................................................................................................................16

Workshop - Deploy the Configuration............................................................................................................17

Workshop - Test the Business Entity in Microsoft Outlook..............................................................................17

Troubleshooting...................................................................................................................19

Conclusion.............................................................................................................................20

3Epicor ERP | 10.0.700.2

ContentsEpicor Information Worker Administration for Epicor ERP Course


4/21

Epicor Information Worker Administration for Epicor ERPCourse

This course reviews the Epicor Information Worker administrative side. Epicor Information Worker is a desktopproductivity application that allows people who use Microsoft® Office® to view and update data from applicationsconfigured to work with Epicor Information Worker. This helps increase productivity and improve real-timedecision-making by offering easy access to data stored in applications.

This course reviews required administrative configuration. The majority of the course explains the Epicor InformationWorker Configuration Manager, followed by a section on troubleshooting data synchronization issues.

The Epicor Information Worker Configuration Manager is an application that configures Epicor application businessactivity queries (BAQs) so people who use Epicor Information Worker can access data in Microsoft Officeapplications via the Epicor menus and commands.

There are shipping configurations that come with Epicor Information Worker. However, an organization maywant to create their own views and want them accessible in the Epicor Information Worker menu structure. TheEpicor Information Worker Configuration Manager allows you to create a new configuration file which you can

deploy to your Information Worker server.

Upon successful completion of this course, you will be able to:

• Understand Information Worker administration and the implications of different configurations.

• Use Information Worker Configuration Manager.

• Modify Information Worker configuration settings.

• Deploy a modified configuration.

Epicor ERP | 10.0.700.24

Epicor Information Worker Administration for Epicor ERP CourseEpicor Information Worker Administration for Epicor ERP Course


5/21


6/21

> Epicor > Downloads and install it. If this is not performed, unexpected results can occur when completingthe course workshops.

• Your system administrator restored (refreshed) the Epicor demonstration database prior tostarting this course. The Epicor demonstration database comes standard with parts, customers, salesorders, 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, productionenvironment) 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 notrestored (refreshed), then you will not be able to ship the sales order. Epicor's education team has writtenthe course workshops to minimize situations like this from occurring, but Epicor cannot prevent usersfrom manipulating the data in your installation of the Epicor demonstration database.

2. Install the Information Worker server using the procedures in the Epicor Installation Guide .

3. Assign your Windows user credentials to the manager account in your Epicor application.

a. Log into your Epicor application. For User name and Password, use epicor and epicor . Thesecredentials allow you the administrative rights needed for this task.

b. Navigate to System Management > Company Maintenance > User to open the User AccountMaintenance program.

c. On the Details sheet, type manager in the User ID field and press Tab to display the settings for themanager user account.

d. In the Domain and Domain User ID fields, type your Windows user name and domain name.

e. Click File > Save.

It takes approximately five minutes for your change to be activated.

4. From a computer with Microsoft Office 2007 or above, open a web browser and go tohttp://yourIWservername/informationworker replacing yourIWservername with your InformationWorker server computer name.

5. Follow the instructions on the client download page to download and install the Information Worker client.

Epicor ERP | 10.0.700.26

Epicor Information Worker Administration for Epicor ERP CourseBefore You Begin


7/21

Overview

Use Epicor Information Worker Configuration Manager to configure Epicor application business activityqueries (BAQs) so people who use Epicor Information Worker can access data in Microsoft Office applications

via the Epicor menus and commands.The following diagram shows an overview of an Information Worker installation, which includes InformationWorker clients, the Information Worker server with its Information Worker Configuration Manager utility, andthe Epicor server that provides application data to the Information Worker clients.

7Epicor ERP | 10.0.700.2

OverviewEpicor Information Worker Administration for Epicor ERP Course


8/21

Security Configuration

Security in Epicor Information Worker is controlled by the Epicor ERP application.

Each user must be set up as a user in the Epicor application with single sign-on capability. In the Epicor applicationUser Account Maintenance program, you do not need to select the Require single-sign on check box for eachuser account record, but the Domain and Domain User ID fields must be set with the Windows credentials ofeach user.

IW users are granted same access to Epicor data as they are granted when using the regular Epicor client.

Note For more information on setting up users with single sign-on, refer to the application online helpfor User Account Maintenance.

Epicor ERP | 10.0.700.28

Epicor Information Worker Administration for Epicor ERP CourseSecurity Configuration


9/21

Benefits of Configuration Manager

Epicor Information Worker is used to access Epicor application data in Microsoft Outlook, Word and Excel. Whenthe Epicor Information Worker client is installed on a computer that also has Microsoft Office, the Epicor

application-specific menu items are added to the Office applications. Most menu items are related to businessentities. Business entities are a class (type) of record whose columns are determined by an Epicor business activityquery (BAQ). For example, Customers is an Epicor application business entity. A Customers record has columnssuch as address, customer ID, credit hold, and territory. When you import the Customers business entity intoMicrosoft Outlook, you view the column data in a form.

The BAQs used by Epicor Information Worker are shipped as a part of the standard system BAQs. The EpicorInformation Worker installation package contains default configuration program files that include a list of businessentities that match the Epicor Information Worker BAQs. The shipped configuration files are created by Epicordevelopers using the Configuration Manager. The shipped configurations are applied during the EpicorInformation Worker installation.

When and why would an Epicor Information Worker installation administrator create and deploy differentInformation 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.

• Unique BAQs exist and you want to make the them available to Information Worker as business entities.

• You want to display BAQ parameters that were not visible before to Information Worker users.

9Epicor ERP | 10.0.700.2

Benefits of Configuration ManagerEpicor Information Worker Administration for Epicor ERP Course


10/21

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.

The Configuration Manager is a Microsoft Management Console (MMC) application. The MMC tree hierarchyorganization may look familiar from using other MMC applications.

From the Help menu, select Help Topics. When the online Help file opens, expand the Information WorkerConfiguration Manager book and browse through the topics. In the Configuration Manager, press F1 to accesshelp related topics on a particular form or node. There also is a section explaining the Microsoft ManagementConsole.

Epicor ERP | 10.0.700.210

Epicor Information Worker Administration for Epicor ERP CourseStarting Configuration Manager


11/21

Configuration Manager Overview

There are several nodes found in the Configuration Manager you can use to modify an Epicor Information Workerinstallation.

Configuration Manager is a user interface for creating configuration files used by IW. If you are interested inlooking at the main configuration file, you can find your deployed configuration files here: C:\Program Files(x86)\Common Files\Epicor Software Corporation\Information Worker\ versionnumber \Configuration Files\CustomConfigurations. Configuration Manager is used by Epicor developers and therefore show some elements thatend users do not use.

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.

Business Entities

Under Business Entities are the configuration links to the Epicor BAQs that determine the data records synchronizedby IW. This is an area in which you would be working if you were customizing your IW installation.

Icons

This node specifies the icons used in the Information Worker menus.

Help Files

This node is where you specify the Information Worker online help files to be included in the IW installation.

Outlook, Word and Excel

These nodes configure the menus and other technical workings of the Information Worker - Office add-in.Generally end-users only work with the menu nodes.

Adapters

Adapters are code libraries that enable Epicor business activity queries BAQs to display in Microsoft applications.

In general, you use the generic adapter for business entities you create (for Outlook), unless you create a businessentity that meets the requirements listed in the Advanced Requirements for Information Worker BAQs. You cansearch for these requirements in the online Help. In that case you may use the Appointment, Contact or Taskadapters. Do not use the Epicor ERP specific adapters for entities based on BAQs you create or select an adapterto view or select which business entities are associated with it.

Commands

Commands call to application code that start a specific action and are part of the Configuration Manager becausethat is where they are created. Commands are assigned to menu items. The addition of new commands is onlysupported for Epicor developers. Assign the List command to new views in the menu editors.

Menus and Toolbars

The menus and toolbars node displays the current menus and toolbars in use for the configuration. Select a menuor toolbar to edit it, or from the Action menu, select New to create a new one.

11Epicor ERP | 10.0.700.2

Configuration Manager OverviewEpicor Information Worker Administration for Epicor ERP Course


12/21

Synchronization Setting

You can establish whether you synchronize automatically (without having to click a Synchronize button) and thelength of the synchronization interval. If you change the settings, it sets initial synchronization settings for everyone.

Note The synchronization setting is only available for Microsoft Outlook.

Data Explorer Context MenuThe Data Explorer context menu displays the current menu being used for Microsoft Word® and Excel® fordocuments and business entities. If the configuration already has menus or toolbars, select a current one to edit,or from the Action menu, select New to create a new menu.

Validation Results

Every time you select Validate from the Action menu for configuration items that support validation, allinformational or warning items are listed under Validation Results.

Epicor ERP | 10.0.700.212

Epicor Information Worker Administration for Epicor ERP CourseConfiguration Manager Overview


13/21

Create and Deploy an Information Worker Configuration

In these workshops, you will use the Information Worker Configuration Manager to create an Information Workerconfiguration, and then deploy the configuration to make a new business entity available on the Epicor Import

menu in Microsoft Outlook.Since this course focuses on using the Information Worker Configuration Manager, you will work with a copyof an existing Epicor business activity query (BAQ) rather than creating a new one. There are other Epicor Universitycourses available that cover designing and creating BAQs. Requirements for BAQs that are run through InformationWorker are detailed in the Information Worker online help.

Workshop - Create a Configuration

In this workshop, create the Information Worker configuration that will be used in the other workshops.

Navigate to Information Worker Configuration Manager.

Menu Path: Start > Programs > Administrative Tools > Information Worker Configuration Manager.

1. In the console tree, expand the Information Worker Configuration Manager > Configurations node.

Information Worker configurations are located under this node.

2. In the Configurations node, right-click the Epicor node and select Create Copy.

A new Copy of Epicor node displays.

3. Select the Copy of Epicor node.

The Configuration Details pane displays.

4. In the Name field, enter XXX_Configuration (where XXX are your initials).

5. In the renamed XXX_Configuration node (where XXX are your initials) select the Data Source node

The Connection details pane displays.

6. In the Connection details pane, click Test Connection. If an error displays:

a. Ensure that your Windows user credentials are correctly mapped to the manager user in your Epicorapplication.

b. Verify that the Use default login credentials option is NOT selected if you are logged onto the machinewhere you are working using Windows user credentials other than those that you mapped to the manageruser in your Epicor application.

c. If your login credentials are correctly set up, contact your system administrator for help in determiningcause of the disconnection.

7. In the Configurations node, right-click the XXX_Configuration node (where XXX are your initials) andselect Save.

13Epicor ERP | 10.0.700.2

Create and Deploy an Information Worker ConfigurationEpicor Information Worker Administration for Epicor ERP Course


14/21

8. Exit Information Worker Configuration Manager.

Workshop - Export an Epicor BAQ

In this workshop, export a BAQ. The exported BAQ will be used in the next exercise to create a copy.In your Epicor client, navigate to the Business Activity Query Designer.

Menu Path: System Management > Business Activity Queries > Business Activity Query

Important This program is not available in the Epicor Web Access.

1. In the Query ID field, search for and select zIWCustomer.

2. From the Actions menu, select Export BAQ.

The Export Business Activity Query window displays.

3. Click Export to File.

A file/folder selection window displays.

4. In the File name field, enter XXX_Customers (where XXX are your initials).

5. Click Save.

6. In the Export Business Activity Query window, click Export.

The export process begins. When the export is complete, a message displays in the Export process messagespane.

7. When the export is complete, click Close.

8. Remain in the Business Activity Query Designer for the next workshop.

Workshop - Import an Epicor BAQ

In this workshop, import a BAQ, using the import action to create copy.

1. In the Business Activity Query Designer, from the Actions menu, select Import BAQ.

The Import Business Activity Query window displays.

2. Click Import File.

A file/folder selection window displays.

3. Search for and select the XXX_Customers file (where XXX are your initials) that you created in the previousworkshop.

4. Click Open.

Epicor ERP | 10.0.700.214

Epicor Information Worker Administration for Epicor ERP CourseCreate and Deploy an Information Worker Configuration


15/21

5. In the New Query ID field, enter XXX_IWCustomers (where XXX are your initials).

6. Select Show in Designer.

7. Click Import.

The import process begins. When the import is complete, a message displays in the Import process messagespane.

The New Query ID field displays the new BAQ name, which is XXX_IWCustomers in this example (whereXXX are your initials).

8. When the import is complete, click Close.

9. Exit the Business Activity Query Designer.

Workshop - Add a Business Entity

In this workshop, add a new business entity to your Information Worker configuration.

Navigate to Information Worker Configuration Manager.

Start > Programs > Administrative Tools > Information Worker Configuration Manager



2. In the Configurations node, expand the XXX_Configuration > Data Source node (where XXX are yourinitials).

3. In the XXX_Configuration > Data Source node, right-click the Business Entities node and select New.

The Select a Definition For Your Business Entity window displays.

Note You may first be prompted for user credentials. This would typically happen if you are loggedonto the machine where you are working using Windows credentials other than those that youmapped to the manager user in your Epicor application at the time that you set up the trainingenvironment. When prompted, enter the Windows user credentials that you have mapped to theEpicor manager user.

4. Search for and select the XXX_IWCustomers BAQ (where XXX are your initials).

5. Click Select to import the BAQ and create the business entity.

The new XXX_IWCustomers business entity (where XXX are your initials) is added to the Business Entitiesnode.

6. Working in the console tree, from the XXX_Configuration > Data Source > Business Entities node,select XXX_IWCustomers (where XXX are your initials) to display its Business Entity pane.

7. In the Business Entity pane, make the following adjustments to the configuration details:

a. In the Adapter field, verify Generic Adapter displays.

b. In the Display Column field, select Customer.

15Epicor ERP | 10.0.700.2



16/21

c. In the Primary key field, select LobId.

d. In the Sync Filter Column field, select LobVersion displays.

8. Expand the XXX_Configuration > Data Source > Business Entities > XXX_IWCustomers node (whereXXX are your initials).

9. Right-click the Parameters node, and select New.

The Parameter Properties window displays.

10. In the Parameter Properties window, define the new parameter:

a. In the Column field, select Customer.Name.

b. In the Display name field, enter CustomerName.

c. In the Operation field, select Begins.

d. Select Visible to users .

e. Click OK.

The Customer.Name parameter is added to the list in the Parameters pane.

11. Again, right-click the Parameters node, and select New.

The Parameter Properties window displays.

12. In the Parameter Properties window, define the new parameter:

a. In the Column field, select Customer.SysRowID.

b. In the Display name field, enter LobID.

c. In the Operation field, select In.

d. In the Default value field, enter * (an asterisk).

e. Click OK.

The LobID parameter is added to the list in the Parameters pane.

13. Remain in Information Worker Configuration Manager for the next workshop.

Workshop - Create a Menu Item

In this workshop, add the new business entity as an Outlook 2007 toolbar menu item in the Information Workerconfiguration.

Do this workshop only if you are deploying Information Worker in Outlook 2007, or if your deployment includesboth Outlook 2007 and 2010 or 2013.

You can skip this workshop if you are deploying Information Worker only on Outlook 2010 or 2013. The newbusiness entity will be added automatically to the Import menu on the Epicor tab in Outlook 2010 or 2013ribbon.

Epicor ERP | 10.0.700.216



17/21



2. In the Configurations node, expand the XXX_Configuration > Outlook > Toolbars node (where XXXare your initials)

3. From the Toolbars node, select Epicor.

The menu editor pane displays.

4. In the menu editor's tree, expand the Import node.

5. From the Import node, select Customers.

6. Click Insert and select Insert Business Entity Element.

A blank menu item is added below the Customers node.

7. In the Caption field, enter XXX_IWCustomers (where XXX are your initials).

8. In the Business Entity field, select your new entity XXX_IWCustomers (where XXX are your initials).

9. In the Command list, select Import Data.

10. Remain in Information Worker Configuration Manager for the next workshop.

Workshop - Deploy the Configuration

In this workshop, deploy the new Information Worker configuration to make your new business entity availablein Microsoft Outlook.



2. In the Configurations node, right-click the XXX_Configuration node (where XXX are your initials)andselect Deploy.

3. In the Configuration deployed successfully message, click OK.

4. Exit Information Worker Configuration Manager.

Workshop - Test the Business Entity in Microsoft Outlook

In this workshop, run a test import of the new business entity in your Microsoft Outlook application.

1. Open Microsoft Outlook.

Important Close and re-open Outlook if it was already running when you deployed your InformationWorker configuration in the previous exercise.

17Epicor ERP | 10.0.700.2



18/21

2. From the Epicor tab (Outlook 2010 or 2013) or Epicor Information Worker toolbar (Outlook 2007), clickImport and select the XXX_IWCustomers menu item (where XXX are your initials).

The Information Worker Explorer - XXX_IWCustomers window displays (where XXX are your initials).

3. In the criteria window, leave criteria blank and click Next.

A list of customers displays.

4. To test your new business entity, in the Import column, select the check box next to any customer and clickFinish.

In the Mail pane, under the Epicor folder, the XXX_IWCustomer folder displays (where XXX are yourinitials).

5. Select the XXX_IWCustomers folder (where XXX are your initials).

In the right pane, the imported customer data displays.

6. Exit Microsoft Outlook.

Epicor ERP | 10.0.700.218



19/21

Troubleshooting

If issues with the Microsoft applications occur during data synchronization, enable logging for Epicor InformationWorker to help locate the issues.

• Back up the configuration file - To copy the configuration file, right-click in the Information WorkerConfiguration Manager, and select Create Copy. You can also include all the content in the InformationWorker Configuration Manager directory in your nightly network back-up process.

• Enable Information Worker logging - Depending on the state of the Information Worker synchronization(success/failed), there are a few types of logging available.

If you click the synchronization icon in the failed state, the Synchronization Errors form displays and liststhe issues encountered. Correct the errors listed and attempt the synchronization process again.

If you right-click the synchronization icon in the success state, select Show Synchronization Log to reviewmessages in the log and open records affected by error warnings.

For each of the add-ins there is a configuration file: Epicor.Infoworker.Outlook.dll.config,Epicor.Infoworker.Excel.dll.config, and Epicor.Infoworker.Word.dll.config. These are located in theInformation Worker Outlook Client program directory (default path is C:\Program Files (x86)\CommonFiles\Epicor Software Corporation\Information Worker\version#).

Open the configuration files, using a text editor, such as Notepad, and set the various property values to 4to receive the most logging. The default location for the InfoWorker.log file is in the root of the client folder.You can change this location by changing the initializeData="InfoWorker.log" setting. For example,initializeData="C:\Documents and Settings\username.DOMAIN\Local Settings\Temp" is a good path for theWindows® Vista® operating application.

The errors listed determine the troubleshooting required. You may have to correct data issues.

As you deploy additional content, situations occur where the data does not display as expected once you deployit to the Information Worker client. The following describes how to determine the source of the issue when datais not synchronizing.

1. Check the Business Activity Query (BAQ) in the Epicor client

If information does not appear, check the BAQ and security for the user. If it displays in the Epicor client,proceed to the next step.

2. Check in Epicor Information Worker

If the data does not display in Information Worker, the most likely cause is synchronization of selectedrecords. Try manually importing a single record.

19Epicor ERP | 10.0.700.2

TroubleshootingEpicor Information Worker Administration for Epicor ERP Course


20/21

Conclusion

Congratulations! You have just completed the Epicor Information Worker Administration course.

Epicor ERP | 10.0.700.220

Epicor Information Worker Administration for Epicor ERP CourseConclusion


21/21

Additional information is available at the Education andDocumentation areas of the EPICweb Customer Portal. To access

this site, you need a Site ID and an EPICweb account. To create anaccount, go to http://support.epicor.com.
http://support.epicor.com/http://support.epicor.com/