RW Functions Global Scripts

These User-Defined Report Writer functions were added to Report Writer back in release 7.0 by David Musgrave (thank you David!)
 In the GP Software Development Kit (SDK), you can the document this posting was copied from, as well as a sample report using each one of these functions You can find the SDK in the Tools folder of the DVD installation media.

The functions are separated into five different categories:

• Numeric Functions
• String & Text Functions
• Date & Time Functions
• Data Functions
• Multicurrency Functions

Below is a listing of each function and how to use it:  

Numeric Functions

RW_Abs

Module: System Manager
Series: System
Script type: Global function
Category: Numeric Manipulation
Description: Returns the absolute value for the currency or vcurrency value supplied. Uses the Dexterity abs() function.
Parameters: in vcurrency IN_value.
Return Value: function returns vcurrency OUT_value. 

RW_ConvertToWordsAndNumbers

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Convert currency value to Words and Numbers, using descriptive terms from the Currency ID supplied. Prerequisites: none Parameters: in currency IN_Value. { Value of Currency } in string IN_Currency. { Currency ID of Currency - Leave Blank for Functional } in integer IN_Mode. { non-zero = Use Numbers and Words instead of only Words } Return Value: function returns string OUT_string.

RW_ConvertToWordsAndNumbersParse

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Convert currency value to Words and Numbers, using descriptive terms from the Currency ID supplied. Returns the result parsed into lines of a specified length. Uses the Dexterity Field_ParseText() function. Prerequisites: none Parameters: in currency IN_Value. { Value of Currency } in string IN_Currency. { Currency ID of Currency - Leave Blank for Functional } in integer IN_Mode. { non-zero = Use Numbers and Words instead of only Words } in integer IN_Characters. { Number of Characters per Line } in integer IN_Line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_Format

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Converts the contents of a currency or variable currency field to a string, applying the specified formatting. Uses the Dexterity format() function. IN_neg_type should use the following values:- 1 = SYSTEMNEG 2 = MINUSNEG 3 = PARENNEG 4 = CRNEG add 100 to display with % symbol Prerequisites: none Parameters: in vcurrency IN_currency. { value to format } in integer IN_cur_symbol. { non zero = display currency symbol } in integer IN_thou_sep. { non zero = display thousands separator }in integer IN_dec_places. { number of decimal places } in integer IN_neg_type. { how to display negative values } Return Value: function returns string OUT_string.

RW_MaxCurr

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the maximum of the two currency or vcurrency values supplied. Uses the Dexterity max() function. Prerequisites: none Parameters: in vcurrency IN_Value1. in vcurrency IN_Value2. Return Value: function returns vcurrency OUT_Max.

RW_MaxInt

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the maximum of the two integer or long values supplied. Uses the Dexterity max() function. Prerequisites: none Parameters: in long IN_Value1. in long IN_Value2. Return Value: function returns long OUT_Max.

RW_MinCurr

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the minimum of the two currency or vcurrency values supplied. Uses the Dexterity min() function. Prerequisites: none Parameters: in vcurrency IN_Value1. in vcurrency IN_Value2. Return Value: function returns vcurrency OUT_Min.

RW_MinInt

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the minimum of the two integer or long values supplied. Uses the Dexterity min() function. Prerequisites: none Parameters: in long IN_Value1. in long IN_Value2. Return Value: function returns long OUT_Min.

RW_PadZero

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns a zero padded string of specified based on the currency value supplied. The number of decimal places and whether to show the decimal separator can be selected. Prerequisites: none Parameters: in currency IN_Amount. { Currency value to Pad } in integer IN_Length. { Length of returned string } in integer IN_Decimal. { Number of Decimal Places } in integer IN_Dec_Sep. { non-zero = Show Decimal Separator } Return Value: function returns string OUT_String.

