Difference between revisions of "Object URL Syntax"

From SmartWiki
Jump to: navigation, search
m (→‎Usage Examples)
(→‎Usage Examples)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=Overview=
 
=Overview=
−
We’ve introduced the following new syntax to dynamically resolve URLs for various system objects and actions: <code>@ssurl(objecttype,action,identifier)@</code>. This syntax allows configuration settings to reference system objects through variables.
+
Designed for internal staff and partners, we’ve introduced a syntax that dynamically resolves URLs for various system objects and actions. This allows configuration teams to reference system objects using variables, streamlining setup when cloning new systems. Previously, configuration teams had to manually adjust URLs due to unique attributes like IDs which differ in cloned systems. Now, with this new syntax, links to assets such as login and signup pages, report charts, submit buttons, and portal sections will automatically point to the correct system asset after cloning without requiring manual intervention.
  
 
=Syntax=
 
=Syntax=
Line 7: Line 7:
 
<code>@ssurl(objecttype,action,identifier)@</code>
 
<code>@ssurl(objecttype,action,identifier)@</code>
  
−
* The "identifier" parameter may consist of more than 1 object. Multiple objects can be separated by using double semicolons ( ;; ) as a delimiter.
+
* The "objecttype" is the type of object being referenced, example "Signup" for a registration page
−
 
+
* The "Action" is the thing being done or opened, example “View” or "Creatlevelone"
−
* For some objects, the system enforces unique naming. For example, if you create an autoloader named "MyAutoloader", it is possible to create another autoloader also named "MyAutoloader". In these situations, we will simply return the object with lower ID.
+
* The "identifier" is the name of the thing being referenced, example the name you have given a sign-up page or an autoloader. If there are multiple identifier objects, separate them using double semicolons ( ;; ) as a delimiter. Note configuration teams should ensure all objects should have a unique identifier (name). if you create two autoloaders with the same name the system will only return the autoloader with the lower ID.
−
 
 
−
'''Note:''' Configuration should avoid these scenarios to begin with.
 
  
 
==Usage Examples==
 
==Usage Examples==
−
See table below: 
+
See the table below for supported variable syntax.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 27: Line 25:
 
||signup
 
||signup
 
||view
 
||view
−
||
+
||Signup Page Name
−
Signup Page Name
 
−
 
 
−
||
 
−
'''User Page Example:'''
 
−
 
 
−
<code>@ssurl(signup,view,169542userpage)@</code>
 
  
−
/s_signup.jsp?token=XVtQC1oGZlBfRxddXxdSQUlSZ1R9Ew%3D%3D
+
||'''User Signup Page Example: '''<code>@ssurl(signup,view,pagename)@</code>
 +
'''Result:''' /s_signup.jsp?token=XVtQC1oGZlBfRxddXxdSQUlSZ1R9Ew%3D%3D
  
  
−
'''Organization Page Example:'''
+
'''Organization Signup Page Example:''' <code>@ssurl(signup,view,pagename)@</code>
  
−
<code>@ssurl(signup,view,169542page1)@</code>
+
'''Result:''' /s_csignup.jsp?token=XVtQHUUGZV1YShBFQhdQXlZSZVxy
  
−
/s_csignup.jsp?token=XVtQHUUGZV1YShBFQhdQXlZSZVxy
 
  
 +
'''Single User + Organization Page Example:''' <code>@ssurl(signup,view,pagename)@</code>
  
−
'''Single User + Organization Page Example: '''
+
'''Result:''' /s_csignup.jsptoken=XVtQHUUGbFxRQhFaXxdSQUlSZ1R9HQ%3D%3D&ptoken=XVtQC1oGZlBeQBNZXxdSQUlTYFZzEg%3D%3D
  
−
<code>@ssurl(signup,view,169542page2)@</code>
+
'''Multiple Users + Organization Page Example: '''<code>@ssurl(signup,view,pagename)@</code>
  
−
/s_csignup.jsptoken=XVtQHUUGbFxRQhFaXxdSQUlSZ1R9HQ%3D%3D&ptoken=XVtQC1oGZlBeQBNZXxdSQUlTYFZzEg%3D%3D
+
'''Result:''' /s_csignup.jsp?token=XVtQHUUGbFxcRhRRXxdSQUlSZ1R9Eg%3D%3D
−
 
 
−
 
 
−
'''Multiple Users + Organization Page Example: '''
 
