Functionality based URLs

Overview

In the topic SkyDesk Creator URL Patterns we learned about the default URLs to access a SkyDesk Creator Application and its Forms, Reports and Pages. In this topic, we will learn about the Functionality based URLs to set default values for Form Fields, edit individual records by passing record-ID in the URL, set criteria for and print Reports and Pages.

Permalink of Forms, Reports and Pages

You can also access the components (Forms, Reports and Pages) in your SkyDesk Creator Application using their permalinks. As the word suggests, a permalink is a permanent link; it refers to the URL of a particular webpage (a Form, Report or Page, here). 

The format of permalinks of your app's components are as given below -

Permalink of Forms 
https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ form-perma/<form_link_name>

Examplehttps://app.skydeskcreator.com/sampleapp/employee-manager/form-perma/Basic_Information 

You may embed your Form in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ form-embed/<form_link_name>'></iframe>
Permalink of Reports ​ 
https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ view-perma/<report_link_name>

Examplehttps://app.skydeskcreator.com/sampleapp/employees/view-perma/All_Employees 

You may embed your Report in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ view-embed/<report_link_name>'></iframe>
Permalink of Pages 
https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ page-perma/<page_link_name>

Examplehttps://app.skydeskcreator.com/sampleapp/employees/page-perma/Complete_Employee_details

You may embed your Page in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/ page-embed/<page_link_name>'></iframe>

where,

<app_owner_name>  is the SkyDesk user-name of the application's owner 
<app_link_name> is the Link Name of the SkyDesk Creator application 

<form_link_name>
<report_link_name>
<page_link_name>

is the Link Name of the component (Form, Report, Page), respectively
Note:

Functionality based URLs for Forms

To set default values for Form Fields

The default values for Form Fields can be set by passing additional parameters in the Form's URL. For example, to automatically load a value for the Field Employee ID in the Employee Manager Application, the default value is passed as query string (Employee_ID=1234) in the Form's URL, where Employee_ID is the Deluge script name of the Field in the Employee Form.

The Form's URL with query string will be in the below formats:

  1. Accessing within the Application:
    https://app.skydeskcreator.com/zchelp/employee-manager/#Form:Employee?Employee_ID=1234
  2. Accessing via its permalink:
    https://app.skydeskcreator.com/zchelp/employee-manager/form-perma/Employee?Employee_ID=1234
  3. Accessing a Form, which is embedded in another webpage:
    https://app.skydeskcreator.com/zchelp/employee-manager/form-embed/Employee?Employee_ID=1234

For Multi Select Fields like Check-box, there can be need for having more than one value selected by default. For this, the values that are to be passed should be separated by a comma. For example, if the values "Manager" and "Programmer" are to be set for the Field Roles in the Employee Form (of the Employee Manager Application), the URL will be - https://creator.skydesk.jp/sampleapp/employee-manager/#Form:Employee?Roles=Manager,Programmer.

Note: The values that are passed (as query string in the URL) will be set when the Form is loaded, i.e., On Load.

To load Form without Field-focus

You may note that when you access your Form in your SkyDesk Creator Application, the focus gets set on the first Field of the Form, i.e., the cursor appears on the first Field of the Form.

Assume that you have a website or blog, in which you have embedded your Form. When your webpage is accessed, this default auto-focus behaviour will scroll your webpage to where your Form is placed. This may hinder a user's experience as the content present above the embedded Form gets skipped. To handle this, SkyDesk Creator provides a parameter - zc_Focus.

Value forzc_Focus   Intended behaviour
true
  • "true" is the default value of this parameter; thus appending zc_Focus=true as query string in your Form's URL is not necessary.
  • Example - https://app.skydeskcreator.com/sampleapp/employees/#Form:Employee_Information
    You may note that the cursor gets set on the Form's first Field (Name in this case). 
false
  • By appending zc_Focus=false as query string in your Form's URL, the auto-focus behaviour is disabled.
  • Example - https://app.skydeskcreator.com/sampleapp/employees/#Form:Employee_Information?zc_Focus=false
    ​You may note that now the focus is not set on the Name Field as given above. 

Note: This parameter (zc_Focus) can be used only by the SkyDesk Creator accounts created after April-2014. It is not supported for the older accounts.

To edit individual records by passing record-ID in the URL

The URL to view and edit individual records using their record-ID is given below. This will display the SkyDesk Creator Form in Edit mode.

https://app.skydeskcreator.com/<user_Name>/<app_link_name>/#Form:<form_link_name>?recLinkID=<record_ID>&viewLinkName=<report_link_name>

Refer the topic Editing Records via Record ID for more information.

Functionality based URLs for Reports

URL format to set criteria for a Report

The criteria for a Report can be passed as query string in a Report's URL. Multiple criterias are specified by appending them to the URL using the "&" Operator.

List of Operators and their Constants -

