CyL's nOtE

aras.getInnovatorUrl Method Get system entry url with below format: http://<servername>/<web_alias> Syntax aras.getInnovatorUrl() Return Value A String. See Also aras Object Aras Innovator Client Framework

aras.evalJavaScript Method Evaluates JavaScript code in the Aras object space. Syntax aras.evalJavaScript( jsCode ) Parameters Name Type Description jsCode String Required. JavaScript code represented as a string. Return Value Returns evaluated result from given JavaScript code. See Also aras Object Aras Innovator Client Framework

aras.evalMethod Method Executes a client side Method with Item node or XML string. Syntax aras.evalMethod( methodNameOrNd , XMLinput , inArgs ) Parameters Name Type Description methodNameOrNd String or Object Required. Client side Method name or node. XMLinput Object Optional. Item node or XML string with Item tag. inArgs Any Optional. Additional arguments to pass. Return Value Returns evaluated result from executed client Method. See Also aras Object Aras Innovator Client Framework

aras.evalItemMethod Method Executes a client side Method with Item node. Syntax aras.evalItemMethod( methodName , itemNode , addArgs ) Parameters Name Type Description methodName String Required. Client side Method name. itemNode Object Optional. Item node. addArgs Any Optional. Additional arguments to pass. Return Value Returns evaluated result from executed client Method. See Also aras Object Aras Innovator Client Framework

aras.convertToNeutral Method Converts local value to neutral value. Only effect on specified data types including date, decimal, and float. Syntax aras.convertToNeutral( localValue , data_type , dotNetPattern4Date ) Parameters Name Type Description localValue Any Required. The local value to convert. data_type String Required. Property data type. dotNetPattern4Date String Optional. Decimal pattern or date pattern. When "data_type" is "date", this parameter only supports the following values: short_date (default) short_date_time long_date long_date_time Return Value A String. Returns the converted value. If conversion fails, original value will be returned. See Also aras Object Aras Innovator Client Framework

aras.convertFromNeutral Method Converts neutral value to local value. Only effect on specified data types including date, decimal, and float. Syntax aras.convertFromNeutral( val , data_type , dotNetPattern4Date ) Parameters Name Type Description val Any Required. The neutral value to convert. data_type String Required. Property data type. dotNetPattern4Date String Optional. Decimal pattern or date pattern. When "data_type" is "date", this parameter only supports the following values: short_date (default) short_date_time long_date long_date_time Return Value A String. Returns the converted value. If conversion fails, original value will be returned. See Also aras Object Aras Innovator Client Framework

aras.clearClientMetadataCache Method Clears all client side metadata caches and empty contents in Work Window Object . Syntax aras.clearClientMetadataCache() See Also aras Object Aras Innovator Client Framework

aras.calcMD5 Method Generates MD5 hash. Syntax aras.calcMD5( s ) Parameters Name Type Description s Any Required. The data to calculate. Return Value A String. Returns MD5 hash. See Also aras Object Aras Innovator Client Framework

CallContext.Email Property Gets Email object. Syntax CCO.Email Return Value An Email object. See Also CallContext Class Aras.Server.Core Namespace Aras Innovator Server Framework

Email.SetupSmtpMailServerAndSend Method Sends an email message with specified message object. Syntax Email.SetupSmtpMailServerAndSend( msg ) Parameters Name Type Description msg MailMessage Required. A MailMessage object that contains the message to send. See Also Email Class Aras.Server.Core Namespace Aras Innovator Server Framework

Email.SendEmailToIdentityEx Method Sends an email message. Syntax Email.SendEmailToIdentityEx( toIdentity , subject , plainBody , htmlBody , fromUser ) Parameters Name Type Description toIdentity String Required. The Identity name of the recipient. subject String Required. The subject for email message. plainBody String Required. The message body in plain text. This parameter will be useless when "htmlBody" is not empty string. htmlBody String Required. The message body in html text. fromUser String Required. The User login name of the sender. See Also Email Class Aras.Server.Core Namespace Aras Innovator Server Framework

Email.SendEmailToIdentity Method Sends an email message with plain text. Syntax Email.SendEmailToIdentity( toIdentity , subject , body , fromUser ) Parameters Name Type Description toIdentity String Required. The Identity name of the recipient. subject String Required. The subject for email message. body String Required. The message body. fromUser String Required. The User login name of the sender. See Also Email Class Aras.Server.Core Namespace Aras Innovator Server Framework

CallContext.Utilities Property Gets UtilitiesProxy object. Syntax CCO.Utilities Return Value An UtilitiesProxy object. See Also CallContext Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.WriteLog Method Writes a message to log file with timestamp and database name. Syntax UtilitiesProxy.WriteLog( logFile , [text] ) Parameters Name Type Description logFile String Required. The file name. [text] String Required. The message to write. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.WriteDebug Method Writes a message to log file with timestamp. Syntax UtilitiesProxy.WriteDebug( debugFile , [text] ) Parameters Name Type Description debugFile String Required. The file name. [text] String Required. The message to write. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.SaveTextData Method Saves text data to a file. Syntax UtilitiesProxy.SaveTextData( fileName , text2Save , append2File ) Parameters Name Type Description fileName String Required. The file path to save. text2Save String Required. The text data to save. append2File Boolean Required. True to append data to the file, false to overwrite the file. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.IsIdValid Method Determines if the item ID is valid. Syntax UtilitiesProxy.IsIdValid( itemId , doThrowException ) Parameters Name Type Description itemId String Required. The ID to check. doThrowException Boolean Required. True to throw exception when ID is not valid, otherwise false. Return Value A Boolean. Returns true if the ID is valid, otherwise returns false. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.GetLogsFolderPath Method Gets log file directory path. Syntax UtilitiesProxy.GetLogsFolderPath() Return Value A String. Returns the "temp_folder" value of "InnovatorServerConfig.xml". See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.GetIdentityNameByUserId Method Gets Alias name of specified user. Syntax UtilitiesProxy.GetIdentityNameByUserId( userId ) Parameters Name Type Description userId String Required. User ID. Return Value A String. Returns Alias Identity name if specified user exists, otherwise returns an empty string. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework

UtilitiesProxy.GetIdentityNameByIdentityId Method Gets Identity name by Identity ID. Syntax UtilitiesProxy.GetIdentityNameByIdentityId( identityId ) Parameters Name Type Description identityId String Required. Identity ID. Return Value A String. Returns Identity name if specified Identity exists, otherwise returns an empty string. See Also UtilitiesProxy Class Aras.Server.Core Namespace Aras Innovator Server Framework