/// <summary>
/// Handle the general RC and error message.
/// <summary>
/// <param name="ex"></param>
/// <param name="platformOutput"></param>
internal int HandleGeneralError(Exception ex, ref PlatformOutput platformOutput)
{
ErrorCodeStandards errCodeStandards = new ErrorCodeStandards();
Logger.WriteLine(string.Format("Received exception: {0}.", ex), LogLevel.ERROR);
platformOutput.Message = errCodeStandards.ErrorStandardsDict[PluginErrors.STANDARD_DEFUALT_ERROR_CODE_IDX].ErrorMsg;
return(errCodeStandards.ErrorStandardsDict[PluginErrors.STANDARD_DEFUALT_ERROR_CODE_IDX].ErrorRC);
}
/// <summary>
/// Plug-in Starting point function.
/// </summary>
/// <param name="platformOutput"></param>
override public int run(ref PlatformOutput platformOutput)
{
Logger.MethodStart();
#region Init
int RC = 9999;
#endregion
try
{
#region Fetch Account Properties (FileCategories)
// Example: Fetch mandatory parameter - Username.
// A mandatory parameter is a parameter that must be defined in the account.
// TargetAccount.AccountProp is a dictionary that provides access to all the file categories of the target account.
// An exception will be thrown if the parameter does not exist in the account.
string username = ParametersAPI.GetMandatoryParameter(USERNAME, TargetAccount.AccountProp);
// Example: Fetch optional parmetere - Port.
// An optional parameter is a parameter that can be defined in the account or in the platform.
// TargetAccount.ExtraInfoProp is a dictionary that provieds access to all the platform parameters of the target account.
// An exception will be thrown if the parameter does not exist in neither the account or the platform.
string strPort = ParametersAPI.GetOptionalParameter(PORT, TargetAccount.AccountProp, TargetAccount.ExtraInfoProp);
// Note: To fetch Logon, Reconcile, Master or Usage account properties,
// replace the TargetAccount object with the relevant account's object.
#endregion
#region Fetch Account's Passwords
// Example : Fetch the target account's password.
string targetAccountPassword = TargetAccount.CurrentPassword.convertSecureStringToString();
// Example : Fetch the target account's new password.
string targetAccountNewPassword = TargetAccount.NewPassword.convertSecureStringToString();
#endregion
#region Logic
/////////////// Put your code here ////////////////////////////
// Logic goes here!!
// Logic goes here!!
// Logic goes here!!
// Logic goes here!!
// Logic goes here!!
/////////////// Put your code here ////////////////////////////
#endregion Logic
}
catch (Exception ex)
{
RC = HandleGeneralError(ex, ref platformOutput);
}
finally
{
Logger.MethodEnd();
}
// Important:
// 1.RC must be set to 0 in case of success, or 8000-9000 in case of an error.
// 2.In case of an error, platformOutput.Message must be set with an informative error message, as it will be displayed to end user in PVWA.
// In case of success (RC = 0), platformOutput.Message can be left empty as it will be ignored.
return(RC);
}