Using ARAPI.NET from PowerShell

In my last post I explained how to install ARAPI.NET. Now let’s take a look at how you can use the Remedy API in a PowerShell Script. The first trick to using ARAPI.NET is to ensure that you are running your script with the 32-bit instance of PowerShell. These days you will most likely be running a 64-bit version of Windows so the default icon launches the 64-bit version of PowerShell. Look for the icon labelled “Windows PowerShell (x86)” to launch the 32-bit version. In the example script below I will show you another method for ensuring that you have a 32-bit instance.

This will do a simple query for a Person record in Remedy. The outline looks like this:

  1. Log into the AR Server
  2. Build a list of Field IDs that you want to retrieve from Remedy
  3. Create a Qualifier string used to query the database
  4. Query a Remedy form (passing in the qualifier and field list)
  5. Process the results
  6. Logoff the AR Server
param ($searchValue="Allen",
       $ARServerName = "arserver.calbrosvcs.internal",
       $ARSvcAccount = "Demo", 
       $ARSvcPassword = "Password", 
       $ARAuthentication = "", 
       $ARServerPort = 51100,
       $formName = "CTM:People")

if ($Env:PROCESSOR_ARCHITECTURE -ne "x86") { 
  $powershell=Join-Path $PSHOME.tolower().replace("system32","syswow64") powershell.exe
  "Launching Windows Powershell (x86)..." 
  & "$powershell" -NonInteractive -ExecutionPolicy Bypass $myInvocation.Line
else { 
   # Load the ARAPI.NET classes
   add-type -path 'C:\Program Files (x86)\BMC Software\ARAPI80.NET\BMC.ARSystem.dll'

   # Login to the AR Server
   $arserver = new-object BMC.ARSystem.Server
   $arserver.Login($ARServerName, $ARSvcAccount, $ARSvcPassword, $ARAuthentication, $ARServerPort)

   # List of field IDs to retrieve from Remedy
   # Hash table of FieldId# = "Display name of field"
   $fieldIDs = @{
               1="Person ID";
               4="Remedy User ID";
               5="Last Modified By";
               6="Last Modified On";
               7="Profile Status";
       300469300="Cost Center Code";
       301336500="Manager ID";
      1000000018="Last Name";
      1000000019="First Name";
      1000000023="Job Title";
      1000000025="Support Staff";
      1000000026="VIP Status";
      1000000048="Internet Email";
      1000000049="Corporate Email";
      1000000346="Assign Availability";
      1000006694="Authorization Alias";
      1764007102="Network ID";

   # Build the Field List by adding the Field Id numbers
   [BMC.ARSystem.EntryListFieldList] $formEntryFieldList = new-object BMC.ARSystem.EntryListFieldList
   $fieldIDs.Keys | %{ $formEntryFieldList.AddField($_) }

   # Query string - default = search for Person by Remedy ID
   $qualifier = "'{0}' = ""{1}""" -f $fieldID,$searchValue

   # Execute the query
   [BMC.ARSystem.EntryFieldValueList] $entryList = $arserver.GetListEntryWithFields($formName, $qualifier, $formEntryFieldList, 0, 0);

   # Display the results
   foreach ($entry in $entryList) {
      $fieldIDs.Keys | sort-object |
         foreach-object { "[{0:0000000000}] {1,19} = {2}" -f $_,$fieldIDs[$_],$entry.fieldvalues[$_] }

Example output:

Launching Powershell x86...
[0000000001]           Person ID = PPL000000002007
[0000000004]      Remedy User ID = Allen
[0000000005]    Last Modified By = AR_ESCALATOR
[0000000006]    Last Modified On = 9/20/2014 1:00:02 AM
[0000000007]      Profile Status = 1
[0200000006]          Department = Customer Service
[0260000006]             Manager = Mary Mann
[0300469300]    Cost Center Code = 100.000012345
[0301336500]          Manager ID = Mary
[1000000001]             Company = Calbro Services
[1000000010]        Organization = Information Technology
[1000000018]           Last Name = Allbrook
[1000000019]          First Name = Allen
[1000000023]           Job Title = Supervisor
[1000000025]       Support Staff = 1
[1000000026]          VIP Status = 1
[1000000048]      Internet Email =
[1000000049]     Corporate Email =
[1000000346] Assign Availability = 0
[1000006694] Authorization Alias = allen
[1764007102]          Network ID = allen

Let’s break this down a bit. First, I define the command line parameters for the script. I have defaulted the values so that the script searches for Allen Allbrook by default.

param ($searchValue="Allen",
       $ARServerName = "arserver.calbrosvcs.internal",
       $ARSvcAccount = "Demo", 
       $ARSvcPassword = "Password", 
       $ARAuthentication = "", 
       $ARServerPort = 51100,
       $formName = "CTM:People")

Any of these parameters can be passed on the command line. For example, if you want to search by email you could run the script as follows:

.\get-remeduser.ps1 -searchValue -fieldID 1000000048

Next, I check to see if the script is running in a 32-bit instance of PowerShell. Windows sets the PROCESSOR_ARCHITECTURE environment variable of a process to the reflect processor architecture (e.g. AMD64 = 64-bit, x86 = 32-bit). This part of the script checks that variable and relaunches the script using the 32-bit version of PowerShell if necessary.

if ($Env:PROCESSOR_ARCHITECTURE -ne "x86") { 
  $powershell=Join-Path $PSHOME.tolower().replace("system32","syswow64") powershell.exe
  "Launching Windows Powershell (x86)..." 
  & "$powershell" -NonInteractive -ExecutionPolicy Bypass $myInvocation.Line

Hopefully the rest of the script is fairly self-explanatory. I like to use a hash table for the Field Ids so that I can map friendly names to the unfriendly field ID numbers.

I am an experienced IT technologist specializing in optimizing user experiences, providing best-in-class support and developing creative solutions. I script therefore I am. I build tools to improve troubleshooting and gather supporting data.

Tagged with: , ,
Posted in ARAPI, Scripting
4 comments on “Using ARAPI.NET from PowerShell
  1. Remy says:

    This is an excellent article, it has taken me from no knowledge right up to querying and getting results in a very short time indeed.


  2. Remy says:

    Can I suggest a future blog article on how to “write” remedy forms using powershell? This one covers the reading part perfectly.


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

sean on it
Follow Sean on IT on
Blog Stats
  • 65,943 hits
Mike F Robbins

Scripting | Automation | Efficiency

%d bloggers like this: