Enabling the Automation Context feature for plug-ins

{
    devices (filters: {device_role__name: "example-role"}){
      id
      name
    	device_role {
    	  id
        name
    	}
      site {
        id
        name
      }
    }
}

{
  "data": {
    "devices": [
      {
        "id": "1",
        "name": "example-device",
        "device_role": {
          "id": "1",
          "name": "example-role"
        },
        "site": {
          "id": "1",
          "name": "example-site"
        }
      }
    ]
  }
}

1. Create an automation file
2. Register the metadata instance
3. Register URL patterns for the Automation tab view
4. Register a template extension

• name
• display_name
• model
• automation_url_group
• automation_url_prefix
• graphql_arg_fields

from nfvi_automation.models.object_type_metadata import ObjectTypeAutomationMetadata
from .models import Application

class ApplicationAutomationMetadata(ObjectTypeAutomationMetadata):

    ## <app_name>.<model_name> (lowercase)
    name = 'netbox_applications.application'

    ## Name displayed to user. Normally the "verbose name" of your model
    display_name = 'Application'

    ## The Model (imported from models.py)
    model = Application

    ## URL for viewing automation
    ## automation_url_group should be "plugins:<app_name>"
    automation_url_group = 'plugins:netbox_applications'
    ## should match the first section (before the first "/") in the paths from urls.py for this model
    automation_url_prefix = 'applications'

    ## Fields to be extracted from the instance and passed as query arguments to the "data_expression" GraphQL query on the Automation Context
    ## Allows a user to query for data based on identifiable information of this object 
    ## We recommend providing any unique/identifiable attributes for your model
    ## Plus any unique/identifiable attributes for related models (e.g. "service__id" is the id of the related "service")
    graphql_arg_fields = ['id', 'installation_name', 'app_name', 'service__id', 'service__name']

    ## If your model can be categorised by "type" then you can enable these fields 
    ## to allow Automation Contexts to be associated with a particular type 
    ## (e.g. Devices have a DeviceType, so we can associate Automation Context to all Devices with DeviceType "HP XYZ")
    ## Name of the field on your model which relates to a type
    #assignable_type_field = 'type'

    ## The model which represents the type
    #assignable_type_model = ApplicationType

    ## Name of the field to be extracted from the related type when exporting an instance of this Automation Context
    #assignable_type_model_export_field = 'name'

    ## Alternative to "assignable_type_model" and "assignable_type_model_export_field"
    ## When the model is categorised by types presented as a ChoiceSet rather than a model
    #assignable_type_choices = None

    ## If your model can be categorised by "role" then you can enable these fields 
    ## to allow Automation Contexts to be associated with a particular role 
    ## (e.g. Devices have a DeviceRole, so we can associate Automation Context to all Devices with DeviceRole "Compute")
    
    ## Name of the field on your model which relates to a role
    #assignable_role_field = 'role'
    
    ## The model which represents the role
    #assignable_role_model = None
    
    ## Name of the field to be extracted from the related role when exporting an instance of this Automation Context
    #assignable_role_model_export_field = 'name'
    
    ## Alternative to "assignable_role_field" and "assignable_role_model_export_field"
    ## When the model is categorised by roles presented as a ChoiceSet rather than a model
    #assignable_role_choices = None
    

# Recommended you create an instance as this will be reused later
application_metadata = ApplicationAutomationMetadata()

def ready(self):
        super().ready()
        from .automation import application_metadata
        from nfvi_automation.models import ObjectTypeAutomationMetadata
        
        ObjectTypeAutomationMetadata.register.add(application_metadata)

from django.urls import path
from .automation import application_metadata
from nfvi_automation.views import AutomationContextProcessView

urlpatterns = (
    ...
    other paths
    ...
    path(f'{application_metadata.automation_url_prefix}/<int:object_pk>/automation/',  AutomationContextProcessView.as_view(), 
        name=application_metadata.get_automation_view_name(), kwargs={'metadata': application_metadata})
)

from nfvi_automation.template_content import AutomationExtensions
from .automation import application_metadata

class ApplicationAutomationExtensions(AutomationExtensions):
    metadata = application_metadata
    model = 'netbox_applications.application'
    
template_extensions = [ApplicationAutomationExtensions]