Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns a variable from the deployment template from which the client was installed. Alternatively, the template is fetched from the businessunit business unit that the client was linked to at installation time.

...

CMS_GetDeploymentTemplateVariable(sSectionSection, sVariableVariable, bMustExist MustExist ) As string

Parameters

sSection Section (String)

The name of the section in the template

sVariable Variable (String)

The name of the variable to return

bMustExist MustExist (Boolean)

TRUE if the variable must exist

Return value

...

The function returns a boolean, indicating if the call was successful. If the requested section and/or variable is not present, then false is returned, unless MustExist is set to false.

The requested value will be stored in gsValue.

If the variable can be read, then gbValue will be set to TRUE, otherwise, it will be set to FALSE.

...

Code Block
breakoutModewide
languagejson
{
	"operatingSystem": {
		"ImageId": 13,
		"diskConfigId": 1,
		"localAdmin": "true",
		"password": "1506Test15aarest"
	},
	"domain": {
		"joinDomain": "CAPADEMO.LOCAL",
		"domainName": "CAPADEMO.LOCAL",
		"domainUserName": "ciinst",
		"domainUserPassword": "dftgyhuj",
		"computerObjectOU": "OU=Computers,OU=Lazise,OU=Dev2,DC=CAPADEMO,DC=local"},
	"title": "Default",
	"customValues": [{
		"key": "a",
		"value": "1"
	}]
}

Example

Code Block
languagevb
'Variable exists:
If bStatus Then bStatus = CMS_GetDeploymentTemplateVariable("domain", "domainUserName", True)
'This will set bStatus = true, gbValue = true and gsValue = "ciinst"

'Root variable:
If bStatus Then bStatus = CMS_GetDeploymentTemplateVariable("", "title", True)
'This will set bStatus = true, gbValue = true and gsValue = "Default"

'Custom variable:
If bStatus Then bStatus = CMS_GetDeploymentTemplateVariable("CustomValues", "a", True)
'This will set bStatus = true, gbValue = true and gsValue = 1

'bMustExist:
If bStatus Then bStatus = CMS_GetDeploymentTemplateVariable("domain", "publishedAuthority", True)
'This will set bStatus = false, gbValue = false and gsValue = ""

...