Service validations

Whenever you work with your service in the Managed services user interface, service validation is performed to raise early warnings and errors. These preemptive warnings and errors are displayed in the navigator panel. They enable you to create a service that is free of any errors or warnings.

User interface validations are triggered when you make changes to the service and API validations are triggered when you click Save or Publish buttons. Click the validation in the notification panel to find out more information about the context of error messages and warnings. In addition, in the composer canvas, a small icon (error and/or warning) is displayed against the related activity that has a validation problem.

Service validation approaches are as follows:

  • User interface validation - It occurs as soon as you edit a new service or already existing service.
  • API validation - It occurs as soon as you save the service. The API validation errors are no longer displayed if you try to modify the service or move away from the composer tab. Some validation results in error, while others result in warning. API can return either errors or warning at a time, so if a service has both errors and warnings, then the user interface does not show both at the same time. You must first fix the errors and click save to see the warnings. For a list of probable API validation messages, see API Validations.
  • Publish time validation - It occurs as soon as you publish a service.

The validation messages are categorized in the following manner for the first two approaches:

  • Warnings and problems that do not prevent you from saving a service.
  • Errors and critical problems that prevents you from saving a service

List of all probable validation messages that occur when you create, save, or publish a service:

Validations in composer

  • These warnings check the source code for various false conditions, such as empty values, mandatory values for decision, Rest Hook, email notification, and templates .
  • The source code is validated whenever there is a change anywhere in the service.
  • The JSON syntax errors that are editor errors are also taken care, but the message does not show the exact point of failure.
  • REST API errors and validation framework errors at the time of save.

Warnings in composer

{: #warnings]

  • When service 'catalog_metadata.name' key is missing - Error is thrown from API
  • When name of the service 'catalog_metadata.name' value is missing - Error is thrown from API
  • Template key 'catalog_metadata' is missing from the SCL - Error is thrown from API
  • If 'longDescription' in overview  has length more than 400 chars.
  • When service 'description' has length more than 150 characters
  • When feature 'bullet's description' has length more than 150 characters
  • When there is decision key missing - Error is thrown from API
  • When title of the decision, that is, decision.title value is missing.
  • When decision.mapped_parameter value is incorrect, that is, it does have interpolation syntax error.
  • When decision.mapped_parameter value is missing from SCL.
  • If there is no condition array in the SCL or "conditions" + " key is missing - Error is thrown from API
  • If notifications array "notifications" + " key is missing" - Error is thrown from API
  • Parameters of email notification like title and receiver list key or value is missing.
  • The Rest Hook array or key is missing. - Error is thrown from API
  • The Rest Hook URL is missing for create/on_delete.
  • The Rest Hook URL value is missing from the SCL for create/on delete.
  • URL is missing from both the create or delete definition of resthook.
  • Templates array or 'templates' key is missing. - Error is thrown from API.
  • Templates title key and value is missing.
  • Templates cloud connection key or value is missing.
  • The template_params are there but name key or value is missing from the template_params.
  • Validation for hidden parameters for template_params.
  • Template is not a valid JSON - Error is thrown from API.
  • Parsing errors for SCL JSON - Error is thrown from API.

Errors on Save:

  • REST error responses from various rest calls.
  • Validation for using same name for the service in a namespace.
  • Empty JSON values for different data structure object like json, array, map etc,
  • Mandatory parameters missing from the various flow components - REST Hook, Decision, Email, Templates etc,
  • Syntax errors.
  • Publish time validations.

API Validations

Validations at the time of service creation

  • Check whether service name is present or not - error
  • Duplicating a service with same name not possible - error
  • Tag present is invalid - error and if it is empty, then assign it to cloud services - warning (at the time of save and edit)
  • Image provided is valid or not, if image is invalid replace it with a valid one - warning (at the time of save and edit)
  • Check the overall json structure in source code, which will include checks for the presence of service attribute, spec_version, catalog_metadata, name, actions attribute of type array, flow attribute of type json, conditions, Rest Hook, notifications, plans and templates section of type array, sequence attribute of type json) - error
  • Checking if sequence object has valid ids and is not empty - error
  • Check if plan name is unique. - error
  • Check if service name is unique. - error
  • Check if parameters present in the source code are of correct Managed services variable format (check if name, hidden, required, immutable, secured type etc are present or not).  - warning (to be generated through schema json)  custom type : warning
  • Error wont be thrown if an unknown element is added.
  • Check if template_name, template_version, template_type, template_provider are present in the source code (Validation framework has added this check) - error
  • Cloud connection checked - warning if not found
  • Rest Hook - url and headers - warning if not found
  • If  'longDescription' in overview  has length more than 400 chars. - warning
  • When service 'description' has length more than 150 characters. - warning
  • When feature 'bullet's description' has length more than 150 characters. - warning
  • When  title of the decision, that is, decision.title value is missing. - warning
  • The decision.mapped_parameter value is missing from SCL - warning
  • Parameters of email notification like title and receiver list key or value is missing. - warning - The Rest Hook URL is missing for create/on_delete. - warning
  • The Resthook URL value is missing from scl for create/on delete - warning
  • Templates title key and value are missing. - warning

Validations at the time of service publish:

  • All the checks present in case of service creation.
  • Check if atleast 1 executable section (resthook/templates/email notification) is present in the source code. - error
  • Check the data type defined for each template variable and verify if values provided in the source code are compliant. - error
  • Check if template name is valid or not - error
  • Check if a valid cloud connection name is present. - error
  • Check if dynamic binding for parameters is done correctly or not. - error - Check if mapped parameter in decision is present in the source code or not. -error - Check if Rest Hook section has "url" and "method" section. - error - Check if email notification has "recieverlist" and "body" elements. - error - Check if "subject" is mandatory in email notification. - error
  • Validate template parameter type provided in the source code with the one defined in template : boolean, password type parameter should have string value, map type value should be of object type, counter type value should be a number of type counter, valid value as per regex defined, valid value as per options defined, catch missing parameters where value is required, check parameter mapping in template parameter. - error
  • The Activity Ids in flow.sequence should be unique. - error
  • The Activity Ids should be valid in flow.sequence. - error
  • The Activity Ids in flow.conditions.decisions.options.sequence should be unique. - error
  • The Activity Ids should be valid in flow.conditions.decisions.options.sequence. - error
  • Pricing Parameter should be valid. It should be from plan parameter list - error
  • Operator used in the pricing object should be valid. Use from gt/lt/ge/le/eq/members - error
  • Condition validation for pricing object. - error
  • Base condition in pricing object should be validated . Use any/all only. - error
  • Plan should not have multiple pricing. - error
  • Method and Headers are a must when URL is present in resthook. - error
  • Rest Hook - create without URL or on_destroy.url should not be provided. - error
  • Method and Headers are a must when on_destroy URL is present in resthook. - error
  • Error Flow can not have Resthook with destroy enabled. - error
  • Action array should have 1 type 'provision' . - error
  • Validate mapped parameter in input_parameters - error
  • Interpolation Validation - error
  • Template does not have cloud connection name - error