home/Data quality/Aperture Data Studio v1/Customize and monitor usage/Create data tags, scripts and other objects

Create data tags, scripts and other objects

Define your business terminology, create data tags/scripts and other objects used by workflow steps. You can also view and edit the blocking keys and rulesets for the Find duplicates step.

Constants

The constants area shows the existing constant libraries. You can view the standard business constants installed with Data Studio or create your own. The business constants supplied are regular expressions that can be used in transformations to verify the format of commonly found data fields. You can also create and define your own business constant libraries to use in transformations or with custom steps.

Events

Events are occurrences/triggers in Data Studio, such as a workflow completing. Each event contains event information - event data items (e.g. the workflow name).

You can set up email notifications to be sent to you/other recipients when certain events have been published.

There are two types of events:

  • System
  • Custom

System events

These are events that occur in Data Studio. The following system events (and the related data items) are available:

System event name Available event data items
Workflow started CURRENT_USER_EMAIL
CURRENT_USER_NAME
WORKFLOW_ID
WORKFLOW_JOB_ID
WORKFLOW_NAME
WORKFLOW_START_TIME
Workflow completed CURRENT_USER_EMAIL
CURRENT_USER_NAME
WORKFLOW_COMPLETION_TIME
WORKFLOW_ID
WORKFLOW_JOB_ID
WORKFLOW_NAME
WORKFLOW_START_TIME
Workflow failed CURRENT_USER_EMAIL
CURRENT_USER_NAME
WORKFLOW_ERROR_MESSAGE
WORKFLOW_ERROR_TIME
WORKFLOW_ID
WORKFLOW_JOB_ID
WORKFLOW_NAME
WORKFLOW_START_TIME
Workflow shared CURRENT_USER_NAME
EVENT_TIME
WORKFLOW_ID
WORKFLOW_NAME
User created CREATED_USER_NAME
CURRENT_USER_NAME
EVENT_TIME
User deleted CURRENT_USER_NAME
DELETED_USER_NAME
EVENT_TIME
License expiring LICENSE_DAYS_REMAINING
LICENSE_EXPIRATION_DATE
LICENSE_NAME
Low disk space
(the default is 10% but you can change that in
Configuration > All server settings > Disk
space free warning threshold)
DISK_SPACE_PERCENTAGE
EVENT_TIME
All events (includes custom events) See individual events for available data items.

Custom events

These are events that you can create depending on your business requirements. In addition to the event data items you've created, the following items will be available for all custom events:

Event type Available event data items
Custom event WORKFLOW_ID
WORKFLOW_NAME
PREVIOUS_STEP_NAME
NEXT_STEP_NAME
EVENT_TIME
CURRENT_USER_NAME
CURRENT_USER_EMAIL

To create a custom event, go to Glossary > Custom events and click Create a new custom event.

  • Name - enter a descriptive name for the event.
  • Description - add an optional description.
  • Event data - you can create data items relevant to this event whose values will be supplied when the event is triggered. The Fire event step is configured to populate these data items when the event is fired. Each data item is identified by its name (the description is for your reference only).
  • Owner/team - specify who will be able to edit the event (in addition to the administrator).

For example, if you want to create a custom event that is fired when the Validate step has failures, you could create a custom event with the name 'Validation failed' and an event data item named 'Reason'. Once used in the Fire event step, different values for the event data item (Reason) can be provided.

To publish a custom event, use the Fire event step.

Data tags

You can create new and manage existing data tags using Glossary.

Experian Match blocking keys

This contains the default blocking keys used by the Find duplicates step. You can't change the default set but administrators can create their own keys to customize the behavior of the step.

Experian Match rulesets

This contains the default rulesets used by the Find duplicates step. You can't change the default ones but administrators can create their own rulesets to customize the behavior of the step.

Notifications

You can receive email notifications when a particular system or custom event occurs in Data Studio (e.g. a workflow has completed).

To create a notification, go to Glossary > Notifications and click Create a new notification.

  • Name - enter a descriptive name for the notification.
  • Description - add an optional description.
  • Event - select an event from a list of system and your custom events that has to occur for this notification to be triggered.
  • Trigger conditions - you can provide specific event data values that will have to be matched for this notification to be triggered.
  • Notification type - the action that will occur when this notification is triggered. Currently, only email notifications are available.
  • Recipient - the email address of the recipient(s). To use multiple addresses, separate them with a space, comma or semicolon.
  • Email subject/Email content - the subject/body of the email. You can insert data item values using the @ symbol followed by the data item name. For example, use @WORKFLOW_NAME to insert the name of the workflow. Note that the list of available data items will depend on the selected event.
  • Owner/team - specify who will be able to edit the event (in addition to the administrator).

Administrators can configure the SMTP server settings by going to Configuration > All server settings > SMTP Properties.

Once set up, click Test SMTP Configuration (in All server settings) to test the connection.

Scripts

The scripts section allows you to define scripts that can be used by the Script steps in a workflow. Scripts have to be added to a script library.

To add a script library, click Create a new script library, enter a name of the library, a description (optional) and click Okay. Note that script libraries can be deleted only when they are empty.

All scripts have to be added to an existing library. To add a new script, click on the required library then click Create a new script. Scripts require a unique name, the area of use, indication of whether they can output logging to a file, the language type and the script code. The script definition can optionally also have parameters to change the script's behavior.

Aperture Data Studio v1

Customize and monitor usage