RW_Round

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the rounded value of a specified field. The field can be rounded on either side of the decimal separator. Uses the Dexterity round() function. IN_side should use the following values:- 0 = DECIMALRIGHT 1 = DECIMALLEFT IN_mode should use the following values:- 0 = ROUNDMODE_UP 1 = ROUNDMODE_DOWN 2 = ROUNDMODE_HALF_UP 3 = ROUNDMODE_HALF_DOWN 4 = ROUNDMODE_HALF_EVEN 5 = ROUNDMODE_CEILING 6 = ROUNDMODE_FLOOR Prerequisites: none Parameters: in vcurrency IN_value. { Currency or vcurrency value to be rounded } in integer IN_side. { Side of Decimal Separator to be rounded } in integer IN_dec_places. { Number of places to round to } in integer IN_mode. { Method to use for Rounding } Return Value: function returns vcurrency OUT_value.

RW_Truncate

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns the truncated value of a specified field. The field can be truncated on either side of the decimal separator. Uses the Dexterity truncate() function. IN_side should use the following values:- 0 = DECIMALRIGHT 1 = DECIMALLEFT Prerequisites: none Parameters: in vcurrency IN_value. Return Value: in vcurrency IN_value. { Currency or vcurrency value to be truncated } in integer IN_side. { Side of Decimal Separator to be truncated } in integer IN_dec_places. { Number of places to truncate }

RW_Value

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Numeric Manipulation Description: Returns a numeric value containing the first set of numeric value encountered in a specified string. Uses the Dexterity value() function. Prerequisites: none Parameters: in string IN_string. Return Value: function returns vcurrency OUT_value.

String & Text Functions

RW_Left

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns the left hand specified number of characters from the string supplied. Prerequisites: none Parameters: in string IN_String. in integer IN_Length. Return Value: function returns string OUT_string.

RW_Length

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns the number of characters in string supplied. Uses the Dexterity length() function. Prerequisites: none Parameters: in string IN_String. Return Value: function returns integer OUT_length.

RW_Lower

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a string in which all the alphabetic characters of a specified string have been converted to lower case. Uses the Dexterity lower() function. Prerequisites: none Parameters: in string IN_String. Return Value: function returns string OUT_string.

RW_Pad

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a padded string based on the string supplied, padded in the specified direction with the characters supplied. Uses the Dexterity pad() function. IN_Direction should use the following values:- 1 = LEADING 2 = TRAILING 3 = LEADING+TRAILING Prerequisites: none Parameters: in string IN_String. { String to Pad } in integer IN_Direction. { Direction to pad } in string IN_Pad. { Character to pad with } in integer IN_Length. { Length of returned string } Return Value: function returns string OUT_string.

RW_ParseString

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns the string of the specified line when parsing the supplied string field into lines of a specified length. Uses the Dexterity Field_ParseText() function. Prerequisites: none Parameters: in string IN_string. { String Field to Parse } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_Pos

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a numeric value indicating the starting position of a string within a string. Uses the Dexterity pos() function. Prerequisites: none Parameters: in string IN_target. { The string you want to search in } in string IN_search. { The string you want to search for } in integer IN_start. { The position at which the search will start in the target string } Return Value: function returns integer OUT_pos.

RW_Proper

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a string in which all the alphabetic characters of a specified string have been converted to Proper or Title case. This means that the first letter of each word will be uppercase and the rest of the letters will be lowercase. Prerequisites: none Parameters: in string IN_String. Return Value: function returns string OUT_string.

RW_Replace

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Allows you to overwrite characters in a string by replacing existing characters in the string. Uses the Dexterity replace() function. Prerequisites: none Parameters: in string IN_target. { A string or string field containing the characters you wish to replace } in string IN_replacement. { A string you wish to replace characters in target with } in integer IN_start. { The position in the target string where you want to put the replacement characters } in integer IN_length. { The number of characters from the replacement string you want to replace characters in the target string with } Return Value: function returns string OUT_string.

RW_Right

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns the right hand specified number of characters from the string supplied. Prerequisites: none Parameters: in string IN_String. in integer IN_Length. Return Value: function returns string OUT_string.

