EN
Español
English
Português
    Register the "category" property

    The property “category” relates the States and Additional Fields of CMDB, the configuration file has the following JSON for model:

    {
        "category": [
        {
          "id": 0,
          "reference": "",
          "keys": [
            ""
          ],
          "projectId": 0,
          "additionalFields": [
            {
              "id": 0,
              "key": "",
              "mapping": [
                {
                  "id": 0,
                  "value": ""
                }
              ]
            }
          ],
          "state": [
            {
              "id": 0,
              "reason": 0,
              "value": ""
            }
          ]
        }
      ]
    }
    

    1. With the help of a CMDB of Aranda get the ID of the category to be related, this value will be recorded in the category.id in the configuration file.

    2. Type the values in the “category.id” from the configuration file:

    {
        "category": [
        {
          "id": 14,
          "reference": "",
          "keys": [],
          "projectId": 0,
          "additionalFields": [],
          "state": []
        }
      ]
    }
    

    3. Add a unique identifier in the “reference” property to group the configuration file sessions, in this example we will use “computer” as shown below.

    {
        "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": [],
          "projectId": 0,
          "additionalFields": [],
          "state": []
        }
      ]
    }
    

    4. Select the “deviceType” you want to associate in the integration, here You can check TechPulse information, in this case we will use “Notebook” as shown below.

    {
        "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 0,
          "additionalFields": [],
          "state": []
        }
      ]
    }
    

    4. Add the CMDB project id to use in the configuration file.

    {
        "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 4,
          "additionalFields": [],
          "state": []
        }
      ]
    }
    

    5. In the additional fields an additional field will be added for our example configuration file, in the id field the id of the additional field is placed in CMDB.

    {
        "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 4,
          "additionalFields": [
            {
    					"id": 329,
    					"key": "",
    					"mapping": [
    					]
    				}
          ],
          "state": []
        }
      ]
    }
    

    6. In the key property, add the property that you want to relate to the additional field in the CMDB.

    {
        "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 4,
          "additionalFields": [
            {
              "id": 329,
              "key": "deviceosMajorVersion",
              "mapping": [
              ]
            }
          ],
          "state": []
        }
      ]
    }
    

    6. In the mapping property of the configuration file you can relate the possible values as shown below.

    {
      "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 4,
          "additionalFields": [
            {
              "id": 329,
              "key": "deviceosMajorVersion",
              "mapping": [
                {
                  "id": 861,
                  "value": "Windows 11"
                },
                {
                  "id": 862,
                  "value": "Windows 10"
                }
              ]
            }
          ],
          "state": []
        }
      ]
    }
    

    7. Identify the states you want to relate between properties, remember that you can query the techpulse states via postman here

    8. Add in the state.id property the state identifier in the CMDB, in the value property add the state identifier in techpulse and if applicable the reason identifier

    {
      "category": [
        {
          "id": 14,
          "reference": "computer",
          "keys": ["Notebook"],
          "projectId": 4,
          "additionalFields": [
            {
              "id": 329,
              "key": "deviceosMajorVersion",
              "mapping": [
                {
                  "id": 861,
                  "value": "Windows 11"
                },
                {
                  "id": 862,
                  "value": "Windows 10"
                }
              ]
            }
          ],
          "state": [
            {
              "id": 185,
              "reason": 262,
              "value": "Enrolled"
            },
            {
              "id": 186,
              "value": "Archived"
            }
          ]
        }
      ]
    }
    

    Continue: Example ci step 2 ↪

    ↩ Return