The new GetWidgetHyperLinkWithPassword() function

Avatar
Natasha Ormiston
Follow

Overview

The new GetWidgetHyperLinkWithPassword() function returns a password-protected widget URL for a single project or a report.

You can use the function to enforce password protection when sharing a project or a report as a widget.

The function accepts the following parameters:

GetWidgetHyperLinkWithPassword(objectId,format,expirationDate,urlOnly,password)

Parameter Description Possible values
objectId An object that the function is applied to currentobject()
or
ID of a specific project or a report
format Format of the widget “roadmap” | “gantt”
expirationDate The expiration date after which the shared widget is no longer accessible The value can be set to Null, if you do not want to set a specific expiration date.
ulrOnly Format of the widget URL TRUE | FALSE
TRUE  — the widget URL will look as a URL (e.g. www.clarizen.com/widget)

FALSE — the widget URL will look as an HTML hyperlink (e.g. <a href=” www.clarizen.com/widget”>Click here to view the report</a>)
password Password for the shared widget You can specify a static password that applies to all shared widgets, or you can create a variable and allow users specify a password at the time of sharing.

Functionality

To use the GetWidgetHyperLinkWithPassword() function:

  1. As a System administrator, navigate to Settings > Configure.
  2. Select a desired item (e.g. Project).
  3. Create a new custom action. For example:
    1. In the Properties section, enter a name for the custom action.
    2. In the User Input section, select the Request values or confirmation from user checkbox.
    3. Enter the label for the new variable.
    4. Enter the variable name. The name is case-sensitive and will be used as a parameter in the function).
    5. From the Type drop-down list, select Text.
    6. Select the Mandatory check box.
    7. In the Success section, select the Show message radio button.
    8. In the text area, enter the formula: 

      {GetWidgetHyperLinkWithPassword(currentobject(),"roadmap",Null,TRUE,SetPassword)}

      Based on the values used in the formula, the function can be used to share any project or report, displays a widget in the roadmap format, has no expiration date, uses a URL without HTML, and allows users to specify a password at the time of sharing.

    9. Click Save.
  4. As a user, navigate to a project and attempt to share it as a widget.
Have more questions? Submit a request

Comments