In order to setup an Agent, it's configuration, please check the information related to the Agent in the table provided below for few DevOps tools.

S.No	Property Type	Property Name	Tool Name	Description
1	Generic	toolsTimeZone	All Tools	Time zone in which the DevOps tool(i.e. Jenkins, JIRA, GIT) is running
2	Generic	startFrom	All Tools	Date and Time using which the data collection of the Agent will start
3	Generic	isDebugAllowed	All Tools	Flag to set debugging to true or false. Useful for seeing more logs
4	Generic	useResponseTemplate	All Tools	Flag to turn on the usage of Response Template
5	Generic	runSchedule	All Tools	Scheduler frequency of Agent in mins. Recommended - 30
6	Generic	timeFieldMapping	All Tools	Add the timeStampField here to get equivalent epoch time generated Eg: for Git timeFieldMapping: { commitTime : "%Y-%m-%dT%H:%M:%S.%fZ"}
7	Generic	ResponseTemplate	All Tools	Defines the field to be collected from the Rest API calls Eg data for Git. In the below example, fields highlighted in Blue is from the API response from the DEvOps tools and text highlighted in green are the attributes that will be stored in Neo4j. Attributes/field names in Neo4j follows camelCase Naming Convention "responseTemplate" : { "sha": "commitId", "commit" : { "author" : { "name": "authorName", "date": "commitTime" } } }
8	Tool Specific	IsEnrichmentRequired	SCM	Boolean value, which takes the input whether the user wants to go for Data Enrichment(which is mandatory for creating a correlation)
9	Tool Specific	SourceProperty	SCM	Property of the SCM tool whose value will be picked up the engine , for processing data enrichment.
10	Tool Specific	KeyPattern	SCM	A pattern to be entered , based on which the value from Source property will be fetched and stored.
11	Tool Specific	TargetProperty	SCM	Property of the SCM tool, which will store the calculated value of data Enrichment.It is used for creating correlations.
12	Tool Specific	userid	HP ALM	Valid UserID with access to read tool data
13	Tool Specific	passwd	HP ALM	Password of the mentioned UserID
14	Tool Specific	baseEndPoint	HP ALM	Url of the HP ALM(ex http://hostname:8080)
15	Tool Specific	timeStampField	HP ALM	last-modified
16	Tool Specific	timeStampFormat	HP ALM	Time stamp format of the field specified in timeStampField
17	Tool Specific	dataFetchCount	HP ALM	It is count of the event to be fetched for one REST call
18	Tool Specific	useResponseTemplate	HP ALM	true
19	Tool Specific	userid	Jira	Valid UserID with access to read tool data
20	Tool Specific	passwd	Jira	Password of the mentioned UserID
21	Tool Specific	baseUrl	Jira	#Jira_URL#/rest/api/2/search
22	Tool Specific	useResponseTemplate	Jira	true
23	Tool Specific	timeStampField	Jira	lastUpdated
24	Tool Specific	timeStampFormat	Jira	Time stamp format of the field specified in timeStampField
25	Tool Specific	userid	Artifactory	Valid UserID with access to read tool data
26	Tool Specific	passwd	Artifactory	Password of the mentioned UserID
27	Tool Specific	BaseUrl	Artifactory	REST URL to get list of Artifactory repositories(ex. https://<HOSTNAME>:8081/artifactory/api)
28	Tool Specific	FirstEndPoint	Artifactory	REST URL to get list of repositorie details (http://<HOSTNAME>:8081/artifactory/api/storage/)
29	Tool Specific	useResponseTemplate	Artifactory	true
30	Tool Specific	timeStampField	Artifactory	lastUpdated
31	Tool Specific	timeStampFormat	Artifactory	Time stamp format of the field specified in timeStampField
32	Tool Specific	userid	Jenkins	Valid UserID with access to read tool data
33	Tool Specific	passwd	Jenkins	Password of the mentioned UserID
34	Tool Specific	useResponseTemplate	Jenkins	true
35	Tool Specific	useAllBuildsApi	Jenkins	If it is set false it will take only latest 100 elements, if is set true retrive all builds
36	Tool Specific	baseUrl	Jenkins	#Jenkins_URL#
37	Tool Specific	jenkinsMasters	Jenkins	#Jenkins_Master_URL#
38	Tool Specific	timeStampField	Jenkins	buildTimestamp
39	Tool Specific	timeStampFormat	Jenkins	Time stamp format of the field specified in timeStampField
40	Tool Specific	access_key_id	AWS	Ii is the access key of an IAM user which has access all services in AWS(i.e PowerUser)
41	Tool Specific	secret_access_key	AWS	It is the Secret key of the specified access key
42	Tool Specific	timeStampField	AWS	launchTime
43	Tool Specific	timeStampFormat	AWS	Time stamp format of the field specified in timeStampField
44	Tool Specific	vpc_id	AWS	Specify the VPC ID(s)
45	Tool Specific	useResponseTemplate	AWS	false
46	Tool Specific	Additional Library	SVN	Agent setup includes download of boto3 library
47	Tool Specific	username	ServiceNow	Valid UserName with access to read tool data which should have access to folllowing table change_request, sysapproval_approver, incident, sysapproval_group
48	Tool Specific	password	ServiceNow	Password of the mentioned Username
49	Tool Specific	baseUrl	ServiceNow	#Service-Now_URL#
50	Tool Specific	timeStampField	ServiceNow	Specify the unique field in SNOW data(ex. commitTime) to refer time for each event
51	Tool Specific	timeStampFormat	ServiceNow	Time stamp format of the field specified in timeStampField
52	Tool Specific	username	SVN	Valid UserName with access to read tool data of all repositories
53	Tool Specific	password	SVN	Password of the mentioned Username
54	Tool Specific	baseUrl	SVN	Specify the URL of the repositories you need to monitor in list(ex. baseUrl : ["http://<HOSTNAME>:18080/svn/repo1","http://<HOSTNAME>:18080/svn/repo2"] )
55	Tool Specific	timeStampField	SVN	Specify the unique field in SVN data(ex. commitTime) to refer time for each event
56	Tool Specific	timeStampFormat	SVN	Time stamp format of the field specified in timeStampField
57	Tool Specific	ResponseTemplate	SVN	false
58	Tool Specific	Additional Library	SVN	Agent setup includes download of pysvn library
59	Tool Specific	accessToken	GIT	Valid UserName access token to read GIT data of all repositories
60	Tool Specific	getRepos	GIT	#GitHub_URL#/user/repos
61	Tool Specific	commitsBaseEndPoint	GIT	#GitHub_URL#/repos/repo_name
62	Tool Specific	timeStampField	GIT	commitTime
63	Tool Specific	timeStampFormat	GIT	Time stamp format of the field specified in timeStampField
64	Tool Specific	userid	SONAR	Valid UserID with access to read tool data
65	Tool Specific	passwd	SONAR	Password of the mentioned UserID
66	Tool Specific	useResponseTemplate	SONAR	false
67	Tool Specific	timeMachineapi	SONAR	yes/no - this is based on the Sonar version
68	Tool Specific	baseUrl	SONAR	#Sonar_URL#
69	Tool Specific	timeStampField	SONAR	buildTimestamp
70	Tool Specific	timeStampFormat	SONAR	Time stamp format of the field specified in timeStampField

DATA ENRICHMENT

Data Enrichment is a separate section added in SCM tools' configs,which deals with the post processing property of the nodes. The section should have the following properties.

IsEnrichmentRequired :- Enable Post Processing.
SourceProperty :-Choose the property on which the post processing has to be applied
TargetProperty :- Name of the new property to be created.
KeyPattern :- Regex to be applied

Once the property is configured in the agent management portion, it is the role of the engine to create the property, when the node is inserted in Neo4j. The property should be created based on the regex which is configured. Later the normal flow should continue ,wherein the user is able to choose the derived property in the co-relation builder screen to link the two nodes and this relationship would be picked up by the co-relation module to create the necessary relationship.

Top Section

Browser not supported