Macros Directory: 20240220633

Jun 10, 2026 10:23:47 PM

• _displayTestResultsHTML lib_macros_tests.vm
  Display test results in HTML format.Parameters$_dtrh_resultResult object generated from #_generateTestResults.Output/ReturnHTML of test results.
• _escapeJSON lib_macros_json.vm
  Renders an escaped JSON string equivalent of provided string.Parameters$_ej_stringString to escape.
• _generateComponentsReport lib_macros_component.vm
  Generate components report data.
  NOTE: Setting the URL parameter 'dump' to 1 will output components as they're having reports generated.
• _generateTestResults lib_macros_tests.vm
  Generates test results.Output/ReturnEither nothing, or HTML of test results if autoDisplayTestResultsHTML() was called.
• _init_lib_macros_cache lib_macros_cache.vm
  Library initialization macro.
• _init_lib_macros_categories lib_macros_categories.vm
  Initialization function for macros library.
• _init_lib_macros_dependencies lib_macros_dependencies.vm
  Library initialization macro.
• _init_lib_macros_javascript_engine lib_macros_javascript_engine.vm
  Initialization function for macros library.
• _init_lib_macros_json lib_macros_json.vm
  Initialization macro for library.
• _init_lib_macros_messages lib_macros_messages.vm
• _init_lib_macros_sorter lib_macros_sorter.vm
  Library initialization macro.
• _initComponentSettingsContainer lib_macros_component.vm
  Initializes a component's settings container. Used internally within the component's library.Parameters$_icsc_componentNameName of component.
• _java_FlexUXCachingEngine lib_macros_cache.vm
  Java class for Flex caching engine.
  Creates the shared
• _java_FlexUXDependencyEngine lib_macros_dependencies.vm
  Java class for Flex dependency engine.
• _java_FlexUXSorterPriority lib_macros_sorter.vm
  Java class for maintaining official priority rankings.
• _js_createLinkedHashMap lib_test_macros_javascript_engine.vm
• _js_vendorId lib_test_macros_javascript_engine.vm
• _js_whileTest lib_test_macros_javascript_engine.vm
• _jsGetMacroCommentHeaderData lib_macros_tests.vm
  Javascript macro. This needs to be executed through a Javascript engine.
  Refer to #evaluateJavaScript() macro for executing server-side Javascript.
• _jsGetMacrosInTemplateContent lib_macros_tests.vm
  Javascript macro. This needs to be executed through a Javascript engine.
  Refer to #evaluateJavaScript() macro for executing server-side Javascript.
  
  Get macros in template content.
• _loadConfigComponentDefaultSettings lib_macros_component.vm
  Internal library macro. Loads in default component settings from configs.vm.
  NOTE: Earlier configs.vm may not have this setting, and instead rely on direct calls to #changeComponentDefaultSetting().
• _readStream lib_macros.vm
  Internal macro used by #runSystemProcess()/#readLocalSiteFile().
  NOTE: This has a limit for output reading of 101,030,350 lines.Parameters$_rspr_streamStream.
• _recurseTest2 lib_test_macros_recursive.vm
  Test recursive macros.Parameters$param1No description available.
• _recurseTest3 lib_test_macros_recursive.vm
  Testing #doesRecursiveVarExist() macro.Parameters$param1No description available.
• _recurseTest4 lib_test_macros_recursive.vm
  Testing #doesRecursiveVarExist() macro.Parameters$param1No description available.
• _recurseTest5 lib_test_macros_recursive.vm
  Test preset variables.Parameters$param1No description available.
• _recurseTest6 lib_test_macros_recursive.vm
  Test the #generateVarsFromRecursiveContainer() macro.
• _resetQuickRenderVariables lib_macros_component.vm
  Resets any VTL variables containing setting values for a quick render component.Parameters$_rqrv_componentNameComponent name.
• _showBareFormattedPrice lib_macros_checkout.vm
  Show formatted price. Used to provide correct formatting versus using a standard decimal or USD format.Parameters$_sfp_pricePrice.Output/ReturnFormatted price, excluding HTML markup.
• _showMessageReplacer lib_macros_messages.vm
  Helper macro for #showMessage() macro.Parameters$_smr_stringString needing replacing.$_smr_replacedReplaced message names.
• _velocityArrayToJSON lib_macros_json.vm
  Internal macro to convert a Velocity array to JSON.Parameters$_vatj_arrayArray to convert to JSON.
• _velocityMapToJSON lib_macros_json.vm
  Parameters$_vltj_mapNo description available.
• _wvcss_beaninfo lib_wvconsole.vm
  Parameters$_bi_beanNameNo description available.
• _wvcss_checklogin lib_wvconsole.vm
• _wvcss_clearcache lib_wvconsole.vm
  Clears any session-based caches.
• _wvcss_components lib_wvconsole.vm
  Lists loaded components. Depends upon macro #listLoadedComponents() in lib_macros_components.vm.
• _wvcss_custprop lib_wvconsole.vm
  Outputs customer properties.
• _wvcss_dependencies lib_wvconsole.vm
  Lists loaded dependencies. Depends upon macro #listLoadedDependencies() in lib_macros_dependencies.vm.
• _wvcss_dto lib_wvconsole.vm
• _wvcss_findbean lib_wvconsole.vm
  Parameters$_fb_beanSubNameNo description available.
• _wvcss_findbeanmethod lib_wvconsole.vm
  Parameters$_fbm_methodSubNameNo description available.
• _wvcss_findbeantype lib_wvconsole.vm
  Parameters$_fbt_beanTypeNo description available.
• _wvcss_global lib_wvconsole.vm
  Lists any global-cached values. These values persist between page requests, regardless of site.
• _wvcss_iter lib_wvconsole.vm
  Parameters$_i_iterableNo description available.
• _wvcss_iterexp lib_wvconsole.vm
  Parameters$_i_iterableNo description available.$_i_exprNo description available.
• _wvcss_logs lib_wvconsole.vm
  Displays logs of a given type. Console command.Parameters$_l_logTypeLog type. This can also a range of log line numbers.
• _wvcss_mfind lib_wvconsole.vm
  Parameters$_mf_criteriaNo description available.
• _wvcss_parseJavaScript lib_wvconsole.vm
  Parse the given server-side JavaScript.Parameters$_wvcpjs_jsJavaScript code.
• _wvcss_parsePHP lib_wvconsole.vm
  Parses the given PHP script. This will use a CLI-style of PHP, and the web server environment will be absent. Many values in $_SERVER will be absent/different, and the web-related super-globals will be empty. If certain page parameters are needed, they can be parsed into the PHP code via Velocity's $request.getParameter() function. For example:
  
  ## The following uses Velocity to parse a value into the PHP script and echo that value.
  #_wvcss_parsePHP("$myPageParameter = '$request.getParameter('parameterName')'; echo $myPageParameter;")Parameters$_wvcpp_phpPHP code.
• _wvcss_parsePython lib_wvconsole.vm
  Parses the given Python script.Parameters$_wvcpp_pythonPython code.
• _wvcss_partials lib_wvconsole.vm
  Lists loaded partials. Depends upon macro #listLoadedPartials() in lib_macros_partials.vm.
• _wvcss_pprint lib_wvconsole.vm
  Parameters$_pp_objectNo description available.
• _wvcss_python_pprint_script lib_wvconsole.vm
  Parameters$_pps_objectNo description available.
