Documentation:DisplayWithVariables: Difference between revisions

DisplayWithVariables

Latest revision as of 05:02, 25 March 2025

This page was created by Hans.karlsen@mdriven.net on 2019-05-16. Last edited by Stephanie@mdriven.net on 2025-03-25.

This article describes how to inject or set variable values from URL parameters.

DisplayWithVariables is a special verb that will inject variable values on navigation.

http://<Host>/Turnkey/DisplayWithVariables?view=<ViewName>&id=<RootId>&vNewVar1=value1&vNewVar2=value2

The URL above will try to find the vNewVar1 variable of type string in <ViewName> - if found, assign the value1 to this variable.

The same will happen for vNewVar2.

Note! Both view and id are required. See below for how to avoid having to send the id.

Improvement Deployed 2019-06-22 DWV

DisplayWithVariables has been given a shortcut verb. You can now also use this form:

http://<Host>/DWV?v=<ViewName>&i=<RootId>&vNewVar1=value1

The Id of the root object is sent in with "i." If "i" is omitted, null is assumed

Improvement Deployed 2020-08-08

These functions now set the ViewModel variable RawURL to the requested URL, including parameters. This makes special processing available to the modeled code.

Improvement Deployed 2020-11-25

Sometimes, when we need a callback URL, the DWV is practical. However, some services cannot handle callbacks with parameters (Docusign Authentication)! So the DWV has now been extended so that all these URLs will do the same thing:

https://<server>/Turnkey/AngularApp#/SomeView/2!28   Original
https://<server>/DWV?v=SomeView&i=2!28               How it was - and still is
https://<server>/DWV/SomeView/2!28                   New! DWV/view/id

Also, see The_ExternalId_explained to get other more time-resilient forms of objects' ids as <classid>!GP!<guid>

@@ Line 1: / Line 1: @@
-This article describes how to inject or set variable values from url parameters.
+<message>Write the content here to display this box</message>
+This article describes how to inject or set variable values from URL parameters.
-DisplayWithVariables is a special verb that will inject variabel values on navigation.
+DisplayWithVariables is a special verb that will inject variable values on navigation.
   http://<Host>/Turnkey/DisplayWithVariables?view=<ViewName>&id=<RootId>&vNewVar1=value1&vNewVar2=value2
-The url above will try and find vNewVar1 variable of type string in <ViewName> - if found assign the value1 to this variable.
+The URL above will try to find the vNewVar1 variable of type string in <ViewName> - if found, assign the value1 to this variable.
 The same will happen for vNewVar2.
-Note! Both '''view''' and '''id''' are '''required'''. See below for avoiding having to send the '''id'''.
+Note! Both '''view''' and '''id''' are '''required'''. See below for how to avoid having to send the '''id'''.
-==== Improvement deployed 2019-06-22 DWV ====
+==== Improvement Deployed 2019-06-22 DWV ====
 DisplayWithVariables has been given a shortcut verb. You can now also use this form:
   http://<Host>/DWV?v=<ViewName>&i=<RootId>&vNewVar1=value1
-The Id of the root object is sent in with "i", If "i" is omitted null is assumed
+The Id of the root object is sent in with "'''i'''." If "'''i'''" is omitted, null is assumed
-==== Improvement deployed 2020-08-08 ====
+==== Improvement Deployed 2020-08-08 ====
-These functions now sets the viewmodel variable '''RawURL''' to the requested URL including parameters. This makes special processing available to modeled code.
+These functions now set the ViewModel variable '''RawURL''' to the requested URL, including parameters. This makes special processing available to the modeled code.
-==== Improvement deployed 2020-11-25 ====
+==== Improvement Deployed 2020-11-25 ====
-Sometimes when we need a callback url the DWV is practical - but some services cannot handle callbacks with parameters (Docusign Authentication)! So the DWV has now been extended so all these urls will do the same thing:
+Sometimes, when we need a callback URL, the DWV is practical. However, some services cannot handle callbacks with parameters (Docusign Authentication)! So the DWV has now been extended so that all these URLs will do the same thing:
   https://<server>/Turnkey/AngularApp#/SomeView/2!28   Original
   https://<server>/DWV?v=SomeView&i=2!28               How it was - and still is
   https://<server>/DWV/SomeView/2!28                   New! DWV/view/id
-Also see The_ExternalId_explained to get other more time-resilient forms of objects id's as <classid>!GP!<guid>
+Also, see [[Documentation:The ExternalId explained|The_ExternalId_explained]] to get other more time-resilient forms of objects' ids as <classid>!GP!<guid>
+[[Category:MDriven Turnkey]]
+{{Edited|July|12|2025}}