{ "synLogic": "$api($1, \n\"URL\u003d$2\",\n\"METHOD\u003d$3\");", "help": "The ns_web_url API is an HTTP function that loads the web page specified by the URL argument. Each Web url API in a script causes the browser to display a new web page or frame. \nns_web_url can be recorded using the Netstorm browser with WEB type script option in C or Java. \nYou can use ns_web_url to simulate the user action on a web page. The ns_web_url function causes the server to perform the same tasks as if a real user is doing it.", "notes": "\u003cul class\u003d\"ul-styled\"\u003e \u003cli\u003eName and URL are mandatory.\u003c/li\u003e \u003cli\u003eArgument names are case insensitive.\u003c/li\u003e \u003cli\u003eAll arguments are in double quotes. If double quotes comes in a value, then it need to be escaped using \\ except in Body.\u003c/li\u003e \u003cli\u003eAll special characters can be in value of any argument.\u003c/li\u003e \u003cli\u003eSpecial characters in URL need to be encoded as per URL encoding rules.\u003c/li\u003e \u003cli\u003eMultiple arguments can be in one line, except body. One argument cannot be split in multiple lines.\u003c/li\u003e \u003cli\u003eBody will end for Main URL when last char is , and next line is: INLINE_URLS or ); \u003c/li\u003e \u003cli\u003eBody will end for Inline URL when last char is , and next line is: END_INLINE \u003c/li\u003e \u003cli\u003eBody cannot have comments as it will be treated as body contents. However complete body can be commented.\u003c/li\u003e \u003cli\u003eComment are allowed using // or /* \u003c/li\u003e \u003cli\u003eSequence of arguments is not important except for PageName must be first. Body if present must be last.\u003c/li\u003e \u003c/ul\u003e ", "returns": "This function returns 0 on success and any other value on failure.", "arguments": "\u003ctable class\u003d\"newGuiTable\"\u003e \u003ctr\u003e \u003cth\u003eArgument\u003c/th\u003e \u003cth\u003eM\u003c/th\u003e \u003cth\u003eP\u003c/th\u003e \u003cth\u003eDescription\u003c/th\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eName\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003e Page name of the web request. It must be first argument and unique within a script.It should start with alpha and can contain alpha-numeric and underscore.Maximum allowed length is 64 characters.It also used as the transaction name for automatic transactions, if enabled in scenario \u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eURL\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eFully qualified resource of the application to load. The format is \"URL\u003durl_address\" address can be HTTP or HTTPS protocol\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eMethod\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eHTTP method can be GET, POST, PUT, HEAD, DELETE, CONNECT, OPTIONS, TRACE, PATCH\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eHeader\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eScript sends following standard HTTP Header automatically in every request : Accept,Host,Connection .You can send additional HTTP header. If you want to override any of the standard header, you can define in script and disable this header setting usign scenario.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eBODY_BEGIN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eIt is START mark of payload/body.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eBODY_END\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eIt is END mark of payload/body.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eCAVINCLUDE\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eHere payload is read from a file and parametrization is allowed. eg. \"$CAVINCLUDE$\u003dGroup_1_UnifiedDashboar.json\"\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eCAVINCLUDE_NOPARAM\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eHere payload is read from file but parameterization is not allowed. It is recommended for Binary file content. $CAVINCLUDE_NOPARAM$\u003dGroup_1_UnifiedDashboar.json\"\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eBODY_ENCRYPTION\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eIf body is to be encrypted then you can specify its algorithm here The format is \"BODY_ENCRYPTION\u003d\u0026lt;encryption_algo\u0026gt;,\u0026lt;base64_encode_option\u0026gt;,\u0026lt;key\u0026gt;,\u0026lt;ivec\u0026gt;\" Supported Algorithm are :AES_128_CBC,AES_128_CTR,AES_192_CBC,AES_192_CTR,AES_192_ECB,AES_256_CBC,AES_256_CTR Base64 encode options:NONE,KEY_IVEC,BODY,KEY_IVEC_BODY Key : encryption key text IVEC : Initialization vector text \u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eHTTPAuthUserName\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eIt will set the username for authorization.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eHTTPAuthPassword\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eY\u003c/td\u003e \u003ctd\u003eIt will set the password for authorization.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003eRepeat\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eThis will repeat inline url of a ns_web_url with specified count.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003ePreUrlCallback\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eCallback function to be called before making the request. This are useful when you want to override parameters before request is made. The format is \"PreUrlCallback\u003d\u0026lt;c_function_name\u0026gt;\" Function name should start with Alpha or Underscore and followed by Alpha/Numeric or Underscore. Maximum length of 32 characters. Callback function must be defined only once in the script. It is only applicable for C type script.\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003ePostUrlCallback\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eN\u003c/td\u003e \u003ctd\u003eCallback function to be called on response completed. This are useful when you want to validate response data and size. The format is \"PostUrlCallback:depth\u003d\u0026lt;c_functio_name\u0026gt;\" Callback function can be call for specified redirection depth. If not specified they are executed for all redirection depths.\u003c/td\u003e \u003c/tr\u003e \u003c/table\u003e", "parameterization": "Standarad Parameterization is allowed", "component": [ { "id": "$1", "type": "TextField", "label": "Page Name", "value": "", "css": "p-grid p-align-center w-100-p", "title": "Page name is of maximum 64 characters.\r\nFirst character must be Alpha.\r\nOther characters are Alpha, Numeric or Underscore ", "placeHolder": "", "style": "", "isDisabled": "", "labelVarCheckbox": "", "argIndex": 0, "validate": { "inputType": "Text", "disabled": false, "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,63}$", "required": true, "min": 0, "max": 0, "method": "isVariableName" } }, { "id": "$2", "type": "TextField", "label": "URL", "value": "", "css": "p-grid p-align-center w-100-p", "title": "Enter url", "placeHolder": "", "style": "", "isDisabled": "", "labelVarCheckbox": "", "argIndex": 0, "quotes":false, "validate": { "inputType": "Text", "disabled": false, "required": true, "min": 0, "max": 0 } }, { "id": "$3", "type": "Dropdown", "label": "Method", "value": "GET", "css": "p-grid p-align-center w-100-p", "title": "Select Method", "placeHolder": "Select Method", "style": "", "isDisabled": "", "list": [ { "label": "GET", "value": "GET" }, { "label": "POST", "value": "POST" }, { "label": "PUT", "value": "PUT" }, { "label": "HEAD", "value": "HEAD" }, { "label": "DELETE", "value": "DELETE" }, { "label": "CONNECT", "value": "CONNECT" }, { "label": "OPTIONS", "value": "OPTIONS" }, { "label": "TRACE", "value": "TRACE" }, { "label": "PATCH", "value": "PATCH" } ], "labelVarCheckbox": "", "argIndex": 0, "validate": { "inputType": "text", "disabled": false, "required": true, "min": 0, "max": 0 } } ], "name": "ns_web_url", "syntax": "int ns_web_url(char *page_name, char *url)", "javaSyntax": "int ns_web_url(String page_name, String url)", "jsSyntax": "ns_web_url(page_name: string, url: string)", "cEx": "flow()\n{\n ns_web_url (\"index\", \n \"URL\u003dhttp:\/\/www.google.com/\", \n \"HEADER\u003dUpgrade-Insecure-Requests:1\", \n \"HEADER\u003dAccept-Language:en-GB,en-US;q\u003d0.9,en;q\u003d0.8\", \n ); \n}", "javaEx": "public class flow implements NsFlow\n{\n public int execute(NSApi nsApi) throws Exception\n {\n nsApi.ns_web_url (\"index\", \n \"URL\u003dhttp:\/\/www.google.com/\", \n \"HEADER\u003dUpgrade-Insecure-Requests:1\", \n \"HEADER\u003dAccept-Language:en-GB,en-US;q\u003d0.9,en;q\u003d0.8\", \n );\n }\n}", "jsEx": " nsApi.ns_web_url (\"index\", \n \"URL\u003dhttp:\/\/www.google.com/\", \n \"HEADER\u003dUpgrade-Insecure-Requests:1\", \n \"HEADER\u003dAccept-Language:en-GB,en-US;q\u003d0.9,en;q\u003d0.8\", \n );\n", "insertStrC": "ns_web_url(char *page_name, char *url);", "insertStrJava": "ns_web_url(String page_name, String url);", "insertStrJs": "ns_web_url(page_name: string, url: string)", "description": "The ns_web_url API loads the Web page specified by the URL argument." }