S. No Operator Constant
1 EQUAL 18
2 NOT_EQUAL 19
3 LESS_THAN 20
4 GREATER_THAN 21
5 LESS_EQUAL 22
6 GREATER_EQUAL 23
7 STARTS_WITH 24
8 ENDS_WITH 25
9 CONTAINS 26
10 NOT_CONTAINS 27
11 LIKE 28
12 EMPTY 29
13 NOT_EMPTY 30
14 YESTERDAY 31
15 TODAY 32
16 TOMORROW 33
17 LAST_7_DAYS 34
18 LAST_30_DAYS 35
19 LAST_60_DAYS 36
20 LAST_90_DAYS 37
21 LAST_120_DAYS 38
22 NEXT_7_DAYS 39
23 NEXT_30_DAYS 40
24 NEXT_60_DAYS 41
25 NEXT_90_DAYS 42
26 NEXT_120_DAYS 43
27 LAST_MONTH 44
28 THIS_MONTH 45
29 NEXT_MONTH 46
30 CURR_PREV_MONTH 47
31 CURR_NEXT_MONTH 48
32 TRUE 49
33 FALSE 50
34 LAST_YEAR 51
35 CURRENT_YEAR 52
36 NEXT_YEAR 53
37 PREVIOUS_2_YEAR 54
38 NEXT_2_YEAR 55
39 CURRENT_PREVIOUS_YEAR 56
40 CURRENT_NEXT_YEAR 57
41 BETWEEN 58

URL format to print a Report

The URL format to print a Report is given below:

https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/print/<report_link_name>

Examplehttps://app.skydeskcreator.com/zchelp/employee-manager/print/Employee_View

URL format to print a Report with criteria

Functionality based URLs for Pages

Pages can also accept URL parameters. You may access the below given URL as an example (parameter emp is being passed a value).

https://app.skydeskcreator.com/sampleapp/employees/#Page:Complete_Employee_details?emp=skydesk-support@fujixerox.co.jp

To print a Page with parameter

The URL format to print a Page with parameter is given below,

https://app.skydeskcreator.com/<app_owner_name>/<app_link_name>/print/<page name>?<paramName>=<paramValue>

where,

paramName is the name of the parameter defined in the Page
paramValue is the value passed to the parameter that is defined in the Page

Example: The URL to print a Page named "TestHTML" with paramName "dept" and paramValue as "Engineering" is given below. Here, the paramName "dept" is the name of the parameter defined in the Page to fetch records with the specified paramValue.
https://app.skydeskcreator.com/zchelp/employee-manager/print/TestHTML?dept=Engineering

To convert Page to PDF

The URL formats are as given below -

  1. The URL format to convert a Page to PDF is given below:
    https://creator.skydesk.jp/<app_owner_name>/<app_link_name>/pdf/<Page link name>

    Examplehttps://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution

  2. The URL format to convert a Page to PDF with output file name is given below: 
    https://creator.skydesk.jp/<app_owner_name>/<app_link_name>/pdf/<Page_link_name>/&zc_FileName=<output_file_name>

    If the parameter zc_FileName is not passed to the URL, then by default the Page's display name will be chosen as file name.
    Examplehttps://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution/&zc_FileName=DownloadReport

  3. The URL format to convert a Page to PDF with parameter, where, paramName is the name of the parameter defined in the Page and paramValue is the value passed to that parameter.
    https://creator.skydesk.jp/<app_owner_name>/<app_link_name>/pdf/<Page_link_name>/&<paramName>=<paramValue>

    Example: PDF Link with arguments: https://creator.skydesk.jp/sampleapp/customer-support/pdf/More_Details_Html_View/&ticketID=104, where, ticketID is the name of the parameter defined in the Page.
    Example: PDF Link with arguments and file name: https://creator.skydesk.jp/sampleapp/customer-support/pdf/More_Details_Html_View/&ticketID=104&zc_FileName=ReportFor_Oct26, where, ticketID is the name of the parameter defined in the Page.

  4. The URL format to convert a Page to PDF with the PDF's orientation value is given below. The orientation value can be landscape or portrait. The default value is portrait.
    https://creator.skydesk.jp/<app_owner_name>/<app_link_name>/pdf/<Page_link_name>/&zc_PdfOrientation=<orientation value>

    Example: PDF link with orientation value as landscape: https://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution/&zc_PdfOrientation=landscape
    Example: PDF link with orientation value as portrait: https://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution/&zc_PdfOrientation=portrait

  5. The URL format to convert a Page to PDF with the PDF's size is given below. Thevalues can be Letter, A4, Legal, Executive, with default value as Letter.
    https://creator.skydesk.jp/<app owner name>/<app link name>/pdf/<Page link name>/&zc_PdfSize=<size value>

    Example: PDF link with orientation value as landscape: https://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution/&zc_PdfSize=Letter
    Example: PDF link with orientation value as portrait: https://creator.skydesk.jp/sampleapp/customer-support/pdf/Most_Recent_Solution/&zc_PdfSize=A4

Limitations

  1. Div embedded Forms/Reports inside Pages is not supported. (This will be done only after we provide #include support, i.e., server-side include directive in Deluge. Users will have to change to the new implementation once done to enable PDF output). Refer the Limitations page for more details.
  2. Any authenticated content like images/CSS that requires your current credential will not be supported, i.e., any link/embedding in the Page to be converted into PDF, should be public content.
  3. Any CSS/images and other links to be rendered have to be specified in full path. For example, /images/xyz.jpg will not be properly rendered.
Note: Refer this page to see how to Show or Hide the PDF export option in your Page.