Scribd
Upload
79 views7 pages

Splunk Integration With Blue Prism v6 - 2

Uploaded by

email2mesurya
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
79 views7 pages

Splunk Integration With Blue Prism v6 - 2

Uploaded by

email2mesurya
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

DATA SHEET

Splunk integration with Blue Prism® v6


Introduction
Splunk is a data collection and analysis tool which can be used to receive Session Log data from your Blue Prism
runtime resources via a HTTP endpoint.
Although Splunk is a generic data capture and reporting tool that can be used to analyse a variety of data, Blue
Prism® Version 6 has been specifically programmed to send data to Splunk in a format it can understand.
What information can be captured?
Blue Prism can send Session Log data directly from each Runtime Resource. This is the only component which has
been specifically programmed to produce data in a format consumable by Splunk.
A Runtime Resource will generate information about each stage within a process, for each process it runs; and
errors which occur during its operation.
This document provides a walkthrough of the steps required to configure Splunk to consume Blue Prism’s Session
Log information for reporting purposes.

Quick Start
To get the Splunk software set up, please follow the Walkthrough available here:
http://www.splunk.com/en_us/download.html

Configuring Splunk
Launch Splunk via a browser interface. On the Explore Splunk main page choose the ‘Data inputs’ link under the
‘Settings’ drop-down:

Commercial in Confidence Page 1 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

Add Data – HTTP Event Collector


On the next screen, select ‘Add New’ for the ‘HTTP Event Collector’ input type:

Create a New Token


On the main HTTP Event Collector page, select ‘New Token:

Commercial in Confidence Page 2 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

Give your token a name, all other settings on this page are optional:

The remaining items can be left as their defaults or configured based on your individual requirements – hit ‘Sumbit’
to generate your token:

Commercial in Confidence Page 3 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

Find and copy the token


The new token will now be listed on the “Settings > Data Items” page you begun configuration on – take a copy of
the token value listed here:

Configure Global Settings


Click ‘Global Settings’ on the HTTP Event Collector page:

Commercial in Confidence Page 4 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

On the Global Settings page, ensure that the ‘All Tokens' setting is set to ‘Enabled’. You can optionally enable SSL
and change the port number events are sent to here:

Commercial in Confidence Page 5 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

Configuring Blue Prism


The requirements for Blue Prism are:
• Version 6.0 or greater.
• A configuration file called “splunk_config.xml” in the %appdata% directory of the account used to launch
the Runtime Resource (e.g. C:\Users\<user>\AppData\Roaming)

Configuration file
The Runtime Resource’s “splunk_config.xml” configuration file is an XML file which has the following parameters in
this format:

splunk_config.xml configuration file File Parameter Definitions


<config> • <host> : the DNS name or IP address of the
<endpoint name="HTTP Server"> machine hosting the Splunk server.
<host>mysplunkserver</host>
<port>8088</port> • <port> : the port number on the <host>
</endpoint> machine. Set to match the HTTP Port Number
<flag name="Secure">false</flag> in Splunk.
<text
name="Path">/services/collector/event</text • <text name=”Path”> : the URI path to send
> event data to on the Splunk server.
<text name="Token"> 3d52171f-0171-435b-8456- • This will not typically change from
d22afbb655ac </text>
/services/collector/event
<text name="Source">Blue Prism Session
Logs</text> • “Secure” : set to match the Enable SSL
</config> parameter in the Global Settings in Splunk.
• “Token” : the Token Value of the HTTP Event
Collector.
• “Source”
NOTE: The ‘splunk_config.xml’ file can be deployed to any Blue Prism Runtime: Used to uniquely
Resource tag events
from which you sent
need to
from the Blue Prism runtime resource.
send Session Log data.
When setting a port number ensure that your organisation’s security mechanisms permit communication on
the configured port between the Blue Prism machine and the machine hosting the Splunk event collector.

Commercial in Confidence Page 6 of 7


®Blue Prism is a registered trademark of Blue Prism Limited
DATA SHEET

For the settings to take


effect you must exit and
relaunch the Blue Prism
Runtime Resource.
This will be required
whenever changes are
made to the
‘splunk_config.xml’ file, as
the Runtime Resource will
only read this file before it
runs its first session after it
has been launched.
Here’s an example of a
report from Blue Prism’s
Session Log data which can
be obtained from the
Search and Reporting
section in Splunk:

Commercial in Confidence Page 7 of 7


®Blue Prism is a registered trademark of Blue Prism Limited

You might also like