• _wvcss_runSystemProcess lib_wvconsole.vm
  Run system process and output results.Parameters$_rsp_commandCommand.$_rsp_argsNo description available.
• _wvcss_runSystemProcessRead lib_wvconsole.vm
  Internal macro used by #runSystemProcess().
  NOTE: This has a limit for output reading of 101,030,350 lines.Parameters$_rspr_streamStream.
• _wvcss_session lib_wvconsole.vm
• _wvcss_spacing lib_wvconsole.vm
  Parameters$_s_stringNo description available.$_s_spaceCountNo description available.$_s_spaceCharNo description available.$_s_useTruncNo description available.$_s_truncSequenceNo description available.
• _wvcss_tn lib_wvconsole.vm
  Outputs the current top-level template name.
• _wvcss_versions lib_wvconsole.vm
• _wvcss_vi lib_wvconsole.vm
  Parameters$_vi_varNo description available.$_vi_treatAsClassNameNo description available.
• addComponentDefaultSetting lib_macros_component.vm
  Adds a default value for a component setting. This is only usable within a component source template.
  To alter a default value from its original outside the component source, use #changeComponentDefaultSetting().Parameters$_acds_settingNameName of the setting.$_acds_defaultValDefault value for setting.
• allowAjaxRendering lib_macros_component.vm
  Allows AJAX rendering of a given component that's being registered.
  
  To render a component via AJAX, make a request to any page using the following format:
  store.html?vid=<vendorid>&componentajax=1&cs<settingname>=<value>&...
  
  Parameters:
  - vid = The vendor ID of the store.
  - componentajax = The name of the component. Activates the AJAX component rendering service.
  - cs<setting> = The value to assign to component's setting of given name <setting>.
  
  NOTE: Only permitted settings are allowed - refer to macro #allowAjaxRenderingSetting().
  
  The response is a JSON-based response, following the given structure:
  { "success": true|false, "messages": ["Resulting messages...", ...], "output": "Output of rendered component..." }
• allowAjaxRenderingSetting lib_macros_component.vm
  Allows a given setting to be used in AJAX component-rendering requests.
  
  Be incredibly careful about allowed settings! These can allow end-user input to be used with component rendering, and could expose potential security holes. Ensure that all ranges of input are considered before exposing a component setting.Parameters$_aars_settingNameSetting name.
• applyResultsModifiers lib_macros_tests.vm
  Applies result modifiers to the test results.
• arrayToCollection lib_macros.vm
  Parameters$_atc_arrayNo description available.
• autoDisplayTestResultsHTML lib_macros_tests.vm
  Auto display test results as HTML as tests are executed..
• callBeanMethod lib_macros.vm
  Calls a bean method. Will attempt to cast any provided parameters.Parameters$_cbm_beanNameBean name.$_cbm_methodNameMethod name.$_cbm_p1Optional. Parameter 1.$_cbm_p2Optional. Parameter 2.$_cbm_p3Optional. Parameter 3.$_cbm_p4Optional. Parameter 4.$_cbm_p5Optional. Parameter 5.$_cbm_p6Optional. Parameter 6.$_cbm_p7Optional. Parameter 7.$_cbm_p8Optional. Parameter 8.$_cbm_p9Optional. Parameter 9.$_cbm_p10Optional. Parameter 10.$_cbm_p11Optional. Parameter 11.$_cbm_p12Optional. Parameter 12.$_cbm_p13Optional. Parameter 13.$_cbm_p14Optional. Parameter 14.$_cbm_p15Optional. Parameter 15.$_cbm_p16Optional. Parameter 16.
• callMacrosLibraryInit lib_macros.vm
  Calls a macro library's initialization macro. The library name should exclude the '.vm' extension. If a library's init macro has already been called, then this macro does nothing.Parameters$_cmli_libraryNameLibrary name.
• callRecursive lib_macros_recursive.vm
  Makes a recursive call. This provides a means of creating variables in a pseudo-local scope and accessible via the #setRecursiveVar and #getRecursiveVar macros.Parameters$_cr_macroNameThe name of the macro.$_cr_macroParams1Parameter for the macro call.$_cr_macroParams2Parameter for the macro call.$_cr_macroParams3Parameter for the macro call.$_cr_macroParams4Parameter for the macro call.$_cr_macroParams5Parameter for the macro call.
• canComponentUseAjaxRendering lib_macros_component.vm
  Determines if a component can use AJAX-based rendering.Parameters$_ccuar_componentNameComponent name.Output/Return"true" if component can use AJAX rendering, "false" otherwise.
• canCustomerChangeCustomerProperty lib_macros.vm
  Determines if the logged in user can adjust a customer property based on a list of customer property permissions. If no list is provided as propListPermissions, then $configAllowedCustPropsAdmin is assumed. If the element '*' is present in propListPermissions, then all permissions are allowed with the exception of 'WVCONSOLE'.Parameters$_ccccp_propNameProperty name.$_ccccp_propListPermissionsOptional. List of customer property names.Output/Return'true' if allowed, 'false' otherwise.$resultTrue if allowed, false otherwise.
• canUserViewCategory lib_macros_categories.vm
  Determines if a user can view a category. This macro assumes the currently logged in user if applicable, and then falls back to to public accessibility.Parameters$_cuvc_categoryIdentifying category data (ID, name, etc).Output/Return'true' if user can view, false otherwise.
• canUseWVConsole lib_wvconsole.vm
  Determines if the current user's session has access to the wvconsole.Output/Return'true' if user has access to wvconsole.
• cast lib_macros.vm
  Typecasts a given object. This method is meant to assist in making method calls using data type parameters unavailable in Velocity shorthand not require a lengthy typecasting process.
  
  NOTE: This only performs a shallow cast on array types and won't attempt to cast elements within that array.Parameters$_c_objectToCastObject to cast.$_c_classToCastToClass to cast to.$_c_silentIf true, will squelch 'true' or 'false' return and only populate $result.Output/Return'true' if casted successfully, 'false' otherwise.$resultCasted object.
• changeComponentDefaultSetting lib_macros_component.vm
  Change a component's default setting.Parameters$_ccds_componentNameComponent name.$_ccds_settingNameSetting name.$_ccds_defaultValDefault val.
• clearSessionCaches lib_macros.vm
  Clears any session-based caches.$resultList of session attribute keys removed.
• clearUsedDependencies lib_macros_dependencies.vm
  Clears all dependencies for the page request set with #useDependency().
• compileJavaClass lib_macros_javascript_engine.vm
  Compiles a Java class from given source and stores within the persistent global values. The global key name for the compiled class is "Java.<className>".
  
  For instance, to access a compiled class called "FlexUXCore", the following Velocity could be used:
  #compileJavaClass('FlexUXCore', $flexUXCoreJavaCodeString) #getGlobalValue('Java.FlexUXCore', true) #set($flexUXCoreClass = $result)Parameters$_cjc_classNameClass name.$_cjc_sourceJava Source.$resultCompiled Java class, or an Exception object.
• containedIn lib_macros_tests.vm
  Tests if the current expected object set in #expect() contains the given string or list of strings.Parameters$_c_containsStringString that contains object set in #expect().
• createCustomerPropertyDefinition lib_macros.vm
  Create a customer property definition.Parameters$_ccpd_nameProperty name.$_ccpd_defaultOptional. Default value.$_ccpd_descriptionOptional. Description of property.$resultCustomer property definition object.
