This is not the latest version of Identity Director documentation.
View available documentation.

Configure Reporting

This feature is available starting with Identity Director 2021.2.

Enable the Reporting feature to generate reports that allow you to analyze performance and activity of the services in your environment, by logging various categories of information in a datastore. This includes information on users, approval behavior, delivered and returned services, and workflow execution.

The Reporting datastore can be either on the same database server as your main Datastore, or on a different server.

Configuration

Setup and Sync Tool

  1. In the Setup and Sync Tool, go to the Reporting tab.

  2. Click on Datastore, where you have the option to either create a new datastore, or connect to an existing one.

  3. Go back to the Reporting tab and check the Active box.

Management Portal

In the Management Portal at Setup > Datastore > Reporting, you can configure the settings for your new or existing Reporting database.

Reporting Tables

After enabling the Reporting feature in your environment, you will see information logged in your reporting Datastore, in the following tables:

Field

Explanation
Id The ID of the insert
PersonId The ID of the person affected by the change
PersonName The person name
IsActive A person's Active/Inactive status (0 - inactive; 1 - active)
MarkedForDeletion A person's Marked for Deletion status (0 - not marked for deletion; 1 - marked for deletion)
Operation Change made to the person (0 - inactive; 1 - active; 2 - deleted)
CreatedOn A time stamp for the insert

Field

Explanation
Id The ID of the insert
PersonId The ID of the person affected by the change
PersonName The person name
OrganizationId The ID of the organization affected by the change

OrganizationName

The name of the organization affected by the change
ChangedOn A time stamp for the insert
Operation Changes made to an organization (0 - added; 1 - updated; 2 - deleted)

Field

Explanation
Id The ID of the insert
ServiceId The ID of the service
TriggeredOn A time stamp for when the service was triggered
DeliveredOn A time stamp for when the service was delivered

ServiceName

The name of the service
Direction Delivery (1) or Return (2)
SubscriberId The ID of the subscriber

SubscriberName

The name of the subscriber

RequesterId

The ID of the requester

RequesterName

The name of the requester

InstanceNo

The number of service instance

State

The state of the service at the time of the insert (0 - undefined; 1 - pending; 2 - failed, 3 - completed; 4 - aborted; 5 - expired; 6 - unlicensed; 7 - on hold; 8 - pending continuation; 9 - resuming; 10 - deleting)

Field

Explanation
Id The ID of the insert
InstanceGuid The GUID from the Or_ transactionaction table from the Identity Director datastore
TransactionGuid The GUID from the Transactions table from the Identity Director datastore
ExecutedByGuid

The GUID of the user who completed the action

  • If the GUID is 00000000-0000-0000-0000-000000000000, the action was completed without a user handling it

ExecutedByName

The name of the user who completed the action

  • If empty, the transaction was completed without a user handling it

State

The state of the service at the time of the insert (0 - unknown; 1 - pending; 2 - failed, 3 - completed; 4 - aborted; 5 - timedout; 6 - canceled by user; 7 - actor not found; 8 - pending continuation)

StartedOn

A time stamp for when the service started

FinishedOn

A time stamp for when the service was completed

Field

Explanation
ID The ID of the insert
InstanceGuid The GUID from the Or_ transactionaction table from the Identity Director datastore
ActorGuid The GUID of the person who needs to receive/approve an action
ActorName The Name of the person who needs to receive/approve an action

Field

Explanation
Id The ID of the insert
IdentifierId The ID of the people identifier saved in the Identity Director datastore
IdentifierTypeId The ID of the people identifier definition from the Identity Director datastore
IdentifierName The name of the people identifier definition

PersonId

The ID of the person to whom the change is made

PersonName

The name of the person to whom the change is made

Value

The people identifier value (if applicable)

OldValue

The old people identifier value (if applicable)

Operation

The value of the operation type (0 - added; 1 - updated; 2 - deleted)

  • Note that an overwrite operation performed by a Set People Attributes and Identifiers action will be logged as a delete (for the old value) and an add (for the new value)

CreatedOn

A time stamp for the insert

Field

Explanation
Id The ID of the insert
AttributeValueGuid The GUID of the people attribute from the OR_attributes table in the Identity Director datastore
AttributeDefinitionGuid The GUID of the people attribute definition for the attribute type

AttributeName

The name of the people attribute

AttributeType

The people attribute type (0 - text; 1 - list; 3 - password; 4 - table)

PersonId

The ID of the person to whom the change is made

PersonName

The name of the person to whom the change is made

Operation

The value of the operation type (0 - added; 1 - updated; 2 - deleted)

CreatedOn

A time stamp for the insert

Field

Explanation
Id The ID of the insert
PeopleAttributeId The ID of the people attribute
RowId

The row position of the people attribute value (for attributes of type table and of type list)

ColumnId

The column position of the people attribute value (for attributes of type table)

For attributes of type text or password, both the RowId and the ColumnId table values will be 0.

For attributes of type list, the ColumnId value will always be 0, while the RowId value will change to reflect the position of the attribute value in the list.

Note that support for the Reporting feature located in the Management Portal at Setup > Reporting (RES Reporting) has been discontinued.

See also