−
 
 
−
<code>@ssurl(signup,view,169542page3)@</code>
 
−
 
 
−
/s_csignup.jsp?token=XVtQHUUGbFxcRhRRXxdSQUlSZ1R9Eg%3D%3D
 
  
 
|-
 
|-
Line 66: Line 52:
 
||UTA Name
 
||UTA Name
 
||
 
||
−
<code>@ssurl(uta,listview,TrSecondUTA)@</code>
+
<code>@ssurl(uta,listview,utaname)@</code>
  
−
/iface/uta/uta_list.jsp?appid=102161
+
'''Result:'''  /iface/uta/uta_list.jsp?appid=102161
  
 
|-
 
|-
Line 78: Line 64:
 
||UTA Name
 
||UTA Name
 
||
 
||
−
<code>@ssurl(uta,createlevelone,TrSecondUTA)@</code>
+
<code>@ssurl(uta,createlevelone,utaname)@</code>
  
−
/Apps/app_editopportunity.jsp?appid=102161<br />&opportunityid=0
+
'''Result:''' /Apps/app_editopportunity.jsp?appid=102161&opportunityid=0
  
 
|-
 
|-
−
||
+
||UTA - Template Page
−
UTA - Template Page
 
−
 
 
 
||uta
 
||uta
 
||templatepage
 
||templatepage
 +
||UTA Name, Type Name
 
||
 
||
−
UTA Name, Type Name
+
<code>@ssurl(uta,templatepage,utaname;;typename)@</code>
  
−
||
+
'''Result:''' /ex/ex_Apppage.jsp?token=HwwPRhMGZVla
−
<code>@ssurl(uta,templatepage,TrSecondUTA;;L1typeB)@</code>
 
−
 
 
−
/ex/ex_Apppage.jsp?token=HwwPRhMGZVla
 
  
 
|-
 
|-
−
||
+
||UTA - Impact Quadrant
−
UTA - Impact Quadrant
 
−
 
 
 
||uta
 
||uta
 
||impactquadrant
 
||impactquadrant
 +
||UTA Name, Quadrant Name
 
||
 
||
−
UTA Name, Quadrant Name
+
<code>@ssurl(uta,impactquadrant,utaname;;quadrantname)@</code>
−
 
 
−
||
 
−
<code>@ssurl(uta,impactquadrant,TrSecondUTA;;MyQuadrant)@</code>
 
  
−
/Apps/db/db_impact.jsp?impactid=@Hw0ERBkfbV5bQRRQRh8~
+
'''Result:''' /Apps/db/db_impact.jsp?impactid=@Hw0ERBkfbV5bQRRQRh8~
  
 
|-
 
|-
Line 118: Line 96:
 
<code>@ssurl(report,view,reportname)@</code>
 
<code>@ssurl(report,view,reportname)@</code>
  
−
/userreport/ur_openreport.jsp?reportid=44372
+
'''Result:'''  /userreport/ur_openreport.jsp?reportid=44372
  
 
|-
 
|-
Line 124: Line 102:
 
||reportchart
 
||reportchart
 
||view
 
||view
 +
||Report Name, Chart Name
 
||
 
||
−
Report Name, Chart Name
+
'''Client-Side Chart Example: '''<code>@ssurl(reportchart,view,reportname;;chartname)@</code>
  
−
||'''Client-Side Chart Example:'''<br />
+
'''Result:''' /ex/ex_highchart.jspenc=1&chartid=H3ZfFAVpLgcxAVQ8GFAMERALMTY1QRYeH2JdUEJB&reportid=f1oJDE4bexInFm8TRRYqIxEmPA8rbTAKH2dZUkVG&rootcompany=GGZzFn0FZhk8JRocHGdIBBI7EzUSYAcDH2JcUg~~
−
<code>@ssurl(reportchart,view,169542report;;chart1)@</code>
 
−
 
 
−
/ex/ex_highchart.jsp?enc=1&chartid=H3ZfFAVpLgcxAVQ8GFAMERALMTY1QRYeH2JdUEJB
 
−
 
 
−
&reportid=f1oJDE4bexInFm8TRRYqIxEmPA8rbTAKH2dZUkVG
 
−
 
 
−
&rootcompany=GGZzFn0FZhk8JRocHGdIBBI7EzUSYAcDH2JcUg~~
 
  
  
 
'''Server-Side Chart Example:'''
 
'''Server-Side Chart Example:'''
 +