• curlRequest lib_macros_ajax.vm
  Executes a cURL request and waits for the response.
  Any POST parameters following the '-d' argument contained in a LinkedHashMap are encoded before cURL is executed.Parameters$_cr_urlURL.$_cr_paramsList of cURL arguments.
• debug lib_macros.vm
  Logs a debug message.Parameters$_d_messageDebug message.
• decodeHexString lib_macros.vm
  Decode a 4-character-hex-encoded string.Parameters$_dhs_stringString to decode.Output/ReturnDecoded string.
• defineDependency lib_macros_dependencies.vm
  Define a dependency by a given name.
  
  Dependency data is a LinkedHashMap (dictionary) that follows the given structure:
  { 'requires': ['depedencyName', 'dependencyName', ...] 'headMarkup': '<link rel="stylesheet" type="text/css" ... >...</link>', 'footMarkup': '<scrip>...</script>' }Parameters$_dd_dependencyNameDependency name.$_dd_dependencyDataDependency data.
• deleteCustomerProperty lib_macros.vm
  Delete a customer property.
  NOTE: Customer will need to log out and back in to take effect.Parameters$_dcp_propNameProperty name.$_dcp_clientIDOptional. Client ID of customer to delete property for. Default is client ID of logged in user.
• deleteLocalSiteFile lib_macros.vm
  Delete a local site file.
  
  The site base path is implied with the $_wlsf_filename argument:
  - Preview: /avetti/tomcat/webapps/ROOT/store/[vid]/[filename] - Production: /avetti/tomcat/webapps/preview/store/[vid]/[filename]Parameters$_dlsf_filenameFilename.$_dlsf_vidOptional. Vendor ID of site.Output/Return'true' if file was deleted, otherwise 'false'.
• displayBindStatusErrorMessages lib_partial_myaccount-billingaddress.vm
• displayBindStatusErrorMessages lib_partial_myaccount-changepassword.vm
• displayComponentsReportHTML lib_macros_component.vm
  Display components report in HTML format.
  NOTE: Setting the URL parameter 'dump' to 1 will output components as they're having reports generated.
• displayComponentsReportJSON lib_macros_component.vm
  Display components report in JSON format.
• displayFailedTestCount lib_macros_tests.vm
  Displays total failed test count.
• displayNewTestCount lib_tests.vm
• displayPartialsReportHTML lib_macros_partials.vm
  Display components report in HTML format.
• displayPassedTestCount lib_macros_tests.vm
  Displays total passed test count.
• displaySkippedTestCount lib_macros_tests.vm
  Displays skipped passed test count.
• displayTestResultsJSON lib_macros_tests.vm
  Generates a JSON equivalent of test results.
• displayTotalTestCount lib_macros_tests.vm
  Display total (passed and failed) test count.
• doesCategoryHaveProperty lib_macros_categories.vm
  Determines if a category has a given property.Parameters$_dchp_catDataName/ID of category, or the Categories object.$_dchp_propNameCategory property name.
• doesCookieExist lib_macros.vm
  Determines if a cookie exists and renders either 'true' or 'false'.Parameters$_gcv_cookieNameCookie name.
• doesRecursiveVarExist lib_macros_recursive.vm
  Determines if a variable within a recursive call exists.Parameters$_drve_macroNameName of the recursive macro.$_drve_varNameName of the variable.Output/Return"true" if the recursive variable exists.
• dumpLogs lib_macros.vm
  Dumps a log of given type(s).Parameters$_dl_typeType of log to dump. 'all' dumps all logs.$_dl_renderPatternRender pattern of output.
• emptyBasket lib_macros_checkout.vm
  Empties the items in the basket for the current session.
• encodeHexString lib_macros.vm
  Encodes a string to a 4-character hex format.Parameters$_ehs_stringString to encode.Output/ReturnEncoded string.
• equals lib_macros_tests.vm
  Tests if the current expected object set in #expect() matches the provided object.Parameters$_e_equalsToObject to test for equivalency against object set in #expect().
• error lib_macros.vm
  Logs an error message and displays.Parameters$_e_messageError message.
• evaluateJavaScript lib_macros_javascript_engine.vm
  Evaluates the given JavaScript by instantiating an instance of javax.script.ScriptEngineManager().
  Any output generated from the script is rendered.Parameters$_ejs_javascriptJavaScript.$_ejs_attribsA hashmap of variable names/values to use within the script.Output/ReturnOutput of script.
• evaluateJavaScriptSilently lib_macros_javascript_engine.vm
  Evaluates the given JavaScript by instantiating an instance of javax.script.ScriptEngineManager().
  Any output generated from the script is NOT rendered.Parameters$_ejss_javascriptJavaScript.$_ejss_attribsA hashmap of variable names/values to use within the script.
• exampleEchoMacro /20240220633/6234/macros.vm
  Parameters$echoStringNo description available.
• executeAllComponentTests lib_macros_component.vm
  Execute all component tests.
• executeComponentTest lib_macros_component.vm
  Execute a component test.Parameters$_ect_componentNameComponent name.
• executeEvery lib_macros.vm
  Executes a given macro on a given page request, at most at every given dileniation of time.
  The _ee_timing parameter can either be a number representing milliseconds, or a string that follows the given format:
  
  [1+][unit] [1+][unit] ...
  
  The following units are available:
  - seconds - minutes - hours - days
  
  Examples:
  - "3 days 1 hour" - "1d1h5s" - "10 seconds"
  
  Additionally, timing can be shared amongst different macro calls if the $_ee_keyName parameter is used and set.Parameters$_ee_timingTiming.$_ee_macroNameMacro name.$_ee_macroParamsOptional. List of macro params.$_ee_keyNameOptional. Unique key name to use.
• executeMacroDoctest lib_macros_tests.vm
  Execute a macro doctest. Doctests are found within a macro's header comments.
  
  Doctests can use a direct VTL statement to evaluate:
  >@test $number.toNumber("#getCategoryID('HOME')") >@test "#getLevensteinDistance('testy', 'zesty')" == '1'
  
  Doctests can also use JSON-encoded tests too:
  >@test json {"name": "#readLocalSiteFile() test", "params": ["file.txt"], "expression": "$test == 'Expected file contents.'"}Parameters$_emd_macroNameMacro name.$_emd_testTypeTest type.$_emd_testExpressionTest expression (eval or json).
• executeSQL lib_macros.vm
  Executes a given SQL statement on either the preview or production database.Parameters$_es_statementSQL Statement.$_es_isPreviewOptional. If set to true, will use the preview database. Defaults as true.
• expect lib_macros_tests.vm
  Sets the expected results from a expect/from test.Parameters$_e_expectedThe results expected from a test.
• findOrderPropertyValue /20240220633/6234/mail_order_approved.vm
  Parameters$propNameNo description available.
• findOrderPropertyValue /20240220633/6234/mail_place_order.vm
  Parameters$propNameNo description available.
• generateBasicBasketItemMap lib_comp_basket.vm
  Parameters$_gbbim_productBeanImplNo description available.
• generateBasicBasketItemMap lib_macros_checkout.vm
  Generates a map of basic product information for a product in the basket. Stores in $result.Parameters$_gbbim_productBeanImplProductBeanImpl object from basket's $productsDetails.products.$resultDictionary of basic product information.
• generateCompleteBasketData lib_macros_checkout.vm
  Generate full basket data from the $productsDetails object, present on basket.vm.
  NOTE: This macro should be used only at the top of templates, just after config parsing.$resultDictionary of basket data.
