Introduction

ey-telemetry is a service used to collect data about auditors auditing behaviour and pattern, so that business can analyse telemetry data and identify opportunity for AI improvements and enhancements.

Getting Started

Project setup

Add a .npmrc file to your project, in the same directory as your package.json

Copy below code block and add it into .npmrc file

registry=https://eysbp.pkgs.visualstudio.com/_packaging/EY.Audit.Automation.Telemetry/npm/registry/ 
                        
always-auth=true

Then, run vsts-npm-auth to get an Azure Artifacts token added to your user-level .npmrc file

npx vsts-npm-auth -config .npmrc

Install the package

Install the ey-telemetry client library using npm

npm install ey-telemetry

Configure Typescript

TypeScript users need to have Node type definitions installed:

npm install @types/node

Request

Data will be sent by using following method(s)

SendMessage(<message>, <event hub connection string>);

SendBatchMessage(<messages>, <event hub connection string>);

Parameters

• Message(s) – model data which will send to event hub.

• Connection String – Event hub connection string with SaS token

Request Body

{
    ApplicationID : "<Unique identifier provided by telemetry team>",
    BusinessDomain: "<Tax/Audit>",
    BusinessProcess: "<PSP/OSP>",
    Country: "<country name>",
    User: "<user email address>",
    UserRank: "<users rank in organization>",
    Payload: "<Free text or Json payload>",
    SystemUniqueID: "<Engagement Id>"
}

Examples

Using strict types

import { Telemetry } from 'ey-telemetry';

Using Angular

Create instance of Telemetry

connectionString = <Event hub connection string>;
producer: Telemetry;
constructor() {
    this.producer = new Telemetry(this.connectionString);
}

Send single message into event hub

let message: Message = {
    ApplicationID : "<Unique identifier provided by telemetry team>",
    BusinessDomain: "<Tax/Audit>",
    BusinessProcess: "<PSP/OSP>",
    Country: "<country name>",
    User: "<user email address>",
    UserRank: "<users rank in organization>",
    Payload: "<Free text or Json payload>",
    SystemUniqueID: "<Engagement Id>"
};
producer.SendMessage(message, this.connectionString);

Send batch of messages into event hub

let messages: Message[] = [
    {message1}, 
    {message2},
    ...
    ];
producer.SendBatchMessage(messages, this.connectionString);

Using javascript / react

Create instance of Telemetry

connectionString = <Event hub connection string>;
producer;
constructor() {
    this.producer = new Telemetry(this.connectionString);
}

var message = { ApplicationID : "", BusinessDomain: "<Tax/Audit>", BusinessProcess: "<PSP/OSP>", Country: "", User: "", UserRank: "", Payload: "", SystemUniqueID: "" }; producer.SendMessage(message, this.connectionString);

# General
## Message properties
Property | Data Type | Required |
--- | --- | ---
ApplicationId | string | Yes
BusinessDomain | string | Yes
BusinessProcess | string (13) | Yes
Country | string | No
User | string | No
UserRank | string | No
Payload | string | Yes
SystemUniqueId | string | No

# Build and Test
TODO: Describe and show how to build your code and run the tests. 

# Contribute
For any suggestion or queries please write to us at [email protected] or [email protected]