RW_Strip

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a string based on the supplied string with all occurrences of the specified character stripped out. Prerequisites: none Parameters: in string IN_String. in string IN_Strip. Return Value: function returns string OUT_string.

RW_Substitute

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Substitutes specified values for replacement markers in the specified string. Function handles up to 5 Substitutions (ie. markers %1 through to %5. Uses the Dexterity substitute command. Can be used with the RW_GetMsg() function. Prerequisites: none Parameters: in string IN_String. in string IN_Sub1. in string IN_Sub2. in string IN_Sub3. in string IN_Sub4. in string IN_Sub5. Return Value: function returns string OUT_string.

RW_Substring

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a portion of a specified string field. Uses the Dexterity substring() function. Prerequisites: none Parameters: in string IN_String. { A string value containing the substring you want } in integer IN_Start. { An integer indicating the starting position to use } in integer IN_Length. { An integer indicating the number of characters you want to return } Return Value: function returns string OUT_string.

RW_Token

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns the string value in the specified position from the supplied string using the token character as a separator. For example: RW_Token(“One|Two|Three|Four|Five|Six|Seven|Eight|Nine|Ten”,”|”, 6) will return the string “Six”. Prerequisites: none Parameters: in string IN_string. { String containing values separated by token character } in string IN_token. { Token character used in String } in integer IN_position. { Position of value to return } Return Value: function returns string OUT_string.

RW_Trim

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Remove a specified string from the beginning, end or both the beginning and end of another specified string. Uses the Dexterity trim() function. IN_Direction should use the following values:- 1 = LEADING 2 = TRAILING 3 = LEADING+TRAILING Prerequisites: none Parameters: in string IN_String. { String to trim } in integer IN_Direction. { Direction to trim } in string IN_Trim. { Characters to trim } Return Value: function returns string OUT_string.

RW_Upper

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: String & Text Manipulation Description: Returns a string in which all the alphabetic characters of a specified string have been converted to upper case. Uses the Dexterity upper() function. Prerequisites: none Parameters: in string IN_String. Return Value: function returns string OUT_string.

Date & Time RW Functions

RW_AddMonth

  Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Allows you to adjust the month portion of a date by a specified amount. Uses the Dexterity addmonth() function. Prerequisites: none Parameters: in date IN_date. in integer IN_months. Return Value: function returns date OUT_date.

RW_DateToString

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Returns the specified date as specified by the format string supplied. For example: RW_DateToString(RW_MakeDate(1,1,2001), "dddd, DD-mmmm-YYYY") returns “Monday, 01-January-2001” ddd = day of week as 3 letters dddd = day of week in full N = day of year NN = day of year (padded) D = day of month DD = day of month (padded) M = month of year MM = month of year (padded) mmm = month of year as 3 letters mmmm = month of year in full YY = year of date (2 digits) YYYY = year of date (4 digits) Prerequisites: none Parameters: in date IN_Date. in string IN_Format. Return Value: function returns string OUT_String.

RW_DiffDate

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Returns the long integer difference between two date values supplied. Prerequisites: none Parameters: in date IN_start. in date IN_end. Return Value: function returns long OUT_diff.

RW_EndOfMonth

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Returns the date of the last day of the month for a specified date. Uses the Dexterity eom() function. Prerequisites: none Parameters: in date IN_date. Return Value: function returns date OUT_date.

RW_MakeDate

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Creates a date value from three integer values. Uses the Dexterity mkdate() function. Prerequisites: none Parameters: in integer IN_month. in integer IN_day. in integer IN_year. Return Value: function returns date OUT_date.

RW_MakeTime

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Creates a time value as a string from three integer values. Uses the Dexterity mktime() function. Prerequisites: none Parameters: in integer IN_hour. in integer IN_minute. in integer IN_second. Return Value: function returns string OUT_time.

RW_SetDate

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Creates a date value or modifies a date value from three integer values. Uses the Dexterity setdate() function. Prerequisites: none Parameters: in date IN_date. in integer IN_month. in integer IN_day. in integer IN_year. Return Value: function returns date OUT_date.

RW_SysDate

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Returns current System Date. Uses the Dexterity sysdate() function. Prerequisites: none Parameters: in integer IN_mode. { non-zero = SQL Server Date } Return Value: function returns date OUT_date.

RW_SysTime

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Date & Time Manipulation Description: Returns current System Time as a string. Uses the Dexterity systime() function. Prerequisites: none Parameters: in integer IN_mode. { non-zero = SQL Server Time } Return Value: function returns string OUT_time.

Data Functions

RW_CityStateZip
 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Used from reports to concatenate the City, State and Zip Code into a string value using the trim function to remove trailing spaces. Prerequisites: none Parameters: in string inCity; in string inState; in string inZipCode; Return Value: function returns string outCityStateZip. 

RW_CoAddrIDInfo

 Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns a string field from the Company Address table for the given Address ID. Leave IN_Address_Code blank for company default location. IN_Field should use the following values:- 1 = Contact Name 2 = Address 1 3 = Address 2 4 = Address 3 5 = City 6 = State 7 = Zip 8 = Country 9 = Phone 1 10 = Phone 2 11 = Phone 3 12 = Fax 13 = Country Code 14 = County 15 = Address Name 16 = Address ID Prerequisites: none Parameters: in 'Address Code' IN_Address_Code. { Leave Blank for Default } in integer IN_Field. { Field to Return } Return Value: function returns string OUT_String.

RW_GetCommentText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns Comment Text field as strings of given length for the specified Comment ID. Prerequisites: none Parameters: in string IN_CommentID. { Comment ID of Comment } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_GetInternetInfo

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns Additional Internet Information fields 1 to 8 for the specified Master Type, Master ID and optional Address ID. Passing in the value of 9 will retrieve the Messenger Address value. IN_MasterType should use the following values:- CMP = CO_INETADDRS_COMPANY VEN = CO_INETADDRS_VENDOR CUS = CO_INETADDRS_CUSTOMER EMP = CO_INETADDRS_EMPLOYEE ITM = CO_INETADDRS_ITEM SLP = CO_INETADDRS_SALESPERSON IN_field must have a value between 1 and 9. Prerequisites: none Parameters: in string IN_MasterType. in string IN_MasterID. in string IN_AddressID. in integer IN_field. Return Value: function returns string OUT_string.

RW_GetInternetPrompt

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns Additional Internet Information prompts 1 to 8 for the current company. IN_field must have a value between 1 and 8. Prerequisites: none Parameters: in integer IN_field. Return Value: function returns string OUT_string.

RW_GetInternetText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns Additional Internet Information Text field as strings of given length for the specified Master Type, Master ID and optional AddressID. IN_MasterType should use the following values:- CMP = CO_INETADDRS_COMPANY VEN = CO_INETADDRS_VENDOR CUS = CO_INETADDRS_CUSTOMER EMP = CO_INETADDRS_EMPLOYEE ITM = CO_INETADDRS_ITEM SLP = CO_INETADDRS_SALESPERSON Prerequisites: none Parameters: in string IN_MasterType. { MasterType Code } in string IN_MasterID. { Master ID } in string IN_AddressID. { Optional Address ID } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } optional in integer IN_field {Text field desired, 10(to), 11(cc) 12(bcc) defaults to INetInfo} Return Value: function returns string OUT_string.