• generateComponentJavaScriptConfigs lib_macros_component.vm
  Generate component JavaScript configs.Parameters$_gcjsc_jsContainerNameJavaScript variable name to use.$_gcjsc_settingsHashMapSettings hash map to use.Output/ReturnJavaScript defining component settings.
• generatePartialsReportData lib_macros_partials.vm
  Generates partials report data and stores in $result.$resultPartials data.
• generateVarsFromRecursiveContainer lib_macros_recursive.vm
  Generate VTL variables from stored variables set with #setRecursiveVar() by using a provided prefix combined with the variable name.
  
  For instance, let's assume a variable is set with #setRecursiveVar() named "counter" for a macro entitled #countDays(). If you wanted to set a VTL variable using the value stored in "counter", and you wanted this variable called $my_var_counter, you'd use the following statement:
  
  #generateVarsFromRecursiveContainer('counter', 'my_var_')Parameters$_grvfrc_macroNameMacro name.$_grvfrc_prefixPrefix.
• getAllComponentNames lib_macros_component.vm
  Gets all component names and renders in a pipe-delimited string.
• getCache lib_macros_cache.vm
  Get a site-level cache.Parameters$_gc_vidVendor ID.$_gc_cacheKeyCache key.Output/ReturnCache payload.
• getCategoryDescription lib_macros_categories.vm
  Get category description based on category ID.Parameters$_gcd_catIDCategory ID.
• getCategoryID lib_macros_categories.vm
  Renders a category ID based on a category name.Parameters$_gcid_cat_nameName of the category.
• getCategoryName lib_macros_categories.vm
  Get category name based on category ID.Parameters$_gcn_catIDCategory ID.
• getCategoryObject lib_macros_categories.vm
  Returns a Categories object as $result based on given identifying category data. This macro accepts the following as arguments:
  - Category ID, being a String/Integer/Long/Number - Category Name, being a String - PageTileDTO (DTO object) that contains a field named 'c' and is a Categories object.
  - Hashtable object containing category data (generated from pageTileDAO.execQuery('...').get('resultSet').get(index))Parameters$_gco_categoryIdentifying category data.$resultCategories object.
• getCategoryObjects lib_macros_categories.vm
  Returns a list of Categories objects as $result based on given identifying category data. This macro accepts the following as arguments:
  - Category ID, being a String/Integer/Long/Number - Category Name, being a String - PageTileDTO (DTO object) that contains a field named 'c' and is a Categories object.
  - Hashtable object containing category data (generated from pageTileDAO.execQuery('...').get('resultSet').get(index)) - An ArrayList of any combination of the above.Parameters$_gco_categoriesIdentifying category/categories data.$resultAn ArrayList of Categories objects.
• getCategoryPathByID lib_macros_categories.vm
  Generates a category path back to the top-level based on a category ID.
  This macro is performance-intensive since it doesn't cache and should only be used sparingly.
  NOTE: This is not truly recursive, and will only search up to 6 levels of sub-categories.Parameters$_gcpbi_catIDCategory ID.$resultList, starting from top-level, of category path.
• getCategoryPropertyValue lib_macros_categories.vm
  Get category property value, if exists.Parameters$_gcpv_catDataName/ID of category, or the Categories object.$_gcpv_propNameCategory property name.Output/ReturnProperty value.
• getChar lib_macros.vm
  Outputs a character based on its ASCII value.Parameters$_gc_asciiValASCII value of character.
• getComponentDefaultSetting lib_macros_component.vm
  Get a component's default setting.
  
  If an object that isn't a string is needed, such as a DTO, calling this method will store the object in the variable $result.Parameters$_gcds_componentNameComponent name.$_gcds_settingNameSetting name.$_gcds_displaySettingIf true or omitted, will display setting.
• getComponentMetaData lib_macros_component.vm
  Get component meta-data by given component and variable name. If variable doesn't exist, nothing is shown.Parameters$_gcmd_componentNameComponent name.$_gcmd_varNameVariable name.
• getComponentRenderingMacroName lib_macros_component.vm
  Get component rendering macro name.Parameters$_gcrmn_componentNameComponent name.Output/ReturnMacro name for rendering component.
• getComponentSetting lib_macros_component.vm
  Retrieves a component setting for the component currently rendering and displays it unless specified otherwise.
  If an object that isn't a string is needed, such as a DTO, calling this method will store the object in the variable $result.Parameters$_gcs_settingNameThe setting name.$_gcs_displaySettingIf false, the setting isn't rendered.
• getComponentTemplateFilename lib_macros_component.vm
  Displays component's source template filename.Parameters$_gctf_componentNameComponent name.
• getComponentTestingMacroName lib_macros_component.vm
  Get component testing macro name.Parameters$_gctmn_componentNameComponent name.Output/ReturnMacro name for testing component.
• getCookieValue lib_macros.vm
  Gets a cookie value and renders it. If cookie doesn't exist, nothing is rendered.Parameters$_gcv_cookieNameCookie name.
• getCurrentRenderedComponent lib_macros_component.vm
  Get currently rendered component.
• getCustomerLoginName lib_macros.vm
• getCustomerPropertyDefinition lib_macros.vm
  Sets $result as a customer property definition for given site, if found.Parameters$_gcpd_nameName of customer property.$resultCustomer property definition if found. Otherwise, false.
• getDirectoryListing lib_macros.vm
  Gets the content of a given directory.Parameters$_gdl_pathPath.$_gdl_recursiveIf true, will recursively list files in all sub-directories as well. Returns a LinkedHashMap instead.$resultArray of java.io.File objects if not recursive, otherwise a map with relative file/directory names.
• getFullMessageName lib_macros_messages.vm
  Gets a message's full name after taking a priority prefix into consideration. If a prefixed message exists, the prefixed name is returned. Otherwise, the base name is returned.Parameters$_gfmn_messageBaseBase message name.Output/ReturnMessage name.
• getGlobalValue lib_macros.vm
  Get a global value. A global value is stored within memory until server reboot, and isn't specific to a site. A string representation will be immediately output of this value unless _ggv_silent is set to true.Parameters$_ggv_keyKey.$_ggv_silentIf true, no immediate string output is produced.$resultValue of global entry.
• getImaginaryCategoryTemplateName lib_macros.vm
  Gets an imaginary category template name, if it exists.
  An imaginary category only exists on the MTL, and uses the following naming standard:
  
  lib_cat_<kebab-cased-name>.vm
  
  The provided category name argument is converted to a lowercased/kebab-cased name before considered. "Cookie Policy" becomes "cookie-policy", and then the template "lib_cat_cookie-policy.vm" is searched for.Parameters$_gictn_categoryNameCategory name.Output/ReturnThe MTL template name
• getItemIDByCode lib_macros_items.vm
  Parameters$_giibc_itemCodeNo description available.
• getItemPrice lib_macros_items.vm
  Parameters$_gip_itemNo description available.$_gip_vidNo description available.
• getItemSEOURL lib_macros_items.vm
  Parameters$_gisu_itemNo description available.$_gisu_biidNo description available.
• getItemURL lib_macros_items.vm
  Parameters$_giu_itemNo description available.$_giu_biidNo description available.
• getKebabCasedVariable lib_macros.vm
  Converts a string into a kebab-cased variable.Parameters$_kc_stringString to convert.Output/ReturnKebab-cased string.