<code>@ssurl(reportchart,view,reportname;;chartname)@</code> 
  
−
<code>@ssurl(reportchart,view,169542report;;chart2)@</code>
+
'''Result:''' /servlet/wChart?width=300&height=200&codedid=YnoRF35kEjwDHm0DMUQMNQ0kZwcdHTgRH2JdUEJC
−
 
 
−
/servlet/wChartwidth=300&height=200
 
−
 
 
−
&codedid=YnoRF35kEjwDHm0DMUQMNQ0kZwcdHTgRH2JdUEJC
 
  
 
|-
 
|-
−
||
+
||Report Dashboard
−
Report Dashboard
 
−
 
 
 
||dashboard
 
||dashboard
 
||view
 
||view
 +
||Dashboard Name
 
||
 
||
−
Dashboard Name
+
<code>@ssurl(dashboard,view,dashboardname)@</code>
−
 
 
−
||
 
−
<code>@ssurl(dashboard,view,169542dashboard)@</code>
 
−
 
 
−
/userreport/ur_viewdb.jsp?dashbid=2348
 
−
 
 
  
−
Note: Even though Dashboards are configured in the Reports area of the system, a dashboard does not seem to belong to any specific report, which is why we don't need to specify a report name in the identifier.
+
'''Result:''' /userreport/ur_viewdb.jsp?dashbid=2348
  
 
|-
 
|-
−
||
+
||SmartFolder (View)
−
SmartFolder (View)
 
−
 
 
 
||smartfolder
 
||smartfolder
 
||view
 
||view
 +
||SmartFolder Name
 
||
 
||
−
SmartFolder Name
+
<code>@ssurl(smartfolder,view,foldername)@</code>
  
−
||
+
'''Result:''' /s_editresource.jsp?display=1&resourceid=68826
−
<code>@ssurl(smartfolder,view,169542folder)@</code>
 
−
 
 
−
/s_editresource.jsp?display=1&resourceid=68826
 
  
 
|-
 
|-
−
||
+
||SmartFolder - View (Internet Enabled)
−
SmartFolder - View (Internet Enabled)
 
−
 
 
 
||smartfolder
 
||smartfolder
 
||viewinet
 
||viewinet
 
||SmartFolder Name
 
||SmartFolder Name
 
||
 
||
−
<code>@ssurl(smartfolder,viewinet,169542folderinet)@</code>
+
<code>@ssurl(smartfolder,viewinet,foldername)@</code>
  
−
/files/113/68827/169542folderinet/
+
'''Result:''' /files/113/68827/169542folderinet/
  
 
|-
 
|-
Line 194: Line 150:
 
||Autoloader Name
 
||Autoloader Name
 
||
 
||
−
<code>@ssurl(autoloader,dropbox,169542autoloader)@</code>
+
<code>@ssurl(autoloader,dropbox,autoloadername)@</code>
  
−
/Archive/al_upload.jsp?loader
+
'''Result:''' /Archive/al_upload.jsp? loaderid=BEUFe2sDA1d7aV1cQUYBRWUDdgVhe2tRCwUDBg~~
  
 
|-
 
|-
Line 204: Line 160:
 
||Name
 
||Name
 
||
 
||
−
<code>@ssurl(aiinsight,view,169542_AI_Global)@</code>
+
<code>@ssurl(aiinsight,view,name)@</code>
  
−
/AI/ai_workingwithai.jsp?token=%40HwwMTxwbeFhFQhFFQRxZQVVTZFV1G3BhHQ~~
+
'''Result:''' /AI/ai_workingwithai.jsp?token=%40HwwMTxwbeFhFQhFFQRxZQVVTZFV1G3BhHQ~~
  
 
|}
 
|}
 +
 +
[[Category: Process Drivers]]

Latest revision as of 15:12, 26 March 2025

Overview

Designed for internal staff and partners, we’ve introduced a syntax that dynamically resolves URLs for various system objects and actions. This allows configuration teams to reference system objects using variables, streamlining setup when cloning new systems. Previously, configuration teams had to manually adjust URLs due to unique attributes like IDs which differ in cloned systems. Now, with this new syntax, links to assets such as login and signup pages, report charts, submit buttons, and portal sections will automatically point to the correct system asset after cloning without requiring manual intervention.

Syntax

The general format of the syntax is the following:

