Managing service code structure

conditions

"conditions": [
          {
            "decision": {
              "title": "The unique title of the decision.",
              "options": [
                {
                  "case": "0",
                  "sequence": {
		  ...},
		  "case": "1",
		  "sequence":{
		  ...},
                }
              ],
              "id": "The generated id for this component. For example: decisionbbb53a59",
              "description": "The description of the component",
              "mapped_parameter": "The parameter to which this component is mapped. This is a mandatory parameter"
            }
          }
        ],

templates

"templates": [{
	"template_name": {
	"title": "The title of the template. For example: 1 Virtual Server with SSH Key",
	"id": "The id of the template component. For example:1virtual6ae83564",
	"template_name": "The name of the template",
	"version:"The version of the template",
	"template_provider: "The provider of the template. For example, IBM",
	"template_content_type": "The content type of the template. For example: prebuilt",
	"instance_name": "The name of the instance associated to this template when deployed",
	"cloud_connection_name": "The name of the cloud connection to be used to deploy the template",
	"content_runtime": "The runtime content",
	"template_params": [
	{
	   "default": "The actual value of the parameter. For read",
	   "description": "A description for this template parameter",
	   "hidden": "Specify if the parameter is not displayed in the user interface. The value must be true or false",
	   "immutable": "Specify if the parameter is read only. The value must be true or false",
           "label": "The label to be displayed in the user interface for this parameter",
	   "name": "The name of the template parameter",						
	   "required": "Specify if the parameter is required. The value must be true or false",
	   "secured": "Specify if the parameter value is shown as asterisk (*). The value must be true or false",
	   "type": "The type of parameter. For example: text",
	},
        {
	  ...
	}
      ]
   }
 ]

The type attribute can have text or list value. If the type value is list, in the default attribute specify the list of the values that can be assigned to the parameter in the format ["<First value>","<Second value>",...,"<Last value>"]. For example, ["IBM Cloud","Amazon EC2"].

If you want to set a template parameter to the value of a input parameter, specify the default attribute value by using the following convention:

"default": "${input_parameters.<service_parameter_name>}

For example, you have the following input parameters:

"input_parameters": [{
   "name": "datacenter",
   "label": "datacenter",
   "description": "Target vSphere datacenter for VM creation",
   "type": "list",
   "default": ["vSphere datacenter 1","vSphere datacenter 2"],
   "hidden": "false",
   "immutable": "false",
   "required": "true",
   "secured": "false",
   "validation": "",
   "dependent": "",
   "dependent_attribute": "",
   "return_type": "text"
},

You can define the following template parameter to set its value to the related input parameter value that you select when ordering the service:

"template_params": [
		{
		"name": "datacenter",
		"label": "datacenter",
		"description": "Target vSphere datacenter for VM creation",
		"type": "text",
		"default": "${input_parameters.datacenter},
		"hidden": "true",
		"immutable": "false",
		"required": "true",
		"secured": "false",
		"validation": "",
		},

In the previous example, note that the hidden attribute value in the template parameter must be set to true to allow the template parameter value to be replaced with the input parameter value when ordering the service.

If you are using a Business Process Manager template, then the following parameters are added to the template:

"async_req": true  //flag to determine whether it is a long running template.
"long_running_delay": "<time in minutes>", //Delay after every poll. Value must be in minutes.
"long_running_timeout": "<time in hour>" //Total time for which polling must be run. The value must be in hours.

Example of a Business Process Manager template:

"templates": [
  {
    "SampleLongRunningProcess": {
      "title": "SampleLongRunningProcess_9de34f",
      "template_name": "SampleLongRunningProcess_25.00746596-7ced-4f98-b382-294e2f702e95_2063.5af7b495-770a-4408-a15b-76ab6f3e890e",
      "version": "1.0"
      "id": "samplel0139690a6",
      "template_type": "BPM",
      "template_content_type": "BPM",
      "template_provider": "BPM",
      "instance_name": "",
      "cloud_connection_name": "BPM Connection",
      "template_data_objects": {},
      "async_req": true,
      "long_running_delay": "5",      
      "long_running_timeout": "24",
      "template_params": {
          "input1": ""
      },
      ...
      ]

Here, in 24 hours, poll happens at a frequency of 5 minutes and in total 288 times. if the Timeout is 24 and delay is 5, then poll happens 24*60/5 = 288 times.

resthooks

"resthooks": [{
	"resthook": {
	"title": "The title of the resthook",
	"id": "The unique id of the resthook",
	"header": {
		"accept": "
		"Content-Type: "application/json",
		The header of the resthook in JSON string format"
		},
	 	"url": "The URL of the external REST server",
        	"method": "The method to poll the external REST server",
        	"payload" : "The request payload if you specified a POST method"
		"timeout": 120,
	}
	"on_destroy":
                {
                "headers": {
                  "accept": "application/json",
                  "Content-Type": "application/json"
                },
                "auth": {
                  "type": "basic",
                  "username": "administrator@vsphere.local",
                  "password": "^(RGFuYzFuZyE=)"
                },
                "url": "https://example.com/create",
                "method": "POST",
                "payload": {
                  "id": "1"
                }
		"timeout": 120,
            }
      }
    ],
      ...
]

The service REST hooks are used to poll an external REST server.

Note: The timeout attribute suggests the maximum time of an URL connection. The default value for timeout is 120 seconds. As the timeout attribute is not available by default in Rest Hooks, you must add the timeout attribute and configure it as per your requirement. The resthook time out occurs either when the network timeout occurs or when the timeout value is reached.

notifications

"notifications": [{
	emailnotification":{
		"title": "The title of the email notification component",
            	"type": "The type of the service notification. For example: email",
		"id": "The identifier of the email notification component",
      		"sender": "The sender address",
		"receiverList": "The list of receiver email addresses",
		"subject": "The subject of the email",
		"body": "The notification body",

      },
      ...
]      

Before using service notifications, you must configure a connection to the SMTP server. For more information, see Configuring a connection for notifications.