forked from abbacode/acixl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Add payload instructions.txt
71 lines (63 loc) · 2.81 KB
/
Add payload instructions.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
============================================
Overview for adding new payload into ACIXL
============================================
1. Create a new file with the payload structure
2. Update launcher.json with a new entry for the new payload
3. Create a table in excel and assign it a dynamic name
4. Press the refresh launcher button in excel
These steps are described in more detail below:
===================================================
1 .Create a new file with the payload structure
====================================================
* Create a new file representing the payload and place it under \jsondata\<sub directory>\
* Example output for the file:
Example of how the file should appear:
{
"fvTenant": {
"attributes": {
"dn": "uni/tn-{{tn_name}}",
"name": "{{tn_name}}",
"descr": "{{description}}",
"status": "{{action}}"
}
}
}
note. The values encompassed in {{ }} will automatically be replaced from the table data in excel.
==========================================================
2. Update launcher.json with a new entry for the payload
===========================================================
"tenant": {
"json_folder": "FabTnPol",
"json_file": "tenant.json",
"json_uri": "mo/uni/tn-{tn_name}",
"action_msg": "Push Tenant configuration",
"worksheet_name": "Tenant_Policies",
"table_name": "TABLE_TENANT",
"mandatory_keys": [
"action",
"tn_name"],
"default_values": {
"example1": "default_value",
"example2": "default_value"}
}
},
Note. Make sure to the values contain the relevant information, i.e.
- "tenant": a unique name to identify this payload, appears in excel
- json_folder: the sub directory under the jsondata\ folder that the payload is located
- json_file: the exact filename that contains the payload
- json_uri: the uri that the payload needs to be pushed to
- action_msg: msg that appear in excel when this payload is pushed
- worksheet_name: name of the worksheet where the table is located
- table_name: name of the table in the excel run sheet that has the values
- mandatory_keys: what column names are mandatory for the row to be considered valid
- default_values: default values for non-mandatory columns
=============================================
3. Create a new table in the excel run sheet
=============================================
- Create a new table using an existing table as an example
- Select the table range (starting from status_code as top left cell) and give it a name, i.e. TABLE_TENANT
- Ensure the new table name does is not already in use
- Add as many columns as required, ensure they match with {{ }} values defined in step 1
=============================================
4. Press the Refresh launcher button in excel
=============================================