R2ObixClient Histories (logs and archives)

The Histories extension of an R2ObixClient is where you can import data from the R2 station’s log objects, as well as existing archives from its appdb (if it has the DatabaseService), by adding history import descriptors. The default view of Histories is the ObixHistoryManager (Figure 20), where you specify which discovered logs and archives you want to import, using the familiar oBIX “lobby” tree in the Discovered pane.

Figure 20. ObixHistoryManager is for importing R2 logs and/or archives into the history space


ObixHistoryManager is for importing R2 logs and/or archives into the history space

NoteThe ObixHistoryManager and created history import descriptors operate as they do in the history import views and descriptors in the NiagaraNetwork and BacnetNetwork. For related details, see the NiagaraAX Drivers Guide sections “About the Histories extension” and “History Import Manager”.

Each added descriptor (after archived in AX) produces one history in the station’s local history space, organized by default under a container with the same name as the source R2ObixClient. Figure 21 shows an example of how the created histories appear in the AX station’s history space.

Figure 21. By default, imported histories under container with name of ObixClient (often, stationName).


By default, imported histories under container with name of ObixClient (often, stationName).

Figure 22 shows an example add/edit dialog for an ObixHistoryImport descriptor with default values, where the import descriptor name matches the source R2 Log object name, and the history ID is a combination of the R2ObixClient’s name / Log object name.

Figure 22. Add/Edit dialog for importing an R2 log or archive by import descriptor


Add/Edit dialog for importing an R2 log or archive by import descriptor

Note that an R2ObixClient histories discover includes an R2 station’s “AuditLogService” and “ErrorLogService,” in addition to logs created by Log objects like “AnalogLog, BinaryLog,” and so on. See the next section ObixClient history import notes for additional notes.

ObixClient history import notes

When importing logs and archives from an R2 station under the Histories extension, note the following:

  • After you click Discover in the Obix History Manager to see the lobby, your subsequent initial expansion of the “histories” node in the Discovered pane may take a long time to process, often several minutes, depending on the number of log objects in the source R2 station, and particularly how many archives are in a source R2 Web Supervisor station. During this period, the Workbench cursor changes to an “hourglass,” and other operations must wait. However, after this initial expansion, the discovered history tree remains cached in memory—at least until you leave the Obix History Manager view.

    NoteIn a few cases involving large numbers of logs or archives, after expanding the histories node, the Workbench connection to the station was found to timeout and drop. Contact Systems Engineering for assistance in this scenario.

  • Note that all log objects and archives appear in the Discover pane after a discover—including log objects with identical names. However, note by default that they are unique by swid/href because of varying locations. It is recommended that you sort (click) the “Obix Name” column in the Discover pane to ASCII-sort discovered logs by name. This will group any identically-named log objects together.

    Although the Obix History Import manager allows you to create multiple import descriptors (with default values) for an identical Obix Name, note that only one can successfully import using the same History Id. Import descriptors with a duplicate History Id will go into fault upon import attempt. Therefore, by grouping you can select and edit History Ids appropriately when you add them to the database.

    For example, if you had a station named “RN_Hall”, with several logs each named “RmTemp”, you could edit the second field of the History Id for each descriptor to make each unique, for example “Zn1_RmTemp”, “Zn2_RmTemp”, and so on. This way, complete History Ids for each would be “RN_Hall/Zn1_RmTemp”, “RN_Hall/Zn2_RmTemp”, and so forth.