Difference between revisions of "Short URL"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
A ''Short URL'' is a convenient, user-friendly URL that can be used to access virtually any element of the platform.
A ''Short URL'' is a convenient, user-friendly URL that can be used (by someone with a platform login) to access virtually any element of the platform.
__TOC__
__TOC__
===Obtaining a Short URL===
===Obtaining a Short URL===
Clicking the tilted "figure-8" icon on a page [[File:CopyShortURL.png]] brings up dialog that gives you a URL you can copy. You can put that URL into an email, a web page, or a bookmark. Any authorized user who follows the link goes directly to the targeted page in the platform.  
Clicking the tilted "figure-8" icon on a page [[File:CopyShortURL.png]] brings up dialog that gives you a URL you can copy. You can put that URL into an email, a web page, or a bookmark. Any authorized user who follows the link goes directly to the targeted page in the platform.  
:'''Note:'''<br>The Short URL icon for an application appears at the top of the ''Manage Application'' page for the app.


Using that URL, you can get to any of the following:
Using that URL, you can get to any of the following:
Line 11: Line 13:
* [[Application]] URL  
* [[Application]] URL  
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/application/{application_id}</nowiki></tt>
&nbsp; <tt>{{platformURL}}/app/{application_id}</tt>


|-
|-
Line 17: Line 19:
* [[Dashboard]] URL
* [[Dashboard]] URL
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/dashboard/{page_id}</nowiki></tt>
&nbsp; <tt>{{platformURL}}/dashboard/{page_id}</tt>


|-
|-
Line 23: Line 25:
* [[Document]] URL
* [[Document]] URL
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/document/{document_id}</nowiki></tt>
&nbsp; <tt>{{platformURL}}/doc/{document_id}</tt>


|-
|-
Line 29: Line 31:
* [[Record URL]]
* [[Record URL]]
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/record/{record_id}</nowiki></tt>
&nbsp; <tt>{{platformURL}}/record/{record_id}</tt>
<br>&nbsp; <tt><nowiki>http://{domain}/networking/record/</nowiki>{[[#Record Name|record_name]]}</tt>
<br>&nbsp; <tt>{{platformURL}}/record/{[[#Record Name|record_name]]}</tt>


|-
|-
Line 36: Line 38:
* [[Report]] URL
* [[Report]] URL
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/report/{report_id}</nowiki></tt><br>
&nbsp; <tt>{{platformURL}}/report/{report_id}</tt><br>


|-
|-
Line 42: Line 44:
* [[View]] URL
* [[View]] URL
|
|
&nbsp; <tt><nowiki>http://{domain}/networking/view/{object_name}/{view_id}</nowiki></tt>
&nbsp; <tt>{{platformURL}}/view/{object_name}/{view_id}</tt>
|}
|}
Once you know the pattern, you can also simply type a URL that matches one of those patterns into your browser.
Once you know the pattern, you can also simply type a URL that matches one of those patterns into your browser.


The Record URL is particularly worthy of note because, once things are set up properly, you can use the record ''name'' to define the URL. (More on that subject below.)
The Record URL is particularly worthy of note because, once things are set up properly, you can use the record ''name'' to define the URL. (More on that subject below.)
;Considerations:
Some URLs go to the platform GUI, and display the page as a tab within it. Other URLs display the page content only, without the platform GUI surrounding it. The following table shows which is which:
:{|  border="1" cellpadding="5" cellspacing="1"
! URL !! Full GUI !! Content Only
|-
| [[Application]] URL ||  align="center"|[[File:Checkmark.gif|link=]]    ||
|-
| [[Dashboard]] URL  ||  || align="center"|[[File:Checkmark.gif|link=]]
|-
| [[Document]]        ||  || align="center"|[[File:Checkmark.gif|link=]]
|-
| [[Record URL]]      ||  align="center"|[[File:Checkmark.gif|link=]]    ||
|-
| [[Report]] URL      ||  || align="center"|[[File:Checkmark.gif|link=]]
|-
| [[View]] URL        ||  align="center"|[[File:Checkmark.gif|link=]]    ||
|}


===Record URL===
===Record URL===
Line 53: Line 73:
===Record Name===
===Record Name===
{{:Record Name}}
{{:Record Name}}
===Sample App===
:* [[HowTo:Use a SQL Query to List Records in a Custom Page]]
:: This sample page uses short URLs as links in a JSP page populated with a list of object records.
<noinclude>
<noinclude>


[[Category:Glossary]]
[[Category:Glossary]]
</noinclude>
</noinclude>

Latest revision as of 21:40, 30 March 2012

A Short URL is a convenient, user-friendly URL that can be used (by someone with a platform login) to access virtually any element of the platform.

Obtaining a Short URL

Clicking the tilted "figure-8" icon on a page CopyShortURL.png brings up dialog that gives you a URL you can copy. You can put that URL into an email, a web page, or a bookmark. Any authorized user who follows the link goes directly to the targeted page in the platform.

Note:
The Short URL icon for an application appears at the top of the Manage Application page for the app.

Using that URL, you can get to any of the following:

  https://na.longjump.com/networking/app/{application_id}

  https://na.longjump.com/networking/dashboard/{page_id}

  https://na.longjump.com/networking/doc/{document_id}

  https://na.longjump.com/networking/record/{record_id}
  https://na.longjump.com/networking/record/{record_name}

  https://na.longjump.com/networking/report/{report_id}

  https://na.longjump.com/networking/view/{object_name}/{view_id}

Once you know the pattern, you can also simply type a URL that matches one of those patterns into your browser.

The Record URL is particularly worthy of note because, once things are set up properly, you can use the record name to define the URL. (More on that subject below.)

Considerations

Some URLs go to the platform GUI, and display the page as a tab within it. Other URLs display the page content only, without the platform GUI surrounding it. The following table shows which is which:

URL Full GUI Content Only
Application URL Checkmark.gif
Dashboard URL Checkmark.gif
Document Checkmark.gif
Record URL Checkmark.gif
Report URL Checkmark.gif
View URL Checkmark.gif

Record URL

A record URL is a URL that can be used to access a record in the platform. When viewing a record, you can get the record URL by clicking the Copy Short URL icon CopyShortURL.png in the upper right corner of the record:

CopyShortURL CustomerRecord.png.
Considerations
  • When a Record Name has been defined, the URL that is returned contains that name.
    For example: "http://.../record/Customer/ABC Co".
  • When a Record Name has not been defined, the URL contains the record ID.
    For example: "http://.../record/Customer/123456789".

Record Name

When you create an Index on an object, it is possible to specify the object's Record Identifier (declared in Record Locators) as the index field.

When the Index you create is unqiue, that value becomes the "name" of the record. That name is then and it can used as part of a Record URL you specify.

For example:

  • If the Record Identifier for the Customer object is specified as customer_name
    -and-
  • A unique Index is created on the Customer object, with Record Identifier chosen as the index field.

Then

  • It becomes possible to use "http://.../record/Customer/ABC Co" to access a Customer record,
    as well as "http://.../record/Customer/12345".
    -and-
  • When you click the Copy Short URL icon CopyShortURL.png in the GUI while displaying the record, the URL you are given to copy is "http://.../record/Customer/ABC Co".
Considerations
  • Most Built-in or CRM objects have a name field, but no Record Identifier. For those objects, creating a unique index on the name field creates a Record Name that is used in URLs.
  • One exception is Contacts, which have neither a name name field nor a Record Identifier. For those objects, it is not possible to define a Record Name. They can be accessed using a Record ID only.

Sample App

This sample page uses short URLs as links in a JSP page populated with a list of object records.