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:
- As a System administrator, navigate to Settings > Configure.
- Select a desired item (e.g. Project).
- Create a new custom action. For example:
- In the Properties section, enter a name for the custom action.
- In the User Input section, select the Request values or confirmation from user checkbox.
- Enter the label for the new variable.
- Enter the variable name. The name is case-sensitive and will be used as a parameter in the function).
- From the Type drop-down list, select Text.
- Select the Mandatory check box.
- In the Success section, select the Show message radio button.
- 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. - Click Save.
- As a user, navigate to a project and attempt to share it as a widget.
not sure this is correct, getting an error message that it is looking for the Register parameter. Looks like this is missing that parameter.
Hi, how different is this feature compared to what is described on this page?
https://success.clarizen.com/hc/en-us/articles/218762427-Enforcing-password-protection-for-widget-sharing
Can you give a use case of GetWidgetHyperLinkWithPassword() function?