4.2.7 About dynamic changes to values set for the input properties for services and plug-ins

(a) If you specify JavaScript as the type

You need to define a JavaScript function. The following function is defined by default.

{"data":[
  Object1,
  Object2,
  …
]}

#1:

The following shared property cannot be used:

com.hitachi.software.dna.sys.cm.cache.interval

#2:

For details about the reserved properties, see Table 3‒13: List of reserved properties.

• Javascript library (auto_util library)

  The auto_util library can be used in JavaScript. The auto_util library has the following main functions:

  • Sends an HTTP or HTTPS request to any connection destination

  • Retrieves the connection information set for the web service connection

  The APIs of the auto_util library are as follows.

  Table 4‒14: Details of the APIs of the auto_util library

  Method name	Argument		Return value	Description
  sleep	1	Specifies the time to sleep in the numeric-value format (unit: milliseconds)	None	Sleeps for the specified time
  parseJson	1	Specifies a JSON character string expression in the character-string format	JSON object	Converts character strings to JSON objects
  stringifyJson	1	Specifies any JSON object	JSON character string expression	Converts JSON objects to character strings
  base64.encode	1	Specifies a character string to be converted to Base64	A character string encoded into Base64	Encodes a character string into Base64
  base64.decode	1	Specifies a Base64 character string	A character string decoded from Base64	Decodes a character string from Base64
  http.call	1	JSON object of the request	JSON object of the response	Performs an HTTP or HTTPS request and returns a response
  http.toRawHeader	1	JSON object of the header	Header character string	Returns the header in a character-string format. In the argument, a JSON object to which a key and its corresponding value are set is specified.
  http.defaultErrorHandler	1	Error	None	Throws the HttpError instance
  	2	JSON object of the request
  	3	JSON object of the response
  http.handleCall	1	httpCall method	None	Calls the httpCall method of the first argument by specifying the request of the second argument. If the resulting response code is 200 or greater, and less than 400, the third argument is called. In other cases, the fourth argument is called.
  	2	JSON object of the request
  	3	Method that is called when an HTTP call is successful
  	4	Method that is called when the result status code of the HTTP call is 200 or greater, and less than 400
  	5	Method that is called when an error occurs before an HTTP call

  The arguments and JSON objects of the return values are as follows.

  Table 4‒15: Details of JSON objects of requests

  Member	Type	Description
  requestUrl	String	If you are not using a web service connection: Specify the request URL starting with HTTP or HTTPS. If you are using a web service connection: Specify the part of the request URL from the "/" after the host name, to the end. Example: In the case of http://host:port/Folder/, specify "/Folder".
  requestMethod	String	HTTP request method. Specify the following values in the character string: GET POST PUT DELETE
  requestHeaders	String	Request headers. The setting of the return value of the http.toRawHeader method is assumed. If you are using a web service connection: The following values can be used as pad characters for the user ID and password: ${connection.username} ${connection.password}
  requestBody	String	The request body
  authScheme	String	If authentication is required, specify one of the following values. basic digest negotiate
  productName	String	Specify the category of the web service connection. Be sure to specify this if you are using a web service connection.
  connectionName	String	Specify the name of the web service connection. Be sure to specify this if you are using a web service connection.
  userName	String	Specify the user name if you want to perform authentication on the connection destination. Do not specify this if you are using a web service connection.
  password	String	Specify the password if you want to perform authentication on the connection destination.
  useProxy	boolean	Specify this (true/false) if you want to use a proxy.
  proxyHost	String	Specify the host name or IP address of the proxy server.
  proxyPort	int	Specify the port number of the proxy server.
  proxyAuthScheme	String	If authentication is required at the proxy server, specify one of the following values. basic digest
  proxyUserName	String	Specify the user name if authentication is required on the proxy server.
  proxyPassword	String	Specify the password if authentication is required on the proxy server.

  Table 4‒16: Details of JSON objects of responses

  Member	Type	Description
  responseHeaders	String	Response header
  responseStatusCode	int	Response code
  responseStatusMessage	String	Response message
  responseBody	String	Response body

• Sample JavaScript code

  The following sample looks up the connection information of the web service connection, acquires a list of service templates from JP1/AO, Note that, in the sample, a web service connection must be registered with the name "view" in the category "Automation" in advance.

  (function fn (requestPath, queryParamMap, properties) {
    return getServiceTemplates('Automation', 'view');
  
    function getServiceTemplates(productname, connectionname) {
      var respBody = null;
      var request = {
        requestMethod: 'GET',
        requestUrl: '/Automation/v1/objects/ServiceTemplates/',
        requestHeaders:auto.util.http.toRawHeader({
          'Accept': 'application/json',
          'Accept-Language': 'en',
          'Content-Type': 'application/json',
        }),
        authScheme: 'basic',
        connectionName: connectionname,
        productName: productname,
      };
  
      auto.util.http.handleCall(auto.util.http.call, request, 
        function(resp, req) {
          respBody = resp.responseBody;
        }, function(resp, req) {
          auto.util.http.defaultErrorHandler(null, req, resp);
        }, function(err, req) {
          auto.util.http.defaultErrorHandler(err, req);
        });
      return respBody;
      }
  })
  

(b) If you specify Script as the type

Specify the following setting items.

{"data":[ 
  Object1,
  Object2,
…
]}

By using scripts, the following environment variable values can be acquired in the os.environ["key-name"] or os.environ.get("key-name") format.

Legend:

Y: Specified, N: Not specified

(c) If you specify CLI Command as the type

Specify the following setting items.

(d) If you specify File as the type

Specify the following setting items.