hmLoadTopic({
hmKeywords:"",
hmTitle:"System Labels",
hmDescription:"System labels are special labels that can be part of some endpoint elements. Those are replaced in runtime by the real values that they represent.",
hmPrevLink:"lk_http-status-code.html",
hmNextLink:"ws_manager.html",
hmParentLink:"index.html",
hmBreadCrumbs:"",
hmTitlePath:"System Labels",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">System Labels<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_Normal\">System labels are special labels that can be part of some endpoint elements. Those are replaced in runtime by the real values that they represent.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">The label list is as follows:<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">&nbsp;<\/p>\n\r<div style=\"text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;\"><table class=\"argumentos\" >\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_LINKARENTRYPOINT%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">Name of the EntryPoint used to access the DataBase.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_LINKARUSER%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">EntryPoint username.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_LINKARLANGUAGE%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">Language code for messages returned by LinkarServer (optional).<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_LINKARFREETEXT%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Optional text associated with the EntryPoint.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_LINKARPLUGINREF%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">Optional code for plugins used by LinkarServer.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_APIRESOURCE%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Name of the ApiResource to which the EndPoint belongs.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_APIKEY%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">APIKEY value in Api Key mode.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_APIKEY_INTERNALNAME%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Internal descripcion of apikey in Api Key mode<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_JWT%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">JWT token value in OAuth2.0 mode.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_REMOTEIP%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">IP of the host from which the request is made.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_HEADERS% <\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">HTTP headers of the request.<\/p>\n\r<p class=\"p_Normal\">They are presented using key=value pairs, separated with the Escaped VM mark. (|253)<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">%LKWS_FULLENDPOINT% <\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Full URL to access the endpoint.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:14.0000rem;\"><p class=\"p_Normal\">%LKWS_REQUESTDATA%<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.6250rem;\"><p class=\"p_Normal\">Concatenation of multiple system tags and other structured data in the form of an MV buffer.<\/p>\n\r<p class=\"p_Normal\">Is a list of MV attributes separated by the AM mark. These are the attributes:<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">1- Host: Host part of endpoint url.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">2- Path: Url part after host and before query strings. <\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">3- Querystrings: Final part of endpoint url.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">4- FULLENDPOINT: Full url to access the endpoint.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">5- REMOTE IP: Access source IP address.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">6- HTTP HEADERS: HTTP headers.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">7- RESOURCE NAME: API Resource name.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">8- APIKEY: APIKEY value.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">9- APIKEY: Internal description of apikey<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">10- JWT: JWT token value.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">11- LINKARENTRYPOINT: Name of the EntryPoint used to access the DataBase.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">12- LINKARUSER: EntryPoint username.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">13- LINKARLANGUAGE: Language code for messages returned by LinkarServer (optional).<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">14- LINKARFREETEXT: Optional text associated with the EntryPoint.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">15- LINKARPLUGREF: Optional code for plugins used by LinkarServer.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 1.6250rem;\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">As mentioned, these system labels can be used on different elements of the EndPoints:<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 1.6250rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: \'Courier New\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">o<\/span>In all CRUD and FUNCTIONS EndPoints, within the “CustomVars” element.<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 1.6250rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: \'Courier New\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">o<\/span>In all CRUD and FUNCTIONS EndPoints of type POST (Update, New, ...), inside the request body.<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 1.6250rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: \'Courier New\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">o<\/span>In the SENDCOMMAND and CUSTOM EndPoints in any part of the request body.<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">Pay Attention: All MV marks in the content of the variables (also those explicitly included in %LKWS_HEADERS% and %LKWS_REQUESTDATA%) are replaced by the following sequence of characters:<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin: 0 0 0 2.4375rem;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>IM: |255<\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin: 0 0 0 2.4375rem;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>AM: |254<\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin: 0 0 0 2.4375rem;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>VM: |253<\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin: 0 0 0 2.4375rem;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>SM: |252<\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin: 0 0 0 2.4375rem;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>TM: |251<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r"
})