• getLevenshteinDistance lib_macros.vm
  Get the Levenshtein distance between two strings.Parameters$_gld_string_sString 1.$_gld_string_tString 2.Output/ReturnMeasured difference between two strings.
• getLoginCache lib_macros_cache.vm
  Get site-level login cache.Parameters$_glc_vidVendor ID.$_glc_loginNameLogin name.$_glc_cacheKeyCache key.Output/ReturnCache payload.
• getMacroCommentHeaderHTML lib_macros_tests.vm
  Executes using the Javascript engine. Use sparingly.
  
  Renders an HTML-formatted description based on a macro's header comment.Parameters$_gmchh_headerCommentHeader comment.$_gmchh_optionsOptional hashmap of options for rendering.Output/ReturnHTML formatted header comment.
• getMTLVID lib_macros.vm
  Renders the MTL VID of the current site.
• getPaymentDesc /20240220633/6234/mail_order_approved.vm
• getPaymentDesc /20240220633/6234/mail_place_order.vm
• getRecursiveVar lib_macros_recursive.vm
  Sets the global variable $result to the parameter _grv_varName local to the recursive function call.
  Local recursive values can be set using the setRecursiveVar macro.Parameters$_grv_macroNameThe name of the macro for the recursive call.$_grv_varNameThe name of the variable.$_grv_displayIf true, will render the variable value.
• getSiteCompany lib_macros.vm
  Get site's company name.Output/ReturnSite's company name.
• getSiteLocalDirectory lib_macros.vm
  Returns a site's base local path.Parameters$_gsld_filenameOptional. Filename to append to directory.$_gsld_vidOptional. VID of site.
• getSiteName lib_macros.vm
  Get current site name from preferences stored in the Avetti database. The site name will be what's displayed in the header of the Avetti admin portal for a specific site.Output/ReturnSite's name.
• getVarByName lib_macros.vm
  Retrieves a VTL variable by a given name and stores its value in $result.Parameters$_gvbn_varNameVariable name.$_gvbn_displayIf false, will not render the variable string.
• handleAjaxRequests lib_macros_ajax.vm
  Handle AJAX requests. A standard AJAX request on the Skeleton Store will include the useajax=1 URL parameter and attempt to defer to a template matching in name with an "ajax_" prefix.
• handleComponentAjaxRenderingRequest lib_macros_component.vm
  Handle component-rendering AJAX request and outputs the JSON response.
  
  NOTE: This doesn't validate the request itself. That's handled in lib_macros_ajax.vm, which calls this macro.Parameters$_hcarr_componentNameComponent name.
• includeEither lib_macros.vm
  #include() either templates. If the first template doesn't exist, it attempts to include the second.Parameters$_ie_includeMainThe name of the main template to include.$_ie_includeBackupThe name of the backup template to include if the main template doesn't exist.Output/ReturnTemplate source output if _ie_includeSilently != true.$resultName of template included.
• instantiate lib_macros.vm
  Instantiates an object based on a Fully Qualified Class Name (FQCN).
  This will attempt to cast any objects used as arguments.Parameters$_i_fqcnFully qualified class name (i.e. 'java.io.File')$_i_p1Optional. Parameter 1.$_i_p2Optional. Parameter 2.$_i_p3Optional. Parameter 3.$_i_p4Optional. Parameter 4.$_i_p5Optional. Parameter 5.$_i_p6Optional. Parameter 6.$_i_p7Optional. Parameter 7.$_i_p8Optional. Parameter 8.$_i_p9Optional. Parameter 9.$_i_p10Optional. Parameter 10.$_i_p11Optional. Parameter 11.$_i_p12Optional. Parameter 12.$_i_p13Optional. Parameter 13.$_i_p14Optional. Parameter 14.$_i_p15Optional. Parameter 15.$_i_p16Optional. Parameter 16.$resultInstantiated object.
• isComponentSettingDefault lib_macros_component.vm
  Determines if a component's current setting is the default value.Parameters$_icsd_componentNameComponent name.$_icsd_settingNameSetting name.Output/Return'true' if default, 'false' otherwise.
• isComponentSourceSite lib_macros_component.vm
  Determines if a component source is site-level or not.Parameters$_icss_componentNameComponent name.Output/Return"true" if given component is sourced on a site level.
• isFilenameComponentTemplate lib_macros_component.vm
  Determines if template filename is a component template filename. Renders either 'true' or 'false'.Parameters$_ifct_filenameTemplate filename.
• isInTestingMode lib_macros_tests.vm
  Determines if page is in testing mode.Output/Return"true" if in testing mode.
• isItemInCategory lib_macros_items.vm
  Parameters$_iiic_itemIDNo description available.$_iiic_categoryIDNo description available.
• isItemInSubcategory lib_macros_items.vm
  Parameters$_iiisc_itemIDNo description available.$_iiisc_categoryIDNo description available.
• isItemSearchable lib_macros_items.vm
  Parameters$_iis_itemNo description available.
• isQuickRendering lib_macros_component.vm
  Determines if the currently rendered component is using quick rendering.Parameters$_iqr_componentNameNo description available.Output/Return"true" if currently rendering component is using quick rendering.
• isTemplateUsedByItems lib_macros_items.vm
  Parameters$_itubi_templateNameNo description available.
• isURLAjaxRequest lib_macros_ajax.vm
  Determines if the URL parameters contains an AJAX request.Output/Return"true" if URL parameters contain 'useajax'.
• isURLComponentAjaxRequest lib_macros_ajax.vm
  Determines if the URL parameters contains a component-rendering AJAX request.Output/Return"true" if URL parameters contain 'componentajax'.
• javascriptComparatorSort lib_macros_sorter.vm
  Sorts a Velocity array using a JavaScript comparator function.Parameters$_cs_arrayToSortArray to sort.$_cs_javascriptComparatorJavascript comparator.$resultSorted Velocity array.
• jsGetMacrosInTemplateContent lib_macros_tests.vm
  Results are returned in $result variable.
  
  Get array of macro names in template content. This is the Velocity equivalent of #_jsGetMacrosInTemplateContent().Parameters$_jgmitc_templateNameTemplate name.
• JSONToVelocity lib_macros_json.vm
  Converts a JSON string to a Velocity object and stores in $result.Parameters$_jtv_JSONStringJSON-encoded string.$_jtv_displayOptional. If true, the result is output as a string when macro is called.Output/ReturnIf _jtv_display is true, the parsed resulting string is output.$resultParsed object.
• listGlobalValues lib_macros.vm
  List global values. Used with wvconsole.
• listLoadedComponents lib_macros_component.vm
  Generates a list of loaded components. Used with the wvconsole.Output/ReturnPlain-text listing of components used on page request.
• listLoadedDependencies lib_macros_dependencies.vm
  Generates a list of loaded dependencies. Used with the wvconsole.Output/ReturnPlain-text listing of dependencies used on page request.
• listLoadedPartials lib_macros_partials.vm
  Generates a list of loaded partials. Used with the wvconsole.Output/ReturnPlain-text listing of partials.
• log lib_macros.vm
  Logs a message.Parameters$_l_messageMessage.$_l_typeType of message. Default is 'debug'.$_l_showImmediatelyIf true, shows message immediately.
• macroName lib_directory_macros.vm
• makeBean lib_macros.vm
  Create a VTL variable storing a Java bean of a designated name. Variable name will match bean name.Parameters$_mb_beanNameBean name.$_mb_varNameOptional. VTL variable name of bean.
