Policy types for @turbot/servicenow-gcp

GCP > Project > ServiceNow

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNow
Targets

GCP > Project > ServiceNow > Configuration Item

Synchronize the data for the GCP > Project based on the policies GCP > Project > ServiceNow > Configuration Item > *

The Configuration Item control is responsible for automatically synchronizing records in a designated ServiceNow table, maintaining an up-to-date reflection of the GCP > Project information within the ServiceNow CMDB.

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowConfigurationItem
Valid Value
[
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Archived",
"Check: Deleted",
"Check: Sync",
"Enforce: Archived",
"Enforce: Deleted",
"Enforce: Sync",
"Enforce: Sync, archive on delete"
],
"example": [
"Skip"
],
"default": "Skip"
}

GCP > Project > ServiceNow > Configuration Item > Record

The policy facilitates the accurate representation of cloud resource within the ServiceNow environment, ensuring that critical data is effectively mapped and managed. Attribute of an GCP > Project is systematically mapped to a specific column in a ServiceNow table.

The policy allows enabling organizations to select and map only those attributes that are most relevant to their operational needs. It significantly reduces the manual effort involved in data transfer and minimizes the risk of errors, thereby enhancing the overall efficiency of data management.

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowConfigurationItemRecord
Default Template Input
"{\n resource: project{\n data\n metadata\n turbot {\n akas\n id\n tags\n title\n }\n }\n}\n"
Default Template
"create_time: {{ $.resource.data.createTime | dump | safe }}\nlifecycle_state: {{ $.resource.data.lifecycleState | dump | safe }}\nparent_id: {{ $.resource.data.parent.id | dump | safe }}\nparent_type: {{ $.resource.data.parent.type | dump | safe }}\nproject_id: {{ $.resource.data.projectId | dump | safe }}\nproject_labels: {{ $.resource.data.projectLabels | dump | safe }}\nproject_name: {{ $.resource.data.name | dump | safe }}\nproject_number: {{ $.resource.data.projectNumber | dump | safe }}\n"
Schema
{
"type": "object"
}

GCP > Project > ServiceNow > Configuration Item > Table Definition

This policy specifically allows users to define two key aspects: the name of the ServiceNow table where the GCP > Project data will be stored, and the details of the columns used for archiving purposes.

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowConfigurationItemTableDefinition
Default Template Input
[
"{\n serviceNowInstance: resources(filter: \"resourceTypeId:tmod:@turbot/servicenow#/resource/types/instance level:self limit:1\") {\n items {\n turbot {\n id\n }\n }\n }\n}\n",
"{\n tableDefinition: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowTableDefinition resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n applicationScope: policyValues(filter: \"policyTypeId:tmod:@turbot/servicenow#/policy/types/serviceNowApplicationScope resourceId:{{$.serviceNowInstance.items[0].turbot.id}} level:self\") {\n items {\n value\n }\n }\n}\n"
]
Default Template
"tableName: "{%- if $.applicationScope.items | length == 0 or $.tableDefinition.items | length == 0 %} {%- else %}{{$.applicationScope.items[0].value}}_{{$.tableDefinition.items[0].value.table.name | lower}}{% endif %}"\n"
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"tableName"
],
"properties": {
"tableName": {
"type": "string"
},
"archiveColumns": {
"type": "object"
}
}
}

GCP > Project > ServiceNow > Table

Configure a Table for GCP > Project resource type in ServiceNow via the GCP > Project > ServiceNow > Table > * policies.

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowTable
Valid Value
[
"Skip",
"Check: Configured",
"Enforce: Configured"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Configured",
"Enforce: Configured"
],
"example": [
"Skip"
],
"default": "Skip"
}

GCP > Project > ServiceNow > Table > Definition

The policy enables the definition of ServiceNow table properties, including its name and the base table from which it extends, and details the specific columns required for representing GCP > Project data.

URI
tmod:@turbot/servicenow-gcp#/policy/types/projectServiceNowTableDefinition
Schema
{
"type": "object",
"additionalProperties": false,
"required": [
"table",
"columns"
],
"properties": {
"table": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string"
},
"extendsTable": {
"type": "string",
"pattern": "^([0-9a-z_])+$"
}
}
},
"columns": {
"type": "array",
"description": "An array of columns with their mappings to the CMDB.",
"default": [],
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the column in the table.",
"pattern": "^([0-9a-z_])+$"
},
"label": {
"type": "string",
"description": "The label for the column."
},
"type": {
"description": "The data type of the column.",
"type": "string"
},
"size": {
"type": "integer",
"description": "The length for data type."
}
}
}
}
},
"default": {
"table": {
"name": "guardrails_gcp_project",
"label": "GCP > Project",
"extendsTable": "cmdb_ci"
},
"columns": [
{
"name": "create_time",
"label": "Create Time"
},
{
"name": "lifecycle_state",
"label": "Lifecycle State"
},
{
"name": "parent_id",
"label": "Parent ID"
},
{
"name": "parent_type",
"label": "Parent Type"
},
{
"name": "project_id",
"label": "Project ID"
},
{
"name": "project_labels",
"label": "Project Labels"
},
{
"name": "project_name",
"label": "Project Name"
},
{
"name": "project_number",
"label": "Project Number"
}
]
}
}

ServiceNow > Turbot > Watches > GCP

The policy ensures that ServiceNow records are appropriately managed, and actions are triggered when necessary, to maintain data accuracy and synchronization.

URI
tmod:@turbot/servicenow-gcp#/policy/types/watchesGcp
Valid Value
[
"Skip",
"Check: Enabled",
"Check: Disabled",
"Enforce: Enabled",
"Enforce: Disabled"
]
Schema
{
"type": "string",
"enum": [
"Skip",
"Check: Enabled",
"Check: Disabled",
"Enforce: Enabled",
"Enforce: Disabled"
],
"example": [
"Skip"
],
"default": "Enforce: Enabled"
}