@ssurl(objecttype,action,identifier)@

  • The "objecttype" is the type of object being referenced, example "Signup" for a registration page
  • The "Action" is the thing being done or opened, example “View” or "Creatlevelone"
  • The "identifier" is the name of the thing being referenced, example the name you have given a sign-up page or an autoloader. If there are multiple identifier objects, separate them using double semicolons ( ;; ) as a delimiter. Note configuration teams should ensure all objects should have a unique identifier (name). if you create two autoloaders with the same name the system will only return the autoloader with the lower ID.

Usage Examples

See the table below for supported variable syntax.

Description objecttype action identifier Examples with Resolved Results
Signup Page signup view Signup Page Name User Signup Page Example: @ssurl(signup,view,pagename)@

Result: /s_signup.jsp?token=XVtQC1oGZlBfRxddXxdSQUlSZ1R9Ew%3D%3D


Organization Signup Page Example: @ssurl(signup,view,pagename)@

Result: /s_csignup.jsp?token=XVtQHUUGZV1YShBFQhdQXlZSZVxy


Single User + Organization Page Example: @ssurl(signup,view,pagename)@

Result: /s_csignup.jsptoken=XVtQHUUGbFxRQhFaXxdSQUlSZ1R9HQ%3D%3D&ptoken=XVtQC1oGZlBeQBNZXxdSQUlTYFZzEg%3D%3D

Multiple Users + Organization Page Example: @ssurl(signup,view,pagename)@

Result: /s_csignup.jsp?token=XVtQHUUGbFxcRhRRXxdSQUlSZ1R9Eg%3D%3D

UTA - Main List View

uta listview UTA Name

@ssurl(uta,listview,utaname)@

Result:  /iface/uta/uta_list.jsp?appid=102161

UTA - Create Level One

uta createlevelone UTA Name

@ssurl(uta,createlevelone,utaname)@

Result: /Apps/app_editopportunity.jsp?appid=102161&opportunityid=0

UTA - Template Page uta templatepage UTA Name, Type Name

@ssurl(uta,templatepage,utaname;;typename)@

Result: /ex/ex_Apppage.jsp?token=HwwPRhMGZVla

UTA - Impact Quadrant uta impactquadrant UTA Name, Quadrant Name

@ssurl(uta,impactquadrant,utaname;;quadrantname)@

Result: /Apps/db/db_impact.jsp?impactid=@Hw0ERBkfbV5bQRRQRh8~

Report report view Report Name

@ssurl(report,view,reportname)@

Result:  /userreport/ur_openreport.jsp?reportid=44372

Report Chart reportchart view Report Name, Chart Name

Client-Side Chart Example: @ssurl(reportchart,view,reportname;;chartname)@

Result: /ex/ex_highchart.jspenc=1&chartid=H3ZfFAVpLgcxAVQ8GFAMERALMTY1QRYeH2JdUEJB&reportid=f1oJDE4bexInFm8TRRYqIxEmPA8rbTAKH2dZUkVG&rootcompany=GGZzFn0FZhk8JRocHGdIBBI7EzUSYAcDH2JcUg~~


Server-Side Chart Example: @ssurl(reportchart,view,reportname;;chartname)@ 

Result: /servlet/wChart?width=300&height=200&codedid=YnoRF35kEjwDHm0DMUQMNQ0kZwcdHTgRH2JdUEJC

Report Dashboard dashboard view Dashboard Name

@ssurl(dashboard,view,dashboardname)@

Result: /userreport/ur_viewdb.jsp?dashbid=2348

SmartFolder (View) smartfolder view SmartFolder Name

@ssurl(smartfolder,view,foldername)@

Result: /s_editresource.jsp?display=1&resourceid=68826

SmartFolder - View (Internet Enabled) smartfolder viewinet SmartFolder Name

@ssurl(smartfolder,viewinet,foldername)@

Result: /files/113/68827/169542folderinet/

Autoloader - Dropbox autoloader dropbox Autoloader Name

@ssurl(autoloader,dropbox,autoloadername)@

Result: /Archive/al_upload.jsp? loaderid=BEUFe2sDA1d7aV1cQUYBRWUDdgVhe2tRCwUDBg~~

AI Insight aiinsight view Name

@ssurl(aiinsight,view,name)@

Result: /AI/ai_workingwithai.jsp?token=%40HwwMTxwbeFhFQhFFQRxZQVVTZFV1G3BhHQ~~

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Object_URL_Syntax&oldid=43609’