• mergeGlobalConfig lib_macros.vm
  Merges a global config with a site-level config.
  NOTE: For now, this only supports hash maps, strings, integer, booleans, and array lists.Parameters$_mgc_globalVarNameGlobal variable name as a string, excluding '$'.$_mgc_siteVarNameSite variable name as a string, excluding '$'.
• notContainedIn lib_macros_tests.vm
  Tests if the current expected object set in #expect() doesn't contain the given string or list of strings.Parameters$_nci_containsStringString that shouldn't contain object set in #expect().
• notEquals lib_macros_tests.vm
  Tests if the current expected object set in #expect() doesn't match the provided object.Parameters$_e_notEqualsToObject to test for not equivalency against object set in #expect().
• parseEither lib_macros.vm
  Parses in either templates. If the first template doesn't exist, it attempts to parse the second.Parameters$_pe_parseMainThe name of the main template to parse.$_pe_parseBackupThe name of the backup template to parse if the main template doesn't exist.$_pe_parseSilentlyIf true, will hide output from parse.Output/ReturnTemplate output if _pe_parseSilently != true.$resultName of template parsed.
• parsePattern lib_macros.vm
  Parses templates on both site and MTL with filenames matching the given regular expression.
  MTL is parsed in first, and then site.Parameters$_pp_patternRegular expression.$_pp_silentParseIf true, will hide any output from the parse.
• parsePHP lib_macros.vm
  Parses the given PHP script. This will use a CLI-style of PHP, and the web server environment will be absent. Many values in $_SERVER will be absent/different, and the web-related super-globals will be empty. If certain page parameters are needed, they can be parsed into the PHP code via Velocity's $request.getParameter() function. For example:
  
  ## The following uses Velocity to parse a value into the PHP script and echo that value.
  #parsePHP("$myPageParameter = '$request.getParameter('parameterName')'; echo $myPageParameter;")Parameters$_pp_phpPHP code.
• parsePython lib_macros.vm
  Parses the given Python script.Parameters$_pp_pythonPython code.
• parseSilently lib_macros.vm
  Silent parse. Will hide any output from the parse.Parameters$_sp_templateNameTemplate name.
• parseXML lib_macros.vm
  Parses given XML into a DOM object.Parameters$_px_xmlXML to parse.$resultXML DOM object.
• presetRecursiveVar lib_macros_recursive.vm
  Sets a variable for a recursive call BEFORE the call is made.Parameters$_prv_macroNameName of the recursive macro call.$_prv_varNameName of the variable to set.$_prv_valueValue of the variable.
• prioritizeGlobalConfig lib_macros.vm
  Prioritizes a global config over a site config when using #mergeGlobalConfig.Parameters$_pgc_globalConfigNameGlobal config name.
• readLocalFile lib_macros.vm
  Read a local system file and output results.
  NOTE: This reads plaintext files only and doesn't support binary formats.Parameters$_rlf_filenameFilename.Output/ReturnFile content.
• readLocalSiteFile lib_macros.vm
  Reads a local site file and outputs results.
  NOTE: This reads plaintext files only and doesn't support binary formats.
  
  The site base path is implied with the $_rlsf_filename argument:
  - Preview: /avetti/tomcat/webapps/ROOT/store/[vid]/[filename] - Production: /avetti/tomcat/webapps/preview/store/[vid]/[filename]Parameters$_rlsf_filenameFilename.$_rlf_vidOptional. Vendor ID of site.Output/ReturnFile content.
• redirectInsideHeadTag lib_macros.vm
  Redirects the site to the given category or URL, and immediately halts further Velocity execution for the request. This is rendered as a <script> tag, and must be used within the <head> tag of the document.Parameters$_riht_redirectObjectIdentifying category information (such as CID or name), or a direct URL.$_riht_useSEOIf a category, use SEO?$_riht_preventCodeHaltIf true, won't halt Velocity execution after rendering redirect script.
• regexReplaceAll lib_macros.vm
  Replaces all occurences of a pattern within a string.Parameters$_rr_expressionExpression to match.$_rr_replaceWithExpression to replace with.$_rr_stringString.
• regexReplaceFirst lib_macros.vm
  Replaces first occurence of a pattern within a string.Parameters$_rr_expressionExpression to match.$_rr_replaceWithExpression to replace with.$_rr_stringString.
• registerComponent lib_macros_component.vm
  Registers a component.Parameters$_rc_componentNameComponent name.$_rc_componentDataComponent data. This must be a linked has map, which can be denoted with curly brackets.
• removeGlobalValue lib_macros.vm
  Remove a global value. A global value is stored within memory until server reboot, and isn't specific to a site. A string representation will be immediately output of this value unless _ggv_silent is set to true.Parameters$_rgv_keyKey.$_rgv_silentIf true, no immediate string output is produced.$resultValue of global entry.
• render_basket lib_comp_basket.vm
  Component rendering macro.
• render_boldchat lib_comp_boldchat.vm
• render_category_filter lib_comp_category_filter.vm
  Component rendering macro.
• render_category_link lib_comp_category_link.vm
  Component rendering macro.
• render_customer_property_field lib_comp_customer_property_field.vm
  Component rendering macro.
• render_item_customization lib_comp_item_customization.vm
  Component rendering macro.
• render_login_link lib_comp_login_link.vm
  Component rendering macro.
• render_message_box lib_comp_message_box.vm
  Component rendering macro.
• render_myaccount_link lib_comp_myaccount_link.vm
  Component rendering macro.
• render_nav_menu lib_comp_nav_menu.vm
  Component rendering macro.
• render_olark lib_comp_olark.vm
• render_price lib_comp_price.vm
  Component rendering macro.
• render_product_card lib_comp_product_card.vm
  Component rendering macro. ss
• render_product_cards lib_comp_product_list.vm
  Parameters$productCardListNo description available.$countNo description available.
• render_product_list lib_comp_product_list.vm
  Component rendering macro.
• render_product_tabs lib_comp_product_tabs.vm
  Component rendering macro.
• render_rep_section lib_comp_rep_section.vm
  Component rendering macro.
• render_scaling_spotlight_slider lib_comp_scaling_spotlight_slider.vm
  Component rendering macro.
• render_spotlight_slider lib_comp_spotlight_slider.vm
• render_sub_category_list lib_comp_sub_category_list.vm
  Component rendering macro.
• render_test lib_comp_test.vm
  The macro below is the main body of the component itself. This is where you'll write whatever you need to display on the site.
  The #render_test() macro is executed whenever the #renderComponent('test') macro is called.
  NOTE: If a site has it's own component source (i.e. comp_test.vm), the macro name would have to be render_<componentName>_<VID> instead of render_<componentName>.
  NOTE: NEVER call a component's rendering macro directly. This is because the #renderComponent() macro manages things such as settings and nested called behind the scenes. Calling the rendering macro directly may cause unexpected results.
• render_test2 lib_comp_test2.vm
• render_test3 lib_comp_test3.vm
• render_test4 lib_comp_test4.vm
• render_test4_20240220633 /20240220633/6234/comp_test4.vm
• renderComponent lib_macros_component.vm
  Renders a given component.Parameters$_rc_componentNameName of the component to render.$_rc_componentSettingsNo description available.
• renderDependencies lib_macros_dependencies.vm
  Render dependencies of a given section. Typically, dependency sections are either 'headMarkup' or 'footMarkup'.Parameters$_rd_dependencySectionDependency section.
