DataMap Guide
DataMap Guide
MAPICS, Inc.
1000 Windward Concourse Parkway, Suite 100
Alpharetta, GA 30005-8001
www.mapics.com
DataMap Guide.book Page 2 Tuesday, April 19, 2005 11:28 AM
Contents____________________________________
DataMap Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
DataMap Spreadsheets .......................................................................................... 1-1
Form-Collection ................................................................................................ 1-2
Collection-Schema ......................................................................................... 1-3
Schema-Properties ........................................................................................... 1-4
Form-Folder...................................................................................................... 1-5
Form-Group-Authorization ................................................................................ 1-5
Form-Events ..................................................................................................... 1-6
SL-CRM-Map.................................................................................................... 1-6
Collection-Method............................................................................................. 1-7
Rpt-Form-SP .................................................................................................... 1-7
Relationships Between the Data in the Spreadsheets ............................................ 1-7
DataMap Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Starting the DataMap .............................................................................................. 2-1
Copying and Modifying the DataMap ...................................................................... 2-1
Using the DataMap ................................................................................................. 2-1
Customizing SyteLine ERP ..................................................................................... 2-2
Customize SyteLine ERP Forms and Field Labels........................................... 2-2
Customize SyteLine ERP Help Topics ............................................................. 2-2
Searching for a Field ............................................................................................... 2-3
Searching for a Field’s Data Source ....................................................................... 2-4
Finding Database Schema Details.......................................................................... 2-8
Using the DataMap with SyteLine Workflow Automation ........................................ 2-8
Getting Help on a Field ........................................................................................... 2-9
Finding Program Information for Forms ................................................................ 2-10
Events Used in a Form ................................................................................... 2-10
Methods and Stored Procedures Used by a Collection .................................. 2-12
Stored Procedures Used by Reports .............................................................. 2-13
Finding Which SyteLine ERP Fields Map to CRM Adapter XML Elements .......... 2-14
Determining Authorization Levels for Forms ......................................................... 2-16
Finding a Form in the Explorer.............................................................................. 2-16
Contacting MAPICS .............................................................................................. 2-17
Contacting MAPICS Support .......................................................................... 2-17
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
Contents
1
DataMap Overview _________________________
The SyteLine® DataMap is an analytical tool designed to help you learn and
analyze relationships between SyteLine forms, collections, stored procedures,
and database schema. It also allows you to track and record changes you
make using user-defined fields or otherwise modifying the standard product.
The DataMap consists of a set of Microsoft Excel® spreadsheets that list
SyteLine ERP forms and fields and their data relationships, default
authorization levels, CRM mapping, and so on.
The DataMap is a tool, not standard documentation. As such, it is not
warranted to exactly match the schema and forms, but it does closely
approximate the supported SyteLine ERP version at the time the DataMap was
created.
DataMap Spreadsheets
The DataMap includes these spreadsheets. Each spreadsheet is described in
more detail, with sample data, in the following pages.
Spreadsheet Description
Form-Collection Lists forms in SyteLine ERP, and both the component name
and the label for most fields on each form. Then it lists the data
source (collection and object or variable) for the form/
component combination. Help on fields or forms is also
available through a button.
Collection- Lists the modules (IDOs), collections, and collection properties
Schema (usually objects) found in the application database. Then,
where applicable, it lists the underlying database tables and
columns relating to collection/object pairs.
Schema- Lists the properties for the application database tables and their
Properties columns (base data type, user-defined type, storage length,
precision, scale, default value, whether the data allows nulls,
and whether the column is a primary key).
Form-Folder For each form, lists the Explorer folder and subfolder where that
form is found.
Form-Group- For each form, lists the group authorization that is set by
Authorization default. You can filter and sort either by group or by form.
DataMap Overview
Spreadsheet Description
Form-Events For each form, lists the possible events and responses.
SL-CRM-Map Lists, in separate worksheet tabs, the SyteLine ERP and CRM
database tables and fields whose data may be exchanged
through XML request and response documents or flat-file
transfers.
Collection- For most collections, lists any methods/stored procedures used
Method in the collection, and the parameters used in the methods.
Rpt-Form-SP For each report form, lists the background task, .RPT (Crystal
Reports) file and the SQL stored procedures used in the report.
Form-Collection
DataMap Overview
DataMap Overview
• Table - Database schema table (if any) that contains the schema column
that maps to this collection and object.
• Column - Database schema column (if any) that maps to this collection
and object.
• Property Value - May contain useful information for properties whose type
is Derived.
Schema-Properties
The Schema-Properties spreadsheet describes the application database
table and column properties. This information is similar to what you see when
you right-click and select Properties for a database table in SQL Enterprise
Manager.
DataMap Overview
Form-Folder
The Form-Folder spreadsheet tells where in SyteLine ERP’s Explorer folder
hierarchy you can find certain forms. The Main Folder is sometimes, but not
always, equivalent to the name of a module or IDO. The Sub Folder, if any,
indicates an additional layer of folders in the Explorer. The Parent Folder is the
folder containing the form.
Form-Group-Authorization
The Form-Group-Authorization spreadsheet lists the default group
authorizations set up for SyteLine ERP, and the forms to which the groups
apply. You can sort or filter this information by either group or form.
DataMap Overview
Form-Events
The Form-Events spreadsheet lists the events, sequences, and responses
available from each form.
SL-CRM-Map
The SL-CRM-Map spreadsheet maps the CRM adapters and CRM database
to SyteLine ERP database table.columns, where appropriate. It includes a tab
for each SyteLine - CRM adapter. Each tab includes the following information:
• XML data elements used in the adapter, and descriptions of the data
elements.
• CRM database table and column to which the element maps.
• SyteLine ERP database table and column to which the element maps.
DataMap Overview
Collection-Method
The Collection-Method spreadsheet lists the module (IDO) to which a
collection belongs and the methods/stored procedures used in the collection.
It also lists parameter information for each method. There may be some
collections not represented in this spreadsheet.
Rpt-Form-SP
Since reports generally do not have associated collections, the Rpt-Form-SP
spreadsheet provides information about the stored procedures, background
tasks, and RPT (Crystal Reports) files associated with reports. A report form
may be associated with multiple tasks, stored procedures and RPT files.
DataMap Overview
DataMap Spreadsheet Relationships
2
DataMap Procedures _______________________
This chapter describes in detail some of the tasks you can perform using the
DataMap.
DataMap Procedures
DataMap Procedures
4. The DataMap then displays only the rows where the ComponentName
column contains the text you specified.
5. Be sure to un-filter again later by selecting All from the column’s drop-
down box.
Normally in Excel, the Auto-Filter dropdown box lists all the different
values from the column’s rows, and you select one. Because we
have pushed Excel beyond its normal limits, our dropdown filter may
NOT list all available values. Use the Custom option on the
dropdown box, as shown above, to filter for a specific value.
DataMap Procedures
2. Open the Form-Collection spreadsheet and filter to display the form and
component from step 1.
DataMap Procedures
SL.SLCustomers(xxxxx)
SL.SLItemprices.ItemPriceChangeSp(xxxxxxx)
MGCore.AccountAuthorizations( xxxxx)
NULL
DataMap Procedures
object.Addr_1
object.DerNewStat
object.UbRangeQty
object2.CheckDate
filter.AdditionalValue
"Filter" indicates that the The object does not map directly to a
data is based on a filter and database table.column.
is used in a query form.
variables.AgingBasis(xxx)
DataMap Procedures
DataMap Procedures
DataMap Procedures
2. Click the Help button. This displays the SyteLine Help for that field:
If you get an error message that macros are not enabled, change the
security level in Excel. It should be set to Medium, to allow macros. You
can change the security level by selecting the Excel menu options
Tools>Macro>Security. Then save and reopen the spreadsheet.
3. You can go from the displayed help topic to any other topic in the SyteLine
online help.
DataMap Procedures
Response Description
Type
0 Method call
2 Execute EXE or other program
3 Run form as modal child
4 Goto form - replace this form with the new form
5 Goto form -page - make the new form page current
6 Run form as linked child
7 Run form
8 Run script
16 Run form to retrieve filter
19 Run background task
DataMap Procedures
Response Description
Type
21 Generate event
22 Set values
23 Collection navigate
24 Collection new
25 Collection copy
26 Collection save
27 Collection delete
28 Collection refresh
29 Collection refresh current
30 Collection notes
31 Collection notes for current
32 Collection init with auto insert row
33 Inline script
34 Collection make current
35 ActiveX script method
36 Conditional action
37 Binary value action
38 Add entry to the audit log
39 Goto URL
40 Print preview
41 Goto Explorer folder
DataMap Procedures
DataMap Procedures
To filter for a specific stored procedure or RPT file (where there may be more
than one SP or RPT listed for a form):
1. Right-click on the down-arrow next to the Stored Procedure or RPT column
heading.
2. Select Custom from the list.
3. In the Custom Auto Filter dialog, specify the text and wildcards you want
to look for.
DataMap Procedures
2. Select a link in the Overview, or click the tabs at the bottom of the
spreadsheet, to go to the worksheet that shows the appropriate adapter’s
XML mapping.
DataMap Procedures
DataMap Procedures
The Main Folder is usually, but not always, the module. The Sub Folder, if any,
indicates an additional layer of folders in the Explorer.The Parent Folder
indicates the type of form (as well as the subfolder in the Explorer). You can
filter or sort by any of the columns.
DataMap Procedures
Contacting MAPICS
Contacting MAPICS Support
If you cannot find the answer to a question in this document or in the product’s
online help, contact MAPICS Support using one of these methods:
• Go to our support Web page (http://support.mapics.com) and log in,
selecting your product area. From the Support web page, you can search
for answers to your questions about the product in our Knowledge Base,
or report issues.
• Find the support contact phone number or email address for your region at
http://support.mapics.com/phonelist.htm.
DataMap Procedures
Index _______________________________________
B E
Base Type, in Schema-Properties spreadsheet 1- Enable Macros 2-1
4 Enabling Macros 2-9
Binding Button 2-4 Event
Name 1-6
C Response Type 1-6
Changing the DataMap 2-1 Sequence 1-6
Collection 1-1, 2-4 Event Handler Responses 2-10
in Collection-Schema Spreadsheet 1-3 Events Used in Forms 1-2, 2-10
Methods 2-12 Explorer Folders 1-1, 2-16
Stored Procedures 2-12
Collection-Method Spreadsheet 1-2, 1-7, 2-12 F
Collection-Schema Spreadsheet 1-1, 1-3 Field Length 1-4
Column Name, in Schema-Properties Field Name 1-4
spreadsheet 1-4 Field Type 1-4
Column, in Collection-Schema Spreadsheet 1-4 Fields
Component Name 1-2, 2-3 Customizing 2-2
Components 1-1 Getting Help 2-9
Contacting MAPICS 2-17 Map to XML Elements in Adapter 2-15
Container, in Form-Collection spreadsheet 1-3 Searching for 2-3
Copying the DataMap Files 2-1 Folder 2-16
CRM Adapters 1-6, 2-14 Form Name, in Form-Collection spreadsheet 1-2
CRM Database 1-2 Form-Collection Spreadsheet 1-1, 1-2, 2-9, 2-12
CRM Database Table 1-6 Customizing Fields 2-2
Crystal Reports 1-2, 2-13 Customizing Help 2-2
Custom Auto Filter Dialog 2-3, 2-13 Searching for Data Source 2-4
Custom Option in Excel 2-3 Searching for Fields 2-3
Customizing Form-Events Spreadsheet 1-2, 1-6, 2-10
SyteLine ERP 2-2 Form-Folder Spreadsheet 1-1, 1-5, 2-16
SyteLine Help Topics 2-2 Form-Group-Authorization Spreadsheet 1-1, 1-5,
2-16
D Forms
Data Element 1-3, 2-4 Authorizations 2-16
Data Length 1-1 Components 1-1
Data Source 1-1 Customizing 2-2
Database Schema Details 2-8
Index
G 1-4
Group Authorizations 1-5 Programming Information 2-10
Groups 1-1 Properties 1-1, 1-3
Property Type 1-3
H Property Value 1-4
Help
Button 1-1 R
Customizing 2-2 Relationships between Spreadsheets 1-7
on a Field 2-9 Reports 1-2
Help ID RPT files 2-13
and Help File 1-3 Stored Procedures 2-13
Column Description 1-3 Response 1-2, 2-10
Using with Custom Help 2-2 Response Types, list of 2-10
Response, Events 1-6
I RPT files 1-7
IDO 1-1, 1-5, 1-7 Rpt-Form-SP Spreadsheet 1-2, 1-7, 2-13
L S
Label (Field) 1-2 Scale 1-1, 1-4
Schema-Properties Spreadsheet 1-1, 1-4, 2-8
M Searching for Data Source 2-4
Macros 2-1 Searching for Fields 2-3
Macros, Enabling 2-9 Security Level 2-9
Main Folder 1-5 Sequence, Events 1-6
MAPICS, Contacting 2-17 SL-CRM-Map Spreadsheet 1-2, 1-6, 2-14
Metadata 2-8 Starting the DataMap 2-1
Methods 1-2, 2-12 Storage, in Schema-Properties spreadsheet 1-4
Notes about 2-12 Stored Procedures 1-2
Populating Form Components 2-5 in Collection-Method Spreadsheet 1-7
MGCore 1-3 in Rpt-Form-SP Spreadsheet 1-7
Modifying the DataMap 2-1 Used by a Collection 2-12
Module 1-1 Used by Reports 2-13
in Collection-Method Spreadsheet 1-7 Sub Folder 1-5
in Collection-Schema Spreadsheet 1-3 Support 2-17
SyteLine ERP Database Table 1-6
N SyteLine Workflow Automation 2-8
Nullable, in Schema-Properties spreadsheet 1-4
T
O Table Name 1-4
Object 1-1 Table Name, in Schema-Properties spreadsheet
1-4
P
Table, in Collection-Schema Spreadsheet 1-4
Parent Folder, in Form-Folder Spreadsheet 1-5
Permissions for Forms 2-16 U
Phone Numbers 2-17 Unfiltering a Column 2-3
Precision 1-1, 1-4 User Defined Data Type, in Schema-Properties
Precision, in Schema-Properties spreadsheet 1-4 spreadsheet 1-4
Primary Collection 1-3, 2-4 User-Defined Type 1-1, 1-4
Examples 2-5
Primary Key, in Schema-Properties spreadsheet
Index
V Winstudio Online Help 2-10
Variable 1-1
X
Variable, in collections 2-5
XML Data Element 1-6
W XML Elements in CRM Adapters 2-15
Web Page 2-17 XML Requests and Responses 1-2
Wildcards 2-3, 2-13
Index