Working with View Type APIs

This chapter describes the Application Programming Interfaces (APIs) that are used for report template definitions. It describes:

  • Raw API

  • Audit Event API

Raw API

ReportConfig.xml / API:

  • Event

Record data type:

  • solutions.dirx.audit.persistence.api.UniversalRecord

Field:

  • rawData : solutions.dirx.audit.persistence.api.Event

Subreports:

  • Identification - Extension

  • Where From - Extension

  • Who - Extension

  • What

Column
Column Group		 Text Field Expression
Data Source Expression

Identification - When

$F{rawData}.getWhen()

Identification - Operation

$F{rawData}.getOperation()

Identification - UID

$F{rawData}.getUid()

Identification - Cause

$F{rawData}.getCause()

Identification - Outcome

$F{rawData}.getOutcome().toString()

Identification - Sensitivity

$F{rawData}.getSensitivity()

Identification - Type

$F{rawData}.getType()

Identification - Source

$F{rawData}.getSource()

Identification - Category

$F{rawData}.getCategory()

Identification - Extension

new JRBeanCollectionDataSource($F{rawData}.getExtension())

Where From - Application

$F{rawData}.getWhereFrom().getApplication()

Where From - Address

$F{rawData}.getWhereFrom().getAddress()

Where From - Type

$F{rawData}.getWhereFrom().getType()

Where From - Extension

new JRBeanCollectionDataSource($F{rawData}.getWhereFrom().getExtensions())

Who - Name

$F{rawData}.getWho().getName()

Who - UID

$F{rawData}.getWho().getUid()

Who - DN

$F{rawData}.getWho().getDn()

Who - From Address

$F{rawData}.getWho().getFromAddress()

Who - From Type

$F{rawData}.getWho().getFromType()

Who - Role

$F{rawData}.getWho().getRole()

Who - Path

$F{rawData}.getWho().getPath()

Who - Extension

new JRBeanCollectionDataSource($F{rawData}.getWho().getExtensions())

What

new JRBeanCollectionDataSource($F{rawData}.getWhat())

Identification - Extension Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.EventExtension

Fields:

  • type : java.lang.String

  • value : java.lang.String

Subreports:

  • -

Column Text Field Expression

Identification - Extension - Type

$F{type}

Identification - Extension - Value

$F{value}

Where From - Extension Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.WhereFromExtension

Fields:

  • type : java.lang.String

  • value : java.lang.String

Subreports:

  • -

Column Text Field Expression

Where From - Extension - Type

$F{type}

Where From - Extension - Value

$F{value}

Who - Extension Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.WhoExtension

Fields:

  • type : java.lang.String

  • value : java.lang.String

Subreports:

  • -

Column Text Field Expression

Who - Extension - Type

$F{type}

Who - Extension - Value

$F{value}

What Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.What

Fields:

  • name : java.lang.String

  • dn : java.lang.String

  • uid : java.lang.String

  • sensitivity : java.lang.String

  • lifecycle : java.lang.String

  • query : java.lang.String

  • type : java.lang.String

  • path : java.lang.String

Subreports:

  • What - Extension

  • What - Detail

Column
Column Group		 Text Field Expression
Data Source Expression

What - Name

$F{name}

What - DN

$F{dn}

What - UID

$F{uid}

What - Sensitivity

$F{sensitivity}

What - Lifecycle

$F{lifecycle}

What - Query

$F{query}

What - Type

$F{type}

What - Path

$F{path}

What - Extension

new JRBeanCollectionDataSource($F{extension})

What - Detail

new JRBeanCollectionDataSource($F{detail})

What - Extension Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.WhatExtension

Fields:

  • type : java.lang.String

  • value : java.lang.String

Subreports:

  • -

Column Text Field Expression

What - Extension - Type

$F{type}

What - Extension - Value

$F{value}

What - Detail Subreport

Record data type:

  • solutions.dirx.audit.persistence.api.WhatDetail

Fields:

  • operation : java.lang.String

  • type : java.lang.String

  • value : java.lang.String

Subreports:

  • -

Column Text Field Expression

What - Operation - Type

$F{operation}

What - Extension - Type

$F{type}

What - Extension - Value

$F{value}

Audit Event API

The Audit Event API is used for reports in Audit analysis. The API references the related audit message and so it can contain all fields listed in the Raw API and reports can also contain subreports. The list below is not complete, but only illustrative.

ReportConfig.xml / API:

  • -

Record data type:

  • solutions.dirx.audit.persistencev3.event.api.record.Identification

Fields:

  • operation : java.lang.String

  • type : java.lang.String

  • detail : java.lang.String

  • auditMessage : solutions.dirx.audit.persistence.AuditMessage

Subreports:

  • -

Column Text Field Expression

When

$F{auditMessage}.getIdentificationWhen()

Source

$F{auditMessage}.getIdentificationSource()

Application

$F{auditMessage}.getWhereFromApplication()

Address

$F{auditMessage}.getWhereFromAddress()

Who

$F{auditMessage}.getWhoName()

Type

$F{auditMessage}.getIdentificationType()

Operation

$F{operation}

What Type

$F{type}

What Details

$F{detail}