| Anchor | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Understand and learn how to setup new agent environment on this page. |
| Panel | |
|---|---|
On this page
|
Extend Base Agent
Extend Base Agent.py file present in the agent directory.
Define config.json file
- Property names in config.json must follow camelcase format.
- Every config.json must have property "toolCategory" with appropriate value in CAPITAL letters.
- For Example - "toolCategory" : "ALM".
- All complex JSON Objects must be kept under property name "dynamicTemplate". For example, Arrays, Properties having sub-properties as a JSON Object.
- "responseTemplate" shall always be part of the dynamicTemplate, to capture the response from the external tool.
The below dynamicTemplate example is for GitHub.
Panel title Dynamic Template Format "dynamicTemplate": {
"responseTemplate": {
"sha": "commitId",
"commit": {
"author": {
"name": "authorName",
"date": "commitTime"
}
}
}
}
Update installagent.sh file
- Update "installagent.sh" file if the OS is other than Linux or Ubuntu.
Data Update Supported
- Any agent which is publishing data in Neo4j and data node will be updated each time agent is collecting data, based on the unique combination of properties(columns),
and using dataUpdateSupported field as True.
The metadata which holds this unique key combinaton and data update supported should be proivided from agent or python files.
example:
metadata = {"dataUpdateSupported": True,"uniqueKeys":["property1","property2"]}