Skip to content

Commit 0128071

Browse files
lingy1028lingy1028
authored
Merge pull request #1 from ifonsecam/upgrade-ta
Upgrade TA
2 parents 4d2bdf5 + c578ed3 commit 0128071

File tree

5 files changed

+34
-126
lines changed

5 files changed

+34
-126
lines changed

‎DEV.md‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ pip3 install splunk-add-on-ucc-framework
77
### 2. Create `globalConfig.json` and `app.manifest`
88
An easy way to create desired `globalConfig.json` and `app.manifest` is by leveraging AOB. You can create a TA with desired UI components using AOB, and then use the generated `globalConfig.json` and `app.manifest` directly.
99

10+
**Note**: For newer versions of the Splunk UCC Framework, the meta property "apiVersion" is deprecated.
11+
1012
**If you use AOB, please pay attention to the following points**:
1113
1. AOB auto-generates an `Add-on Folder Name` for your add-on, which has the format `TA-your-add-on-name`. This format is not consistent with the built-in OAuth redirect URL format. You'd better change it to a format that only contains **lowercase** and **"_"**.
1214
e. g. `ta_your_add_on_name`
@@ -33,10 +35,6 @@ Two ways to change the Add-on Folder Name for AOB Add-on:
3335
...
3436
```
3537
36-
3. Pay attention to `"meta"` section inside `globalConfig.json`. Make sure you have `"apiVersion"` under `"meta"`
37-
e.g. `"apiVersion": "4.1.10".`
38-
39-
4038
### 3. Create required file structure
4139
```
4240
mkdir <TA-name>
@@ -585,8 +583,7 @@ Re-run `ucc-gen` the desired `input.conf` and `props.conf` will be copied into y
585583
"displayName": "Cisco Webex Add-on for Splunk",
586584
"version": "1.0.0",
587585
"restRoot": "ta_cisco_webex_add_on_for_splunk",
588-
"apiVersion": "4.1.10",
589-
"schemaVersion": "0.0.3"
586+
"schemaVersion": "0.0.9"
590587
}
591588
```
592589
@@ -603,8 +600,6 @@ Re-run `ucc-gen` the desired `input.conf` and `props.conf` will be copied into y
603600
604601
605602
## Troubleshooting
606-
### ERROR: Config is not valid. Error: 'apiVersion' is a required property
607-
- Make sure you have `"apiVersion": "3.2.0"` under `meta` section in `globalConfig.json`
608603
609604
### ModuleNotFoundError: No module named 'mmap'
610605
- If you encounter this error after running `ucc-gen`, please try to setup a new python3 (>=v3.7) virtual environment and re-run `ucc-gen`

‎globalConfig.json‎

Lines changed: 26 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
"meta": {
33
"name": "ta_cisco_webex_add_on_for_splunk",
44
"displayName": "Cisco Webex Add-on for Splunk",
5-
"version": "1.0.7",
5+
"version": "1.0.8",
66
"restRoot": "ta_cisco_webex_add_on_for_splunk",
7-
"apiVersion": "4.1.10",
8-
"schemaVersion": "2.0.0",
9-
"_uccVersion": "5.39.1"
7+
"schemaVersion": "0.0.9",
8+
"supportedThemes": [
9+
"light",
10+
"dark"
11+
]
1012
},
1113
"pages": {
1214
"configuration": {
@@ -92,7 +94,8 @@
9294
"oauth_popup_height": 600,
9395
"oauth_timeout": 180,
9496
"auth_code_endpoint": "/v1/authorize?response_type=code&scope=spark:kms meeting:admin_participants_read meeting:admin_schedule_read spark:organizations_read audit:events_read meeting:admin_config_read spark-admin:people_read analytics:read_all&state=set_state_here",
95-
"access_token_endpoint": "/v1/access_token"
97+
"access_token_endpoint": "/v1/access_token",
98+
"oauth_state_enabled": false
9699
}
97100
}
98101
]
@@ -194,41 +197,7 @@
194197
}
195198
},
196199
{
197-
"name": "logging",
198-
"title": "Logging",
199-
"entity": [
200-
{
201-
"field": "loglevel",
202-
"label": "Log level",
203-
"type": "singleSelect",
204-
"options": {
205-
"disableSearch": true,
206-
"autoCompleteFields": [
207-
{
208-
"label": "DEBUG",
209-
"value": "DEBUG"
210-
},
211-
{
212-
"label": "INFO",
213-
"value": "INFO"
214-
},
215-
{
216-
"label": "WARNING",
217-
"value": "WARNING"
218-
},
219-
{
220-
"label": "ERROR",
221-
"value": "ERROR"
222-
},
223-
{
224-
"label": "CRITICAL",
225-
"value": "CRITICAL"
226-
}
227-
]
228-
},
229-
"defaultValue": "INFO"
230-
}
231-
]
200+
"type": "loggingTab"
232201
}
233202
]
234203
},
@@ -290,7 +259,6 @@
290259
],
291260
"actions": [
292261
"edit",
293-
"enable",
294262
"delete",
295263
"clone"
296264
]
@@ -322,18 +290,11 @@
322290
]
323291
},
324292
{
293+
"type": "interval",
325294
"field": "interval",
326295
"label": "Interval",
327-
"type": "text",
328-
"required": true,
329296
"help": "Time interval of input in seconds",
330-
"validators": [
331-
{
332-
"type": "regex",
333-
"pattern": "^\\d+$",
334-
"errorMsg": "Interval must be an integer"
335-
}
336-
]
297+
"required": true
337298
},
338299
{
339300
"field": "index",
@@ -377,10 +338,7 @@
377338
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
378339
"errorMsg": "Start time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2023-01-01T00:00:00Z)"
379340
}
380-
],
381-
"options": {
382-
"placeholder": "2023-01-01T00:00:00Z"
383-
}
341+
]
384342
},
385343
{
386344
"field": "end_time",
@@ -394,10 +352,7 @@
394352
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
395353
"errorMsg": "End time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2033-01-01T00:00:00Z)"
396354
}
397-
],
398-
"options": {
399-
"placeholder": "2033-01-01T00:00:00Z"
400-
}
355+
]
401356
}
402357
]
403358
},
@@ -427,18 +382,11 @@
427382
]
428383
},
429384
{
385+
"type": "interval",
430386
"field": "interval",
431387
"label": "Interval",
432-
"type": "text",
433-
"required": true,
434388
"help": "Time interval of input in seconds",
435-
"validators": [
436-
{
437-
"type": "regex",
438-
"pattern": "^\\d+$",
439-
"errorMsg": "Interval must be an integer"
440-
}
441-
]
389+
"required": true
442390
},
443391
{
444392
"field": "index",
@@ -483,10 +431,7 @@
483431
"maxLength": 8192,
484432
"errorMsg": "Max length of text input is 8192"
485433
}
486-
],
487-
"options": {
488-
"placeholder": "example.webex.com"
489-
}
434+
]
490435
},
491436
{
492437
"field": "start_time",
@@ -500,10 +445,7 @@
500445
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
501446
"errorMsg": "Start time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2023-01-01T00:00:00Z)"
502447
}
503-
],
504-
"options": {
505-
"placeholder": "2023-01-01T00:00:00Z"
506-
}
448+
]
507449
},
508450
{
509451
"field": "end_time",
@@ -517,10 +459,7 @@
517459
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
518460
"errorMsg": "End time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2033-01-01T00:00:00Z)"
519461
}
520-
],
521-
"options": {
522-
"placeholder": "2033-01-01T00:00:00Z"
523-
}
462+
]
524463
}
525464
]
526465
},
@@ -550,18 +489,11 @@
550489
]
551490
},
552491
{
492+
"type": "interval",
553493
"field": "interval",
554494
"label": "Interval",
555-
"type": "text",
556-
"required": true,
557495
"help": "Time interval of input in seconds",
558-
"validators": [
559-
{
560-
"type": "regex",
561-
"pattern": "^\\d+$",
562-
"errorMsg": "Interval must be an integer"
563-
}
564-
]
496+
"required": true
565497
},
566498
{
567499
"field": "index",
@@ -605,10 +537,7 @@
605537
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$",
606538
"errorMsg": "Start time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2023-01-01T00:00:00.000Z)"
607539
}
608-
],
609-
"options": {
610-
"placeholder": "2023-01-01T00:00:00.000Z"
611-
}
540+
]
612541
},
613542
{
614543
"field": "end_time",
@@ -622,10 +551,7 @@
622551
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$",
623552
"errorMsg": "End time must be in the format YYYY-MM-DDTHH:MM:SS.SSSZ (example:2033-01-01T00:00:00.000Z)"
624553
}
625-
],
626-
"options": {
627-
"placeholder": "2033-01-01T00:00:00.000Z"
628-
}
554+
]
629555
}
630556
]
631557
},
@@ -655,18 +581,11 @@
655581
]
656582
},
657583
{
584+
"type": "interval",
658585
"field": "interval",
659586
"label": "Interval",
660-
"type": "text",
661-
"required": true,
662587
"help": "Time interval of input in seconds",
663-
"validators": [
664-
{
665-
"type": "regex",
666-
"pattern": "^\\d+$",
667-
"errorMsg": "Interval must be an integer"
668-
}
669-
]
588+
"required": true
670589
},
671590
{
672591
"field": "index",
@@ -710,10 +629,7 @@
710629
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
711630
"errorMsg": "Start time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2023-01-01T00:00:00Z)"
712631
}
713-
],
714-
"options": {
715-
"placeholder": "2023-01-01T00:00:00Z"
716-
}
632+
]
717633
},
718634
{
719635
"field": "end_time",
@@ -727,10 +643,7 @@
727643
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
728644
"errorMsg": "End time must be in the format YYYY-MM-DDTHH:MM:SSZ (example:2033-01-01T00:00:00Z)"
729645
}
730-
],
731-
"options": {
732-
"placeholder": "2033-01-01T00:00:00Z"
733-
}
646+
]
734647
}
735648
]
736649
}

‎package/app.manifest‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"id": {
66
"group": null,
77
"name": "ta_cisco_webex_add_on_for_splunk",
8-
"version": "1.0.7"
8+
"version": "1.0.8"
99
},
1010
"author": [
1111
{

‎package/default/app.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build = 1
55

66
[launcher]
77
author = FDSE
8-
version = 1.0.7
8+
version = 1.0.8
99
description =
1010

1111
[ui]
@@ -17,7 +17,7 @@ docs_section_override = AddOns:released
1717
id = ta_cisco_webex_add_on_for_splunk
1818

1919
[id]
20-
version = 1.0.7
20+
version = 1.0.8
2121

2222
[triggers]
2323
reload.ta_cisco_webex_add_on_for_splunk_account = simple

‎package/lib/requirements.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
splunktaucclib==6.0.7
2-
splunk-sdk==2.0.1
1+
splunktaucclib==8.0.0
2+
splunk-sdk==2.1.0

0 commit comments

Comments
 (0)