RW_GetMsg

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: This function will receive a integer value and return the string of the getmsg Prerequisites: none Parameters: in integer imsg; Return Value: function returns string smsg;

RW_GetMsgDisplay

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Decomposes a GetMsg into two strings to be displayed on a report. The first 80 chars are returned in sFront with the next 80 chars returned in sTail. The returned values are then passed in as legends. Prerequisites: none Parameters: in integer nGetMsg; out string sFront; out string sTail;

RW_GetNoteText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns Note Text field as strings of given length for the specified Note Index. Prerequisites: none Parameters: in currency IN_NoteIndex. { Note Index of Note } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_GetPOPTypeString

 
Module: Distribution Series: Purchasing Script type: Global function Form (If a form global): Category: Data Retrieval Description: Takes the POP Type field (integer) and outputs the POP Type string. POP_DOCTYPE_SHIPMENT POP_DOCTYPE_INVOICE POP_DOCTYPE_SHIPMENT_INVOICE POP_DOCTYPE_RETURN POP_DOCTYPE_RETURNCREDIT POP_DOCTYPE_INVENTORYRETURN POP_DOCTYPE_INVENTORYRETURNCREDIT Prerequisites: none Parameters: in 'POP Type' nPOPType; Return Value: function returns string sPOPType;

RW_GetPOTypeString

 
Module: Distribution Series: Purchasing Script type: Global function Form (If a form global): Category: Data Retrieval Description: Takes the PO Type field (integer) and outputs the PO Type string. POP_DOCTYPE_PO POP_DOCTYPE_DROPSHIP POP_DOCTYPE_BLANKET POP_DOCTYPE_BLANKET_DROPSHIP Prerequisites: none Parameters: in 'PO Type' nPOType; Return Value: function returns string sPOType;

