Guide 8
Software Version 5.4.1-0
Status Release
FEAtures Integrate
Table of Contents
History ............................................................................................................................................................ 3
Tell Me About… ............................................................................................................................................... 4
Integration Editor, Data Store Editor and Data Source............................................................................................. 4
XML Attribute..........................................................................................................................................................13
XML Integration Interface .......................................................................................................................................19
XML Integration Source ..........................................................................................................................................22
XML Interface Chooser............................................................................................................................................24
XML Node................................................................................................................................................................25
XML Source Chooser ...............................................................................................................................................32
What Can I Build? .......................................................................................................................................... 33
Application Form Integration ..................................................................................................................................33
Exercise 1 » Add an XML Integration Source.......................................................................................................35
Exercise 2 » Add an XML Integration Interface using Drag and Drop from Data Store Editor............................44
Exercise 3 » Add an XML Node ............................................................................................................................50
Exercise 4 » Add an XML Attribute ......................................................................................................................53
Exercise 5 » Add an Error Management Phase to Manage XML Integration Rule Errors ...................................59
Exercise 6 » Add an XML Integration Rule to Save Data to an XML Document ..................................................64
Exercise 7 » Add an XML Integration Rule to Load Data from an XML Document .............................................78
History
Author Version Date Comments
Dr Kevin M Potter 2.0 15 January 2015 New Foundation, Enterprise, Advanced Features
(FEAtures) true multi-channel learning platform.
Tell Me About…
Integration Editor, Data Store Editor and Data
Source
What you need to know
Integration Editor and Data Store Editor enable your solution to talk to a Data Source.
You build Integration Source and Integration Interface objects that describe data transfer (at run-time) between a
Data Source and the Data Store (as defined using Data Store Editor).
Integration Source: An Integration Source describes the connection to the Data Source that you want to
integrate with. The Source dialog allows you to build all Integration Sources. When you select an Integration
Source Type additional tabs are displayed; these allow you to set properties to build a specific Integration
Source.
Integration Interface: An Integration Interface describes how to map Data between the Data Source and the
Data Store. The Interface dialog allows you to build all Integration Interfaces. When you select an Integration
Interface Type additional tabs are displayed; these allow you to set properties to build a specific Integration
Interface.
Generate Interface: A Generate Interface dialog allows you to automatically generate an Integration
Interface based on existing Data Groups and Data Items in the Data Store. You can drag-drop Data Groups
from the Data Store Editor to the Integration Editor. This opens the Generate Interface dialog.
Data Source: You can integrate with many different types of Data Source.
COM Integration: Integrate to Microsoft COM objects.
Database Integration: Integrate to a Database using JDBC or JNDI.
Java Integration: Integrate to Properties and Methods in a Java class.
Log Integration: Integrate to a Log file.
Web Service Integration: Integrate to an external Web Service.
Polaris Integration: Integrate to Polaris. (This option is only displayed if you have a license that allows
you to work with Polaris.)
XML Integration: Integrate to an XML file, URL, Socket or Data Item.
Browse Class Integration: Display a Choose Source Class dialog. Manually select and integrate to
Properties and Methods in a Java class. (This is not the same as Java Integration.)
Information Component Object Model (COM) is a binary-interface standard for software components
introduced by Microsoft in 1993. It is used to enable inter-process communication and dynamic
object creation in a large range of programming languages.
Information Java Database Connectivity (JDBC) is an application programming interface (API) for the
programming language Java that defines how a client may access a database.
Information The Java Naming and Directory Interface (JNDI) is a Java API for a directory service that allows Java
software clients to discover and look up data and objects via a name.
Information Polaris is a third-party software application developed for the insurance business. It holds details of
external components such as occupations and motor vehicle classifications.
Essential Commands
User Interface
Integration Editor
Integration Editor allows you to build a Source to enable your solution to integrate with a Data Source. Integration
Editor allows you to build an Interface to enable your solution to transfer data between a Data Source and the Data
Store.
Source Dialog
The Source dialog allows you to build all Data Sources.
Details Tab
The Details Tab allows you to Name and select the Type of Integration Source that you need.
Interface Dialog
The Interface dialog allows you to build all Data Interfaces.
Details Tab
The Details Tab allows you to Name and select the Type of Integration Interface that you need.
Generator Tab
The Generator Tab allows you to Name and select the Type of Integration Interface that you need.
10
Information Component Object Model (COM) is a binary-interface standard for software components
introduced by Microsoft in 1993. It is used to enable inter-process communication and dynamic
object creation in a large range of programming languages.
Information Java Database Connectivity (JDBC) is an application programming interface (API) for the
programming language Java that defines how a client may access a database.
Information The Java Naming and Directory Interface (JNDI) is a Java API for a directory service that allows Java
software clients to discover and look up data and objects via a name.
Information Polaris is a third-party software application developed for the insurance business. It holds details of
external components such as occupations and motor vehicle classifications.
11
Figure 7 Generate Interface dialog » Details tab (for XML Integration only).
12
XML Attribute
What you need to know
In XML Document Object Model (DOM) vernacular, everything in an XML Document is a node.
Document: The entire document is a document node.
Element: Every XML element is an element node.
Text: The text in the XML elements are text nodes.
Attribute: Every attribute is an attribute node.
Comment: Comments are comment nodes.
In edgeConnect vernacular an XML Attribute essentially allows you to build a DOM element node that simply
contains Attributes and/or Text. Or in other words, an edgeConnect XML Attribute allows you to add an XML
Element to your XML Document, where the Element contains data expressed as Attributes or as Text.
Best It is best practice to use meaningful Customer and/or Project Specific XML Attribute names.
Practice
13
Essential Commands
14
User Interface
Details Tab
The Details Tab allows you to enter a Name and to mark read/write operation requirements.
15
Mapping Tab
The Mapping Tab allows you to map the attribute to a Data Item, Data Group, Variable or Value.
16
17
Information XML namespaces are used for providing uniquely named elements and attributes in an XML
document. They are defined in a W3C recommendation. An XML instance may contain element or
attribute names from more than one XML vocabulary.
Information CDATA stands for Character Data and it means that the data in between these tags includes data
that could be interpreted as XML mark-up, but should not be.
The key difference between CDATA and a Comment is, CDATA is still part of the XML Document,
while a Comment is not.
18
Best It is best practice to use meaningful Customer and/or Project Specific XML Integration Interface
Practice names.
19
User Interface
Information XML namespaces are used for providing uniquely named elements and attributes in an XML
document. They are defined in a W3C recommendation. An XML instance may contain element or
attribute names from more than one XML vocabulary.
20
21
Best It is best practice to use meaningful Customer and/or Project Specific XML Integration Source
Practice names.
22
User Interface
Connection Tab
The Connection Tab allows you describe the connection to the XML Data Source.
23
The XML Interface Chooser dialog helps you to work with other dialogs.
Rule dialog.
24
XML Node
What you need to know
In XML Document Object Model (DOM) vernacular, everything in an XML Document is a node.
Document: The entire document is a document node.
Element: Every XML element is an element node.
Text: The text in the XML elements are text nodes.
Attribute: Every attribute is an attribute node.
Comment: Comments are comment nodes.
In edgeConnect vernacular an XML Node essentially allows you to build a DOM element node. Or in other words,
an edgeConnect XML Node allows you to add an XML Element to your XML Document, where an XML element is
everything from (and including) the element's start tag to (and including) the element's end tag.
Optionally, you can map an (edgeConnect) XML Node to a repeating Data Group. This allows you to structure and
map repeating data as child Elements and child Attributes (based on child Data Groups, Data Items, Variables and
Values) within the parent Element.
Best It is best practice to use meaningful Customer and/or Project Specific XML Node names.
Practice
25
Essential Commands
26
User Interface
Details Tab
The Details Tab allows you to enter a Name and optionally select a repeating Data Group.
27
Information XML namespaces are used for providing uniquely named elements and attributes in an XML
document. They are defined in a W3C recommendation. An XML instance may contain element or
attribute names from more than one XML vocabulary.
28
29
30
31
The XML Source Chooser dialog helps you to work with other dialogs.
Rule dialog.
32
33
34
35
36
37
38
39
40
41
42
Best It is best practice to create your own Folders within the Project Folder to manage custom Files that
Practice are going to be part of your solution.
Exercise 2 » Add an XML Integration Interface using Drag and Drop from Data Store
Editor
Step-By-Step
The following steps show you how to use Integration Editor and Data Store Editor to add an XML Integration
Interface.
1. Select Window menu » Integration Editor.
2. Select Window menu » Data Store Editor.
3. Position Editors side-by-side.
44
4. Drag the ApplicationFormData Data Group from Data Store Editor to the XML Integration node in Integration
Editor.
45
46
47
An XML Interface is automatically generated based on Data Groups and Data Items contained in the
ApplicationFormData Data Group.
Figure 42 Drag-Drop from Data Store Editor to Integration Editor to create and Interface.
48
49
50
51
52
53
54
55
56
57
58
Exercise 5 » Add an Error Management Phase to Manage XML Integration Rule Errors
Step-By»-Step
Errors can occur when using the XML Integration Rule. For example, if the Rule cannot locate the required Source
or Interface then an error is thrown. The Rule allows you to specify the name of a Phase to jump to when an error
occurs.
The following steps show you how use Process Editor to add a new Phase to the Error Management Process to
manage XML Integration Rule Errors.
1. Select Window menu » Process Editor.
2. Expand Error Management Process.
3. Right-click General Error Phase » Copy.
4. Right-click Error Management Process » Paste.
5. Expand General Error – Copy Phase.
59
8. Click OK.
60
9. Right-click XML Integration Rule Error Phase FEAtures Info Note » Properties.
10. Enter new Comment text.
An XML Integration Rule Error occurs when a Source or an Interface cannot be found or are incorrectly
configured.
61
12. Right-click XML Integration Rule Error Phase Heading 2 Really sorry but… » Properties.
13. Enter new Display Text.
Really sorry but I could not load or save your data. Please try again...
62
The new XML Integration Rule Error Phase is now ready for use.
Figure 57 New Error Management Phase for use with XML Integration Rules.
63
64
65
66
67
68
69
70
71
72
The XML Integration Rule is added to the Save Data and Return to Application Form Button.
Figure 67 Process Editor » Application Form Floating Areas Process » Save Data to XML Phase.
73
74
75
Figure 69 Save Data to an XML Document using the XML Integration Rule.
76
77
Exercise 7 » Add an XML Integration Rule to Load Data from an XML Document
Step-By-Step
The following steps show you how to use Process Editor to add an XML Integration Rule to load data from an XML
Document.
1. Select Process Editor.
2. Expand Application Form Floating Areas Process.
3. Expand Reload Data from XML Phase.
4. Right-click Reload Data and Return to Application Form Button » Add » Button Rule » Other.
5. Enter Rule Name.
Reload Application Form Data from XML Document
6. Select Rule Class.
XML Integration Rule
78
79
80
81
82
83
84
85
86
The XML Integration Rule is added to the Reload Data and Return to Application Form Button.
Figure 81 Process Editor » Application Form Floating Areas Process » Reload Data from XML Phase.
87
88
Figure 82 Copy the Application Reference Number from the XML Document file name.
Figure 83 Paste the Application Reference Number to the Reference Question Answer.
89
Figure 84 Confirm that data has been reloaded to the Application Form from the XML Document.
Brilliant, you’ve finished all of the exercises in this chapter. Go back to the Introduction Guide and build something else!
90