AR System Developer Community http://www.bmc.com/arsystem/dev_community/ AR System .NET and COM API
________________________________ From: Action Request System discussion list(ARSList) [mailto:[EMAIL PROTECTED] On Behalf Of Rem Valenzuela Sent: Tuesday, April 17, 2007 4:48 PM To: arslist@ARSLIST.ORG Subject: API & .NET/C++ ** Anyone know of anyplace where I can look at some free sample code using VB.NET or C++ for the Remedy API? I'm a relative newbie to the Remedy API and am intermediate in ASP.NET and C++. I looked at the examples in the e-books, but it doesn't seem to address some questions I have about it. Thanks. - Rem ________________________________ Get news, entertainment and everything you care about at Live.com. Check it out! <http://www.live.com/getstarted.aspx> __20060125_______________________This posting was submitted with HTML in it___ _______________________________________________________________________________ UNSUBSCRIBE or access ARSlist Archives at www.arslist.org ARSlist:"Where the Answers Are"
BMC AR System .NET and COM API (version 7.0) ============================================ IMPORTANT: This API continues to remain officially unsupported at this time. If customers seek to use a supported AR System API, the C/Java API remain the APIs of choice for our customer's various development needs. DOWNLOAD INSRUCTIONS ==================== * To reach the download location, do the following: - Go to http://www.bmc.com/arsystem/dev_community/ - Click on Community Downloads - In the Quick Search, choose Download Type: Utility, Category - API, Click Search button - Locate "AR System .NET and COM API" row in the resulting table, select it, click on View Download button - In the resulting page, go to Attachment tab * Download the attachments named ARAPI70.NET1.zip ARAPI70.NET2.zip ARAPI70.NET3.zip ARAPI70.NET4.zip [We wanted to make them into 1 zip file, but Dev Community downloads has a limit on the attachment size to be 4MB; so we had to split the content into 4 separate files] * Unzip all these 4 files into same folder (say arapi.net). If any files are prompted to be overwritten - choose OK. * Follow the INSTALL instructions below for installation. [Observe the MSI installer is removed in this version and is replaced by a simple unzip & a couple of one time steps described in the readme.txt.] INSTALL ======= * Extract all the files from this distribution into your file system say "C:\ARAPI.NET" or another location of your choice. Let's call it "<YourInstallDir>". * From Command prompt, run the following command: "%FrameworkDir%\%FrameworkVersion%\regasm" "<YourInstallDir>\BMC.ARSystem.dll" /codebase [If these environment variables are not defined in your system - then a. ensure that your system indeed has .NET Framework v1.1.4322 or above is installed; b. Locate regasm.exe in your .NET Framework directory (similar to "C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322"); c. then run the above command with absolute path to regasm prepended appropriately.] * Add <YourInstallDir> to the PATH environment variable (or) When you run this API's client program, make sure all the files in this directory are available in the DLL search path for that process (either by copying needed files to the working directory of the program, or using this installation directory as the working directory for your program). HOW TO USE ========== From .NET Client programs (C#, ASP.NET, VB.NET etc) * From your .NET application projects, simply add reference to "BMC.ARSystem.DLL" by browsing to "<YourInstallDir>". * Instantiate a BMC.ARSystem.Server instance in your code and issue any other AR System API calls - typically a SetServerPort (optional- applicable only if connecting to a server which is runnning on a specific TCP Port), Login, then any other API calls and finally Logout. * Build and run. [IMPORTANT - When you run this API's client program, make sure all the files in this directory are available in the DLL search path for that process (either by copying needed files to the working directory or the program, or using <YourInstallDir> as working directory for your program) From COM Client programs (VB6, ASP, VBA in Word/Excel etc) * Import BMC.ARSystem.TLB or create/get objects using the "BMC.ARSystem.XXX" prog ids. * Instantiate a BMC.ARSystem.Server instance in your code and issue any other AR System API calls - typically SetServerPort (optional- applicable only if connecting to a server which is runnning on a specific TCP Port), Login, then any other API calls and finally Logout. UNINSTALL ========= * From Command prompt, run the following command: "%FrameworkDir%\%FrameworkVersion%\regasm" "<YourInstallDir>\BMC.ARSystem.dll" /unregister * If PATH environment variable were altered as suggested above during installation, then remove <YourInstallDir> from the PATH. Otherwise no action needed. * Delete the entire <YourInstallDir> from your system. Upgrading from previous versions of this API ============================================ [Previous versison of this API can co-exist with the current version. So you can continue to use it. If you intend to upgrade to the current version, then ...] * [OPTIONAL] Uninstall the previous version of the "AR System .NET and COM API" using "Control Panel -> Add/Remove Programs" * Install this version using the steps described in the INSTALL section above. * If you have previously created client programs, they need to be changed and recompiled as there are significant changes in this drop. Upgrading previously created .NET API client programs ===================================================== AR System .NET and COM API is upgraded to 7.0 API. In this upgrade, there are few significant changes, so this How To upgrade" section is deemed necessary. This section tries to list out the major changes and the required changes for a given client program to migrate from older drops to this. List of changes * The packaging of this API. This older drops have file names like DotNet.dll, ATLWrappers.Dll etc. Now some of the files are no more needed and whatever files that are packaged now have more formal/productized names (like BMC.ARSystem.dll for example). OLD FILES NEW FILES ----------------------------------------- DotNet.dll BMC.ARSystem.dll DotNet.tlb BMC.ARSystem.tlb ATLWrappers.dll BMC.arnettoc.dll ATLWRAPPERSLib.dll arcni.dll ARSystem.chm BMC ARSystem.chm arapi63.dll etc arapi70.dll etc * More functionality. Support for more AR API calls has been added. Now, for example, you can call methods to create/set server objects such as forms, activelinks, filters, escalations etc. * Some deprecated functions/functionality Since more functionality to get at server objects is added now, some of the shortcut or workaround API functions are no more necessary. So the following have been deprectated - GetVuiNames, GetFieldNames. If you happen to use these, then youre advised to alter the usage to GetListVui/GetVui and GetListField/GetField. * New names ARSystem namespace => BMC.ARSystem ARSystem.Exception => ARException Schema => ARForm * No internal COM objects (ATLWrappers.dll) Since this library has been eliminated now, there is no need to register such component. However this means that the client program you run, should have the AR System .NET API installation directory as the programs working directory or have it in the PATH. * To use this API in your project, Add reference to BMC.ARSystem.dll instead of DotNet.dll KNOWN ISSUES & OTHER NOTES ========================== * Note that this version and older version (DotNet.dll) can co-exist without stepping on each other. So you could leave the old version as-is and make a copy of any of your projects and try converting the copy to make use of the the latest API. That way you can slowly implement the upgrade/migration. * Few sample programs delivered as source previously are not available any more. Why? There is no significant reason for it, but needs to be packaged again. In any case, now we've included few samples/utilities that can be used. Simply give the exe name followed by a "-?" to read more about how to use them.] * Help file needs some work, especially to include usage code snippets. * The .NET based usage will work much better and has lot of new functions; and the COM usage (asp or vbscript or vba) may have more challenges as it is not tested a whole lot. FAQ ==== * Is this API supported? Or, when will it be? Or, what are future plans? Etc BMC has developed the AR System.NET API to support our customers and their various integration needs. While we continue to invest and expand functionality for the .NET API, it continues to remain officially unsupported at this time. If customers seek to use a supported API, the C/Java APIs will continue to be the APIs of choice for our customer's various development needs. TROUBLESHOOTING =============== * After first-time installation, run FieldLabelChanger.exe. It should come up just fine; allow you to enter server login details and bring up a GUI with a comboboxes for form names & vuis and a field label/name grid below. [This program allows for quickly viewing/editing field labels per vui and bulk change the labels.] If this program came up properly, your installation works correctly. * Make sure your system has .NET Framework v1.1.4322 or above is installed. If not, go to http://update.microsoft.com to install it. This API is developed and tested using v1.1.4322, and is known work fine in 2.0 environments as well. In case of any unknown problems when using this API in .NET Framework 2.0 environments, simply install .NET Framework 1.1 as well - that way your system can indeed have both the frameworks, these are known to co-exist just fine and any apps that require respective frameworks can work. * Please contact [EMAIL PROTECTED] for reporting any defects or enhancement requests or if you have any questions.
-- *****DISCLAIMER***** The information contained in this communication is confidential and may be legally privileged. It is intended solely for the use of the individual or entity to whom it is addressed and others authorized to receive it. If you are not the intended recipient you are hereby notified that any disclosure, copying, distribution or taking action in reliance of the contents of this information is strictly prohibited and may be unlawful. Orange Romania S.A. is neither liable for the proper, complete transmission of the information contained in this communication nor any delay in its receipt. *****END OF DISCLAIMER***** _______________________________________________________________________________ UNSUBSCRIBE or access ARSlist Archives at www.arslist.org ARSlist:"Where the Answers Are"
