Action Request System .NET and COM API

Theme:  Cool Tech Tips

Action Request System .NET and COM API

Part 1 of 2 - Overview

In this Tips and Tricks article, we introduce the Action Request System .NET and COM API.

The Action Request System .NET and COM API is an add-on companion to your existing AR System solutions, and provides open, standard integration from Microsoft Windows.  It is freely available from Community Downloads on the AR System Developer Community.

Strong Microsoft Integration

The Action Request System .NET and COM API provides open integration to the AR System platform from COM and .NET environments on Microsoft Windows.  Integration from the Microsoft Office family of products, Active Server Pages, ASP.NET, or other .NET applications is standard and straightforward.  AR System integration is now possible from VBScript, JScript, VBA, Visual Basic 6, C#, Visual Basic .NET, or any other .NET or COM compatible language.

The .NET and COM API can be used to integrate with any 5.1 (or later) AR System server on any supported server platform.

What Is Included?

You will find an installer, a ReadMe, and reference documentation at Community Downloads.
The installer will copy and register necessary DLLs, copy documentation files, and also install several sample integrations.  The documentation provides a complete reference, fully tested code samples in both C# (.NET) and VBScript (COM) for most methods, and several complete sample integrations.  Indexed, searchable documentation is provided in .chm format, and XML documentation for integration with Visual Studio .NET?s IntelliSense is also included:

Note: Click images for full screen view.

Figure 1 - Visual Studio .NET?s IntelliSense documentation for the AR System .Net and COM API

Wait, Back Up A Bit?What Is COM?

COM is short for Component Object Model.  COM is aimed at component-oriented software development, and has been central to Microsoft Windows for many years.  COM allows software components to be developed in a language-independent fashion, so that are usable by other software regardless of language or compiler version.  In addition, COM supports automation, or scripting, of components.  If you are familiar with writing macros in Microsoft Office products, or writing VBScript or JScript in Active Server Pages, or have ever called CreateObject(), then you have used COM.  COM is ubiquitous on Windows, and COM automation is used extensively within both VBA macros and Active Server Pages.

Ok, Got It?So What Is .NET?

.NET is Microsoft?s newer technology for component-based software development.  .NET software components can be developed in, and used by, any .NET language, such as C#, Visual Basic .NET, or J# .NET.

 

.NET offers strong interoperability with COM, and in fact, that is how the AR System .NET and COM API are provided together.

How Does This Work Internally?

The .NET and COM API, like the Remedy Java API, is a wrapper of the public Remedy C API.  Internally, it uses a set of private COM objects to interface between the managed and unmanaged code and provide a .NET interface to the AR System.

The .NET and COM API is architected to provide, as much as possible, the exact same API interfaces to .NET and COM clients.  It does so by providing COM-Callable-Wrappers of the .NET API to COM clients.  The architecture is therefore as follows:

Figure 2 ? Overview of the .NET and COM API architecture

You can see from the code sample in the documentation that using the API from .NET or from COM are both very similar:

Figure 3 - .NET and COM code samples

Summary

The Action Request System .NET and COM API provides open, standard integration from the Windows platform.  It is also provides an efficient and straightforward development environment for developing AR System integrations and tools.  I hope that you find this to be a useful addition to the toolset you keep handy when developing great Remedy solutions!

~Dan
Principal Product Developer, Remedy Product Development
Joined Remedy 1994

 

Related Document
Action Request System .NET and COM API part 2