RW_GetSOPTypeString

 
Module: Distribution Series: Sales Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns the SOP type as a string value SOP_QUOTE SOP_ORDER SOP_INVOICE SOP_RETURN SOP_BACK_ORDER SOP_FULFILLMENT_ORDER Prerequisites: none Parameters: in integer nSOPType; Return Value: function returns string rw_GetSOPTypeString;

RW_GetWFApprovalStatusStr

 
Module: System Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns the Workflow Approval Status as a string value WF_APPROVAL_STATUS_NOTSUBMITTED WF_APPROVAL_STATUS_SUBMITTED WF_APPROVAL_STATUS_NOAPPROVALNEEDED WF_APPROVAL_STATUS_PENDINGAPPROVAL WF_APPROVAL_STATUS_PENDINGCHANGES WF_APPROVAL_STATUS_APPROVED WF_APPROVAL_STATUS_REJECTED WF_APPROVAL_STATUS_WORKFLOWENDED WF_APPROVAL_STATUS_NOTACTIVATED WF_APPROVAL_STATUS_DEACTIVATED Prerequisites: none Parameters: in 'Workflow Approval Status' nWrkflwApprvlStatus; Return Value: function returns string rw_GetWFApprovalStatusStr;

RW_GetWFPriorityStr

 
Module: System Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns the Workflow Approval Status as a string value WF_PRIORITY_LOW WF_PRIORITY_NORMAL WF_PRIORITY_HIGH Prerequisites: none Parameters: in 'Workflow Priority' nWrkflwPriority; Return Value: function returns string rw_GetWFPriorityStr;

RW_PMAddrIDInfo

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns a string field from the Vendor Master Address table for the given Vendor ID and Address ID. IN_Field should use the following values:- 1 = Contact Name 2 = Address 1 3 = Address 2 4 = Address 3 5 = City 6 = State 7 = Zip 8 = Country 9 = Phone 1 10 = Phone 2 11 = Phone 3 12 = Fax 13 = Country Code Prerequisites: none Parameters: in 'Vendor ID' IN_Vendor_ID. in 'Address Code' IN_Address_Code. in integer IN_Field. Return Value: function returns string OUT_String.

RW_POPHDRCommentText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns POP Header Comment Text field as strings of given length for the specified Document. Prerequisites: none Parameters: in string IN_Number. { POP Number of Document } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_POPLINECommentText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns POP Line Comment Text field as strings of given length for the specified Line. Prerequisites: none Parameters: in integer IN_Type. { POP Type of Document } in string IN_Number. { POP Number of Document } in long IN_Ord. { Ord Number of Line } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_RMAddrIDInfo

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns a string field from the Customer Master Address table for the given Customer ID and Address ID. IN_Field should use the following values:- 1 = Contact Name 2 = Address 1 3 = Address 2 4 = Address 3 5 = City 6 = State 7 = Zip 8 = Country 9 = Phone 1 10 = Phone 2 11 = Phone 3 12 = Fax 13 = Country Code Prerequisites: none Parameters: in 'Customer Number' IN_Customer_Number. in 'Address Code' IN_Address_Code. in integer IN_Field. Return Value: function returns string OUT_String.

