SDK: Default Parameters and Custom Editors (Basic)

Overview

When creating simple steps by registering public methods, default values can also be set for the inputs of those methods. This allows users to change these input values still but populates the inputs with default values when the step is first used.

Example

The following code example demonstrates how to write a step to upload a file to an FTP server and have the server address and server port populated by default. Below is the code example of the method with the options parameters and default inputs.

public void FtpUpload(string username, string password, string serverAddress = "myftpserver.com", int serverPort = 21)
{
//upload files to ftp site
}

Custom editors can also be supplied on property values in the same manner.

public static void CreateUserAdvanced(
string ouPath,
string loginName,
[PasswordText]
string userPassword,
string email,
string firstName,
string lastName,
string department,
[PropertyClassification(0, INPUT_NAME_SYSTEM_USER_NAME, PROPERTY_NODE_ROOT, PROPERTY_NODE_LDAP_SETTINGS)]
string systemUserName,
[PasswordText]
[PropertyClassification(1, INPUT_NAME_SYSTEM_PASSWORD, PROPERTY_NODE_ROOT, PROPERTY_NODE_LDAP_SETTINGS)]
string systemPassword,
[PropertyClassification(2, INPUT_NAME_LDAP_SERVER_ADDRESS, PROPERTY_NODE_ROOT, PROPERTY_NODE_LDAP_SETTINGS)]
string ldapServerAddress)