Difference between revisions of "Passing Values Using Parameters"

From SmartWiki
Jump to: navigation, search
 
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Using several techniques you can pass values from one page to another in order to pre-populate form fields or display on an HTML page. This is done by creating links with parameters.
+
Using several techniques, you can pass a value (called a Parameter) from one page to another in order to pre-populate form fields or display on an HTML page.  
  
'''Portal'''
+
==Sending Page==
* Create a [[Portal]] shortcut and associate the link with that shortcut.
+
Values can be sent from the initial (sending) page by creating a link to the destination page that includes parameters linking the variables to be passed. These are then parsed by the receiving page back into values.
 +
 
 +
'''Syntax:'''
 +
:<font size="3">'''/urltopage?var1=@variable1@&var2=@variable2@'''</font>
 +
 
 +
 
 +
'''Where:'''
 +
* ''urltopage'' is the relative [[URL]] to the destination page.
 +
* ''variable1'', ''variable2'' etc. are the variable names (e.g. @firstname@).
 +
* ''var1'', ''var1'' corresponding names for the variables
  
<pre>
 
/urltopage?parameter1=@variable1@&parameter2=@variable2@
 
</pre>
 
  
User and Company variables can be used to pass the current logged in user details and their company details.
+
<u>'''Examples:'''</u>
  
+
'''Portal'''
'''Application'''
+
* Create a [[Portal]] shortcut and associate the link with that shortcut.
* Create a [[Custom Field]] of the type [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] with one of the following.
+
/urltopage?var1=@variable1@&var2=@variable2@
  
  
'''Display as button'''
+
'''Button'''
 +
* Create a [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] Custom Field with:
 
<pre>
 
<pre>
<input type="button" class=Button value="Button Label" onClick='parent.location.href="/urltopage?parameter1=@variable1@&parameter2=@variable2@"'/>
+
<input type="button" class=Button value="Button Label"  
 +
onClick='parent.location.href="/urltopage?var1=@variable1@&var2=@variable2@"'/>
 
</pre>
 
</pre>
  
'''Display as hyperlink'''
+
 
 +
'''Hyperlink'''
 +
* Create a [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] Custom Field with:
 
<pre>
 
<pre>
<a href="/urltopage?parameter1=@variable1@&parameter2=@variable2@">Click Here</a>
+
<a href="/urltopage?var1=@variable1@&var2=@variable2@">Click Here</a>
 
</pre>
 
</pre>
  
 +
'''Note''': User and Company variables can be used to pass the current logged in user details and their company details.
  
==Parsing Parameters==
+
==Receiving Page==
  
On the receiving page the parameters can pre-populate a form or an html element which resides on that page. In order to achieve this the following javascript functions can be used.  
+
On the receiving page the parameters can pre-populate a form or an HTML element which resides on that page. In order to achieve this the following [[JavaScript]] functions can be used.  
  
Place the following first function in the head of the html.
+
Place the following first function in the head of the HTML.
  
 
<pre>
 
<pre>
Line 49: Line 60:
  
  
Place one of the following second functions in the body.
+
Place one of the following second functions within the body just prior to the closing body tag (&lt;/body>).
  
  
Line 61: Line 72:
 
var para2=document.getElementById('field2');
 
var para2=document.getElementById('field2');
  
para1.value = unescape(params["parameter1"]);
+
para1.value = unescape(params["var1"]);
para2.value = unescape(params["parameter2"]);
+
para2.value = unescape(params["var2"]);
  
  
Line 79: Line 90:
 
var para2=document.getElementById('element2');
 
var para2=document.getElementById('element2');
  
para1.value = unescape(params["parameter1"]);
+
para1.value = unescape(params["var1"]);
para2.value = unescape(params["parameter2"]);
+
para2.value = unescape(params["var2"]);
  
 
</script>  
 
</script>  
Line 86: Line 97:
 
</pre>
 
</pre>
  
Repeat for additional fields and values.
+
 
 +
Replace "field1" or "element1" etc. with the actual form or element id name and "var1" with the parameter name.
 +
 
 +
eg.
 +
 
 +
var para1=document.getElementById('firstname');
 +
 
 +
&lt;input type="text" value="" id="firstname">
 +
 
 +
or
 +
 
 +
var para1=document.getElementById('firstname');
 +
 
 +
&lt;div id="firstname">&lt;/div>
 +
 
 +
 
  
 
   
 
   
  
  
[[SmartSimple]] will replace the variable references (@lastname@ etc) with values derived from the current [[User|user]] session.
+
[[SmartSimple]] will replace the variable references (@lastname@, etc.) with values derived from the current [[User|user]] session.
 +
 
  
 +
[[Category:JavaScript]]
  
[[Category:System Management]][[Category:JavaScript]]
+
==See Also==
 +
* [[Pass Variables To Level 1]]

Latest revision as of 13:39, 20 October 2017

Using several techniques, you can pass a value (called a Parameter) from one page to another in order to pre-populate form fields or display on an HTML page.

Sending Page

Values can be sent from the initial (sending) page by creating a link to the destination page that includes parameters linking the variables to be passed. These are then parsed by the receiving page back into values.

Syntax:

/urltopage?var1=@variable1@&var2=@variable2@


Where:

  • urltopage is the relative URL to the destination page.
  • variable1, variable2 etc. are the variable names (e.g. @firstname@).
  • var1, var1 corresponding names for the variables


Examples:

Portal

  • Create a Portal shortcut and associate the link with that shortcut.
/urltopage?var1=@variable1@&var2=@variable2@


Button

 <input type="button" class=Button value="Button Label" 
 onClick='parent.location.href="/urltopage?var1=@variable1@&var2=@variable2@"'/>


Hyperlink

<a href="/urltopage?var1=@variable1@&var2=@variable2@">Click Here</a>

Note: User and Company variables can be used to pass the current logged in user details and their company details.

Receiving Page

On the receiving page the parameters can pre-populate a form or an HTML element which resides on that page. In order to achieve this the following JavaScript functions can be used.

Place the following first function in the head of the HTML.

function getParams() {
var idx = document.URL.indexOf('?');
var params = new Array();
if (idx != -1) {
var pairs = document.URL.substring(idx+1, document.URL.length).split('&');
for (var i=0; i<pairs.length; i++) {
nameVal = pairs[i].split('=');
params[nameVal[0]] = nameVal[1];
   }
}
return params;
}
params = getParams();


Place one of the following second functions within the body just prior to the closing body tag (</body>).


Form Field Population


<script>

var para1=document.getElementById('field1');
var para2=document.getElementById('field2');

para1.value = unescape(params["var1"]);
para2.value = unescape(params["var2"]);


</script> 


HTML Element Population (eg. <div>, <span>)


<script>

var para1=document.getElementById('element1');
var para2=document.getElementById('element2');

para1.value = unescape(params["var1"]);
para2.value = unescape(params["var2"]);

</script> 


Replace "field1" or "element1" etc. with the actual form or element id name and "var1" with the parameter name.

eg.

var para1=document.getElementById('firstname');

<input type="text" value="" id="firstname">

or

var para1=document.getElementById('firstname');

<div id="firstname"></div>




SmartSimple will replace the variable references (@lastname@, etc.) with values derived from the current user session.

See Also