Aperio Objects Naming Reference

This section describes naming rules for all objects and names used to build APerio framework.

Iptor API framework

The API framework was built as separate product which can be installed as stand alone. There is no need to have DC1 installation. Following rules were used to name objects in Iptor API Framework:

  • IAF100AP - API framework production library

  • IAF100AQ - API framework quality control library

  • IAF100AD - API framework development library

  • APIBNDDIR - API binding directory

  • IAFLAPI - Common parameter list for all manager programs (IAFR02*, MGRR*, ZnMGRR*, etc…)

  • IAFC* - CLLE programs

    • IAFC0001..IAFC9999 - common programs

  • IAFR* - RPGLE programs

    • IAFR0001..IAFR0099 - common programs
    • IAFR0101..IAFR0199 - Table maintenance programs
    • IAFR0201..IAFR0299 - API methods
    • IAFR0301..IAFR0399 - API methods blackboxes

  • IAFD* - DSPF files

    • IAFD0101..IAFD0199 - Table maintenance DSPF’s

  • IAO* - Physical files

  • IAB*, IA1*, IA2*, … IAJ*… - Logical files

  • IAFS0001 - Common API framework service program.

    • IAFS0001 - Common module used to build IAFS0001 service program
    • IAFS0002 - Message handling module
    • IAFS0003 - External API call module
    • …

  • IAFS0001 - API Framework binding directory

  • IAFMSGF - Message file used in API framework

  • IIADPGM - Externally described data structure for: PGM - Program data structure

  • IADWKS - Externally described data structure for: WKS - Work station data structure

  • IAFFRF - API FRF Reference fields

APIBNDDIR - This binding directory. This object is added to compilation of every Aperio framework program.

API Method names and sequence

There are few Aperio related API shipped together with API Framework:

Method nameSequenceprogram
api.init99IAFR0227
apiCommonParameters.get99IAFR0240
apiFrameworkStatistics.get99IAFR0213
apiMetadataInfo.get99IAFR0214
apiMethod.get99IAFR0229
apiMethodAttributeTypes.get99IAFR0237
apiMethods.get99IAFR0228
apiSettings.get99IAFR0215
apiSubsets.get99IAFR0238
appNotification.add99IAFR0221
appNotification.delete99IAFR0220
appNotification.get99IAFR0219
appNotification.update99IAFR0222
appNotifications.get99IAFR0218
appNotificationServer.add99IAFR0225
appNotificationServer.delete99IAFR0226
appNotificationServers.get99IAFR0224
appNotificationServers.notify99IAFR0223
systemSettings.get99IAFR0216

All of them has sequence 99 which s reserved for aperio specific API. aperio.

API Procedure names

  • The framework service program (IAFS0001) contains a lot of procedures which may be used to build manager programs (API methods). The following standard was established for procedure naming:
  • API_* All procedures responsible for communication and API framework
  • JSON_* All procedures used to maintain JSON (parser/builder)
  • req* All procedures responsible for getting information from request
  • resp* All procedures responsible for putting information to response

The service program contains also other procedures but these are common tools and there is no specific naming convention.

Vocabulary

JSON: http://www.json.org/