Skip to content
REFERENCE

U.SAVE_CREDENTIALS

Summary

Persists the Runline login password for the current Windows user to an encrypted, user-specific local file. Used in environments where Active Directory is not deployed. Also persists credentials for non-Runline resources such as FTP sites

Syntax

=U.SAVE_CREDENTIALS([resource], [username], [password], [ssh_private_key], [block])

Parameters

Parameter Required Description
[resource] No An optional parameter that can be used to save the user credentials for a non-default Runline environment or for a Web resource such as an FTP URL. Set to TRUE to retrieve report of credentials set (passwords and keys not displayed)
[username] No If set, then this username is used instead of the logged-in Windows user. Not meaningful for Runline resources, which always use the Windows username
[password] No The password to be saved for the current Windows user. If empty, then a secure dialog for entry will be displayed. If set to "delete" then any current credentials are deleted
[ssh_private_key] No The SSH private key to be used for SFTP, or the path to the file containing the SSH private key.
[block] No If set to TRUE then method will not be calculated unless triggered by user interaction or calculated as a step in a script; If set to a number then will be throttled to not calculate more frequently than the specified number of seconds; make number negative to prevent auto recalc of blocked methods

Behavior

The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.

Return Value

Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.

Examples

=U.SAVE_CREDENTIALS()

Notes

  • Formula examples are preserved from maintained workbook usage and normalized to the current U. prefix.
  • Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
  • Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
  • For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.