This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Monitoring API calls

As BMC Remedy administrator, you can monitor the AR System server API calls by configuring certain fields in the AR System Server Information — Advanced tab. You can monitor the API calls between an AR System server and its clients and capture the following information, which is recorded in the AR System API Statistics form:

The default value being 0 seconds, the AR System API Statistics form is updated immediately after the fields are configured.

  • Number of API calls by client type (for example, mid tier or BMC Remedy Developer Studio)
  • Total amount of data sent to the client as a result of the API calls
  • Total amount of data sent by the client to the server as a request
  • Number of successful API calls
  • Number of failed API calls
  • IP address of the client from where the call was initiated
  • IP address of the server that responded to the request

To monitor API calls

  1. In a browser, open the AR System Administration Console, and click System > General > Server Information.
    The AR System Administration: Server Information form appears.
  2. Click the Advanced tab.
  3. In the API Recording Client Types field, enter the client types for which you want to monitor API calls.
    By default, calls from all client types are monitored. Specify values separated by semicolons in the following format: clientType;IPAddressExpression;clientType;IPAddressExpression.
    For more information, see Setting performance and security options.
  4. In the Enable API Recording field, select whether you want to enable the system for monitoring API calls.
    By default, monitoring is disabled. Selecting Yes in this field indicates that you have enabled the system for monitoring.
    For more information, see Setting performance and security options.
  5. Save the changes.

To view API call details

Open the AR System API Statistics form by typing the URL in a browser in this format: http://midTier:port/arsys/forms/server/AR+System+API+Statistics.

The AR System API Statistics form displays the following information:

Field name

Description

Client type

Type of client that initiated an API call (see the following table)

Total count

Total number of successful and failed calls

Error count

Number of unsuccessful calls

Client IP Address

IP address of the client making a call

End client IP Address

IP address of the client using the mid tier or the web service

Data In

Total number of bytes sent as a request from the source IP address

Data Out

Total number of bytes sent out as a response to the API call

Start Timestamp

Time when the API call monitoring started, specified in hours. The monitoring time frame is 1 hours.

End Timestamp

End time of API call monitoring. For example, if the start time is 03:00, the end time will be 04:00.

Server

IP address of the computer where the AR System server is running

The following table lists the supported client types and the value associated with each client type.

Client types

Client type

Value

Unknown

0

Pre-5.0 AR System clients

1

BMC Remedy Administrator

2

BMC Remedy User

3

BMC Remedy Data Import

4

BMC Remedy Distributed Server Option (DSO)

5

BMC Remedy AR System ODBC

6

BMC Remedy Approval Server

7

AR Web Server

8

BMC Remedy Mid Tier

9

Palm Pilot

10

BMC Remedy Flashboards

11

Flashboards Mid Tier

12

BMC Remedy Enterprise Integration Engine

13

arreload

14

arcache

15

ardist

16

runmacro

17

armail

18

Command-line import tool

19

Report Creator plug-in

20

BMC Remedy Email Engine

22

Debugger

24

Object Store API

25

Object Store Sync Utility

26

Server Administration plug-in

27

BMC Service Impact Management Publishing server

28

BMC Service Impact Management Service Model Editor

29

BMC Atrium CMDB Engine

30

BMC Atrium CMDB Driver

31

BMC Atrium CMDB Reconciliation Engine

32

BMC Remedy Assignment Engine

33

BMC Remedy AR System Web Service

34

Normalization Engine

35

BMC Remedy Developer Studio

36

Full Text Reader

37

BMC Atrium Single Sign-On Server

38

AR Migrator

39

AR UDM Adapter

40

BMC Remedy Knowledge Management Operations plug-in

41

BMC Remedy Knowledge Management Form Permissions plug-in

42

BMC Remedy Knowledge Management Document Migrator plug-in

43

BMC Remedy Knowledge Management File System plug-in

44

BMC Remedy Knowledge Management File System Sync plug-in

45

BMC Remedy Knowledge Management Group plug-in

46

BMC Remedy Knowledge Management Registration plug-in

47

BMC Asset Management SWLM Rule Engine plug-in

48

BMC Asset Management Software Usage plug-in

49

BMC Asset Management RLE Configuration plug-in

50

BMC Asset Management Charge Back plug-in

51

BMC Remedy IT Service Management (ITSM) Common plug-in

52

BMC Remedy ITSM CAI plug-in

53

BMC Remedy ITSM Utility plug-in

54

BMC Remedy ITSM AppQuery plug-in

55

BMC Remedy ITSM Next ID plug-in

56

BMC Atrium Integrator

57

BMC Atrium Discovery (ADDM)

58

BMC Proactive Performance Management

59

Driver

4000

Dispatcher

4001

arhelp

4002

arjanitor

4003

armenu

4004

arstruct

4005

artext

4006

arsqled

4007

archgsel

4008

archgid

4009

arlabel

4010

BMC Remedy AR System Installer

4011

BMC Remedy Install Kit (RIK)

4012

Reserved range

5000

Was this page helpful? Yes No Submitting... Thank you

Comments