We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF or read online on Scribd
You are on page 1/ 74
07/07/2022, 15:49 PDFs viewer
Workforce Integration Manager
User’s Guide
Auser’s guide to setting up, running, and managing Workforce
Integration Manager interfaces on the Workforce Central
application server, and performing reiated data integration
operations.
Kronos Workforce Central Suite
Version 6
€4KRONOS
Document Part Number: 4704293-001
Document Revision: A
hitps:ftoazinfoldec-viow wa0710712022, 15:48 POs viewor
‘The information in this documents subject to change winout noice and shouHt not be construed as @ eommAment
bby 4ranos nco rated 0nd ingot? ated assumes ne resaensibity fer eny @res thal ray a,pear A this
‘manual his document oF any yar therwat ma not be reproduced in any form without the w ifn yermision of
‘Fanos Incon.orated Al ights roserved. Copyright 2000
‘Alitude.Alitude Dream, Cambridge Clock CardSaver Datakeoper Lalakaeper Central, erorce, atenecpor
‘Gatckwopor Contra, lmagokeuper Jobxeeper Central, Kaop.Trac, Kronos, Kronos 1ouch ID, the Kionos 00. My
‘Gonies, PeoplePiannor, PeoplePianner _ Design, Schedule Manayer & Design, ShitLowt, ShopTrae, ShopTrac.
ro, terComm, SarPor, StarSaver, Star ‘imer,TeleTime, Timekeoper, Tmekedper Cantel, TimeMaker, “tery,
Visionware, Workfaree Accruals, Workforce Central, Workforce Decisions, Workforce Epress, Warkforee Gani,
and Workorea TeleTime are rooistorod trademarks of Kronos Incorporatod ora related company. Alttuda MPP.
Alitude MPPXpress, Attude Painng, Attude PBS, Comm Mgr, CommLink, DKC/Dataling, eDiegnostics, Experts at
Improving the Performance of People and Business, FasTrack, Mireport, HR and Payrol Answerforce, HyperFin,
Kronos #500 Touch ID, Kronos 4500, Kronos 4510, Kronos Ac wuisiton, Kronos @ Central, Kronos KnowledgePass,
kkroncs TechKnowledgy, KronosWorks, KVC OnDemand, Labor Pius, Momentum Essontiais, Momentum Onino,
‘Momentum, MPPXpress, Overall! abor Effectiveness, Schedule Assistant, Smart Scheduler. mart view, Stat
uly, Start WIP, Sterler Series, SlerLabor,Timekeeper Decisions, Timekeeper Web, VisionPlis, Winsiar Ete,
\MP Plus, Workforce Anwuisiion, Workforce Activities, Workforce Analytics, Workforce Attendance, WorkToroe
Central Portal, Workforce Connect, Workforce Employee, Workforce Forecast Manager. Workforce HR, Workioree
Leave, Workforce Manager, Workforce ModileTime, Workforce Operations Pianner, Workforce Payrall, Workforce
Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing,
Workforce Timekoeper, Workforce View, and Workforce Worksheet aro trademarks of Kranos Incorporated or &
‘lated company
“This product includes software developed by the OpenSSL Project for use in the OpenSSL Took (itp!
‘www openssl org). This product includes software vitlen by Exic Young (eay@ervpisoft com).
Mozila org is registered trademark of the Mozila Foundetion_All other trademarks or registered trademarks used
herein ae the property of their respective owners and are used for identification purposes only
\Whhen using and applying the information generated by Kronos products, customers should ensure that they comely
With the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing inthis
Guide shall be construed as an assurance or usranty that Kronos products comply with any such laws
Published by Kronos Incorporated
207 Billerica Road, Chelmsford, Massachusetts 01824-4118 JSA
Phone’ 878 250-800, Fax: 976-307 5800
Kronos Incorporated tlobal Support: 1-800-304-HELP (1-800-394-4357)
For inks to information about international subsisanes of Kronos Incorporated, ga to
Intpsiw vv kronos com
Document Revision History
Document Re
a Workforce Integration Manager 6.1 ‘January 2008
Procuct Version Reece ste
hntips:teazinfoldoc-view air0710712022, 15:48
POs viewor
Welcome
Welcome to Workforce Integration Manager
Read the Preface to learn about the product documentation that exists for
Workforce Integration Manager and related products. Because the documentation
addresses multiple audiences, it may use the term Integration Manager to reter to
Workforce Integration Manager.
We hope that Vorkforce Integration Manager will help you to improve the
performance of your people and your business.
Integration Manager User's Guide 3
hntips:teazinfoldoc-view0710712022, 15:48
POs viewor
hntips:teazinfoldoc-view0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Contents
Welcome
Preface
Product documentation
Extending the online help ..
‘Translation and Customization 9
Adding information 9
Chapter 1: Overview
untroduction “ - 32
Overview ofthe data integration implementation process 3
Getting started ‘vith data integration .. 16
Chapter 2: Setting Up the System for Data Integra ion
Configuring system settings
Data Integration system settings
Configuring fimetion access profi.es.....
Configuring the generic data access profile
‘Viewing the list of generic data access profiles for data integration ... 25
Assigning multiple generic data access profiles to one user... 25
Using generic data access profiles to suppor the Delegate Atorty
feature . . 25
Allowing access to the data integration accral Genie 27
Installing custom database drivers 29
Chapter 3: Working with Interfaces
Running an interface 32
Canceling an interface 34
Deleting an interface ... 380710712022, 15:48
Contents
POs viewor
hntips:teazinfoldoc-view
Scheduling an interface with Event Manager
Overriding interface options at runtime
Chapter 4: Working with Connections
Creating a new connection
Editing a connection ......
Deleting a connection...
Using custom connections
Chapter 5: Wor
Creating a new mapped folder
Duplicating a mapped folder
Editing a mapped folder ..
Deleting a mapped folder
ing with Mapped Folders
Chapter 6: Working with Lookup Tables
Editing lookup tables,
Using wildcards in lookup tables
Examples of using wildcards in a lookup table
Extended wildcard option .....
Pattern matching with wildcards...
Sort order of wildcards in a lookup table
Chapter 7: Working with Reports and Logs
‘Viewing reports
Interface Results summary
Interface Error Report
Link Error Report
Disqualified Records Report
Link XML Log Report
System log report of data integration results
Saving reports
Index
36
37
a2
a4
46
AT
36
57
58
“39
160
62
63
68
66
67
68
69
700710712022, 15:48
POs viewor
Preface
Product documentation
hntips:teazinfoldoc-view
‘Comprehensive documentation accompanies all the suite products,
‘The documentation is role-based. It provides explanations and procedures from.
the point of view of:
+ Product users,
= Managers and supervisors
— Employees
+ System Administrators
+ Application programmers
+ Database managers
Documentation includes:
+ Online Help
Click Melp at the right end of the vendor identification bar on any application
page to bring up the Help system. The Table of Contents, Index, and a Search
tool are available in the left pane.
‘The Help system can be extended to include custom information. In most
shite products, it can also be:
— Translated to a language other than English
Customized, by making substitutions for tems
See “Extending the online help” on page 9.
a40710712022, 15:48
Preface
POs viewor
hntips:teazinfoldoc-view
A Documentation CD for each product
‘The CD contains product manuals in PDF and HTML format. To view or print
a PDF document. you must use Adobe Acrobat Reader v5.0 or later. You can
download a free Acrobat Reader from the Adobe Web site.
Manuals on the CDs include, but are not limited to:
— Planning. installation, and upgrading guides
— User's gtiides
— Administrator's guides
— Database tables and views reference guides
— Best practices guides
— Programmer’s guides
— Developer's Toolkit reference guides
— Quick References for employees, managers, and supervisors
A merged documentation application
‘You cau merge several selected HTML documents to make them available
through one browser window, accessed by a single Table of Contents, a
‘merged Index. and single search mechanism. Instructions inside the CD case
explain how to create a set of merged documents.0710712022, 15:48 POs viewor
Extending the online help
Extending the online help
Translation and Customization
‘Translation changes the text from one language to another—for example, from.
English to German. The Fielp can be translated from any language that is available
‘on the system, For example, if the French language pack is installed, the Help can
be translated from French to Japanese.
(Customizati n changes some texminology while retaining the same language.
For example, if'a company uses the term Associates instead of employees, the
word employees can be changed to Associates throughout the Help.
The Translation and Customization Toolkit contains software tools and
instructions that facilitate the translation and customization of the user interface,
including the online Help. Either exercise can usually be accomplished without
additional help from the vendor. The Toolkit includes the Guide to Translating and
Customizing,
Adding information
When a user clicks the View Helper Tabs button on an online Help page, a
‘Custom tab appears. Each topic here refers to an empty Custom Info file whose
content can be modified, An administrator or programmer can add custom
information to this tab. Custom information can include links to other files.
‘New information can expand existing Help topics or add new topics, such as site-
specific tips, guidelines, terms, and support information. For example, a company
might add guidelines for historical edits and deadlines for timecard approval by
‘managers and employees. Relevant Help topics can link to other documents, stich
as the company policy manual, Note that information in Custom Info or in linked
files is not included in the TOC, Search, or Index for online Help.
Instructions for adding custom information are on the View Helper Tabs >
Custom * tab.
Integration Manager User's Guide 9
hntips:teazinfoldoc-view oma0710712022, 15:48
Preface
POs viewor
Jo
hntips:teazinfoldoc-view0710712022, 15:48 POs viewor
Chapter 1
Overview
This chapter contains the following sections:
+ “Introduction” on page 12
“Overview of the dita integrs‘ion implamentation process” on page 13,
+ “Getting staitec with data integration” on page 16
hntips:teazinfoldoc-view w780710712022, 15:48
POs viewor
Chapter 1_ Overview
Introduction
hntips:teazinfoldoc-view
Integration Manager is a data integration tool that enables you to transfer data
from one data source, such as the timekeeping application, another suite
application, XML files, text files, or SQL. queries, to an o:tpur destination. That
output destination can be a text file, database, XML document. or another suite
application.
The key component of Integration Manager is the interfiz e, which is a file (KND)
that contains a set of instructions, or steps, for the data transfer. Those steps are
executed when you rum the interface. A step can be a command or it can be a link.
which is a file (KNX) that specifies the source of the data, how to manipulate and
iransfer the data, and the ourput of the data
Depending on your access rights, you can perform the following data integration
‘operations on the server where Integration Manager is installed:
+ Select, nin, modify, cancel, and delete the interfaces that have been deployed
‘on the server.
* Schedule an interface to nun at a specific time, using Event Manager,
* Create or change the connection that an interface uses to transfer data between
the source and the output destination. The connection can be a database
connection or an XML API connection.
+ Edit lookup tables that are used by the interface. A lookup table is a comma
delimited text file that is typically used to translate one piece of text into
another of to validate user input.
+ Create or change the mapped folder that is used for the source and output text
files that are associated with the interface.
+ View reports that show the results of the interface and its associated links. The
reports include information about any errors that occurred and they list any
records that were disqualified.0710712022, 15:48 POs viewor
Overview of the data tegration implementation process
Overview of the data integration implementation process
Before users can nun interfaces and perform related data integration tasks,
Integration Manager must be installed and configured on the server where the
timekeeping suite of products is installed. Users must have access to that system
and to the data integration components,
Interface programmers must have the Interface Designer component installed on
their client systems. They use Interface Designer to configure and deploy the
interfaces that users run on the server where Integration Manager is installed.
The following workflow sliows how Integration Manager is typically set up and
implemented at a site:
1. The individual who is responsible for installing the suite of time and labor
management products on the servers at your site does the following as part of
the overall suite installation process
— Selects and installs the Integration Manager component.
— Ensures that the JBoss user (the default user that will execute Workforce
Integration Manager interfaces) has appropriate rights on the Windows
domain to access all source and output file locations that will be used for
Workforce Integration Manager interfaces and links,
Copies all the product licenses, including the Integration Manager license
to the licensing directory of each instance of the suite installation on the
application server
— Installs the separate Interface Designer component on the client systems
where interfaces will be developed and on application servers from which
interfaces may be run as batch jobs.
Tip: See the Workforce Central installation documentation for more
information about installing Integration Manager and Interface Designer, and
for information about installing the corresponding license.
2. The system administrator configures the system settings that control how the
Integration Manager engine functions on the server during data integration
operations and how certain elements will be displayed on the data integration
sereens (for example, the format of the date and time)
Integration Manager User's Guide B
hntips:teazinfoldoc-view sara0710712022, 15:48 POs viewor
Chapter 1_ Overview
The system administrator configures and assigns function access profiles
(FAPs) to allow users basic access to Integration Manager components. The
administrator also allows individuals who have more extensive administrative
and programming responsibilities access to additional data integration
fimetions.
4. The interface programmer uses Interface Designer to develop and test
interfaces, and then deploys them to the server where the interfaces will be
run, The programmer can also download an interface from the server to the
client machine, make any necessary changes to the interface, and then
redeploy it to the server.
Tip: The Interface Designer online help on the client machine and the
Integration Manager Programmer s Guide have complete information about
developing, upgrading, testing, deploying, and downloading interfaces.
5. After interfaces have been deployed on the server, the system administrator
configures and assigns generic data access profiles (GDAPs) to control user
access to the interfaces, and to the connections and mapped folders that are
used by those interfaces. The following kinds of access can be granted to
specific users or groups of users:
— Interfaces — Controls which interfaces, along with their associated
lookup tables, the user has access to on the server.
= Connections — Controls which database and XML API connections the
user has access to: for example, the connection to the timekeeping
database.
— Mapped folders — Controls which mapped folders the user has access to
‘on the server, These folders contain the files that are used by interfaces.
6, After Integration Manager is set up on the server and the interfaces have been
deployed, users log on to that server, click the Data Integration tab on the suite
home page, and then run an interface or perform related data integration tasks,
Tip: The Integration Manager online help and the Integration Manager
User's Guide have complete information about setting up and using the data
integration features on the server
Mu
hntips:teazinfoldoc-view air0710712022, 15:48
POs viewor
Overview of the data integration implementation process
Integration Manager User's Guide
hntips:teazinfoldoc-view0710712022, 15:48 POs viewor
Chapter 1_ Overview
Getting started with data integration
To get started implementing and using the data integration features on the
timekeeping server. 20 to the following topics:
+ Toperform administrative functions on the server, see “Setting Up the System
for Data Integration” on page 17.
+ If the server is already set up for access to data integration functions, see
“Working with Interfaces” on page 31
16
hntips:teazinfoldoc-view0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Chapter 2
Setting Up the System for Data Integration
Before users can access the data integration components that are installed on the
server. the system administrator must configure Integration Manager on that
system,
This section contains the following topics:
* “Configuring system settings” on page 18
+ “Configuring fimction access profiles” on page 22
* “Configuring the generic data access profile” on page 24
+ “Allowing access to the data integration acertal Genie” on page 27
+ “Installing custom .atabase drivers” on page 29
swt0710712022, 15:48 POs viewor
Chapter 2 Setting Up the System for sata Integration
Configuring system settings
‘You can configure system settings to control how the Integration Manager engine
performs certain operations or displays data, such as the following’
* The number of threads the engine can generate for interfaces (requires that
you restart the timekeeping application)
‘+ How long to block competing job requests and how often to scan the database
for stalled job requests
+ How to perform sort operations
+ The date and time formats to use for data integration operations
+ Whether to allow commands that are specified in an interface to execute on
the server
* Which delimiter to use to identify mapped folders that are specified in a
command
+ How error messages are logged
To configure these system settings:
1. From the suite home page, click Setup.
In the System Configuration module, click System Settings
3. Click the Data Tntegration tab and configure the settings (click the online
Help in that workspace ot see “Data Integration system settings” on page 18
for information about specific system settings).
4, To configure the error logging settings. click the Logging Context tab and edit
the following settings (see the online Help for that workspace for more
information)
— site.loggingContext. WFC.BUSINESS.WIM
—_site.loggingContext. WFC. BUSINESS. WIM.SVC
Click Save,
Data Integration system settings
Use the Data Integration system settings to configure the Integration Manager
application.
Is
hntips:teazinfoldoc-view e1740710712022, 15:48 POs viewor
Configuring system settings
Key and value details
knx.engine.ThreadPoolSize — The number of threads the Integration Manager
engine can generate for working with the interfaces that have been created and
deployed on the system. If you change this setting, you mmust restart the
timekeeping application.
‘Value: required: minimum=1; installed default=5
knx.engine.GetJobTimeout — The number of seconds to block other requests
while waiting for the job stars to be remmned.
Value: required; minimum=1; installed default=2
knx.engine.StalledJobFrequency — The number of minutes to wait before
scanning the database for interface jobs that have stalled and will not be
completed. Those jobs will be assigned a status of ABORTED
Value: required: minimum=1; installed default=S
knx.engine.MaxTnMemorySortSize — This setting determines when the
Integration Manager engine uses memory or the database to perform a sort
operation on the output, The value that you specify represents the result of the
following calculation: number of rows of input * the number of fields of output.
+ Values above the setting will be sorted in a database
+ Values below the setting will be sorted in memory.
installed default=2000000
knx.engine.CreateSortTableSQL — Set to true if you want to specify your own
DDL for the sort database: otherwise, set to false. If you set to true, then you can
specify values for the CreateSortTable system settings that follow.
‘Value: required; minimuny
knx.engine.CreateSortTableStringDatatype — Configure this setting only if)
you ate using your own DDL for the sort database and have set
kx engine. CreateSortTableSQL to tme. This setting defines the String column
datatype (include size). Example: NVARCHAR(4000)
knx.engine.CreateSortTableFloatDatatype — Configure this setting only if you
are using your own DDL for the sort database and have set
knx engine CreateSortTableSQL to tme. This setting defines the Number column
datatype, Example: FLOAT.
Integration Manager User's Guide 19
hntips:teazinfoldoc-view 191740710712022, 15:48 POs viewor
Chapter 2 Setting Up the System for Data Integration
kns.engine.CreateSortTableBinaryDatatype — Configure this setting only if
you are using your own DDL for the sort database and have set
knnx.engine CreateSortTableSQL to true. This setting defines the Binary datatype
Example: NTEXT
Knx.engine.CreateSortTableMaxTableNameLen — Configure this setting only
if you are using your own DDL for the sort database and have set
knx.engine.CreateSortTableSQL to true. This setting defines the the maximum
length of a database table name (in characters)
knx.engine.TruncationThreshold — The number number of duplicate errors
that will appear in the error report.
Value: required; minimum=1; installed default=S00
Knx.engine. MaxXMLLogSize — The size in megabytes (MB) of the XML log
files that the system generates when the source is Workforce Central API Export
or the output is Workforce Central Import, The default value of 0 indicates that
there is no limit to the size of the log files. Specify a value for this setting (for
example, 50) only if you plan to run one or more interfaces that use a very large
‘number of records (for example, 100,000 records).
knx.engine.ShortDateFormat — The date format MM/dd/yy (month, day, and
last two numbers of the year) that will be used by the system for data integration
operations. This is the default. For example: 04/30/08,
knx.engine.LongDateFormat — The date format MM/dd’yyyy (month, day, and
all four numbers of the year) that will be sed by the system for data integration
operations. For example: 04/30/2008,
knx.engine.ShortTimeFormat — The time format HH:mm (hours and minutes)
that will be used by the system for data integration operations. This is the default,
For example: 10:15.
Knx.engine.LongTimeFormat — The time format HF:mm:ss (hours, minutes,
and seconds) that will be used by the system for data integration operations. For
example: 10:15:25.
knx.engine.TimeAMString — The AM. time format that will be used by the
system for data integration operations, The default is am,
knx.engine.TimePMString — The P.M. time format that will be used by the
system for data integration operations. The default is pm.
hntips:teazinfoldoc-view ora0710712022, 15:48
POs viewor
Configuring system settings
knx.engine.DateSeparator — The symbol that will be used to separate the
elements of a date format, The default is a slash (/ )
For example: 04/30/08,
knx.engine.TimeSeparator — The symbol that will be used to separate the
elements of a time format. The default is a colon ( : )
For example: 10:15.
knx.engine.AllowRunCommand — If an interface contains steps with
commands, this property must be set to trie to enable those commands to execute
on the server whenever that interface is run. The default is false.
knx.engine.RunCommandVarDelimiter — When designing an interface, a
mapped folder may be specified in a command for a step. A symbol, or delimiter.
is required to identify that portion of the command as a mapped folder. For
‘example, if you specify the @ symbol for this setting, the system will identify the
following entry as a mapped folder while executing the command in a nmning
interface: @MAPPED_FOLDER@. The default symbol is @.
Integration Manager User's Guide a
hntips:teazinfoldoc-view
aura0710712022, 15:48 POs viewor
Chapter 2 Setting Up the System for Data Integration
Configuring function access profiles
To configure function access profiles (FAPs) that control how users access and
use the data integration components:
1, From the suite home page. click Setup.
2. Inthe Access Profiles module, click Function Access Profiles,
3. To control basic access to the Data Integration tab and access to associated
administrative functions, select Workforce Manager - Common Setup >
Data Integration and then use the drop-down list boxes to allow or disallow
access to the following fimctions:
— Data Integration Access — Controls the ability of the user to view and use
the Data Integration tab on the suite home page. This is basic access that a
user needs to nun interfaces, edit associated lookup tables, and view the
results,
Note: The format of the totals that are displayed in the Interface Results,
Summary is based on the user’s Display Profile.
— View data integration results for all users, in addition to your own results
— Controls the ability of a user with administrative responsibilities to
view the results of interfaces (that this user has access to) that are mun by
other users
— Delete Interfaces — Controls the ability of a user with administrative
responsibilities to view and use the Delete button to remove interfaces
(that this user has access to) from the server.
— View output files displayed in Interface Run Summary — Controls the
ability of a user to access the output file from the Interface Run Summary
page,
4. To control user access to data integration components that appear in the
Workforce Central Setup area, select Workforce Manager - System
Configuration > Setup > Data Integration Setup and then use the drop-
down list boxes to allow or disallow access to the following flmetions:
hntips:teazinfoldoc-view zara0710712022, 15:48
Integration Manager User's Guide
hntips:teazinfoldoc-view
POs viewor
Configuring function access profites
= Connections — Controls the ability of a user to create, edit, duplicate, and
delete connections used by the interfaces that the user has access to.
= Mapped Folders — Controls the ability of a user to create, edit, duplicate,
and delete mapped folders that contain the files that are associated with
the interfaces that the user has access to,
5. Click Save & Return when you are done.
6. Use the People Editor to assign the flmction access profile to the individuals
who require access to the data integration components and functions that you
selected for this profile
Tip: You can use the Reports feature to view which employees or groups of
anployees have function access profiles set up for data integration. From the
General tab of the suite home page, select Reports and then click the Select Report
tab. Under Categories. select Configuration > Function Access Profiles and then
use the Set Options tab to select the appropriate function access profiles for the
report,
zara0710712022, 15:48 POs viewor
Chapter 2 Setting Up the System for Data Integration
Configuring the generic data access profile
‘When a user has a function access profile that allows access to the Data
Integration tab and Setup area, that user can now run interfaces and manage the
associated lookup tables, connections, and mapped folders.
To control which interfaces (and associated lookup tables). connections, and
‘mapped folders the user has access to, you must configure a generic data access
profile (GDAP) and assign it to that user.
‘To configure a generic data access profile for data integration users:
1, From the suite home page, click Setup.
In the Access Profiles module, click Generic Data Access Profiles,
Click New or Edit.
Add or edit the name and description as necessary.
In the Setup Category field, select Data Integration from the drop-down list
box,
6, Inthe Setup Item box, select each component that you are providing access to:
— Interfaces — The interfaces that you want users to have access to
(Access to the associated lookup table files is inchided automatically with
this setting.) Users will also be able to view the results for these interfaces
in the corresponding Interface Run Summary reports and log files.
— Connections — The connections between the source and output areas that
the interfaces use.
— Mapped Folders — The named directories that contain the source or
‘output files associated with an interface.
Note: The JBoss user (the default user that executes interfaces) must also
have access rights to all mapped folders. See the installation documentation
for more information about JBoss setup.
7. For each selected Setup Item, use the arrow buttons to move specific
interfaces, connections, or mapped folders from the Available box to the
Selected box.
8. Click Save & Return
hntips:teazinfoldoc-view zara0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Configuring the generic data access profile
9. Use the People Editor to assign the generic data access profile to the
individuals who require access to the specific data integration connections,
‘mapped folders, and interfaces that you specified
Viewing the list of generic data access profiles for data integration
Use the Reports feature to view which generic data access profiles are set up for
data integration:
1. From the General tab of the suite home page, select Reports and then click
the Select Report tab.
Under Categories, select Configuration > Generic Data Access Profiles
Click Run Report.
Click View Report. Any data access profiles that were set up for data
integration will be listed in the report.
Assigning multiple generic data access profiles to one user
‘To enable a user to switch among several profiles and view different sets of
interfaces, connections, and mapped folders, you can assign multiple generic data
access profiles to that user
The user will be able to use the Change button in the Connections. Mapped
Folders, and Interfaces workspaces to switch to a different generic data access
profile
Using generic data access profiles to support the Delegate
Authority feature
‘The Delegate Authority feature allows any individual (delegate) who is listed in
the manager’s delegates profile to perform tasks in the role of that manager
However. to view and run the manager’s data integration interfaces, the delegate
must also have access to the manager's generic data access profile that contains
those interfaces.
Integration Manager User's Guide 25
2sira0710712022, 15:48
Chapter 2
hntips:teazinfoldoc-view
POs viewor
Setting Up the System for Data Integration
Therefore, to allow the delegate authority feature to include access to the
‘manager’s data integration interfaces, the manager (or administrator) must use the
following procedure
1, The manager must identify a delegate and specify the time period when the
delegate is authorized to act in the manager's role.
2. The manager or administrator must use the People Editor to assign the
appropriate generic data access profile (that contains the list of interfaces) to
the delegate
3. The manager or administrator must use the People Editor to remove access to
that generic data access profile when the authorization period ends,
For more information about the Delegate Authority feature, see the suite online
Help, the manager or employee Gerring Started guides for timekeeping, and the
Workforce Central System Administrator's Guide
2060710712022, 15:48 POs viewor
Allowing access to the data integration accrual Genie
Allowing access to the data integration accrual Genie
‘When individuals run an interface with links that export aceruals data fiom the
timekeeping database to an output file, the user names that can be specified in the
XML API connections that are used in the links must have access to the data
integration accrual Genie that the system uses to perform that operation,
By default, the Workforce Genie Profile includes the data integration accrual
Genie, Because that profile is associated with the SuperAccess display profile, all
individuals with that display profile have access to the data integration accrual
Genie.
However, if you want individuals to have access to the data integration accrual
Genie through a different display profile, complete these steps
1. Use the People Editor to determine what the display profile is for the
individual, For example:
a, Select a user name from the QuickFind workspace and then click People
‘on the menu bar
bb, Select the Job Assignment tab and then click Access Profiles.
¢. Inthe Display Profile field, note which display profile is assigned to the
user (for example, Defeat),
From the suite home page, click the Setup link.
Under Display Preferences, click Display Profiles
Select the display profile that you identified in step 1e (Default in this,
example) and then click Edit.
In the Edit Display Profile workspace, click the Manager Selections tab and
then select a Workforce Genie Profile from the drop-down list box.
6. Click Save & Return
7. Click the Setup link again
8. Under Display Preferences > Display Profile Building Blocks, select
Workforce Genie Profiles
9, Select the profile that you selected in step 5 and then click Katt.
Integration Manager User's Guide 2
hntips:teazinfoldoc-view anita0710712022, 15:48 POs viewor
Chapter 2 Setting Up the System for Data Integration
10. In the left pane of Available Genies, select the check box for (Timekeeping)
Data Integration - Accrual Review (Accrual Detail) and then click the
right-arrow button to move the selected Genie to the right pane, Selected
Genies
11, Click Save & Return,
Any individual who uses the Display Profile Default wil be able to perform a data
integration operation that exports accruals data
hntips:teazinfoldoc-view
zara0710712022, 15:48 POs viewor
Installing custom database drivers
Installing custom database drivers
To allow interface programmers fo create a custom connection to data contained
in a database, you must install a custom database driver.
1, The driver_name. jar file contains all the Java class files for the custom
database driver that you want to make available. Store that file on the
timekeeping application server at the following location. For example:
drive: \Kronos\wEc\ appli sations\mps (lib
To incorporate the contents of the driver_name. jar file into the
timekeeping application, you must rebuild the wc ear file. On the
timekeeping application server, double-click the Stop icon on the desktop to
stop the timekeeping application,
3. Once timekeeping application is completely stopped, double-click the
Workforce Central Configuration Manager icon on the desktop. This starts the
Configuration Manager InstallShield
4. Atthe welcome screen, click Next.
5. At the configuration action screen, select Modify am instance and then click
Next.
6. Atthe next screen, select the instance (for example, wfc) and then click Next.
7. At the actions screen, do not select Add or remove products. Instead, leave
this check box clear and then click Next
8. Atthe modification confirmation screen, click Next to start rebuilding the
wie. ear file,
9. Once the rebuilding of the w£c..ear file is complete, exit from
Configuration Manager.
10. Double-click the Go icon on the desktop to start the timekeeping application.
Wait for the application to startin online mode before proceeding to the next
task.
11, To confirm that a connection is valid for the newly installed driver, in the
Setup workspace of the application server, click Connections in the Data
Integration module. You can then create and test the connection. (See
“Creating a new connection” on page 42.)
Integration Manager User's Guide 29
hntips:teazinfoldoc-view ora0710712022, 15:48
Chapter 2
Setting Up the System for Data Integration
POs viewor
30
hntips:teazinfoldoc-view
sora0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Chapter 3
Working with Interfaces
When you have access to the data integration components that are installed on the
server. you can access and run the interfaces that have been deployed on your
system,
Note: If you previously used a batch file to mun an interface without opening the
configuration tool or to schedule an interface from Event Manager, use the
Integration Manager features described in these topics instead. For more
information about using batch files to run interfaces, see the TTorkforce
fanager Programmer's Guide.
Integration
This section contains the following topics:
+ “Running an interface” on page 32
+ “Canceling an interface” on page 34
* “Deleting an interface” on page 35
+ “Scheduling an interface with Event Manager” on page 36
+ “Overriding interface options at runtime” on page 37
aura0710712022, 15:48 POs viewor
Chapter 3_ Working with Imerfaces
Running an interface
This topic describes how to run a single interface fiom the application server. For
other methods of running interfaces, see the Workforce Integration Manager
Programmers Guide.
1, From the suite home page, select the Data Integration tab and then click:
Interfaces,
In the Interfaces workspace, select the option button that is next the interface
name.
‘To enable or disable certain steps of override certain options before you run or
schedule the interface, click the Set Runtime Options button and make the
necessary changes to the selected steps in the interface. (See “Overriding
interface options at runtime” on page 37 for more information.)
4. To schedule the interface to run at a specific time, click the Schedule button
and run the interface from Event Manager. (See “Scheduling an interface with,
Event Manager” on page 36 for more information.)
5. Click the Rum button,
6. (Optional) Depending on the design of the interface. you may be prompted to
provide specific information before the interface runs or you may have the
‘option to perform some other task, such as renaming the output file. For either
scenario, the system displays the Enter Data workspace, where you can
complete those preliminary tasks.
Click OK in the confirmation message window. The Interface Monitor
workspace opens’
— Tostop an interface that is currently running, click the Cancel button.
— To view a summary report for the interface, click the Refresh button and
then click the hyperlink text in the Status field. You can analyze the
information in the Interface Results Summary window.
8. View the error report for the interface in one of the following ways:
Click the Total Errors hyperlink at the bottom of the Interface Monitor
workspace,
Click the Errors hyperlink that is next to the Totals area in the Interface
Results Summary window.
hntips:teazinfoldoc-view0710712022, 15:48
POs viewor
Rurming an interface
10
‘You can analyze the information in the Interface Error Report window.
‘View an error report for specific links. In the Interface Error Report window,
click a mumbered hyperlink in the Step Details area of the report. You can
‘analyze the information for that specific step in the Link Error Report
window.
To run the same interface again after you resolve any errors, or to run another
interface, click the Return button in the Interface Monitor workspace: then
repeat steps 2 through 6
Integration Manager User's Guide B
hntips:teazinfoldoc-view
sara0710712022, 15:48
POs viewor
Chapter 3_ Working with Imerfaces
Canceling an interface
34
hntips:teazinfoldoc-view
In the Interface Monitor workspace, click the Cancel button.
Click OK in the confirmation message window. After the interface is
canceled, the Interface Monitor workspace displays an informational
message.
‘To run another interface, click the Return button in the Interface Monitor
workspace and then select another interface,
sara0710712022, 15:48
POs viewor
Deleting an interface
Deleting an interface
To delete any of the interfaces that are available to you (as specified in your
generic data access profile):
1.
From the suite home page, select the Data Integration tab and then click
Interfaces,
2. Inthe Interfaces workspace, select the button that is next to the interface
name.
3. Click the Delete button.
Integration Manager User's Guide 35
hntips:teazinfoldoc-view
asi740710712022, 15:48
Chapter 3
POs viewor
Forking with Imerfaces
Scheduling an interface with Event Manager
36
hntips:teazinfoldoc-view
Integration Manager provides access to the Event Manager, where you can.
schedule an interface to min at any time or to run repeatedly at specified intervals.
To schedule multiple interfaces, see the Warkforce Integration Manager
Programmers Guide.
To schedule an interface:
1. From the suite home page, select the Data Integration tab and then click:
Interfaces.
In the Interfaces workspace, select tle button that is next to the interface
name.
3. Ifyou want to enable or disable certain steps or override certain options
before you schedule the interface to nin, click the Set Runtime Options
button and make the necessary changes to the selected steps in the interface.
(See “Overriding interface options at runtime” on page 37 for more
information.)
4. Click the Schedule button. The Event Manager window opens.
In Event Manager. specify how often the interface should run and the time
frame (start and end dates),
6. Click Run.
Use the browser to return to the Interfaces workspace.
30740710712022, 15:48 POs viewor
Overriding interface options at runtime
‘When you select an interface to run (as described in “Running an interface” on
page 32), you can enable or disable specific steps (links or commands) within the
interface and override certain options for both the source and output before you
run that interface.
After you click the Set Runtime Options button in the Interfaces workspace, you
can do the following in the Set Runtime Options workspace:
* To edit the description for the interface, change the text in the Description
field that is below the name of the interface.
+ Tomodify a step. click the button that is next to the step. You can then do the
following:
— Inthe Enabled column of the row of the step that you selected, select the
check box to enable the step or clear the check box to disable the step.
— Change the text in the Description field that is below the name of the step
— Change the options that are displayed on the Source and Output tabs (for
links only),
‘Note: If you cannot edit the options that are displayed in the workspace after you
select a step. it is because the step was configured to disallow overrides to those
values, See your administrator if you want to change those options.
Source tab
‘The following override options for links may appear on the page, depending on
the configuration of the interface:
+ Mapped Folder — The folder that contains source text files for the interface.
For example: MyInterface
+ Path/File Name — The source file for the interface.
+ Lookup Table File Name — If a lookup table is the source, the file name of
that lookup table.
+ One of the following connection types:
= Database Connection
hntips:teazinfoldoc-view anita0710712022, 15:48
POs viewor
38
hntips:teazinfoldoc-view
— XML API Connection
+ Timekeeping database options:
— Pay Period —Previous, current, or range of dates
— Use Variables—Select a variable from the drop-down list for start and end,
dates,
— Options — Active employees only, ignore signoff, and daily records.
Output tab
‘The following override options for links may appear on the page. depending on
the configuration of the interface:
‘+ Mapped Folder — The target folder for the output file from the interface. For
example: MylnterfaceResults
+ PatlvFile Name — The name of the output file from the interface
* Append records to any previous output file — Select this check box to enable
this feature. Clear this check box if you want to create a separate file that will
overwrite the original file.
+ Rename existing file — Select this check box iff you want to retain the output
file that was created the last time the interface was 1un. Renaming the existing
‘output file prevents the new output file from overwriting it.
+ One of the following connection types:
— Database Connection
= XML API Connection
* Submit import errors to the Transaction Assistant — Select this box to send
errors to the Transaction Assistant so that those errors can be easily
resubmitted after they are corrected,
+ Batch Name — The name that you enter is referenced along with each import
error submitted to the Transaction Assistant. The batch name enables you to
distinguish which links caused specific errors.
+ ADP options:
— Batch Number — The default is 50.
= Company Code — A three-character alphanumeric code.
Variables tab
sera0710712022, 15:48
POs viewor
Overriding interface options at runtime
Ifthe interface uses variables, you can use the Variables tab to do the following:
+ Override the value of a variable, by entering a new value as text in the New
Text Value column
+ Add a descriptive note in the Comment cohmmn,
+ Select or clear the check box in the Enabled column to activate or disable the
variable for this run of the interface
Actions
‘The following buttons are available’
+ Save — Saves the new or changed data. To view that data in the workspace,
click the Refresh button.
+ Save & Return — Saves the new or changed information and retums you to
the Interfaces workspace
+ Return — Retums you to the Interfaces workspace without saving changes.
+ Refresh —Displays the data that was last saved in the workspace and
discards any otter changes.
+ Reset Options — Reverts to the options that were originally configured for
the individual links before any override options were specified.
Integration Manager User's Guide 39
hntips:teazinfoldoc-view
30740710712022, 15:48
POs viewor
40
hntips:teazinfoldoc-view
40740710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Chapter 4
Working with Connections
‘You use the Connections workspace and the Connection Editor to manage the
connections that Integration Manager uses to transfer data between databases (or
other sources and targets for data). The workspace includes the name and
description for each connection that you can select. You use the Connections
Editor to create new connections, edit existing connections, or delete connections
that you no longer need.
Note: Ifmore than one generic data access profile (GDAP) has been assigned to
mu, there will be a Change button at the top of the Connections workspace. You
can use that button to select a generic data access profile that provides access to a
different set of connections.
The connections that you create ot edit in the Connection Editor also appear in the
list of available connections in Interface Designer (which is installed separately on
‘client system) when the interface programmer creates or edits links and
interfaces that use certain source types, such as SQL Query and Workforce
Timekeeper.
‘This chapter contains the following sections
+ “Creating a new connection” on page 42
+ “Editing a connection” on page 44
+ “Deleting a connection” on page 46
+ “Using custom connections” on page 47
aura0710712022, 15:48
POs viewor
Chapter 4 Working with Conmections
Creating a new connection
2
hntips:teazinfoldoc-view
In the Setup workspace, click Connections in the Data Integration module.
In the Connections workspace, click the New button.
In the Connection Editor, specify the following information.
— The name of the new connection,
— A description of the connection
— The type: Oracle, SQL, XML API. or Custom (see “Using custom
connections” on page 47).
‘The remaining fields that the system displays vary. depending on what you
specify for Type.
— JDBC driver and JDBC database URL (for custom connections only:
refer to your JDBC documentation)
SQL Server Note: Ina mulfi-instance environment with a SQL Server
database, specify only the server name: do vior include the name of the
instance. Instead, specify the port mober of the instance name.
— Thename of the server where the database (or other source or target area)
resides,
— Thename of the instance of Workforce Central on the server (X
— The URL prefix for the path, depending on whether a secure SSL
connection is required (XML. APD),
— The SID (security identifier reqired for Oracle databases only) or
Database Name (SQL Server database).
— Port number — The port number of the server. Oracle default is 1521 and
SQL Server default is 1433.
— Parameters — Refer to your Oracle or SQL Server driver documentation.
ML. API).
— Timeout — The number of seconds to establish the connection before that
connection times out.
User name and password.
aaa0710712022, 15:48
POs viewor
Creating a new connection
Note: The user name and password are not required for all connections.
However, they ave required for a connection to a database.
Click the Test button to ensure that the connection is working correctly. If
necessary, make changes in the Connection Editor to correct any errors. and.
then test the connection again
Click Save or Save & Return.
Integration Manager User's Guide B
hntips:teazinfoldoc-view
ara0710712022, 15:48
POs viewor
Chapter 4 Working with Conmections
Editing a connection
“4
hntips:teazinfoldoc-view
In the Setup workspace, click Connections in the Data Integration module
In the Connections workspace, select the check box next to the connection
name; then click the Edit button.
In the Connection Editor, add or modify the following information
— Thename of the connection.
(Caution: If you rename an existing connection that is used by one or more
interfaces or links on that server, those interfaces or inks may not work
correct
— A description of the connection
— The type: Oracle, SQL, XML API, or Custom (see “Using custom
connections” on page 47).
‘The remaining fields that the appear vary, depending on what you specify for
Type.
— IDB driver aud JDBC database URL (for custom connections only:
refer to Your JDBC documentation).
SQL Server Note: In a muli-instance environment with a SQL Server
database. specify only the server name: do nor include the name of the
instance, Tnstead, specify the port number of the instance name.
— The name of the server where the database (or other source or target area)
resides,
— The name of the instance of Workforce Central on the server (XML API)
— The URL prefix for the path, depending on whether a secure SSL
connection is required (XML API)
— The SID (security identifier required for Oracle databases only) or
Database Name (SQL Server database).
— Port mumber — The port number of the server
— Parameters — Refer to your Oracle or SQL Server driver documentation,
ara0710712022, 15:48
POs viewor
Editing a connection
— Timeout — The number of seconds to establish the connection before the
connection times out.
— User name and password.
Note: The user name and password are not required for all connections
However, they are required for a connection to a database
4. Click the Test button to ensure that the connection is working correctly. If
necessary, make changes in the Connection Editor to correct any errors and
then test the connection again.
5. Click Save or Save & Return
Integration Manager User's Guide 4s
hntips:teazinfoldoc-view
48740710712022, 15:48
POs viewor
Chapter 4 Working with Conmections
Deleting a connection
46
hntips:teazinfoldoc-view
1. Inthe Setup workspace, click Connections in the Data Integration module
In the Connections workspace, select the check box next to the connection
name.
3. Click the Delete button.
Note:
+ A-connection cannot be deleted if it is used by one or more interfaces or links
ou that server,
+ The custom connection, CONNECTION _TO_SORT_TABLE. cannot be
deleted. This connection is created automatically at system startup and points
to the location where sort tables are placed temporarily during sort operations,
40740710712022, 15:48 POs viewor
Using custom commections
Using custom connections
Tncluded in the list of connections that are displayed in the workspace is a custom
connection: CONNECTION_TO_SORT_TABLE. This connection is created.
automatically at system startup and points to the location where sort tables are
placed temporarily during sort operations. The default target for this connection is
the Workforce Central database. You can use the Connection Editor to change that
target, but you cannot change the name of this connection or delete it,
To create a new custom connection, be sure the database driver required for that
connection is installed on the application server. See “Installing custom database
drivers” on page 29.
Integration Manager User's Guide uv
hntips:teazinfoldoc-view ana0710712022, 15:48
Chapter 4 Working with Conmections
POs viewor
4
hntips:teazinfoldoc-view
aera0710712022, 15:48 POs viewor
Chapter 5
Working with Mapped Folders
In the Setup workspace of the application server, you use the Mapped Folders
option in the Data Integration module to create. edit, duplicate, or delete mapped
folders that are used by an interface. These folders can contain one or more source
input files or they can serve as the target folder for output files generated by the
interface.
Note: All text files used as the source must be in the same mapped folder.
‘This is an example of a name and path for a mapped folder’
+ Name: MyPayrol1Data
+ Path to the folder (LINC format)
\\server\ instance\kronos\applications\wim
Note: In an environment that has multiple application servers running Integration
‘Manager, use a UNC (Universal Naming Convention) for the mapped folder path
whenever possible.
‘The folders that you create on the server appear in the list of available mapped
folders (with their paths) that appears in the Interface Designer component that is,
installed on the client system. You can select a folder from that list when you
configure the source or output for a link, ot you can create and deploy a mapped
folder from the client. See the Interface Designer online Help and the Workforce
Integration Manager Programmer's Guide for more information about
configuring links with mapped folders.
‘This chapter contains the following sections:
+ “Creating anew mapped folder” on page 51
+ “Duplicating a mapped folder” on page 52
hntips:teazinfoldoc-view 49740710712022, 15:48
Chapter 5
POs viewor
Working with Mapped Foiders
50
hntips:teazinfoldoc-view
+ “Editing a mapped folder” on page $3
+ “Deleting a mapped folder” on page 54
sora0710712022, 15:48
POs viewor
Creating a new mapped folder
Creating a new mapped folder
1.
In the Setup workspace, click Mapped Folders in the Data Integration
module.
In the Mapped Folders workspace, click the New button,
In the Mapped Folder Editor, specify the following information:
— Thename of the new folder. For example: MyInterface
— The path to that folder. For example (UNC format):
\\server\ instance\kronos\applications\wim
‘Note: If you click the Refresh button in the Mapped Folder Editor without
first saving your edits, you will lose the data that you have entered or changed
in the two fields,
‘To ensure that the path to the folder is valid and that the folder has write
access, click the Test bution. Ifthe folder does not have write access, contact
the system administrator
Do one of the following:
— Ifyou are done creating new mapped folders, click Save & Return.
— Ifyou want to create a duplicate of the folder name and path or create a
new folder name and path that is similar to the one that you just created.
click Save and then click the Duplicate button in the Mapped Folder
Editor. Modify the duplicate mapped folder name or path as needed and
then click Save & Return.
= Ifyou want to create another new mapped folder, click Save and then
click New. Enter new information in the Name and Path fields: then click
Save & Return when you are done.
Integration Manager User's Guide 31
hntips:teazinfoldoc-view
sure0710712022, 15:48
POs viewor
Chapter 5 Working with Mapped Foiders
Duplicating a mapped folder
1
hntips:teazinfoldoc-view
In the Setup workspace, click Mapped Folders in the Data Integration
module,
In the Mapped Folders workspace, use the check box to select the mapped
folder name, and then click the Duplicate button.
In the Mapped Folder Editor, modify the following information as necessary:
— The name of the new folder. For example: MyInterface
— The path to that folder: For example (UNC format):
\\server\ instance\kronos\applicat ions\wim
‘Note: If you click the Refresh button in the Mapped Folder Editor without
first saving your edits, you will lose the data that you have entered or changed
in the two fields,
‘To ensure that the path to the folder is valid and that the folder has write
access, click the Test button. If the folder does not have write access, contact
the system administrator.
Do one of the following:
— Ifyou are done creating mapped folders, click Save & Return.
— Tocteate another duplicate of the folder name and path or to create a new
folder name and path that is similar to the one that you just created. click
Save and then click the Duplicate button in the Mapped Folder Editor,
‘Modify the duplicate mapped folder name or path as needed and then
click Save & Return,
— Tocteate a new mapped folder, click Save and then click New. Enter new
information in the Name and Path fields; then click Save & Return,
sara0710712022, 15:48
POs viewor
Editing a mapped folder
Editing a mapped folder
1.
In the Setup workspace, click Mapped Folders in the Data Integration
module.
In the Mapped Folders workspace, use the check box to select the mapped
folder name, and then click the Balt button.
In the Mapped Folder Editor, modify the following information as necessary
— The name of the new folder. For example: MyInterface
— The path to that folder. For example (UNC format):
\\server\ instance\kronos\applicat ions\wim
Note: If you click the Refresh button in the Mapped Folder Editor without
first saving your edits, you will lose the data that you have entered or changed
in the two fields,
‘To ensure that the path to the folder is valid and that the folder has write
access, click the Test button, Ifthe folder does not have write access, contact
the system administrator.
Do one of the following:
— Ifyou are done editing the mapped folder, click Save & Return,
— Toedit another mapped folder. click Save & Return and then repeat steps
2 through 4
— Tocteate a duplicate of the folder name and path or to create a new folder
name and path that is similar to the one that you just edited, click Save
and then click the Duplicate button in the Mapped Folder Editor, Modify
the duplicate mapped folder name or path as needed and then click Save
& Return,
— Tocreate a new mapped folder, click Save and then click New. Enter new
information in the Name and Path fields: then click Save & Return.
Integration Manager User's Guide 33
hntips:teazinfoldoc-view
sara0710712022, 15:48
Chapter 5
POs viewor
Working with Mapped Foiders
Deleting a mapped folder
hntips:teazinfoldoc-view
1
In the Setup workspace, click Mapped Folders in the Data Integration
module,
In the Mapped Folders workspace, use the check boxes to select one or more
mapped folder names,
Click the Delete button and then click OK in the confirmation message box,
‘Note: You cannot delete a mapped folder if any of the files stored in it are
used by an interface or link that is deployed on the server,
sara0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Chapter 6
Working with Lookup Tables
A lookup table is a comma-delimited text file that is typically used to translate one
piece of text into another. A lookup table can have one or nore columns (lookup
tables with one column are used for validating user input), and an interface can
contain as many lookup tables as necessary.
‘The chapter contains the followings sections:
* “Editing lookup tables” on page 56
+ “Using wildcards in lookup tables” on page 57
ssi740710712022, 15:48
POs viewor
Chapter 6 Working with Lookup Tables
Editing lookup tables
hntips:teazinfoldoc-view
To edit a lookup table:
1
From the suite home page, click the Data Integration tab and then select
Lookup Tables
In the Lookup Tables workspace, select the button that is next to the lookup
table name.
Click the Edit button. The Lookup Table Editor opens.
Click the button next to the row that you are editing or click directly in the
box within the row or column. Then edit the data within the box.
Note:
= Ifa lookup table is empty, it may be because the associated interface has
not yet been run. When you nin that interface, it will populate that lookup
table with data,
— Ifa lookup table does not contain any rows, there may be an error in how
the lookup table was configured for the interface: contact the interface
programmer or administrator.
Use the Row Actions buttons to add, delete. or cut and paste entire rows.
‘To view, save, or discard the changes, use the following buttons:
— Save — Saves the new or changed information
— Save & Return — Saves the new or changed information and retums you
to the Lookup Tables workspace
= Return —Retums you to the Lookup Tables workspace and discards any
changes that you made since you last clicked the Save button.
— Refresh — Discards any changes and displays the rows with the data and
format that was last saved.
sera0710712022, 15:48 POs viewor
Using wildcards in lookup tables
Using wildcards in lookup tables
Lookup tables can use “wildcard” characters to match and translate text. The
ability to use wildcards frees you from having to enter every possibility in a
lookup table, You can use wildcards in both the lookup and retum columns of a
lookup table. There are different wildcard options for each column and the
wildcards themselves behave differently depending on the column in which they
are used.
Tip: Integration Manager searches down a lookup column until it finds the first
‘match, and retums the value from the return column without searching further.
‘You can use this logic to your advantage by placing the most frequently found
lookup values near the top of the table. Place wildcard values after any explicit
lookup vahtes contained in the table,
Lookup Column Wildcards
There are three standard wildcards for use in the lookup column:
— Matches any single character.
+ *— Matches any number of consecutive characters.
+! Allows you to use a wildcard character in the lookup column without
performing the wildcard matching.
Return Column Wildcards
The following wildcards can be used in the rerum column:
+ 2 Inserts the character from the same position in the lookup string here.
+ ~—Does not insert the character from the same position in the lookup string
here.
+ 1 — Allows you to use a wildcard character in the return column without
performing the wildcard translation,
+ *— Allows you to extract all consecutive characters that follow the
asterisk (*) in the string.
Integration Manager User's Guide 37
hntips:teazinfoldoc-view srtPOs viewor
Chapter 6 Working with Lookup Tables
Other characters, such as A - Z and 0-9, are substituted based on their position in
the string in the return column,
Examples of using wildcards in a lookup table
‘The following table provides some lookup wildcard examples
Lookup Return Search Text,
Column Column — Exam-le_Returnad Description
1” om” 123 any texi 3 characiers long
shat starts with 1, re,wnse the 1
wish a9,
man ABC-1U31 254 Ignore the firt four characters
and estract the last tour,
PIII 107,205 07 ‘eatract the fourth and fifth
characters from the strmg,
mm i784 271234 recede all text 4 characters
ong “ith 2
Extended wildcard option
‘When the Extended wildcard options check box in the Lookup table dialog box is
sele
hntips:teazinfoldoc-view
scted, you can use these additional wildcards:
| — The brackets symbols find one of the specified characters. For example,
wfio]a finds wi and won.
[-]— The brackets symbols with a hyphen find any single character inthis
range. For example, {r-t}ight finds right, sight, and tight. Ranges must be in
ascending order. The order will be based on the ASCII table position.
[-] — The brackets symbols with a tilde find any single character except the
characters inside the brackets. For example, m[-alst finds mist and most, but
not mast.
sara0710712022, 15:48 POs viewor
Using wildcards in lookup tables
+ [42] — The brackets symbols with a tilde and range of characters find any
single character except characters in the range inside the brackets. For
example, t{~a-mck finds rock and ruck, but not zack or tick. Ranges must be
in ascending order. The order will be based on the ASCH table position.
+ @—The "At" symbol finds one or more occurrences of the previous
character of expression. For example lo@t finds fot and Toot
+ {,} —Matches n or more occurrences of the previous character. For
example, 10{2.} finds 100, 1000, 1000 and so on,
+ {n} —Matches exactly n occurrences of the previous character. For example,
10(2} finds 100 only.
+ {n,m} —Matches n tom occurrences of the previous character. For example,
10{1,3} finds only 10, 100, and 1000.
Note:
+ Ifyou are using extended wildcard characters, and you need to look up one of
the wildcard characters. you must precede it with the exclamation point
escape character (1).
+ Each column in a table is separated by a comma. Any space before or after the
comma is not inchided with the text of the column.
+ To incnde a comma or another character as part of the text, you must add
quotation marks before and after the string that contains that character.
Pattern matching with wildcards
Another method for extracting parts of data is to use lookup tables to search for
pattems. Construct a lookup table with all possible combinations, using wildcards
{o establish the pattems. The return columns are the respective pieces of the data,
In the following example. you search for a dash character: the first column is the
lookup. the second column rerums the part of the data before the dash, and the
third column returns the part of the data after the dash.
Integration Manager User's Guide 39
hntips:teazinfoldoc-view sora0710712022, 15:48
POs viewor
Chapter 6 Working with Lookup Tables
Sort order of wildcards in a lookup table
60
hntips:teazinfoldoc-view
‘The following demonstrates the proper sort order for wildcard entries
22182?
pooea?
aa
‘The entries with the question marks come before those with the asterisks. This is
because the question mark entries have a definite length (six characters in this
example), whereas the asterisk entries do not have a definite length. Integration
‘Manager searches down the lookup column until it finds a match. and then it
sends back the value from the rerum column: it does not continue to look for a
better match,
The last entry is an asterisk, which will match any lookup text of any length. Tn
other words, this will always match. If you include an asterisk, there is no need to
define a default value in the Lookup Table dialog box,
eos0710712022, 15:48
hntips:teazinfoldoc-view
POs viewor
Chapter 7
Working with Reports and Logs
Integration Manager provides several reports and logs that you can tse to analyze
the results of an interface or link, including information about any errors and.
disqualifications that may have occurred.
This section contains the following topics:
+ “Interface Results Summary” on page 63
+ “Interface Error Report” on page 65
‘Link E1vor Report” on page 66
‘Disqualified Records Report” on pag
+ “Link XML Log Report” on page 68
67
+ “System log report of data integration results” on page 69
+ “Saving reports” on page 70
ours0710712022, 15:48
Chapter
POs viewor
Working with Reports and Logs
Viewing reports
hntips:teazinfoldoc-view
‘When you run an interface, you can view data about that interface, including
information about any errors that may have occurred. You can also view system-
level errors and information about the Integration Manager application, Save ot
print the reports just as you would any web page, or send them using e-mail
+ “Interface Results Summary” on page 63 — View this report in one of the
following ways:
— Whenever you run an interface interactively, the Interface Monitor
‘workspace opens. Click the Refresh button in that workspace and then
lick the hyperlink text in the Status field to view the summary report.
— To view results for any interfaces that you have already run, click the
Data Integration tab and then select Results, Click the hyperlink text in
the Status column to view the summary report for a specific interface
+ “Interface Error Report” on page 65 — View this report in one of the
following ways:
— Click the Total Errors hyperlink at the bottom of the Interface Monitor
workspace.
— Click the Errors hyperlink in the Totals area under General Information
in the Interface Results Summary window.
* “Link Error Report” on page 66 — View this report in one of the following
ways:
— Inthe Interface Error Report window, click a numbered hypertink in the
Step Details area of the report.
— In the Interface Results Summary window, click the Enrors hyperlink in
the Totals column for a specific step.
* “Disqualified Records Report” on page 67 — View this report from the
Interface Results Summary window. Click the Disqualified hyperlink in the
Totals column within a specific step.
+ “Link XML Log Report” on page 68 — View this report from the Interface
Results Summary window. If. step generated an XML log report, click the
‘View hyperlink on the right side of the summary
+ System log report of data integration results” on page 69 — View this report
by using the Log Report feature in the System Configuration area of Setup.
ears0710712022, 15:48 POs viewor
Interface Results Sunmary
Interface Results Summary
‘View this report in one of the following ways:
+ Whenever you run an interface interactively. the Interface Monitor workspace
‘opens. Click the Refresh button in that workspace and then click the
hyperlink text in the Status field to view the summary report.
+ To view results for any interfaces that you have already run, click the Data
Integration tab and then select Results. Click the hyperlink text in the Status,
column to view the summary report for a specific interface.
‘The report displays the following types of information, depending on the
configuration of the interface and its associated links:
+ General Information — The name and description of the interface, the name
of the user who ran the interface, the start and end date, the duration, the status
of the interface, and totals for errors and disqualified records
Tip: Click the Errors hyperlink in the Totals column to view the Interface
Error Report
+ Interface Details —The name of the application server, name of the interface,
the names of variables used for that interface, and setup information.
+ Step Details —If there are multiple steps, each step number is a hyperlink
that you can click to access the relevant data. The following kinds of data
appear for each link or command in a step, depending on how the step was
configured.
Note: If there is no Integration Manager license installed on the server and a
step is configured to process more than SO records (the maximum allowed
without a license), the report will display an error message indicating that the
step stopped processing after reaching 50 records.
Name of the link.
‘Variables (if any) that are used in the interface.
Start and end date, and the duration.
Status of the Tink.
Integration Manager User's Guide 6
hntips:teazinfoldoc-view ears0710712022, 15:48
Chapter
POs viewor
Working with Reports and Logs
os
hntips:teazinfoldoc-view
— Mapped folders and files used by the link for the source and output
— Selected options that were specified for the source and output. Examples
include: timekeeping data such as pay period, daily records, pay code
totals, job totals, and custom labor account totals: batch information:
Activities data: custom output totals: a delimiter (, ): XML APT import or
export information; and Payroll Prep indicator.
— The name of the source and output connection.
— SQL Query name.
— Tables used by the link.
— Hypertext link to the XML log report that is generated when the XML
APIs extract or import data,
= Ifan XML document is the source: the file, folder, and schema,
— [fan XML document is the output: a hypertext link to that XML output
file.
— Totals for the number of batches, records that were created, processed.
and disqualified, and errors
Tip: Click the Errors or Disqualified hyperlinks in the Totals column within a
any step to view detailed reports,
ears0710712022, 15:48
POs viewor
Interface Error Report
Interface Error Report
‘View this report in one of the following ways:
+ Click the Total Errors hyperlink at the bottom of the Interface Monitor
workspace,
+ Click the Errors hyperlink in the Totals area under General Information in the
Interface Results Summary window.
This report displays the following error information:
+ The name and description of the interface.
+ A Step column that contains a series of step numbers that each have a
hyperlink to the corresponding error information.
+ Each step in sequential order with the specific error information, such as the
following
— Could not find one or more files
= Could not get exciusive access to the source or output file while the
interface was running.
Note: Whenever Integration Manager detects an incorrect date value, it skips the
record that is being processed at the time. That particular record will not be
written to the output file
Integration Manager User's Guide 6
hntips:teazinfoldoc-view
esi7a0710712022, 15:48
POs viewor
Chapter 7 Working with Reports and Logs
Link Error Report
‘View this report in one of the following ways:
+ In the Interface Error Report window, click a numbered hyperlink in the Step
Details area of the report
+ Inthe Interface Results Summary window, click the Errors hyperlink in the
Totals column for a specific step.
This report displays the following error information:
+ The name and description of the interface that includes the link.
+ The step mumber that contains the Link, as well as associated error
information, such as the following:
— The names of any vatiables that failed for that link.
— A message that directs you to the wfe.Log file for more details abont the
errors,
Note: Whenever Integration Manager detects an incorrect date value, it skips the
record that is being processed at the time. That particular record will not be
‘written to the output file
66
hntips:teazinfoldoc-view
esis0710712022, 15:48
POs viewor
Disqualified Records Report
Disqualified Records Report
‘View this report from the Interface Results Summary window. Click the
Disqualified hyperlink in the Totals column within a specific step.
This report displays the following information about records that were
disqualified within a step when the link was executed by the interface’
+ Interface name
* Description of the interface
+ Step number that contains the Link
+ List of disqualified records for that link
Integration Manager User's Guide 7
hntips:teazinfoldoc-view
ents0710712022, 15:48
Chapter
POs viewor
Working with Reports and Logs
Link XML Log Report
hntips:teazinfoldoc-view
‘The XML log report displays the name and description of the link, along with the
results (including errors) from XML API operations that extracted or imported
data
‘You can access the Link XML Log Report from the Interface Results Summary
window. Under each step in the summary, locate the XML Log entry. If that step
generated an XML log report, click the View hyperlink in the right column,
ears0710712022, 15:48
POs viewor
Sustem log report of data imegration results
System log report of data integration results
Ifyou want to analyze data integration operations at the programming level
without having to review the entire system log (wfe.log). you can create a report
that extracts only the Integration Manager information from that system log file.
1, From the suite home page, click the Setup link and then select System
Configuration > Log Report.
Specify the server names and the start and end dates.
3. Inthe Log Context drop-down list box, select one of the following:
— WFC.BUSINESS. WIM — For system-level errors and information about
the Integration Manager application that is installed and running on the
server
— WFC.BUSINESS WIMSVC — For errors and information about
specific Integration Manager interfaces that ran on the server.
4. Specify information in the remaining fields as necessary. See the Log Report
online help ot the Workforce Central System Administrator's Guide if you
need more detailed information about the Log Report feature.
5. Click the Run Report button
Integration Manager User's Guide 0
hntips:teazinfoldoc-view
eorra0710712022, 15:48
Chapter 7
POs viewor
Working with Reports and Logs
Saving reports
hntips:teazinfoldoc-view
‘When you view any report, you may want to save it for futher analysis or
delivery to a technical support person. You can use the Save As feature on your
browser to save the report as an HTML or text file
Note: If the Interface Run Summary report contains hyperlinks to other reports,
be sure to open and save those individual reports as wel.
ro1r40710712022, 15:48
A
accruals
data integration Genie 27
B
batch files
running interfaces 31
scheduling interfaces 31
c
Change batton
data integration 2<
connections
changing 44
creating 42
custom connections 4
deleting 46
editing 44
Connections workspace 41
custo 1comections 4
custom database drivers
installing 29
D
data integration
accruals Genie 27
assigning multiple profiles 25
canceling an interface 34
Change button 25
Connections workspace 41
hntips:teazinfoldoc-view
POs viewor
Index
creating a mapped folder $1
creating new connections 42
‘custom connections 47
deleting a ma,ped folder 54
deleting an interface 37
deleting connections 46
Disqualified Records Report 67
duplicating a mapped folder 52
editing a mapped folder 53
editing connections 44
‘fimetion access profiles 22
‘generic data access profiles 24
Interface Error Report 65
Interface Results Summary 63
“ink Ervor Report 66
1 apped Folders workspace 49
overview 11
removing an interface 35
running an interface 32
saving reports 70
scheduling an interface 36
setup 17
sefup and implementation 13,
stopping an interface 34
system settings 13
‘users with generic data access profiles 25
using Delegate Authority to nun interfaces 25
using interfaces. 31
using the Mapped Folder Editor $4
viewing interface results 62
‘viewing reports 61
mira0710712022, 15:48
POs viewor
Indes.
XMLLog 68 custom database drivers 29.
Data Integration system settings 18 data integration Genie
database divers deleting a mapped folder 54
installing custom drivers 29
Delegate Authority
‘using with data integration features 25
display profiles
format of Interface Results Summary 22
Disqualified Records Report 67
divers
installing custom database drivers 29
EnterData workspace 39
Event Manager
scheduling am interface 36
F
folders
creating a mapped folder $1
deleting @ mapped folder 54
duplicating a mapped folder 52
editing a mapped folder $3
using the Mapped Folder Editor
GS
generic data access profiles
assigning multiple profiles 25
running interfaces with Delegate
Authority 25
users with access to data integration 25
Integration Manager
canceling an interface 34
Connections workspace 41
creating a mapped folder 51
creating new connections 42
custom connections 47
4
hntips:teazinfoldoc-view
deleting an interface 35
deleting connections 46
Disqualified Records Report 67
Guplicating a mapped folder $2
editing a mapped folder 53
editing connections 44
fimction access profiles 22
seneric data access profiles 24
Interface Enor Report 65
Interface Results Summary 63
sink Hsror Report 65
Mapped Folders workspace 49
overview
removing an interface 35
running an interface 32
saving reports 70
scheduling an interface 36
setup 17
setup and implementation 13
stopping an interface 34
system setings 18
using interfaces 31
using the Mapped Folder Editor 54
viewing interface results 62
viewing reports 61
XML Loz 68
Interface Ersor Report 65
Interface Results Summary 63
format 22
interfaces 31
canceling 34
deteting 35
Disqualified Records Report 67
enabling and disabling steps 37
Interface Enror Report 65
Interface Results Summary 63
Link Error Report 66
rama0710712022, 15:48
POs viewor
Index
overriding options 37
removing 35
running 32
savingreports 70
scheduling 36
setting rintime options 37
stopping 34
viewing results 62
XML Log 68
L
Link Enror Report 66
lookup tables
editing 56
sortonder 60
wildcard examples $8
M
‘Mapped Folder Editor $4
Mapped Folders workspace 49
creating-a mapped folder 51
deleting a mapped folder 54
duplicating a mapped folder 52
editing a mapped folder 53
using the Mapped Folder Editor 54
Pp
pattem matching 59
R
reports
saving 70
Ss
scheduling interfaces 36
batch files 31
‘Set Runtime Options workspace 37
sort order
in lookup tables 60
Integration Manager User's Guide
hntips:teazinfoldoc-view
system settings
Data Integration 18
U
using batch files 31
w
wildcards
in lookup tables, examples 58
lookup tables 57
x
XML Log
running an interface 68
rata0710712022, 15:48
Indes.
POs viewor
”
hntips:teazinfoldoc-view
rata