• renderPartials lib_macros_partials.vm
  Render list of loaded partials.Parameters$_rp_partialsListPartials list.
• requestAjax lib_macros_ajax.vm
  Generates an AJAX request to the local web server and stores the results in $result. Using this method will make a request using the session (JSESSIONID cookie) from the original request.Parameters$_rl_URLAjax URL, e.g. "http://data.fixer.io/api/latest"Output/ReturnRaw response body of AJAX request.$resultRaw response body of AJAX request.
• requestLocalAjax lib_macros_ajax.vm
  Generates an AJAX request to the local web server and stores the results in $result. Using this method will make a request using the session (JSESSIONID cookie) from the original request.Parameters$_rla_ajaxURIAjax URI, e.g. "getbasket.ajx?vid=20160101123"$_rla_protocolProtocol to use, e.g. "https". Default is "http".$_rla_basePathBase path to use on localhost request. Default is $request.contextPath.Output/ReturnRaw response body of AJAX request.$resultRaw response body of AJAX request.
• requestLocalAjaxEscaped lib_macros_ajax.vm
  Generates an AJAX HTTP request to the local web server and stores the results in $result, escaping JavaScript characters. Useful for embedding AJAX responses into JavaScript. Using this method will make a request using the session (JSESSIONID cookie) from the original request.Parameters$_rlae_ajaxURIAjax URI, e.g. "getbasket.ajx?vid=20160101123"$_rlae_protocolProtocol to use, e.g. "https". Default is "http".Output/ReturnJavaScript escaped response body of AJAX request.$resultJavaScript escaped response body of AJAX request.
• requestLocalAjaxPOST lib_macros_ajax.vm
  Generates an AJAX request to the local web server and stores the results in $result. Using this method will make a request using the session (JSESSIONID cookie) from the original request. It also will make a POST request instead of requestLocalAjax's GET.Parameters$_rla_ajaxURIAjax URI, e.g. "getbasket.ajx"$_rla_postParamsMap of parameters to include in POST body.$_rla_protocolProtocol to use, e.g. "https". Default is "http".$_rla_basePathBase path to use on localhost request. Default is $request.contextPath.$_rla_addCurlParamsList of additional cURL parameters.Output/ReturnRaw response body of AJAX request.$resultRaw response body of AJAX request.
• requiringLogin lib_macros_tests.vm
  Toggles required login for test.
• requiringLogout lib_macros_tests.vm
  Toggles required logout for test.
• resetComponent lib_macros_component.vm
  Resets a component's settings on the current settings chain.Parameters$_rc2_componentNameThe component name.
• runRomanceUpdates lib_macros.vm
  Runs the PHP romance updater script.
  NOTE: If romances aren't updating after executing this macro, the user:pass may need to be updated within the cURL arguments, which immediately follows '-u'.
• runSystemProcess lib_macros.vm
  Run system process and output results.Parameters$_rsp_argsCommand args.
• saveSitePreviewTemplate lib_macros.vm
  Saves a site-level preview template and sets its status as 'In Progress'.
  This macro has been designed to only work in the preview environment for a user who's session includes a valid Avetti admin login. For security reasons, it's imperative this remains as is and should never be adjusted to exclude either of these pieces of criteria.Parameters$_sspt_templateNameTemplate name.$_sspt_templateContentTemplate content.
• searchFilteringPassingTest lib_partial_search-content.vm
  This search filtering macro expects $_sft_itemData follows the given structure:
  { "targetItemCodes": [itemCode], "targetItemIDs": [itemID], "targetCategoryIDs": [itemCatID, itemCatID, ...], "targetCategoryNames": [itemCatName, itemCatName, ...], "item": itemObject }
  
  $_sft_filterData follows the given structure:
  { "targetItemCodes": [itemCode, itemCode, ...], "targetItemIDs": [itemID, itemID, ...], "targetCategoryIDs": [itemCatID, itemCatID, ...], "targetCategoryNames": [itemCatName, itemCatName, ...], "requiredCustomerProperties": [requiredProp, requiredProp, ...], "filteringMacros": [macroName, macroName, ...] }
  
  If this macro renders 'true' (after trimming), then this item is considered visible to search results.Parameters$_sft_itemDataNo description available.$_sft_filterDataNo description available.
• sendEmail lib_macros.vm
  Parameters$_se_fromNo description available.$_se_toNo description available.$_se_subjectNo description available.$_se_messageNo description available.$_se_bccNo description available.
• setCache lib_macros_cache.vm
  Set a site-level cache.Parameters$_sc_vidVendor ID.$_sc_cacheKeyCache key.$_sc_payloadCache payload.Output/ReturnCache key.
• setComponentAuthor lib_macros_component.vm
  Set component's author metadata.Parameters$_sca_authorAuthor.
• setComponentHelpURL lib_macros_component.vm
  Set component's help URL metadata.Parameters$_schu_URLURL to help document.
• setComponentMetaData lib_macros_component.vm
  Set component meta-data.Parameters$_scmd_varNameVariable name.$_scmd_varValueVariable value.
• setComponentSetting lib_macros_component.vm
  Sets a component setting on the current settings chain.Parameters$_scs_componentNameName of the component.$_scs_settingsNameName of the setting.$_scs_settingsValValue of setting.
• setComponentVersion lib_macros_component.vm
  Set component's version metadata.Parameters$_scv_versionVersion.
• setCustomerProperty lib_macros.vm
  Set a customer property. If the property of a given name doesn't exist, a new one is created.Parameters$_scp_propNameProperty name.$_scp_propValueProperty value.$_scp_clientIDOptional. Client ID of customer to set property for. Default is client ID of logged in user.
• setExistingCookieValue lib_macros.vm
  Set an existing cookie value.Parameters$_scv_cookieNameCookie name.$_scv_cookieValueCookie value.
• setGlobalValue lib_macros.vm
  Sets a global value. A global value is stored within memory until server reboot, and isn't specific to a site.Parameters$_sgv_keyKey.$_sgv_valueValue of global entry.
• setLoginCache lib_macros_cache.vm
  Set site-level login cache.Parameters$_slc_vidVendor ID.$_slc_loginNameLogin name.$_slc_cacheKeyCache key.$_slc_payloadPayload.Output/ReturnCache key.
• setMessagePriorityPrefix lib_macros_messages.vm
  Sets showMessage's priority prefix. When set, the showMessage macro will attempt to use a message with the given prefix first, and then use base message name if a prefixed version isn't found.
  
  Consider the following message name:
  
  faq.customerservice
  
  When setMessagePriorityPrefix('eu') is called, any render calls for faq.customer service will first use:
  
  eu.faq.customerserviceParameters$_smpp_prefixPrefix.
• setRecursiveVar lib_macros_recursive.vm
  Sets a recursive call variable.Parameters$_srv_macroNameName of the recursive macro call.$_srv_varNameName of the variable to set.$_srv_varValValue of the variable.
• setVarByName lib_macros.vm
  Stores a VTL variable by a given name. The variable can be referenced natively in Velocity.Parameters$_svbn_varNameVariable name.$_svbn_varValueValue to store.
• showErrorMessages lib_comp_message_box.vm
  Show error messages using the message_box component.Parameters$_sem_messagesMessage(s).
• showFormattedPrice lib_comp_basket.vm
  Parameters$_sfp_priceNo description available.
