New Documentation

   

Control-M Automation API Documentation has moved to a new location, with a new design to enhance ease of use.

Site Standard Policies

Site Standard Policies enable you to enforce Site Standards on more than one folder.
You can filter where the Policy applies by folder name and server.

The following example shows a Site Standard Policy with all the defined parameters. You can use these JSON definitions to deploy Site Standard Policies using Automation API commands, as described in Site Standard Policies.

{
	"SiteStandardsPolicyName":	{
		"Type": "SiteStandardPolicy",
		"Description": "Description", 
		"SiteStandard": "BasicStandard", 
		"BusinessFields" : [ { "Department" : "HR" }, {"Company": "BMC"} ],
		"Status": "Active",
		"ErrorLevel": "Default",
		"ApplyOn": {
			"Server": "Server",
			"Folder": "Folder"
		}
	}
}

Note: Parameters that are not defined are set to the default and do not appear in the response.

Parameter

Description

Description

Describes the Policy. Optional.

SiteStandardDefines the Site Standard associated with the Policy.
BusinessFields

Defines the values for the business fields of the specified Site Standard.

Enter this information as an array with the following format:
[ {BusinessField1_Name:value}, {BusinessField2_Name:value} ]

Status

Indicates whether the Policy is Active or Not active.

The default is Active.

ErrorLevel

Defines the message severity level when a user does not obey a Site Standard Policy.

Valid values:

  • Error: Forces the user to obey the rules defined in Site Standard Policy before proceeding.
  • Warning: Warns the user that the Site Standard Policy has not been met, but allows the user to proceed.
  • Default: Enforces the strictness level defined by the administrator. This is the default value. 

Note:

  • If validations are not strictly enforced, Site Standard warning messages are not included in the deploy command response by default.
  • The error level of a Policy overrides the strictness level defined by the administrator.
ApplyOn

Defines where to enforce the Site Standard associated with the Policy, filtered by server and folder name.

You can specify multiple values separated by commas, and use asterisks (*) as wildcards, for example:

“Server”: “server1,server2”,
“Folder”: “*A,B*”

Was this page helpful? Yes No Submitting... Thank you

Comments