Infor Mongoose

IDO Development Guide

Copyright © 2012 Infor
All rights reserved. The word and design marks set forth herein are trademarks and/or registered
trademarks of Infor and/or related affiliates and subsidiaries. All rights reserved. All other trademarks
listed herein are the property of their respective owners.
Important Notices
The material contained in this publication (including any supplementary information) constitutes and
contains confidential and proprietary information of Infor.
By gaining access to the attached, you acknowledge and agree that the material (including any modi-
fication, translation or adaptation of the material) and all copyright, trade secrets and all other right,
title and interest therein, are the sole property of Infor and that you shall not gain right, title or interest
in the material (including any modification, translation or adaptation of the material) by virtue of your
review thereof other than the non-exclusive right to use the material solely in connection with and the
furtherance of your license and use of software made available to your company from Infor pursuant
to a separate agreement ("Purpose").
In addition, by accessing the enclosed material, you acknowledge and agree that you are required to
maintain such material in strict confidence and that your use of such material is limited to the Purpose
described above.
Although Infor has taken due care to ensure that the material included in this publication is accurate
and complete, Infor cannot warrant that the information contained in this publication is complete, does
not contain typographical or other errors, or will meet your specific requirements. As such, Infor does
not assume and hereby disclaims all liability, consequential or otherwise, for any loss or damage to
any person or entity which is caused by or relates to errors or omissions in this publication (including
any supplementary information), whether such errors or omissions result from negligence, accident or
any other cause.
Trademark Acknowledgements
All other company, product, trade or service names referenced may be registered trademarks or
trademarks of their respective owners.
Publication Information
Release: Infor Mongoose 8.00
Publication date: December 17, 2012
Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Related documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Contacting Infor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Chapter 1 IDO .NET API and Class Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
IDO .NET Class Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
IDO Protocol Class Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
IDO Commands Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
AppDB Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
IDO Commands Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
IIDOCommands Interface (C#) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
IIDOCommands interface (Visual Basic) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
IDO Commands Interface - Request/Response Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
APIs and Related IDO Protocol Classes - Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
About the Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
GetPropertyInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
GetPropertyInfo Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
LoadCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
LoadCollection Example 1: Using the Protocol Class . . . . . . . . . . . . . . . . . . . . . . . . . . .14
LoadCollection Example 2: Using the Commands Interface . . . . . . . . . . . . . . . . . . . . . .14
LoadCollection Example 3: Accessing Item Properties . . . . . . . . . . . . . . . . . . . . . . . . . .15
UpdateCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
UpdateCollection Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
LoadCollection/UpdateCollection Example:
Saving Changes to Existing Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Infor Mongoose - IDO Development Guide | 3

 Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Invoke Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Invoke Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Assigning and Checking Null Values in IDO Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Assigning Null Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Checking Null Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Translation/Localization Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Internal Format for Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Internal Format for Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Type Conversions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Setting Property and Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Add/SetValue with InvokeRequestData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Add/SetValue with UpdateCollectionRequestData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Getting Property and Parameter Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
GetValue with LoadCollectionResponseData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Handling Nullable Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Creating Filter Strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
SqlLiteral.Format Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Supported .NET CLR Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Diagnostics and Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Logging Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Message Logging API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Wire Tap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Standalone Application Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Open Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
OpenSession Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Close Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
GetConfigurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
ConfigurationInfo Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
ConfigurationInfo Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
MongooseConfigs Class (MGShared.dll Class Library) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

4 | Infor Mongoose - IDO Development Guide

 External Data Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
External Data Store - Stored Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
External Data Store - Client Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Chapter 2 IDO Extension Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

About Extension Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Creating an IDO Extension Class Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Importing Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Implementing an IDO Extension Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Mongoose.IDO.IIDOExtensionClass Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Mongoose.IDO.IIDOExtensionClassContext Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Declaration of an IDO Extension Class for an IDO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
IDO Extension Class Starter Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Adding Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Sample Standard Method Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
IDOMethod Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
MessageParm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Including Filters in Custom Load Methods to Load Collections . . . . . . . . . . . . . . . . . . . . . . .44
Using Variables and a Bookmarking Algorithm to Get More Rows in a Custom Load Method .
44
IDO Event Handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Adding an IDO Event Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Event Handler Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Special Cases for UpdateCollection Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Using the ActionMask Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Replacing Standard IDO Processing with Event Handlers. . . . . . . . . . . . . . . . . . . . . . . . . . .50
Generating Application Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Code Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
LoadCollection Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
UpdateCollection Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Inserting a New Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Infor Mongoose - IDO Development Guide | 5

 Updating an Existing Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Invoke Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
AppDB Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Application Database Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Opening a Connection to the Application SQL Server Database. . . . . . . . . . . . . . . . . . .55
Executing SQL Server Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Application Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Message Lookup Using the AppDB Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Session Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Process Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Using AppDB in an Extension Class Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Disposing of IDO Extension Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Translation/Localization Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Type Conversions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
IDORequest/Response Property Values (IDOProtocol classes) . . . . . . . . . . . . . . . . . . .59
Converting Internal Format Strings to Strong Typed Variables . . . . . . . . . . . . . . . . . . . .60
Testing Extension Class Assemblies Locally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Debugging Extension Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Logging Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

6 | Infor Mongoose - IDO Development Guide

About This Guide

Use this guide if you are developing your own IDOs based on the Infor Mongoose framework, or if you
are extending the functionality of an existing IDO by adding methods and event handlers.
This guide describes the classes and libraries available to you, and provides some examples of their
use.

Intended audience
The primary audience for this guide includes form and application developers who need to develop
their own Intelligent Data Objects (IDOs) for Mongoose-based applications. Secondary audiences
include training, support, marketing, and other personnel.

Related documents
You can find the documents in the product documentation section of the Infor Xtreme Support portal,
as described in "Contacting Infor" on page 6. These additional resources are available:
 Integrating IDOs with External Applications - Includes an overview of what IDOs are and the
different ways that applications can interface with IDOs. It provides examples and syntax showing
how to set up IDO requests and responses in different protocols (XML documents, the application
event system, .NET Web service, and so on).
 Guide to the Application Event System - Describes the Application Event System, which
developers and system administrators can use to create events and event handlers that automate
tasks. It also contains sample scenarios that will help you understand how you can take
advantage of the Application Event System.
 Modifying SyteLine - Includes a list and descriptions of the tools available for creating and editing
forms, IDOs, application events, and event handlers. It also describes the administrative and
development utilities to use for managing a development project and deploying an application.
This guide also includes information you may need about external touch points, application
messages, licensing for IDOs, and so on. We strongly recommend that you read through this
guide before creating or modifying IDOs, especially for SyteLine.

Infor Mongoose - IDO Development Guide | 5

About This Guide

Contacting Infor
If you have questions about Infor products, go to the Infor Xtreme Support portal at http://
www.infor.com/inforxtreme.
If we update this document after the product release, we will post the new version on this Web site.
We recommend that you check this Web site periodically for updated documentation.
If you have comments about Infor documentation, contact [email protected].

6 | Infor Mongoose - IDO Development Guide

Chapter 1: IDO .NET API and Class
Library 1

Overview
Developers can use the IDO .NET class library to programmatically access the Mongoose business
objects, which are called IDOs (Intelligent Data Objects).
Interactions with an IDO are based on requests and responses. The caller constructs an IDO request
and sends it to the IDO runtime service to be executed. The IDO runtime service constructs and
returns a response to the caller containing the results of the action requested.
All client access to the application database is through the IDOs. The primary responsibilities of the
IDO runtime service include querying data sets (LoadCollection), saving data (UpdateCollection), and
calling methods (Invoke).

Each IDO request has a request type such as OpenSession, LoadCollection, UpdateCollection, or
Invoke. It also contains an optional request payload that is dependent on the request type. For
example, the payload for an OpenSession request contains logon information for a user, such as user
ID, password, and configuration.
The API is used by standalone client applications, WinStudio scripts, user controls, and within IDO
extension classes. The same programming interface is available on the client using the
Mongoose.IDO.Client class and from an IDO extension class using the Me.Context.Commands
property. This chapter focuses on use of the class library; the extension classes are described in
Chapter 2, “IDO Extension Classes."

Infor Mongoose - IDO Development Guide | 7

IDO .NET API and Class Library

IDO .NET Class Library

The IDORequestClient .NET class library has one class, Client. It is in the Mongoose.IDO.Client
namespace.
The Client class implements the IDO command interface (LoadCollection, UpdateCollection, and
Invoke), plus additional commands (OpenSession, GetConfigurations, CloseSession) that are used
only for external application communications.

IDO Protocol Class Library

The IDOProtocol .NET class library contains classes that correspond to each level in the hierarchy of
an IDO request or response. These classes are used to construct IDO requests and responses. All
IDOProtocol classes are in the Mongoose.IDO.Protocol namespace.
The top level of the IDOProtocol class hierarchy is implemented by the IDORequestEnvelope class,
and the IDO request (RequestHeader in XML) is implemented by the IDORequest class. The request
payload implementation (if any) varies depending on the request type. For an OpenSession request,
the payload is implemented by the OpenSessionRequestData class. The payload for a
LoadCollection request is implemented by the LoadCollectionRequestData class. There are other
similar classes for each request type that carries a payload.
The IDO responses are implemented in classes that mirror the requests, with the
IDOResponseEnvelope at the top of the hierarchy.
As an example, these steps are required to execute an IDO runtime Invoke call using IDOProtocol
classes:
1 Create a new IDORequestEnvelope instance.
2 Set the IDORequestEnvelope.SessionID property.
3 Create a new instance of IDORequest.
4 Set the IDORequest.Type property to Invoke.
5 Create a new instance of InvokeRequestData.
6 Set the InvokeRequestData.IDOName property.
7 Set the InvokeRequestData.MethodName property.
8 Add the parameters to the InvokeRequestData.Parameters collection.
9 Add the IDORequest to the IDORequestEnvelope.Requests collection.
10 Set the payload for the IDORequest using the IDORequest.SetPayload method.
11 Send your completed IDORequestEnvelope to the IDO runtime and receive the
IDOResponseEnvelope in return.

8 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

IDO Commands Interface

Whether you are writing code on the client side or in an IDO extension class, the framework also
provides wrapper methods through the IDO Commands interface. These wrappers typically reduce
IDO interactions to a single line of code.
However, a limitation of using the IDO Commands interface is that you can specify only one IDO
request per command, and receive one response per command. When using the IDOProtocols
classes instead, you can build one IDORequestEnvelope that includes multiple requests, and then
receive one response that includes information for all the requests.

AppDB Class
The AppDB class, part of the Mongoose.IDO.DataAccess namespace, is available only to extension
classes. It provides direct access to the application database, plus access to common framework
features such as application messages and session variables. For more information about this class,
see “AppDB Class” on page 55.

IDO Commands Interface

This basic IDO runtime API is defined by the IIDOCommands interface, which is shown below, in both
C# and VB formats. The properties used in each request type are explained later in this chapter.

Infor Mongoose - IDO Development Guide | 9

IDO .NET API and Class Library

IIDOCommands Interface (C#)

public interface IIDOCommands
{
GetPropertyInfoResponseData GetPropertyInfo( string idoName );
LoadCollectionResponseData LoadCollection(
LoadCollectionRequestData requestData );
UpdateCollectionResponseData UpdateCollection(
UpdateCollectionRequestData requestData );
InvokeResponseData Invoke(
InvokeRequestData requestData );
string[] GetIDONames();
LoadCollectionResponseData LoadCollection(
string idoName,
string propertyList,
string filter,
string orderBy,
int recordCap );
LoadCollectionResponseData LoadCollection(
string idoName,
PropertyList propertyList,
string filter,
string orderBy,
int recordCap );
InvokeResponseData Invoke(
string idoName,
string methodName,
params object[] parameters );
}

IIDOCommands interface (Visual Basic)

Public Interface IIDOCommands
Function GetIDONames() As String()
Function GetPropertyInfo(ByVal idoName As String) As _
GetPropertyInfoResponseData
Function GetPropertyInfo(ByVal idoName As String, _
ByVal includeClassNotesFlag As Boolean) As _
GetPropertyInfoResponseData
Function Invoke(ByVal requestData As InvokeRequestData) As _
InvokeResponseData

10 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Function Invoke(ByVal idoName As String, ByVal methodName As

String, _
ByVal ParamArray parameters() As Object) As
InvokeResponseData
Function LoadCollection(ByVal requestData As _
LoadCollectionRequestData) As LoadCollectionResponseData
Function LoadCollection( _
ByVal idoName As String, _
ByVal propertyList As PropertyList, _
ByVal filter As String, _
ByVal orderBy As String, _
ByVal recordCap As Integer) As LoadCollectionResponseData
Function LoadCollection( _
ByVal idoName As String, _
ByVal propertyList As String, _
ByVal filter As String, _
ByVal orderBy As String, _
ByVal recordCap As Integer) As LoadCollectionResponseData
Function UpdateCollection(ByVal requestData As _
UpdateCollectionRequestData) As
UpdateCollectionResponseData
End Interface

IDO Commands Interface - Request/Response Syntax

The IDO Commands interface provides a simple alternative to constructing IDO requests when
interacting with IDOs. The process of creating an IDORequestEnvelope, IDORequest and payload
class instance for each interaction is replaced by a single method call, which will construct the request
for you using the parameter list.

APIs and Related IDO Protocol Classes - Details

This section describes each API and associated protocol classes, and provides examples of each.

About the Examples

The examples in this section use the syntax of extension class methods, for example:
VB.NET: ... Me.Context.Commands.LoadCollection(request)
C#: ... this.Context.Commands.LoadCollection(request)

Infor Mongoose - IDO Development Guide | 11

IDO .NET API and Class Library

The syntax for using the IIDOCommands interface is different in other contexts, such as a form script
or a standalone client application.

GetPropertyInfo
Use GetPropertyInfo to retrieve a list of properties and their attributes for an IDO.

Properties
This table describes the properties available on the LoadCollectionRequestData class

Property Data Type Description

IDOName System.String Identifies the IDO used to execute the
request.
IncludeClassNotesFlag System.Boolean If True, set the ClassNotesExist
property in the response to indicate if
any class notes exist for this IDO (only
available if using the Client class
GetResponse method).

GetPropertyInfo Example
Note: The remaining code examples in this chapter are given for C# unless otherwise indicated.
GetPropertyInfoResponseData response;

response = this.Context.Commands.GetPropertyInfo( "SLItems" );

foreach ( PropertyInfo idoProp in response.Properties )

{
String propertyName = idoProp.Name;
// etc.
}

LoadCollection
Queries are performed using the LoadCollection API and associated protocol classes. LoadCollection
requests can be constructed using the LoadCollectionRequestData IDO protocol class.

12 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Properties
This table describes the properties available on the LoadCollectionRequestData class.

Property Data Type Description

IDOName System.String Identifies the IDO used to execute the
request.
ReadMode Mongoose.IDO.Protocol. Specify the collection read mode, which
ReadMode controls the isolation level used when
executing queries (see the online help on
Process Defaults). Options are:
 ReadCommitted
 ReadUncommitted
 Default
This property does not apply to custom
load methods.
PropertyList Mongoose.IDO.Protocol. A subset of properties published by the
PropertyList IDO to be included in the response.
Filter System.String A filter or WHERE clause to be used for
the query.
Default: Empty
RecordCap System.Int32 The maximum number of items to return
in the response. The setting 0 returns all
items. The setting -1 uses the default cap
(200).
Default: -1
OrderBy System.String A list of property names used to override
the default sort order. Only bound
properties can be included in OrderBy.
Default: Empty
Distinct System.Boolean If this flag is set to True, the request
returns a set of items containing only the
unique combinations of properties named
in the PropertyList property.
Default: False
CustomLoadMet Mongoose.IDO.Protocol. Allows the caller to specify a method to
hod CustomLoadMethod perform the query in place of the standard
query built by the IDO runtime.
PostQueryComm System.String Allows the caller to specify a method to
and be executed for each item returned by the
query. The method must be a member of
the IDO specified by the IDOName
property.
Default: Empty

Infor Mongoose - IDO Development Guide | 13

IDO .NET API and Class Library

Property Data Type Description

LinkBy Mongoose.IDO.Protocol. Applies to inner nested LoadCollection
PropertyPair array requests only and specifies the
relationship between a parent and child
IDO in terms of property pairs. Use the
SetLinkBy method to set this property.
Default: Empty
NestedRequests System.Collections. A collection of additional
ICollection LoadCollectionRequestData instances
used to load child collections.
LoadCap System.Int32 Specifies the maximum number of nested
LoadCollection requests to process. For
example, if this property is set to 1, and
200 items are returned by the parent
LoadCollection request, only the first
parent item in the response contains
nested child items.

LoadCollection Example 1: Using the Protocol Class

To execute a LoadCollection request, first construct an instance of the LoadCollectionRequestData
class, and pass it to the LoadCollection method on the IIDOCommands interface.
LoadCollectionRequestData request = new LoadCollectionRequestData();
LoadCollectionResponseData response;

request.IDOName = "SLItems";
request.PropertyList.SetProperties( "Item, Description, QtyOnHand" );
request.Filter = "Item LIKE N'AB%'";
request.OrderBy = "QtyOnHand";
request.RecordCap = 0;
response = this.Context.Commands.LoadCollection( request );

LoadCollection Example 2: Using the Commands Interface

In many cases it will be more convenient to call the overloaded version of the LoadCollection method
that accepts parameters for the required and most common LoadCollectionRequestData properties.
LoadCollectionResponseData response = LoadCollectionResponseData;

// This is equivalent to example 1.

response = this.Context.Commands.LoadCollection(
"SLItems",
"Item, Description, QtyOnHand",

14 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

"Item LIKE N'AB%'",

"QtyOnHand",
0);

LoadCollection Example 3: Accessing Item Properties

The LoadCollection methods return an instance of the LoadCollectionResponseData class, which is
populated with the same values that were sent in the request plus the results from the query. These
results are accessed through the Items property, which is a collection of IDOItem instances.
Properties can be accessed through the IDOItem instances or directly using the indexer on the
LoadCollectionResponseData class.
int x = response.PropertyList.IndexOf("QtyOnHand");
int qty = 0;
foreach (IDOItem item in response.Items)
{
qty += item.PropertyValues[x].GetValue<int>();
}

qty = 0;
for (int row = 0; row < response.Items.Count; row++)
{
qty += response[row, "QtyOnHand"].GetValue<int>();
}

UpdateCollection
Updates (includes inserts, updates and deletes) are performed using the UpdateCollection API and
associated protocol classes. UpdateCollection requests can be constructed using the
UpdateCollectionRequestData IDO protocol class. This table describes the properties available on
the UpdateCollectionRequestData class.

Infor Mongoose - IDO Development Guide | 15

IDO .NET API and Class Library

Properties
Property Data Type Description
IDOName System.String Identifies the IDO used to execute the
request.
CollectionID System.String An identifier associated with this
UpdateCollection request.
RefreshAfterUp System.Boolean A boolean value used to indicate if the caller
date wants the response to contain the updated
items refreshed after they were saved.
CustomInsert System.String These properties are used to specify
CustomUpdate custom actions to use when saving items.
Note: This is the same as a custom INS/
CustomDelete
UPD/DEL in WinStudio.
LinkBy Mongoose.IDO.Protocol. Applies to inner nested UpdateCollection
PropertyPair array requests only and specifies the relationship
between a parent and child IDO in terms of
property pairs. Use the SetLinkBy method to
set this property.
Default: Empty
Items Mongoose.IDO.Protocol. An instance of the IDOUpdateItems class
IDOUpdateItems that contains zero or more IDOUpdateItem
instances. The IDOUpdateItem class
contains the update information for a single
item.
TxnScope Mongoose.IDO.Protocol.T When the TxnScope is set to Item, each
xnScope individual item in the UpdateCollection
request is saved in a separate transaction.
For a hierarchical (nested) UpdateCollection
request, the value of the TxnScope attribute
at the root level determines the behavior for
the entire UpdateCollection request. This
attribute has no effect when it is included in
an inner UpdateCollection within
hierarchical requests.

To execute an UpdateCollection request, first construct an instance of the

UpdateCollectionRequestData class, and pass it to the UpdateCollection method on the
IIDOCommands interface.

16 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

UpdateCollection Example
UpdateCollectionRequestData request = new
UpdateCollectionRequestData();
UpdateCollectionResponseData response;
IDOUpdateItem newCust = new IDOUpdateItem();

request.IDOName = "SLCustomers";
request.RefreshAfterUpdate = true;

newCust.Action = UpdateAction.Insert;
newCust.ItemNumber = 1;
// used for error reporting
newCust.Properties.Add( "CustNum", "C000100" );
newCust.Properties.Add( "Name", "Boxmart" );
newCust.Properties.Add( "CurrCode", "USD" );
newCust.Properties.Add( "BankCode", "BK1" );

request.Items.Add( newCust );

response = this.Context.Commands.UpdateCollection( request );

LoadCollection/UpdateCollection Example:
Saving Changes to Existing Records
This example loads data from an IDO, updates the data and saves the collection.
public void DoUpdate()
{
LoadCollectionResponseData Loadresponse =
LoadCollectionResponseData;
string sCoNum = null;
string sFilter = null;

sCoNum =
ThisForm.PrimaryIDOCollection.GetCurrentObjectProperty("CoNum");
sFilter = "CoNum = '" + sCoNum + "'";

Loadresponse = this.IDOClient.LoadCollection("SLCos", "Charfld1,

CustNum", sFilter, "", -1);
if (Loadresponse.Items.Count > 0)
{
UpdateCollectionRequestData updateRequest =
UpdateCollectionRequestData;
IDOUpdateItem updateItem = IDOUpdateItem;

Infor Mongoose - IDO Development Guide | 17

IDO .NET API and Class Library

// Create a new UpdateCollection request:

updateRequest = new UpdateCollectionRequestData("SLCos");
// Create a new update item for the row we loaded:
updateItem = new IDOUpdateItem(UpdateAction.Update,
Loadresponse.Items[0].ItemID);
// Add the CustNum property from LoadResposne, not modified:
updateItem.Properties.Add("CustNum", Loadresponse[0,
"CustNum"].Value, false);
// Add the Charfld1 property using a new value, modified:
updateItem.Properties.Add("Charfld1", "Owzat?", true);
// Add the update item to update the request:
updateRequest.Items.Add(updateItem);
// Save the changes:
this.IDOClient.UpdateCollection(updateRequest);
}
}

Invoke
IDO methods (not including custom load methods) are called using the Invoke API and associated
protocol classes. Invoke requests can be constructed using the InvokeRequestData IDO protocol
class. This table describes the properties available on the InvokeRequestData class.

Properties
Property Data Type Description
IDOName System.String Identifies the IDO used to execute the request.
MethodName System.String Identifies the IDO method to be executed.
Parameters Mongoose.IDO.Protocol. A collection containing instances of the
InvokeParameterList InvokeParameter class corresponding to the
IDO method parameters.

To execute an Invoke request, first construct an instance of the InvokeRequestData class, and pass it
to the Invoke method on the IIDOCommands interface.

18 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Invoke Example 1
InvokeRequestData request = new InvokeRequestData();
InvokeResponseData response;

request.IDOName = "UserNames";
request.MethodName = "UserValidSp";
request.Parameters.Add( "ajones" );
// user name, input
request.Parameters.Add( IDONull.Value );
// user ID, output
request.Parameters.Add( IDONull.Value );
// description, output
request.Parameters.Add( IDONull.Value );
// infobar, output

response = this.Context.Commands.Invoke( request );

if ( response.IsReturnValueStdError() )
{
// get infobar output parameter
string errorMsg = null;
errorMsg = response.Parameters[3].Value;
}
else
{
int userID = 0;
string desc = null;

userID = response.Parameters[1].GetValue<int>();
if ( !response.Parameters[2].IsNull )
{
desc = response.Parameters[2].Value;
}
}

In many cases it is more convenient to call the overloaded version of the Invoke method that accepts
parameters for the IDOName, MethodName and method parameters InvokeRequestData properties.

Infor Mongoose - IDO Development Guide | 19

IDO .NET API and Class Library

Invoke Example 2
InvokeResponseData response;

response = this.Context.Commands.Invoke(
"UserNames",
"UserValid",
"ajones",
IDONull.Value,
IDONull.Value,
IDONull.Value );

if ( response.IsReturnValueStdError() )
{
// get infobar output parameter
string errorMsg = "";
errorMsg = response.Parameters[3].Value;
}
else
{
int userID = 0;
string desc;
userID = response.Parameters[1].GetValue<int>();

if ( !response.Parameters[2].IsNull )
{
desc = response.Parameters[2].Value;
}
}

Assigning and Checking Null Values in IDO Requests

Assigning Null Values

When assigning a null value to a property or parameter in the IDO protocol classes, the best practice
is to use the IDONull.Value static property.
InvokeResponseData myMethodResponse;
UpdateCollectionRequestData updateRequest;

20 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

// pass NULL for the 3rd parameter

myMethodResponse = this.Invoke("MyMethod", "test", 100,
IDONull.Value);

// set the Note property to NULL

updateRequest.Items[0].Properties.Add("Note", IDONull.Value);

Checking Null Values

When checking for null values, the best practice is to use the IDONull.IsNull static method. For
parameter or property values in an IDO protocol class, you may also use the IsNull property to check
for null values.
// Check for null value in a LoadCollectionResponseData:

{
if (!loadResponse(0, "UserId").IsNull)
{
userId = loadResponse(0, "UserId").GetValue<long>(-1);
}
}

// Check for a null parameter value:

public int MyFunc(Nullable<int> param)
{
// Test for a null value:
if (IDONull.IsNull(param))
{
// Handle the null parameter.
}
}

Translation/Localization Considerations
All data values in IDO requests and responses are stored as string values in an "internal" format that
is independent of any regional settings for the application or local machine where the code is
executing.

Infor Mongoose - IDO Development Guide | 21

IDO .NET API and Class Library

Internal Format for Numbers

Numeric values are always stored internally using a period for the decimal separator (for non-integer
values) and without any digit-grouping characters.

Internal Format for Dates

Date values are always stored internally using the format YYYYMMDD HH:MM:SS.mmm for date and
time, YYMMDD for date only, and HH:MM:SS.mmm for time only (milliseconds are optional).

Type Conversions
The IDO protocol classes store all property and parameter values internally as strings in a non-
localized internal format. However, the framework also provides methods that allow you to
transparently convert between supported native .NET CLR data types and the internal formatted
string values. You should always use strongly typed variables when getting values from, or putting
values into, any of the IDO protocol classes in order to take advantage of this feature and avoid
problems related to systems running with different regional settings. This is especially important when
working with date and numeric values.
The built-in VB functions for data type conversions (CStr, CDate, CInt, etc.) are sensitive to the
regional settings for the application or local machine.

Setting Property and Parameter Values

Use the SetValue or Add methods to set parameter and property values into the IDO protocol classes.

Add/SetValue with InvokeRequestData

This example shows how to do this with the InvokeRequestData IDO protocol class:
InvokeRequestData invokeRequest = new InvokeRequestData();
int version = 600;
DateTime recordDate = DateTime.Now;

invokeRequest.IDOName = "MyIDO";
invokeRequest.MethodName = "MyMethod";
invokeRequest.Parameters.Add("Mongoose");
invokeRequest.Parameters.Add(version);
invokeRequest.Parameters.Add(Guid.NewGuid());

22 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

invokeRequest.Parameters.Add(recordDate);
invokeRequest.Parameters.Add(IDONull.Value); // Set later.

// Set the fifth parameter after it has been added:

invokeRequest.Parameters[4].SetValue(100);

Both the Add and SetValue methods accept a value of any supported .NET data type and
automatically handle the conversion to internal format, so that the developer does not need to think
about conversion issues.

Add/SetValue with UpdateCollectionRequestData

The code to set property values into the UpdateCollectionRequestData IDO protocol class is very
similar to the previous example.
UpdateCollectionRequestData updateRequest = new
UpdateCollectionRequestData();
IDOUpdateItem updateItem = new IDOUpdateItem();
updateItem.Action = UpdateAction.Insert;
updateItem.Properties.Add("UserId", IDONull.Value);

// Set later.
updateItem.Properties.Add("UserName", "MGUser");
updateItem.Properties.Add("RecordDate", DateTime.Now);
updateItem.Properties.Add("RowPointer", Guid.NewGuid());
updateItem.Properties["UserId"].SetValue(100L);
updateRequest.IDOName = "MyIDO";
updateRequest.Items.Add(updateItem);

Getting Property and Parameter Values

Use one of the overloaded GetValue methods to get parameter and property values from the IDO
protocol classes. These examples show how to do this using the LoadCollectionResponseData IDO
protocol class.

GetValue with LoadCollectionResponseData

In this example, the desired native .NET data type is specified as an additional parameter in the call to
GetValue (using the .NET Framework's generics feature).
LoadCollectionResponseData loadResponse;
long userId = 0;

Infor Mongoose - IDO Development Guide | 23

IDO .NET API and Class Library

string userName = null;

DateTime recordDate;
Guid rowPointer;

loadResponse = this.Context.Commands.LoadCollection("UserNames",
"UserId, UserName, RecordDate, RowPointer", "", "", 0);
userId = loadResponse[0, "UserId"].GetValue<long>();
userName = loadResponse[0, "UserName"].GetValue<string>();
recordDate = loadResponse[0, "RecordDate"].GetValue<DateTime>();
rowPointer = loadResponse[0, "RowPointer"].GetValue<Guid>();

Handling Nullable Values

Be aware that if any of the values are null, this version of the GetValue method throws an exception.
When working with nullable values, you have three options to avoid throwing an exception:
 Check the IsNull property before calling GetValue.
 Call the overloaded GetValue method with a default value to be returned in case of null.
 Use .NET nullable value types.
Those three techniques are illustrated in this example:
LoadCollectionResponseData loadResponse;
Nullable<long> userId;

loadResponse = this.Context.Commands.LoadCollection("UserNames",
"UserId, UserName, RecordDate, RowPointer", "", "", 0);

// Check for null before calling GetValue:

if (!loadResponse[0, "UserId"].IsNull) {
userId = loadResponse[0, "UserId"].GetValue<long>();
} else {
userId = -1;
}

// Call GetValue, return -1 if null:

userId = loadResponse[0, "UserId"].GetValue<long>(-1);

// Call GetValue, check for null return value:

userId = loadResponse[0, "UserId"].GetNullableValue<long>();

if (!userId.HasValue)
userId = -1;

24 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Creating Filter Strings

If you need to dynamically build a SQL filter (WHERE clause) to be used in a LoadCollection request,
the framework provides the SqlLiteral class to help build filter strings that contain embedded literals.

SqlLiteral.Format Method
The static SqlLiteral.Format method accepts any supported .NET CLR typed value and converts it
into a literal that can be used when constructing a filter as shown in this example:
string filter = null;

filter = string.Format(
"SessionId = {0} AND trans_num = {1}",
SQL Literal.Format(SessionID),
SQL Literal.Format(TransNum));

The above example produces a filter with the appropriate syntax for the literal values, similar to this:
SessionId = N' 7A4930D6-AE9E-4F32-9687-17ABDBF4E818' and trans_num = 1234

You must always pass in a strongly typed value in order to get the correct result. For example, you
should not pass a string containing a date value.
This table shows some examples of input types, values, and the SqlLiteral.Format result for each.

.NET CLR Type Input Value SqlLiteral.Format Result

System.DateTime 12/31/2006 23:59:59.999 N'20061231 23:59:59.999'
System.Int32 123 123
System.String Joe's Bar N'Joe''s Bar’
System.Decimal 150.32 150.32
System.Guid 7A4930D6-AE9E-4F32- N' 7A4930D6-AE9E-4F32-9687-
9687-17ABDBF4E818 17ABDBF4E818'

Supported .NET CLR Types

These .NET data types are supported by the IDO protocol classes using the GetValue, Add, and
SetValue methods.
System.String System.Char
System.DateTime System.Int32
System.UInt32 System.Int16
System.UInt16 System.Int64
System.UInt64 System.SByte

Infor Mongoose - IDO Development Guide | 25

IDO .NET API and Class Library

System.String System.Char
System.Byte System.Single
System.Double System.Guid
System.Decimal System.Boolean
System.Byte[ ]

Transactions
The IDO runtime automatically executes all UpdateCollection requests in a transaction. It also
executes IDO methods in a transaction if they are marked as "transactional" methods. All other IDO
requests are executed without a transaction. Note that if a method is not marked "transactional" and
is called from a method that is marked "transactional", then it still executes in the caller's transaction.
For transactional IDO methods, if the method returns an integer value less than 5, the transaction is
committed. The exception is if the method was executed within an existing outer transaction. Then
the transaction commits only if and when the outer transaction commits. If the IDO method returns an
integer value greater than or equal to 5 the transaction is rolled back immediately. The Mongoose
standard is to return 16 to indicate a method failed. The transaction also rolls back if the method
throws an exception.
If you need more control over transaction scope, which is often necessary for long running processes,
this can be achieved while still allowing the IDO runtime to manage transactions.
For example, consider a method that posts a large batch of records. We need a method that reads
the batch, loops through each record, and attempts to post it. If the post is successful, the action
commits, otherwise it rolls back. The best way to accomplish this is to create two methods: a top level
entry point method that queries the records to be posted; and another method to do the posting. The
top-level method should not be marked as transactional, while the posting is transactional. The entry
point method queries the records to be posted and loops through each one, calling the posting
method to post each record. This way, if a record fails to post, it does not roll back all posted records,
only the failed record.

Diagnostics and Debugging

Logging Diagnostic Messages

All applications and services in the Infor framework use a common message logging facility. This
enables the framework to provide a single, consolidated view of all activity logged on the local
machine. For developers, this log is available in the IDO Runtime Development Server
(IDORuntimeHost.exe).

26 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Message Logging API

public static void LogUserMessage(
string messageSource,
UserDefinedMessageType messageType,
string message)
{
}

public static void LogUserMessage(

string messageSource,
UserDefinedMessageType messageType,
string format, params object[] args)
{
}

Parameters
 messageSource - A short, user-defined identifier of the source of a message (for example, class
or project name)
 messageType - One of the UserDefinedMessageType enumeration values; used for searching
and filtering log messages
 message - A string containing the log message text
 format - A log message format string (see “String.Format()” in the .NET Framework
documentation for more information about formatting strings)
 args - A variable-length list of format-string substitution parameters

Infor Mongoose - IDO Development Guide | 27

IDO .NET API and Class Library

Examples
IDORuntime.LogUserMessage(
"SLCustomers",
UserDefinedMessageType.UserDefined0,
"Method A() called.");

IDORuntime.LogUserMessage(
"SLCustomers",
UserDefinedMessageType.UserDefined0,
"Parameter 1 is {0}.",
p1);

Wire Tap
You can use the Wire Tap feature of the IDO Runtime Development Server to monitor all the IDO
request and response documents generated by a specific user session. For more information see the
online help for the IDO Runtime Development Server.

Standalone Application Communications

When you create an instance of the Client class, it includes some commands (OpenSession,
GetConfiguration, CloseSession) that are only used for external application communications.
To open sessions or access configuration information from an external application:
1 Create a VS 2010 .NET executable (C#, VB, etc.) or any other program where you can reference
and execute methods on a .NET 4.0 class library.
2 Add references in your project's definition to these Mongoose framework's class libraries.
 IDOProtocol.dll
 IDORequestClient.dll
 MGShared.dll
 WSEnums.dll
 WSFormServerProtocol.dll

Open Session
The OpenSession method is used to create a new session (log in) in the application.

28 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

OpenSession Example
This code sample creates a new Client instance accessing the IDO runtime using the URL in
requestServiceURL, where the URL is similar to this:
http://servername/IDORequestService/RequestService.aspx
Client client = new Client(requestServiceURL, IDOProtocol.Http);
OpenSessionResponseData response = OpenSessionResponseData;

using (client)
{
// Substitute a valid SL user, password, and configuration name:
response = client.OpenSession("user", "password", "config");

if (response.LogonSucceeded)
{
Console.WriteLine("Success");
}

// Close the session when finished:

client.CloseSession();
}
Caution: In the first line of this sample code, for the second argument for Client, you can also use
IDOProtocol.Ipc. This indicates that the client class should connect to the IDO run-time service on
the local machine. In this case, requestServiceURL is ignored.

This is equivalent to using the default constructor:

Client client = new Client();

Close Session
The CloseSession method is used to close an existing session (log out).
The OpenSession example above also includes an example of CloseSession.

GetConfigurations
Mongoose configuration information is stored in MongooseConfigs.xml. By default, this file is created
and resides in C:\Documents and Settings\All Users\Application Data\Mongoose.
The Client class accesses configuration information through the ConfigServer.aspx page
(IDORequestService ASP.NET Web server application) in conjunction with the IDO Runtime Service
or the IDORuntimeHost.exe developer tool. The Web Server application, IDO Runtime Service and

Infor Mongoose - IDO Development Guide | 29

IDO .NET API and Class Library

IDORuntimeHost.exe are all installed as part of a utility server installation. Configuration information
obtained using the GetConfigurations static method includes a subset of configuration properties and
all of the referenced application properties.
In code that utilizes the Client class, include these using statements (Import statements if written in a
VB project):
using Mongoose.IDO;
using Mongoose.IDO.Protocol;
using Mongoose.Core.Configuration;

ConfigurationInfo Example 1
This snippet of code retrieves an array of ConfigurationInfo classes through the IDORequestService.
Infor IDO Runtime Service must be running for this method to work.
//*******************************************************************
// This line calls the IDORequestClient ASPX web application
// to retrieve the configuration list via an array of
// ConfigurationInfo classes.
// Parm -> URL to IDORequestClient's ConfigServer.apsx file.
//*******************************************************************

ConfigurationInfoList configList = null;

configList = Client.GetConfigurations(
@"http://server1/
IDORequestService/ConfigServer.aspx", "Acme" );

// Config info can be enumerated as follows:

foreach ( ConfigurationInfo config in configList )
{
// Do whatever...
}

30 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

ConfigurationInfo Example 2
This snippet of code retrieves an array of ConfigurationInfo classes through IDORuntimeHost.exe.
(IDORuntimeHost.exe must be running for this method to work.)
//*******************************************************************
// This line calls through to the local IDO runtime service
// (IPC protocol) to retrieve the configuration list via an array of
// ConfigurationInfo classes.
// Note: No parameter is passed to the GetConfigurations() method.
//*******************************************************************
ConfigurationInfoList configList = null;
configList = Client.GetConfigurations();
// Config info can be enumerated as follows:
foreach ( ConfigurationInfo config in configList )
{
// Do whatever.
}

Properties
These configuration/application properties are available through the ConfigurationInfo class.
Caution: Some information in the MongooseConfigs.xml file related to database connections, user
names, passwords, etc., is encrypted. The methods described here simply retrieve the encrypted
strings for these entities. If they need programmatic access to this information (that is, decrypted
strings), contact Infor Professional Services to discuss methods for decrypting it.
public bool ActiveScriptingOnly;
public string AppName;
public string AppURL;
public string BaseHelpFile;
public bool ColSecurityPrimaryOnly;
public string CompanyName;
public string Copyright;
public string DefFormBGColor;
public string DefFormFGColor;
public string DefFormFont;
public string DefNormalBGColor;
public string DefNormalFGColor;
public string DefReadOnlyBGColor;
public string DefReadOnlyFGColor;
public string DefRequiredBGColor;
public string DefRequiredFGColor;
public string DefTbdBGColor;
public string DefTbdFGColor;

Infor Mongoose - IDO Development Guide | 31

IDO .NET API and Class Library

public string DeleteExistingPrompt;

public string DeleteNewPrompt;
public bool DisableInvalidValuePrompt;
public string FormCLSID;
public string FormFileExtension;
public string FormsURL;
public string HelpBasePath;
public string HelpContentsIndexMenuText;
public string HorzComponentSpacing;
public string IconFilename;
public string LoginOverrideProgID;
public string Name;
public string ObjectMenuName;
public bool PrimaryCacheUsesFormCaption;
public string ProgIDRootAugment;
public string ReportViewerExecutable;
public string ReportViewerExecutablePath;
public bool RightJustifyNewLabels;
public string SplashFilename;
public bool UseHtmlHelp;
public bool ValidationErrorIndicators;
public string VBAFilename;
public string Version;
public string VertComponentSpacing;
public string WallpaperDisplayOption;
public string WallpaperFilename;
public bool XPVisualStyle;

MongooseConfigs Class (MGShared.dll Class Library)

An alternative way to get configuration information programmatically is to use the MongooseConfigs
class. It accesses configuration information directly through a set of methods that load an XML file
and parse the XML information into retuned classes. An instance of the class must be instantiated
and separate methods are used to retrieve the list of configurations, configuration properties,
application properties, and DB connection information (DB connection information is returned as an
encrypted string.)
To do this:
1 Create a VS 2010 .NET executable (C#, VB, etc.) or any other program where you can reference
and execute methods on a .NET 4.0 class library.
2 Add a reference in your project's definition to the MGShared.dll Mongoose framework's class
library.

32 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

3 In code that utilizes the Client class, include these "using" statements (Import statements if written
in a VB project)
using Mongoose.Core.Configuration;
using Mongoose.Core.Common;

Example
This snippet of code retrieves an array of configuration names, gets the application name and a
couple of application properties, and finally retrieves the Runtime Forms Database name (encrypted):
// Create instance of ManageConfigs class:
MongooseConfigs ManageConfigs = null;
ManageConfigs = new MongooseConfigs();

// Load MongooseConfigs.xml:
ManageConfigs.Load(true);

// Get array of the configuration names:

string[] configNames = ManageConfigs.GetConfigNames();

foreach ( string configName in configNames )

{
// Get config info:
Configuration config = ManageConfigs.GetConfig( configName );
// Get Application info:
AppProperties appInfo = ManageConfigs.GetAppProperties(
config.Application );

// Get Connection Info (most properties here are encrypted):

ConnectionProfile connProfile = ManageConfigs.GetFormsConnection(
configName,
ConnectionProfileType.Runtime );

// NOTE: Various information can be retrieved from the

// Configuration, AppProperties, and ConnectionProfile classes.
// You can view the available class properties
// via IntelliSense when programming against them.
}

Properties
These configuration/application properties are available through the Configuration class:
public string Application;
public string ConfigName;

Infor Mongoose - IDO Development Guide | 33

IDO .NET API and Class Library

public ArrayList ConnectionRoles;

public bool FormControlSSEnabled;
public string ObjectStudioProjBuildDir;
public bool ObjectStudioSSEnabled;
public string SSPassword; //(encrypted string)
public string SSProjectName;
public string SSUNCPath;
public string SSUserId; //(encrypted string)
These configuration/application properties are available through the AppProperties class:
public bool ActiveScriptingOnly;
public string Application;
public string AppName;
public string BaseHelpFile;
public bool ColSecurityPrimaryOnly;
public string CompanyName;
public string Copyright;
public string DefFormBGColor;
public string DefFormFGColor;
public string DefFormFont;
public string DefNormalBGColor;
public string DefNormalFGColor;
public string DefReadOnlyBGColor;
public string DefReadOnlyFGColor;
public string DefRequiredBGColor;
public string DefRequiredFGColor;
public string DefTbdBGColor;
public string DefTbdFGColor;
public string DeleteExistingPrompt;
public string DeleteNewPrompt;
public bool DisableInvalidValuePrompt;
public string FormCLSID;
public string FormFileExtension;
public string HelpBasePath;
public string HelpContentsIndexMenuText;
public string HorzComponentSpacing;
public string IconFilename;
public string LoginOverrideProgID;
public string ObjectMenuName;
public bool PrimaryCacheUsesFormCaption;
public string ProgIDRootAugment;
public string RelFormServerURL;
public string RelWebServerURL;

34 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

public string ReportViewerExecutable;

public string ReportViewerExecutablePath;
public bool RightJustifyNewLabels;
public string SplashFilename;
public bool UseHtmlHelp;
public bool ValidationErrorIndicators;
public string VBAFilename;
public string Version;
public string VertComponentSpacing;
public string WallpaperDisplayOption;
public string WallpaperFilename;
public bool XPVisualStyle;

External Data Store

The External Data Store facility provides a framework API to store data from within a session and
then allow another process to fetch the data, knowing only the configuration name and key. (There is
no need to log in, directly access the database, etc.)

External Data Store - Stored Procedures

These stored procedures can be called directly or through the ExternalDataStores IDO.
 CreateDataStoreEntrySp(@AccessKey, @Lifetime, @Value, @Infobar)
Inserts a record into the ExternalDataStore table with the specified @AccessKey, @Lifetime, and
@Value.
 DeleteDataStoreEntrySp(@AccessKey, @Infobar)
Deletes a record from the ExternalDataStore table that has the specified @AccessKey.
 FetchDataStoreEntrySp(@AccessKey, @Value, @Infobar)
Fetches a value from the ExternalDataStore table with the specified @AccessKey.
The @Value is returned in an output parameter.

Infor Mongoose - IDO Development Guide | 35

IDO .NET API and Class Library

Parameters
Parameter Description
@AccessKey The key value used to uniquely identify the external data store item. It is
up to the developer to create a unique key. For example, you might use
the user’s current session ID plus a row pointer as the key.
@Lifetime Numeric value that determines the lifetime of the external data store
item.
 0 = Delete on fetch
 1 = Delete on session close
 2 = Keep until explicitly deleted
@Value The data value that is being stored/fetched.
@Infobar A message returned by the stored procedure in an output parameter.

Examples
// Create a new data store entry.
EXEC CreateDataStoreEntrySp
@AccessKey = 'my key'
, @Lifetime = 0
, @Value = 'my value'
, @Infobar = @Infobar OUTPUT

// Delete the specified data store entry.

EXEC DeleteDataStoreEntrySp
@AccessKey = 'some key'
, @Infobar = @Infobar OUTPUT

// Fetch the value from the specified data store entry.

EXEC FetchDataStoreEntrySp
@AccessKey = 'my key'
, @Value = @Value OUTPUT
, @Infobar = @Infobar OUTPUT

External Data Store - Client Method

This static method in the Client class can be used to fetch an external data store value by passing the
configName and accessKey.
 FetchDataStoreEntry( string configName, string accessKey )
Fetches a value from the ExternalDataStore table with the specified accessKey.

36 | Infor Mongoose - IDO Development Guide

 IDO .NET API and Class Library

Parameters
Parameter Description
configName The configuration name
accessKey The key value used to uniquely identify the external data store item.

Examples
using Mongoose.IDO.Protocol;
using Mongoose.IDO;

// Fetch a data store entry.

string configName = "MyConfig";
string accessKey;

// Retrieve accessKey generated by the CreateDataStoreEntrySp

// stored procedure.
string value = Client.FetchDataStoreEntry(configName, accessKey);

Infor Mongoose - IDO Development Guide | 37

IDO .NET API and Class Library

38 | Infor Mongoose - IDO Development Guide

Chapter 2: IDO Extension Classes
2

About Extension Classes

An IDO extension class is a .NET class that allows developers to extend the functionality of an
existing IDO by adding methods and event handlers. IDO extension classes are compiled into a .NET
class library assembly and stored in the IDO metadata database. The IDO runtime engine loads these
assemblies on demand and calls methods and event handlers in the extension classes in response to
IDO requests.
An extension class is short-lived; it is created at the start of a request and disposed of immediately
when the response is completed. Therefore, no state should be stored in an extension class.
Any public class in an IDO extension class assembly can be identified as the extension class for an
IDO in the IDO metadata database.
IDO extension class assemblies are created from VisualStudio 2010 class library projects. The
projects can use any of the .NET languages; however, all code samples and procedures described in
this document use VB.NET.

Creating an IDO Extension Class Project

To create an IDO extension class project:
1 Open VisualStudio 2010 and from the File menu, select New > Project.
2 In the New Project dialog box:
 For the project type, select Visual Basic.
 Select the Class Library template.
3 Specify a name and location for your project and click OK.
4 The new project will contain a class file named Class1.vb. Right click the file in the Solution
Explorer and delete it.
5 From the Project menu, select Add Reference.
6 In the Add Reference dialog box, click the Browse tab and navigate to the Infor Mongoose
Framework installation directory. Add references to these assemblies:

Infor Mongoose - IDO Development Guide | 39

IDO Extension Classes

 IDOCore.dll
 IDOBase.dll
 IDOProtocol.dll
 MGShared.dll
 WSEnums.dll
7 From the Project menu, select Add New Item.
8 Select Code File, name the new file AssemblyInfo.vb, and click Add.
9 Open the new AssemblyInfo.vb source file and add this assembly attribute:
<Assembly: Mongoose.IDO.IDOExtensionClassAssembly("assembly-name")>

Substitute a meaningful name for the assembly-name parameter. This can be anything but
typically is the name of the IDO project associated with the classes in this assembly. When this
class library is imported to the IDO Custom Assemblies form, the name you specify here
becomes the name of the assembly.
Caution: If you add a reference to another assembly from your IDO extension class assembly, the
referenced assembly must also be imported as another custom assembly. When .NET tries to locate
the referenced assembly, the IDO runtime service searches the database for a matching assembly
and loads it on demand.

Importing Assemblies
To import assemblies, use the IDO Custom Assemblies form.
Link the IDO to the custom assembly on the IDOs form by checking out the IDO and entering the
Custom Assembly Name (the Assembly Name from the IDO Custom Assemblies form), the Ext
Class Name (the name of the class—usually the same as the IDO), and the Ext Class Namespace
(usually the same as the Project Name).
Link the methods in the extension class to the IDO by entering the Method Name and specifying the
Parameters list on the IDO Methods form. The Method Type will be Handcoded - Standard
Method or Handcoded - Custom Load Method.

40 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

Implementing an IDO Extension Class

Mongoose.IDO.IIDOExtensionClass Interface
In order for an extension class to access the calling user's context (session information, databases,
and so forth), the extension class should implement the IIDOExtensionClass interface in the
Mongoose.IDO namespace.
public interface IIDOExtensionClass
{
void SetContext(Mongoose.IDO.IIDOExtensionClassContext
context);
}

Mongoose.IDO.IIDOExtensionClassContext Interface
The SetContext method is called once when the extension class is created, passing a reference to
the IIDOExtensionClassContext interface for accessing the calling user's context.
public interface IIDOExtensionClassContext
{
Mongoose.IDO.IVirtualIDO IDO { get; }
Mongoose.IDO.IIDOCommandHelper Commands { get; }
}

The framework provides a class named Mongoose.IDO.ExtensionClassBase that is intended to be

used as the base class for most typical IDO extension classes. This class provides a default
implementation of the IIDOExtensionClass interface and provides a number of methods to facilitate
calling methods, loading and updating collections, and other common tasks, which will be covered
later.

Infor Mongoose - IDO Development Guide | 41

IDO Extension Classes

Declaration of an IDO Extension Class for an IDO

When declaring an IDO extension class, you can add the optional IDOExtensionClass attribute in
order to facilitate adding the necessary IDO metadata to associate an extension class with an IDO.
This sample code shows how to associate an extension class with the SLJobMats IDO.
[IDOExtensionClass("SLJobtMats")]
public class SLJobtMats : ExtensionClassBase
{
// ...Implementation goes here...
}

It is generally a good idea to import some common framework namespaces to make your code less
verbose and more clear, and to enable the Explicit and Strict VB compiler options.

IDO Extension Class Starter Template

This sample code can be used as a template for creating new IDO extension classes.
using Mongoose.IDO;
using Mongoose.IDO.Protocol;
using Mongoose.IDO.DataAccess;
using Mongoose.Core.Common;

[IDOExtensionClass("class-name")]
public class class-name : ExtensionClassBase
{
// optionally override the SetContext method
// public override void SetContext(
// IIDOExtensionClassContext context )
// {
// call base class implementation
// base.SetContext(context);
//
// Add event handlers here, for example:
// context.IDO.PostLoadCollection +=
// new IDOEventHandler( IDO_PostLoadCollection );
// }
// ...Implementation goes here...
}

42 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

Adding Methods
To call a method on an IDO extension class, the method must be declared as public and it must also
be defined in the IDO metadata as a hand-coded method. This is different from previous versions of
the framework, where the metadata for a method was defined by convention, using the Do not
generate source attribute, but not required.
A hand-coded method can be either a standard method, which is a Function with zero or more input/
output parameters and returns an integer; or a custom load method, which is a Function with zero or
more parameters and returns an instance of either an IDataReader or a DataTable (see the .NET
Framework documentation for information about these).
When implementing a hand-coded method that will be callable through the IDO runtime, you could
add the optional IDOMethod attribute, which can be used in the future to facilitate adding the
necessary IDO metadata to make the method accessible.

Sample Standard Method Call

For example, the declaration of a standard method might look like this Function declaration:
[IDOMethod(MethodFlags.None, "Infobar")]
public int DoWork(string SessionID, long TransNum, ref string
Infobar)
{
// ...Implementation goes here...
}

IDOMethod Parameters
The IDOMethod attribute takes two optional parameters: flags and messageParm.

Flags
The flags parameter is one or more of the values defined by the MethodFlags enumeration. This
table shows the MethodFlags values:

MethodFlags value Description

None Standard method call.
CustomLoad Custom load method.
RequiresTransaction Method runs in the context of a transaction.

Infor Mongoose - IDO Development Guide | 43

IDO Extension Classes

MessageParm
The messageParm parameter is a string and is the name of the parameter that will be used to return
messages to the caller (Infobar). The parameter that is identified should be declared as a String and
passed by reference.
Remember that these attributes are not used at run time. They might be used in the future to facilitate
adding and synchronizing the IDO metadata for an extension class and its methods when an
assembly is imported.

Including Filters in Custom Load Methods to Load Collections

When a custom load method is used to load a collection, the filters defined on an IDO are not applied
automatically by the system, so you must explicitly implement the filtering in the custom method.
(Before you implement a custom load method, you should be very familiar with the IDO definition.)
The system passes the currently active filter to the method if the method defines a specifically-named
parameter. For methods that are hand-coded in .NET, this parameter must be named IdoFilter and it
must be of type string. For stored procedure methods, this parameter must be named @IdoFilter
and it must be of type nvarchar(max). This must be the last parameter listed for the method.
However, when you specify method parameters in the IDO metadata (that is, by using the
development forms IDOs, IDO Methods, and IDO Method Parameters) or in WinStudio Design
mode, you must not provide this filter parameter. It is an implicit parameter that the system satisfies if
it exists; however, if the parameter does not exist, the method still works. There is no logical value that
can be specified in the IDO metadata or design mode for the filter parameter, since it varies
depending on who is logged in, which groups they are members of, and so on.
The filter that is passed is a fully-parsed, valid SQL filter. The filter can be appended with a
conjunction to the WHERE clause of a query, or the filter by itself can be the entire clause for the
query. However, since the filter can refer to any table referenced in the IDO definition, you must make
sure that any tables referenced in the filter are present in the query.

Using Variables and a Bookmarking Algorithm to Get More Rows

in a Custom Load Method
In order to include the “Get More Rows” functionality in a custom load method, you must create a
bookmarking algorithm. The framework provides and receives relevant information for bookmarking
through these variables:
 EnableBookmark: This is set to either True or False, depending on whether the load request
wants to apply bunching. If the variable is set to False, the custom load method is expected to
ignore bunching.
 Bookmark: This is the bookmark value. It is blank for an initial load type, and contains values for
bookmarks (which the algorithm must create) for subsequent load calls. A bookmark must
uniquely identify a set of rows, referred to as a "bunch."

44 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

 LoadType: This is set to First, Last, Next, or Prev. First and Last are initial load types: when a
collection initially loaded, a bookmark is not needed and the framework expects either the first or
the last bunch to be returned. Next and Prev are used on subsequent loads with a bookmark, and
the framework expects the bunch either after or before the bunch identified by the bookmark. For
the Last and Prev load types (essentially, “browsing backward" through the collection), the
returned rows are expected to be sorted in reverse order.
 RecordCap: This is the maximum number of rows the framework expects to be returned for a
single bunch. NOTE: The method is expected to return one extra row (RecordCap+1 rows total),
if it is available. The framework uses this information to determine whether there are more rows
available to be queried for the next bunch. The bookmark is still expected to identify uniquely the
set of rows that will be returned to the user; the extra row is not considered part of the set.
After the custom load method constructs the set of rows it is going to return, it is expected to update
the Bookmark variable with a unique value that represents the set of rows it is returning.
Custom load methods that are implemented as stored procedures receive these variables through the
use of process variables (see “Process Variables” on page 57). Before it calls into a custom load
method, the framework creates these variables from the load request that generated the call. Upon
return, the framework checks the process variable called “Bookmark” for the new bookmark. Custom
load methods that are implemented as hand-coded methods have access to the load request
structure, which contains these variables as properties of the request.

Bookmarking Algorithms
Although you must create the bookmarking algorithm for your custom load method, Infor provides
some examples.
Example 1: If you have a collection with a unique, consecutive integer row number property, your
bookmark could be a single number, and the custom load method sorts the collection by that property
and returns the top RecordCap+1 rows for a load type of First, setting the bookmark to the second-to-
last row's number. Loads of type Next return RecordCap+1 rows, where RowNumber > bookmark.
The method performs similarly for load types Last and Prev, except that it sorts in reverse order and
uses RowNumber < bookmark. The algorithm must have special cases for an empty result set, and
for a single row being returned.
Example 2: The algorithm the framework uses for standard loads is more complicated, since it must
work with any possible collection, combination of properties being loaded, etc. The bookmark is an
XML fragment with this schema:
<B>
<P><p>ColumnName1</p><p>ColumnName2</p>…</P>
<D><f>DescendingFlag1(true or false)</f><f>Flag2</f>…</D>
<F><v>FirstRowValue1</v><v>FirstRowValue2</v>…</F>
<L><v>LastRowValue1</v><v>LastRowValue2</v>…
</B>
This XML fragment is combined with the <RecordCap> and <LoadType> elements in the request.
The framework fills the bookmark with the data necessary to uniquely describe the set of rows that it
just retrieved. It uses either the RowPointer column, or a set of columns that make up a unique key,
together with a descending flag for each column, and the values of those columns in the first and last
rows of the set.

Infor Mongoose - IDO Development Guide | 45

IDO Extension Classes

IDO Event Handlers

When an IDO is processing a LoadCollection or UpdateCollection request, it fires several events. An
IDO extension class can add its own event handlers to these events to get control when these events
are fired.
The available events are:

Event Description
PreLoadCollection Fires when a LoadCollection request is received.
PostLoadCollection Fires after a LoadCollection request has been processed.
PreUpdateCollection Fires when an UpdateCollection request is received.
PostUpdateCollection Fires after an UpdateCollection request has been processed.

Adding an IDO Event Handler

IDO event handler methods should be declared as private "Sub" methods in your IDO extension
class. These methods should use the same signature as this example:
private void HandlePreLoadCollection(
Object sender,
IDOEventArgs args)

These IDO events are available on the IDO property of the IIDOExtensionClassContext interface. To
add your handler to an IDO event you must override the ExtensionClassBase.SetContext method in
your IDO extension class and use the AddHandler keyword as shown in this example.
public override void SetContext(IIDOExtensionClassContext context)
{
// Call the base class implementation:
base.SetContext(context);

// Add event handlers here, for example:

this.Context.IDO.PreUpdateCollection += this.PreUpdateCollection;
}

Event Handler Parameters

The first parameter on an IDO event handler method is the sender parameter, which is simply a
reference to the IDO that initiated the event. This is equivalent to the
IIDOExtensionClassContext.IDO property.

46 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

The second parameter is an instance of the IDOEventArgs class which allows you to access the
original IDO request that initiated the event, and for the Post events, the IDO response also.
public class IDOEventArgs : EventArgs
{
public PayloadBase RequestPayload { get; }
public PayloadBase ResponsePayload;
}

This table describes the contents of the IDOEventArgs parameter for each IDO event.

Event RequestPayload property ResponsePayload field

PreLoadCollection Contains an instance of the Nothing
LoadCollectionRequestData
class that the IDO is
processing
PostLoadCollection Contains an instance of the Contains an instance of the
LoadCollectionRequestData LoadCollectionResponseData
class that the IDO processed class that will be returned to the
caller
PreUpdateCollection Contains an instance of the Nothing
UpdateCollectionRequestDat
a class that the IDO is
processing
PostUpdateCollection Contains an instance of the Contains an instance of the
UpdateCollectionRequestDat UpdateCollectionResponseData
a class that the IDO class that will be returned to the
processed caller

An event handler method can access the IDO request and response payloads as shown in this
examples.
private void HandlePreLoadCollection(object sender, IDOEventArgs
args)
{
// Get the original request:
LoadCollectionRequestData loadRequest = LoadCollectionRequestData;

loadRequest = (LoadCollectionRequestData)args.RequestPayload;

// ...Additional logic based on loadRequest.

}

private void HandlePostLoadCollection(object sender, IDOEventArgs

args)
{

Infor Mongoose - IDO Development Guide | 47

IDO Extension Classes

// Get the original request:

LoadCollectionRequestData loadRequest = LoadCollectionRequestData;
LoadCollectionResponseData loadResponse =
LoadCollectionResponseData;

loadRequest = (LoadCollectionRequestData)args.RequestPayload;
loadResponse = (LoadCollectionResponseData)args.ResponsePayload;

// ...Additional logic based on loadRequest or loadResponse.

}

private void HandlePreUpdateCollection(object sender, IDOEventArgs

args)
{

// Get the original request:

UpdateCollectionRequestData updateRequest =
UpdateCollectionRequestData;
updateRequest = (UpdateCollectionRequestData)args.RequestPayload;

// ...Additional logic based on updateRequest.

}

private void HandlePostUpdateCollection(object sender, IDOEventArgs

args)
{

// Get the original request:

UpdateCollectionRequestData updateRequest =
UpdateCollectionRequestData;
UpdateCollectionResponseData updateResponse =
UpdateCollectionResponseData;

updateRequest = (UpdateCollectionRequestData)args.RequestPayload;
updateResponse =
(UpdateCollectionResponseData)args.ResponsePayload;

// ...Additional logic based on loadRequest or loadResponse.

}

48 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

Special Cases for UpdateCollection Events

There are special cases when an IDO UpdateCollection request might not process all items in the
update. For example, this might happen when a caller is saving hierarchical data, which is
represented as an UpdateCollection request with nested UpdateCollection child requests. The
framework first processes only the deleted items in the child requests, then all items in the parent,
followed by the inserted or updated items in the child requests. This example shows how an event
handler can determine if the framework is processing inserted, update and/or deleted items.
private void HandlePostUpdateCollection(object sender, IDOEventArgs
args)
{

// Get the original request:

UpdateCollectionRequestData updateRequest =
UpdateCollectionRequestData;
UpdateCollectionResponseData updateResponse =
UpdateCollectionResponseData;
IDOUpdateEventArgs updateArgs = IDOUpdateEventArgs;

updateArgs = (IDOUpdateEventArgs)args;
updateRequest = (UpdateCollectionRequestData)args.RequestPayload;
updateResponse =
(UpdateCollectionResponseData)args.ResponsePayload;

if ((updateArgs.ActionMask & UpdateAction.Delete) ==

UpdateAction.Delete)
{
// ...Only perform this logic if processing deleted items:
}

if ((updateArgs.ActionMask & UpdateAction.Insert) ==

UpdateAction.Insert)
{
// ...Only perform this logic if processing inserted items:
}

if ((updateArgs.ActionMask & UpdateAction.Update) ==

UpdateAction.Update)
{
// ...Only perform this logic if processing updated items:
}
// ...Additional logic based on loadRequest or loadResponse.
}

Infor Mongoose - IDO Development Guide | 49

IDO Extension Classes

Using the ActionMask Property

In the example above, the IDOUpdateEventArgs class inherits from IDOEventArgs, but has one
additional property: ActionMask. The ActionMask is declared as an UpdateAction, which is an enum
(shown below).
public enum UpdateAction : ushort
{
None = (ushort)0x0000,
Insert = (ushort)0x0001,
Update = (ushort)0x0002,
Delete = (ushort)0x0004,
All = (ushort)0xffff
}

The ActionMask is usually a combination of Insert, Update and Delete (All), meaning the
UpdateCollection that was just performed executed all types of actions.
However, there are certain circumstances when this can be a subset of Insert, Update and Delete,
which means only the items that match the mask were actually saved. There are times when the IDO
runtime must save items in a particular order (with nested updates), and it might first process only
deleted items; then in another pass it executes all inserts and updates.
ActionMask is valid for both Pre- and PostUpdateCollection. The PreUpdateCollection parameters
are the same as the PostUpdateCollection parameters – but the action indicates which items are
about to be saved, rather than which items were just saved.

Replacing Standard IDO Processing with Event Handlers

By adding event handlers, not only can you perform additional logic when a particular event fires, but
in the case of PreUpdateCollection and PreLoadCollection you can also completely replace the
default framework implementation by constructing your own response and setting that in the
IDOEventArgs.ResponsePayload field. This example shows how this is done for an UpdateCollection
request.
private void HandlePreUpdateCollection(object sender, IDOEventArgs
args)
{
// Get the original request:
UpdateCollectionRequestData updateRequest =
default(UpdateCollectionRequestData);
UpdateCollectionResponseData updateResponse =
default(UpdateCollectionResponseData);
updateRequest = (UpdateCollectionRequestData)args.RequestPayload;
updateResponse = new UpdateCollectionResponseData(updateRequest);
// Process items in the request, filling in the response...

50 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

// Override the standard processing, returning my

// custom response instead:
args.ResponsePayload = updateResponse;
}

Generating Application Events

The ExtensionClassBase class provides a method named FireApplicationEvent that can be used to
generate an application event.
protected bool FireApplicationEvent(string eventName,
bool sychronous,
bool transactional,
ref string result,
ref ApplicationEventParameter[] parameters)
{
}

Properties
Property Description
eventName The name of the event to generate
synchronous Determines if the event handlers should be executed synchronously (True)
or asynchronously (False).
transactional Determines if the event handlers should be executed in a transaction. If
passed as False and one of the synchronous handlers fails, any database
activity performed by prior handlers remains committed.
result The value of the last RESULT() keyword executed on a Finish or Fail action
on any handler.
parameters An array of named parameters passed to the event handlers.

Example
using Mongoose.IDO;
using Mongoose.IDO.Protocol;
using Mongoose.IDO.DataAccess;
using Mongoose.Core.Common;

[IDOExtensionClass("MyIDO")]
public class TestFiringEvent : ExtensionClassBase

Infor Mongoose - IDO Development Guide | 51

IDO Extension Classes

{
[IDOMethod(MethodFlags.None, "Infobar")]
public void FireMyEvent(string Parm1, long Parm2, ref string
Infobar)
{
ApplicationEventParameter[] ParmList = new
ApplicationEventParameter[2];
string result = null;
ParmList[0] = new ApplicationEventParameter();
ParmList[0].Name = "PString";
ParmList[0].Value = Parm1;
ParmList[1] = new ApplicationEventParameter();
ParmList[1].Name = "PNumeric";
ParmList[1].Value = Parm2.ToString();
if (!FireApplicationEvent("MyEvent", true, true, out result,
ref ParmList))
{
Infobar = result;
}
}
}

Code Samples
Caution: The examples in this section assume you are writing code in an IDO extension class that
inherits from the Mongoose.IDO.ExtensionClassBase class.

LoadCollection Examples
This sample code demonstrates executing a LoadCollection for the SLTtJobtMatPosts IDO, bringing
back the TransNum and TransSeq properties.
LoadCollectionResponseData loadResponse =
default(LoadCollectionResponseData);
loadResponse = this.Context.Commands.LoadCollection(
"SLTtJobtMatPosts",
"TransNum,TransSeq",
[filter],
string.Empty, 0);

52 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

This sample demonstrates executing a LoadCollection for the IDO that the extension class belongs to
(the current instance of the executing IDO).
LoadCollectionResponseData loadResponse = LoadCollectionResponseData;
loadResponse = this.LoadCollection(
"TransNum, EmpNum, EmpEmpType, EmpDept, DerJobPWcDept ",
[filter],
"Posted, LowLevel DESC, Job, Suffix, CloseJob, TransNum", 0);

This sample demonstrates one way to iterate through items in a LoadCollectionResponseData

instance returned from a LoadCollection request, and how to access property values.
string empNum = null;

for (int index = 0; index <= responseData.Items.Count; index++)

{
if (!responseData[index, "EmpNum"].IsNull)
{
empNum = responseData[index, "EmpNum"].Value;
// ...Processing...
}
}

UpdateCollection Examples

Inserting a New Item

This sample demonstrates inserting a new item.
UpdateCollectionRequestData request = new
UpdateCollectionRequestData();
UpdateCollectionResponseData response;
IDOUpdateItem customerItem = new IDOUpdateItem();

request.IDOName = "SLCustomers";
request.RefreshAfterUpdate = true;
customerItem.Action = UpdateAction.Insert;
customerItem.Properties.Add("CoNum", "C000100");
customerItem.Properties.Add("Name", "New Company");
customerItem.Properties.Add("CreditHold", 1);
request.Items.Add(customerItem);
response = this.Context.Commands.UpdateCollection(request);

Infor Mongoose - IDO Development Guide | 53

IDO Extension Classes

Updating an Existing Item

This sample demonstrates updating an existing item queried through a LoadCollection request.
LoadCollectionResponseData loadResponse = new
LoadCollectionResponseData();
UpdateCollectionRequestData request = new
UpdateCollectionRequestData();
UpdateCollectionResponseData response;
IDOUpdateItem customerItem = new IDOUpdateItem();

loadResponse = this.Context.Commands.LoadCollection("SLCustomers",
"CoNum, Name, CreditHold", "CoNum = N'C000100'", "", 1);

if (loadResponse.Items.Count == 1)
{
request.IDOName = "SLCustomers";
request.RefreshAfterUpdate = true;

// Must have the ItemID to update or delete...

customerItem.ItemID = loadResponse.Items[0].ItemID;
customerItem.Action = UpdateAction.Update;
customerItem.Properties.Add("CreditHold", 0);
request.Items.Add(customerItem);
response = this.Context.Commands.UpdateCollection(request);
}

Invoke Example
This sample demonstrates invoking the JobtClsLogErrorSp method on the SLJobtCls IDO, passing
two parameters and retrieving the output value for the second parameter.
InvokeResponseData invokeResponse = new InvokeResponseData();
string message = null;
invokeResponse = this.Context.Commands.Invoke("SLJobtCls",
"JobtClsLogErrorSp", [transNum], IDONull.Value);
message = invokeResponse.Parameters[1].Value;

54 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

AppDB Class
The AppDB class, part of the Mongoose.IDO.DataAccess namespace, provides direct access to the
application database, plus access to common framework features such as application messages and
session variables. You can create a new instance of this class by calling the CreateAppDB method,
which is implemented by the ExtensionClassBase class.
AppDB db = Mongoose.IDO.IDORuntime.Context.CreateAppDB();

Application Database Connections

In general, the best practice to access the database to execute queries, updates or stored procedure
calls is to go through the Infor framework using IDO requests. However, there might be times when it
is necessary or more efficient to access the database directly (for example, building and executing
dynamic SQL or iterating through records from an extremely large query result set). Direct database
access is accomplished using the standard .NET Framework SQL Server classes: SqlConnection
and SqlCommand. See the Microsoft .NET Framework documentation for more information on these
classes.

Opening a Connection to the Application SQL Server Database

The AppDB.Connection property provides an opened SqlConnection instance pointing to the
application database. By going through the AppDB.Connection property, the framework is able to
open and initialize the connection based on the calling user's session information.

Executing SQL Server Commands

The SqlCommand class is used to execute stored procedures, queries, updates, or any other T-SQL
command. The SqlCommand may be created by using the VB New operator and setting the
necessary properties on the command, as described in the .NET Framework documentation.
However, when the command is executed, you should use the AppDB.ExecuteScalar,
AppDB.ExecuteNonQuery, or AppDB.ExecuteReader methods. This allows you to leverage the
framework infrastructure for executing SQL commands including logging and exception-message
translation.

Application Messages
Access to translatable strings and messages stored in the application database message tables is
implemented by the AppDB class. The strings and messages that are returned are queried and
constructed according to the calling session's regional settings. Access is provided through the
IMessageProvider interface and makes use of application database messaging stored procedures
such as MsgAppSp.

Infor Mongoose - IDO Development Guide | 55

IDO Extension Classes

These methods are published by the IMessageProvider interface:

Method Description
public string GetMessage( Get a string or message by message ID.
string msgID)
public string GetMessage( Get a string or message by message ID with
string msgID, substitution parameters.
params object[] args)
public string AppendMessage( Append a string or message by message ID.
string message,
string msgID)
public string AppendMessage( Append a string or message by message ID with
string message, substitution parameters.
string msgID,
params object[] args)
public string GetErrorMessage( Get a constraint error message by object name
string objectName, and type.
AppMessageType messageType)
public string GetErrorMessage( Get a constraint error message by object name
string objectName, and type with substitution parameters.
AppMessageType messageType,
params object[] args)

Message Lookup Using the AppDB Class

This example shows how to use the AppDB class to retrieve messages.
IMessageProvider messageProvider = null;

using (AppDB appDB = this.CreateAppDB())

{
messageProvider = appDB.GetMessageProvider();
Infobar = messageProvider.AppendMessage(Infobar,
"I=CmdMustPerform",
"@:PostPendingMaterialTransactions");
}

If you are writing code in an extension class method for a class that derives from
ExtensionClassBase, you can simply call the ExtensionClassBase.GetMessageProvider method as a
shortcut to getting a reference to the IMessageProvider interface, as shown in this example:
IMessageProvider messageProvider = null;
messageProvider = this.GetMessageProvider();

56 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

Session Variables
The AppDB class publishes these methods for manipulating session variables for the caller's session.

Method Description
public void SetSessionVariable( Set the value of a session variable.
string name,
string varValue)
public string GetSessionVariable( Get the value of a session variable.
string name)
public string GetSessionVariable( Get the value of a session variable, returning
string name, the specified default value if it does not exist.
string defaultValue)
public string GetSessionVariable( Get the value of a session variable, returning
string name, the specified default value if it does not exist,
string defaultValue, and delete it if it does exist.
bool delete)
public void Delete a session variable.
DeleteSessionVariable(
string name)

Process Variables
Process variables are similar to session variables, except the scope is tied to a single database
connection. This is unlike sessions, which span any number of database connections. A process
variable declared before one method call could be in a different scope than a later method call which
was run on a different database connection..

Method Description
public void SetProcessVariable( Create or update a process variable in the
string name, database.
string varValue)
public void SetProcessVariable( Get the value of a process variable.
string name,
string varValue,
bool ignoreError)
public string GetProcessVariable( Get the value of a process variable.
string name)
public string GetProcessVariable( Get the value of a process variable, using
string name, defaultValue if it does not exist.
string defaultValue)

Infor Mongoose - IDO Development Guide | 57

IDO Extension Classes

Method Description
public string GetProcessVariable( Get the value of a process variable, using
string name, defaultValue if it does not exist. Delete the
string defaultValue, process variable after retrieving the value.
bool deleteVariable)
public void Delete the process variable.
DeleteProcessVariable(
string name)

Using AppDB in an Extension Class Method

This example shows how to use AppDB in an extension class.
public int MyMethod()
{
using (AppDB appDB = this.CreateAppDB())
{
// Use appDB here...
}
}

Note that the AppDB instance is created as part of the Using…End Using block. This ensures that the
AppDB instance will be disposed and any resources it is holding will be released as soon as the
instance goes out of scope. See the .NET Framework documentation for more information on the
Using statement.

Disposing of IDO Extension Classes

If an IDO extension class implements the IDisposable interface, the Dispose method will be called by
the IDO runtime when it is finished with each instance. The ExtensionClassBase class implements
IDisposable and provides a virtual method which you can override in a derived class to get control
when an instance is disposed.
protected virtual void Dispose( bool disposing );

See the .NET Framework documentation for more information on the IDisposable interface.

58 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

Translation/Localization Considerations

Type Conversions
The built-in VB functions for data type conversions (CStr, CDate, CInt, etc.) are sensitive to the
regional settings for the application or local machine, and therefore should not be used for type
conversions in IDO extension class methods.
The framework stores all property values internally as strings regardless of their data type. In
WinStudio, this is also true for values stored in components, variables and IDO collections. The
internal string format is culture independent so the built-in string conversion functions may not work,
or may work inconsistently depending on the data or the current culture settings. The internal
formatted string value is always available, but when accessing numeric, date or Guid property values
programmatically, you should use the APIs provided by the framework that will convert the values
from internal string format to the proper “strong” data types.

IDORequest/Response Property Values (IDOProtocol classes)

Property values in IDO Request and Response classes are represented using the
Mongoose.IDO.Protocol.IDOValueType class, or a class that inherits from this class.
This example accesses properties in a LoadCollectionResponseData instance:
LoadCollectionResponseData responseData = LoadCollectionResponseData;
string name = null;
DateTime recordDate;
decimal cost;
decimal newCost = Convert.ToDecimal(100.0);
Guid id;

// Perform LoadCollection:
// Access internal value for strings:
name = responseData[0, "Name"].Value;

// Convert internal date to DateTime:

recordDate = responseData[0, "RecordDate"].GetValue<DateTime>();

// Convert to Decimal, specifying a default if the property is null:

cost = responseData[0,
"Cost"].GetValue<decimal>(Convert.ToDecimal(0.0));
id = responseData[0, "ID"].GetValue<Guid>();

// Assign a new value to cost:

responseData[0, "Cost"].SetValue(newCost);

Infor Mongoose - IDO Development Guide | 59

IDO Extension Classes

Note that the name property simply gets the internal format, since string values do not need
conversion. Also note that the GetValue call for the cost property specifies an optional default value
to return if the property is null. You can also check for null values using the IsNull property.
The last line assigns a new value to the cost property. Passing in a decimal value to the SetValue
method allows the framework to perform the conversion to the internal string format automatically.

Converting Internal Format Strings to Strong Typed Variables

WinStudio supports a similar set of methods for automatically converting internal format strings to
strong typed variables in scripts, as shown in this example.
string name = null;
DateTime recordDate;
decimal cost;
decimal newCost = Convert.ToDecimal(100.0);
Guid id;

// Perform LoadCollection:
name = ThisForm.Components["NameEdit"].Value;

// Access the internal values for strings:

recordDate =
ThisForm.Components["DateTimeEdit"].GetValueOfDateTime(DateTime.Now);
cost =
ThisForm.PrimaryIDOCollection[0].Properties["Cost"].GetValueOfDecimal(
0.0);
id = ThisForm.Variables["IDVar"].GetValueOfGuid(Guid.Empty);
ThisForm.PrimaryIDOCollection[0].Properties["Cost"].SetValue(newCost);

Note that there are individual methods for each data type, instead of a single generic method that is
supported in the IDOProtocol classes. Also, the methods all require a default value to return if the
requested value is null.
Again, the last line assigns a new value to the cost property. Passing in a decimal value to the
SetValue method allows the framework to perform the conversion to the internal string format
automatically.

Testing Extension Class Assemblies Locally

To test a new version of an extension class assembly locally before checking it in, copy the new
version of the extension class assembly to a folder named:

60 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

appName/idoxca/configName
where:
 appName is the application root folder, usually C:\Program Files\Infor\MongooseApp.
 idoxca is a directory you must set up specifically for testing your application and configurations.
 configName is the name of the configuration you will be using to test the DLL.
The IDO runtime checks this location first when it loads an assembly.
This might also be useful to developers working on different classes in the same assembly, since only
one developer can have an assembly checked out at a time.
You might need to discard the IDO metadata cache to force the IDO runtime to load the new version.
This section applies only if you have a Visual Studio version other than the "Express" edition.

Debugging Extension Classes

IDO extension class code can be debugged using the Visual Studio debugger. In order to debug an
extension class, the developer must:
1 Build a debug version of the extension class assembly.
2 Import the assembly (DLL) and the symbols (PDB) into the objects database using the IDO
Custom Assemblies form (first checking out the assembly, if it has been checked in).
3 Run the IDO Runtime Development Server (IDORuntimeHost.exe) on the developer's local
machine. Alternatively, you can use the technique described in “Testing Extension Class
Assemblies Locally” on page 60.
4 Run WinStudio configured to access the IDO runtime on the local machine.
5 Open Visual Studio and select Attach to Process from the Debug menu.
6 Select IDORuntimeHost.exe in the list of available processes and click Attach.

Infor Mongoose - IDO Development Guide | 61

IDO Extension Classes

You should now be able to set breakpoints in the Visual Studio debugger and step through code.

Logging Diagnostic Messages

IDO extension class methods can send messages to the common logging facility IDO Runtime
Development Server (IDORuntimeHost.exe) by calling one of the overloaded
IDORuntime.LogUserMessage methods. For more information about the facility, see “Diagnostics
and Debugging” on page 26.

Example
This sample sends a message to the log each time the ValidateCreditCard method is called.
 The first parameter is messageSource (String). This is the source identifier that displays in the log
viewer.
 The second parameter is messageType (Mongose.IDO.UserDefinedMessageType). This is the
type identifier that displays in the log viewer.
 The third parameter is message (String). This is the text of the message to be logged.
[IDOMethod(MethodFlags.None, "infobar")]
public int ValidateCreditCard(
string cardNumber,
DateTime expires,

62 | Infor Mongoose - IDO Development Guide

 IDO Extension Classes

decimal amount,
string infobar)
{

int result = 0;

// Call a Web service to validate the CC info:

IDORuntime.LogUserMessage(
"MyExtensionClass",
UserDefinedMessageType.UserDefined0,
"ValidateCreditCard called by user " +
IDORuntime.Context.UserName);

return result;
}

Infor Mongoose - IDO Development Guide | 63

IDO Extension Classes

64 | Infor Mongoose - IDO Development Guide

Index
Symbols Conversions of data types 22
.NET CLR data types 22 CreateAppDB method 55
.NET data types supported by IDO protocol Custom assemblies, importing 40
classes 25 Custom Load Method, using Get More Rows 44
A Custom Load Methods, Filters 44
ActionMask 50 CustomDelete property 16
Add method 22 CustomInsert property 16
AddHandler keyword 46 CustomLoadMethod property 13
AppDB class 9, 55 CustomUpdate property 16
AppDB class, using in extension class method 58 D
AppDB.Connection 55 Data type conversions 22
AppDB.ExecuteNonQuery 55 Data type conversions in IDO extension classes
AppDB.ExecuteReader 55 59

AppDB.ExecuteScalar 55 Data types, supported 25

Application database connections 55 Database, connecting to 55
Application messages, accessing 55 DataTable 43
AppProperties class 34 Date values, format 22
Attach to Process 61 Debug menu 61

B Debugging 26

Base class 41 Debugging extension classes 61

Bookmark variable 44 Declaring an IDO extension class 42

Bookmarking Algorithm 44 Diagnostic messages, logging 26, 62

C Dispose method 58

Client class 8 Disposing of extension classes 58

CloseSession method 8, 29 Distinct property 13

CollectionID property 16 E
ConfigServer.aspx page 29 EnableBookmark variable 44

Configuration class 33 Event handlers 46

Configuration information 32 Event handlers, replacing standard IDO process-

ing 50
Configuration information storage 29
Events available fo extension classes 46
ConfigurationInfo class, examples 30
Events, generating 51

Infor Mongoose - IDO Development Guide | 65

Index

Examples, syntax of 11 IDO

Extension class 39 Commands interface 8, 9
Debugging 61 Definition of 7
Disposing of 58 Protocol class library 8
Examples 52 Runtime Development Server 26
Project, creating 39 IDO Custom Assemblies form 40, 61
Testing assemblies locally 60 IDO Methods form 40
ExtensionClassBase class 41, 55 IDO Runtime Development Server 61
ExtensionClassBase.SetContext method 46 IDO Runtime Service 29
External applications 28 IDOCore.dll 40
External Data Store IDOEventArgs class 47
client MMethod 36 IdoFilter 44
stored procedures 35 IDOMethod attribute 43
F IDOName property 12, 13, 16, 18
Filter strings. creating 25 IDONull.IsNull static method 21
Filters in Custom Load Methods 44 IDONull.Value static property 20
FireApplicationEvent method 51 IDOProtocol.dll 28, 40
Flags parameter 43 IDORequest class 8
Function 43 IDORequestClient .NET class library 8

G IDORequestClient.dll 28

Get More Rows, use in CLM 44 IDORequestEnvelope class 8

Get parameter and property values 23 IDORequestService ASP.NET Web server 29

GetConfigurations 8 IDORuntimeHost.exe 26, 30, 61

GetConfigurations static method 30 IDOs form 40

GetMessageProvider method 56 IDOValueType class 59

GetPropertyInfo 12 IIDOCommands interface (shown in C#) 10

GetValue call 60 IIDOCommands interface (shown in VB) 10

GetValue methods 23 IIDOExtensionClass interface 41

I IIDOExtensionClassContext interface 46

IDataReader 43 IMessageProvider interface 55

IDisposable interface 58 Importing assemblies 40

IncludeClassNotesFlag property 12
Internal format strings, converting to strong typed

66 | Infor Mongoose - IDO Development Guide

 Index

variables 60 Mongoose.IDO.Protocol namespace 8

Invoke 8, 18 MongooseConfigs class 32
Invoke call execution, sample steps 8 MongooseConfigs.xml 29
Invoke examples 19, 54 MsgAppSp 55
IsNull property 21, 60 N
Item, inserting new - example 53 NestedRequests property 14
Item, updating existing - example 54 Null values, assigning and checking 20
Items property 16 Nullable values, in GetValue method 24
L Numeric values, format 22
LinkBy property 14, 16 O
LoadCap property 14 OpenSession 7, 8
LoadCollection 8, 12, 25, 52 OpenSessionRequestData class 8
LoadCollection examples 14 OrderBy property 13
LoadCollectionRequestData class 8 P
LoadType variable, with bookmarks 45 Parameter values
Localization 21, 59 Retrieving 23
Logging diagnostic messages 26 Setting 22
Logging into a session 28 Parameters property 18
Logging out of a session 29 payload 7
LogUserMessage method 62 Posting a batch of records 26
Look up application messages 56 PostLoadCollection event 46, 47
M PostQueryCommand property 13
Me.Context.Commands property 7 PostUpdateCollection event 46, 47
Message lookup 56 PreLoadCollection event 46, 47
MessageParm parameter 44 PreUpdateCollection event 46, 47
Messages, accessing 55 Process variables, description of 57
MethodFlags enumeration 43 Property values 59
MethodName property 18 Retrieving 23
Methods, adding in extension class 43 Setting 22
MGShared.dll 28, 32, 40 PropertyList property 13
Mongoose.IDO namespace 41 R
Mongoose.IDO.Client class 7 ReadMode property 13
Mongoose.IDO.DataAccess namespace 9, 55 RecordCap property 13

Infor Mongoose - IDO Development Guide | 67

Index

RecordCap variable 45 System.Int32, use with SqlLiteral.Format 25

RefreshAfterUpdate property 16 System.String, use with SqlLiteral.Format 25
Regional settings 22 T
S Template for new IDO extension classes 42
Sender parameter on event handler method 46 Testing extension class assemblies 60
Session variables, manipulating 57 Transaction, executing requests in 26
SetContext method 41 Translation 21, 59
SetValue method 22 TxnScope property 16
SQL commands, executing 55 U
SqlCommand class 55 UpdateCollection 8, 15, 53
SqlConnection instance 55 UpdateCollection events, special cases 49
SqlLiteral class 25 UpdateCollection example 17
SqlLiteral.Format method 25 W
Standalone application communications 28 Web server application 29
Standard Method Cal 43 WHERE clause 25
Strong typed variables 60 Wire Tap feature for debugging 28
System.DateTime, use with SqlLiteral.Format 25 WSEnums.dll 28
System.Decimal, use with SqlLiteral.Format 25 WSFormServerProtocol.dll 28
System.Guid, use with SqlLiteral.Format 25

68 | Infor Mongoose - IDO Development Guide