• showMessage lib_macros_messages.vm
  Shows a message using #springMessage, but also allows for parameterized fields.
  Parameters are denoted with double curly brackets, {{parameterName}}.
  Other messages can be nested as well. To nest a message within another, use a syntax similar to parameters: {{:message.name}}. To nest a partial, use the syntax {{!partialName}}.
  
  Example 1, Parameters:
  ## Assuming the message 'vm.example.message' = 'Hello, {{name}}!'
  
  #showMessage('vm.example.message', {'name': 'John'})
  
  ## This would yield 'Hello, John!'
  
  Example 2, Nested Messages:
  ## Using the message, vm.example.message, from above and this one:
  ## vm.example.message2 = '{{:vm.example.message}} How are you today?'
  
  #showMessage('vm.example.message2', {'name': 'Bob'})
  
  ## This would yield 'Hello, Bob! How are you today?'Parameters$_sm_messageNameMessage name.$_sm_parametersParameters stored in a map.
• showPaymentDescription /20240220633/6234/mail_order_approved.vm
  Parameters$descNo description available.
• showPaymentDescription /20240220633/6234/mail_order_rejected.vm
  Parameters$descNo description available.
• showPaymentDescription /20240220633/6234/mail_place_order.vm
  Parameters$descNo description available.
• showPriceOnOrderDetail lib_partial_myaccount-selfservedproductreturn.vm
  Parameters$priceNo description available.
• showPriceOnOrderDetail lib_partial_myaccount-selfservedproductreturn_result.vm
  Parameters$priceNo description available.
• showSuccessMessages lib_comp_message_box.vm
  Show success messages using the message_box component.Parameters$_ssm_messagesMessage(s).
• spacing lib_macros.vm
  Generates a string with a given length, padding the end of the string with _s_spaceChar.Parameters$_s_stringBase string.$_s_spaceCountTotal space count, less the length of _s_string.$_s_spaceCharSpace character to use.Output/ReturnString with trailing spaces.
• SRI_Hash lib_macros.vm
  Parameters$linkNo description available.
• suppressComponentHTMLComments lib_macros_component.vm
  Suppress surrounding component HTML comments that would otherwise render if the config $configDisplayComponentsHTMLComments is set to true. This is useful for being able to keep the config set to true, but suppress the comments in the event the component is rendering in JSON format instead of HTML.
• test lib_macros_tests.vm
  Sets the test's name and intializes settings.Parameters$_t_testNameThe name of the test.
• test_basket lib_comp_basket.vm
  Unit tests.
• test_boldchat lib_comp_boldchat.vm
• test_category_filter lib_comp_category_filter.vm
  Unit tests.
• test_category_link lib_comp_category_link.vm
  Unit tests.
• test_customer_property_field lib_comp_customer_property_field.vm
  Unit tests.
• test_item_customization lib_comp_item_customization.vm
  Unit tests.
• test_login_link lib_comp_login_link.vm
  Unit tests.
• test_message_box lib_comp_message_box.vm
  Unit tests.
• test_myaccount_link lib_comp_myaccount_link.vm
  Unit tests.
• test_nav_menu lib_comp_nav_menu.vm
  Unit tests.
• test_price lib_comp_price.vm
  Unit tests.
• test_product_card lib_comp_product_card.vm
  Unit tests.
• test_product_list lib_comp_product_list.vm
  #setComponentSetting('product_card', 'priceFormat', $_rpl_priceFormat)#* #setComponentSetting('product_card', 'priceAtNoCost', $_rpl_priceAtNoCost)#* #setComponentSetting('product_card', 'priceRenderPattern', $_rpl_priceRenderPattern)#* #setComponentSetting('product_card', 'class', $_rpl_productCardClass)#* #setComponentSetting('product_card', 'imageClass', $_rpl_productCardImageClass)#* #setComponentSetting('product_card', 'source', $_rpl_item)#* #setComponentSetting('product_card', 'displayAddToWishlist', $_rpl_displayAddToWishlist)#* #renderComponent('product_card')#* #end#*
  
  Unit tests.
• test_product_tabs lib_comp_product_tabs.vm
  Unit tests.
• test_rep_section lib_comp_rep_section.vm
  Unit tests.
• test_spotlight_slider lib_comp_scaling_spotlight_slider.vm
  Unit tests.
• test_spotlight_slider lib_comp_spotlight_slider.vm
• test_sub_category_list lib_comp_sub_category_list.vm
  Unit tests.
• test_test lib_comp_test.vm
  This macro serves as a self-contained unit test for the component. This macro is automatically called whenever unit testing is performed.
• test_test2 lib_comp_test2.vm
• test_test3 lib_comp_test3.vm
• test_test4 lib_comp_test4.vm
• test_test4_20240220633 /20240220633/6234/comp_test4.vm
• toggleTestingModeOff lib_macros_tests.vm
  Toggles testing mode off.
• toggleTestingModeOn lib_macros_tests.vm
  Toggles testing mode on.
• trace lib_macros.vm
  Logs a trace message.Parameters$_t_messageTrace message.
• trimmingResults lib_macros_tests.vm
  Toggles trimming for the results.
• updateMessagesCache lib_macros_messages.vm
  Updates the message name cache used for debugging #showMessage() calls.
• useComponent lib_macros_component.vm
  Initializes a component. This will look for a site-level component and if found, parse it in.
  If the template doesn't exist on the site, an MTL version of the component is parsed in.
  
  NOTE: Setting the URL parameter 'dump' to 1 will parse the component template directly to output.Parameters$_uc_componentNameThe component name.
• useDependency lib_macros_dependencies.vm
  ## Flags a dependency as being used. Will render out any of the dependencies sections.Parameters$_ud_dependencyNameDependency name.
• usePartials lib_macros_partials.vm
  Loads a set of partials to use on a given page.Parameters$_rp_partialsListPartials list.
• useQuickRendering lib_macros_component.vm
  Toggles currently-being-defined component to use quick rendering. Any component using quick rendering cannot be called more than once at any given point within a component render stack. For example, if a category link component uses quick rendering, it cannot render another category link within it. However, it can be rendered multiple times within another component, such as a category list.
• velocityToJSON lib_macros_json.vm
  Parameters$_vtj_objectNo description available.
• velocityToJSONResponse lib_macros_json.vm
  Converts a Velocity object to JSON and adjusts the HTTP response to 'application/json'.Parameters$_vtjr_objectObject.
• warn lib_macros.vm
  Logs a warning message.Parameters$_w_messageWarning message.
• writeLocalSiteFile lib_macros.vm
  Writes a local site file.
  NOTE: This writes plaintext files only and doesn't support binary formats.
  
  The site base path is implied with the $_wlsf_filename argument:
  - Preview: /avetti/tomcat/webapps/ROOT/store/[vid]/[filename] - Production: /avetti/tomcat/webapps/preview/store/[vid]/[filename]Parameters$_wlsf_filenameFilename.$_wlsf_contentFile content.$_wlsf_vidOptional. Vendor ID of site.
• WVConsoleCommandExecute lib_wvconsole.vm
  Executes a given command and generates an HTML DIV of the response, which is then utilized by AJAX calls from the console.Parameters$_wvcce_cmdNo description available.
• WVConsoleExecutionPoint lib_wvconsole.vm
  Creates a console execution point.Parameters$_WVConsoleExecutionPointName of the console execution point. If 'post', the browser console client is rendered.