RW_SOPHDRCommentText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns SOP Header Comment Text field as strings of given length for the specified Document. Prerequisites: none Parameters: in integer IN_Type. { SOP Type of Document } in string IN_Number. { SOP Number of Document } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

RW_SOPLINECommentText

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns SOP Line Comment Text field as strings of given length for the specified Line. Prerequisites: none Parameters: in integer IN_Type. { SOP Type of Document } in string IN_Number. { SOP Number of Document } in long IN_LineItem. { Line Item Sequence of Line } in long IN_Component. { Component Sequence of Line } in integer IN_characters. { Number of Characters per Line } in integer IN_line. { Line Number to Return } Return Value: function returns string OUT_string.

Multicurrency Functions

RW_ConvertToReportingCurrency

 
Module: System Manager Series: System Script type: Global function Form (If a form global): Category: Data Retrieval Description: Used by Report Writer to convert functional amounts to reporting amounts given what the currency is to be printed in, the rate calculation method, and the reporting exchange rate. Prerequisites: none Parameters: in 'Print Currency In' nPrintCurrencyIn; in currency cyFunctionalAmt; in 'Rate Calculation Method' nRateCalcMethod; in 'Reporting Exchange Rate' cyReptExchRate; Return Value: function returns currency cyReportingAmt;

RW_CurrencyIndex

 
Module: System Manager Series: Financial Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns the Currency Index for a report by calling the GetCurrencyIndex Prerequisites: none Parameters: In 'Currency ID' IN_CurrencyID; Return Value: function returns integer 'Currency Index';

RW_Currency_GetIndexForView

 
Module: Distribution Series: Purchasing Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns the Currency Index to use for Currency amounts for reports dependant on the View selected – Functional, Originating or Reporting. Prerequisites: none Parameters: in integer nCurrencyView; { View selected: CURRENCYVIEW_FUNCTIONAL, CURRENCYVIEW_ORIGINATING, CURRENCYVIEW_REPORTING} In integer nCurrencyIndex; { Document's Currency Index } Return Value: function returns integer rw_Currency_GetIndexForView;

RW_DecCurr

 
Module: Distribution Series: Inventory Script type: Global function Form (If a form global): Category: Data Retrieval Description: Given a specific number of decimal places, the multiple format selector value needed to display a currency value is returned. Prerequisites: none Parameters: in integer iDecCurr; Return Value: function returns integer DecCurr;

RW_DecQty

  Module: Distribution Series: Inventory Script type: Global function Form (If a form global): Category: Data Retrieval Description: Given a specific number of decimal places, the multiple format selector value needed to display a quantity value is returned. Prerequisites: none Parameters: in integer iDecQty; Return Value: function returns integer DecQty;

RW_FormatCurrencyToString

 
Module: Distribution Series: Purchasing Script type: Global function Form (If a form global): Category: Data Retrieval Description: Formats the currency amount to the specified currency index using the format() function and returns it as a string value. If the currency index is not specified, it will be formatted to the functional currency. Prerequisites: none Parameters: in integer nCurrencyIndex; in currency cyCurrencyValue; Return Value: function returns string rw_FormatCurrencyToString;  

RW_MCTransaction

  Module: System Manager Series: Financial Script type: Global function Form (If a form global): Category: Data Retrieval Description: Returns : True for MCUR registered & Include MC Info is marked False for MCUR registered & Include MC Info is not marked False for MCUR is not registered Prerequisites: none Parameters: in integer nControlType; in string sTransactionCurrencyID; in string sReceiptCurrensyID; Return Value: function returns boolean fReturn; Last Modified: 14-Sep-2005
Enjoy!
Leslie