# Actions-Fields-Field

The Fields-Field actions are grouped in the modules shown below:

<table><thead><tr><th width="125.33333333333331">Module</th><th width="249">Type</th><th>Description</th></tr></thead><tbody><tr><td>Cache</td><td>LookupCachedCustomValue</td><td>Returns a custom value saved in the cache</td></tr><tr><td></td><td>LookupCachedKeyValue</td><td>Returns a table key value that has been saved in the cache</td></tr><tr><td>Counters</td><td>GetCurrentCounterValue</td><td>Returns the specified counter value</td></tr><tr><td></td><td>IncrementCounter</td><td>Initializes, Increments the value of a specified counter and returns it</td></tr><tr><td>Custom</td><td>Composite</td><td>Executes selected defined or pre-defined actions in sequence and returns the result of executing the last action in the list.</td></tr><tr><td></td><td>Expression</td><td>The Expression action executes a simple expression (javascript). The expression must return a value</td></tr><tr><td></td><td>Function</td><td>Executes a .Net custom function and returns a value</td></tr><tr><td></td><td>Script</td><td>The Script field action executes a script (javascript). The script must return a value.</td></tr><tr><td>DateTime</td><td>AddDaysToDate</td><td>Adds (or subtracts) the specified number of days to a date</td></tr><tr><td></td><td>AddMonthsToDate</td><td>Adds (or subtracts) the specified number of months to a date</td></tr><tr><td></td><td>AddTimeSpanToDateTime</td><td>Adds (or subtracts) the specified TimeSpan (00:00:00:00) to a datetime. To subtract place - in front of TimeSpan value.</td></tr><tr><td></td><td>AddYearsToDate</td><td>Adds (or subtracts) the specified number of years to a date</td></tr><tr><td></td><td>GetDateDay</td><td>Gets the Day (integer) from the date</td></tr><tr><td></td><td>GetDateMonth</td><td>Gets the Month (integer) from the date</td></tr><tr><td></td><td>GetDateThisDayLastMonth</td><td>Gets this day last month (date)</td></tr><tr><td></td><td>GetDateThisDayLastWeek</td><td>Gets this day last week</td></tr><tr><td></td><td>GetDateThisDayLastYear</td><td>Gets this day last year (date)</td></tr><tr><td></td><td>GetDateThisDayNextMonth</td><td>Gets this day next month (date)</td></tr><tr><td></td><td>GetDateThisDayNextWeek</td><td>Gets this day next week</td></tr><tr><td></td><td>GetDateThisDayNextYear</td><td>Gets this day next year (date)</td></tr><tr><td></td><td>GetDateThisMonthEnd</td><td>Gets this month's end date</td></tr><tr><td></td><td>GetDateThisMonthStart</td><td>Gets this month's start date</td></tr><tr><td></td><td>GetDateThisYearEnd</td><td>Gets this year's end date</td></tr><tr><td></td><td>GetDateThisYearStart</td><td>Gets this year's start date</td></tr><tr><td></td><td>GetDateTimeNow</td><td>Gets the current date/time</td></tr><tr><td></td><td>GetDateToday</td><td>Gets today's date</td></tr><tr><td></td><td>GetDateTomorrow</td><td>Gets tomorrow's date</td></tr><tr><td></td><td>GetDateYear</td><td>Gets the Year (integer) from the date</td></tr><tr><td></td><td>GetDateYesterday</td><td>Gets yesterday's date</td></tr><tr><td></td><td>GetElapsedTimeDays</td><td>Returns the integer number of days between two dates</td></tr><tr><td></td><td>GetElapsedTimeHours</td><td>Returns the integer number of hours between two datetimes</td></tr><tr><td></td><td>GetElapsedTimeMilliseconds</td><td>Returns the integer number of milliseconds between two datetimes</td></tr><tr><td></td><td>GetElapsedTimeMinutes</td><td>Returns the integer number of minutes between two datetimes</td></tr><tr><td></td><td>GetElapsedTimeMonths</td><td>Returns the integer number of years between two dates</td></tr><tr><td></td><td>GetElapsedTimeSeconds</td><td>Returns the integer number of seconds between two datetimes</td></tr><tr><td></td><td>GetElapsedTimeWeeks</td><td>Returns the integer number of weeks between two dates</td></tr><tr><td></td><td>GetElapsedTimeYears</td><td>Returns the integer number of years between two dates</td></tr><tr><td></td><td>GetYearWeekNumber</td><td>Gets the number of the week in the year</td></tr><tr><td></td><td>SetTime</td><td>Sets the time for a date/time</td></tr><tr><td>File</td><td>GetFileContentsAsBytes</td><td>Gets the contents of a file as a string</td></tr><tr><td></td><td>GetFileContentsAsString</td><td>Gets the contents of a file as a string</td></tr><tr><td></td><td>GetFileRecordSubstring</td><td>Gets a substring from a fixed length file record</td></tr><tr><td>Lookup</td><td>LookupBulkLoadRecordId</td><td>Gets a record Id retrieved from a bulk load on a parent target</td></tr><tr><td></td><td>LookupDataFieldValue</td><td>Loads a record and returns a specific data field</td></tr><tr><td></td><td>LookupMappedFieldValue</td><td>The LookupMappedFieldValue initializes a table to be used for replacing an input value with a defined output value.  Useful for mapping picklist or option set values.</td></tr><tr><td></td><td>LookupPickListValue</td><td>Gets the key or description for a picklist</td></tr><tr><td></td><td>LookupRetrievedIdFromAuditLog</td><td>Returns a table key value that has been saved in the audit logs table</td></tr><tr><td></td><td>LookupRoundRobinValue</td><td>Supports the lookup of values in a round-robin fashion. This can be used for lead distribution, record assignment, etc.</td></tr><tr><td>Numeric</td><td>CalculateRunningTotal</td><td>Adds a value to a running total</td></tr><tr><td></td><td>FormatNumber</td><td>Returns the string representation of an integer, adding extra 0's to the right if the string is smaller than the specified number of characters.</td></tr><tr><td></td><td>GetCurrentCounterValue</td><td>Returns the current value of a counter.</td></tr><tr><td></td><td>GetNextCounterValue</td><td>Increments a counter and returns the new value.</td></tr><tr><td></td><td>GetRunningTotal</td><td>Gets a running total</td></tr><tr><td></td><td>GetRunningTotalAverage</td><td>Gets the average value in a running total</td></tr><tr><td></td><td>GetRunningTotalCount</td><td>Gets the count of number of entries in a running total</td></tr><tr><td></td><td>GetRunningTotalMaximum</td><td>Gets the maximum value in running total</td></tr><tr><td></td><td>GetRunningTotalMinimum</td><td>Gets the minimum value in running total</td></tr><tr><td></td><td>InitializeCounter</td><td>Initializes a counter of integer values.  At any time, executing this action returns the current value of the counter.  Use GetNextCounterValue to increment and get next counter value.</td></tr><tr><td></td><td>InitializeRunningTotal</td><td>Initializes a running total.  At any time, executing this action returns the current value of the counter.  Use GetNextCounterValue to increment and get next counter value.</td></tr><tr><td>String</td><td>AlternateCases</td><td>Returns a string with alternated letter casing(upper/lower). First character of the string stays the same</td></tr><tr><td></td><td>Base64Decode</td><td>Decodes a Base64 string</td></tr><tr><td></td><td>Base64Encode</td><td>Encodes a Base64 string</td></tr><tr><td></td><td>Capitalize</td><td>Capitalizes the first character in a string</td></tr><tr><td></td><td>CharMid</td><td>Returns the character at a position given by the startingIndex plus the given count.</td></tr><tr><td></td><td>CharRight</td><td>Returns the character in a string at a given index counting from the right.</td></tr><tr><td></td><td>Concatenate</td><td>Concatenates values into a string</td></tr><tr><td></td><td>ConcatenateHtml</td><td>Inserts values into Html using the Html editor</td></tr><tr><td></td><td>ConvertHtmlToPlainText</td><td>Converts a string from Html to plain text</td></tr><tr><td></td><td>ConvertRtfToString</td><td>Converts Rtf to a string</td></tr><tr><td></td><td>ConvertStringToRtf</td><td>Converts a string to Rtf</td></tr><tr><td></td><td>Format</td><td>Returns a string formatted to match the format string</td></tr><tr><td></td><td>FormatDataType</td><td>Returns a formatted datetime, decimal, double, integer or single value using .Net formatting</td></tr><tr><td></td><td>GetEmptyString</td><td>Returns an empty string value</td></tr><tr><td></td><td>GetHashCodePolynomial</td><td>Returns the hash code of a string based on a polynomial function with a specified factor.</td></tr><tr><td></td><td>GetInitials</td><td>Returns the initials of each word in a string. Words are separated according to the sepecified string sequence.</td></tr><tr><td></td><td>GetKeyFromGuid</td><td>Gets a Guid key</td></tr><tr><td></td><td>GetKeyFromRandomNumber</td><td>Returns a key based on randomly generated number</td></tr><tr><td></td><td>GetKeyFromTimestamp</td><td>Gets a Timestamp key</td></tr><tr><td></td><td>GetLength</td><td>Returns the length of a string.</td></tr><tr><td></td><td>GetNullString</td><td>Returns a null string value</td></tr><tr><td></td><td>GetTitle</td><td>Returns the initials of each word in a string. Words are separated according to the sepecified string sequence.</td></tr><tr><td></td><td>IndentLines</td><td>Returns a string with the given number of spaces prepended to the beginning of each line.</td></tr><tr><td></td><td>InsertSeparator</td><td>Returns a string with a given seperator inserted after a specified interval of characters.</td></tr><tr><td></td><td>InsertString</td><td>Inserts a string at a specified index position in the source string (0 origin)</td></tr><tr><td></td><td>KeepAlphaNumeric</td><td>Returns a string with only alpha-numeric characters preserved.</td></tr><tr><td></td><td>KeepVowels</td><td>Returns a string with only the vowel characters.</td></tr><tr><td></td><td>PadLeft</td><td>Pads a string on the left with a specified character</td></tr><tr><td></td><td>PadRight</td><td>Pads a string on the right with a specified character</td></tr><tr><td></td><td>PrependLinesWithCharacter</td><td>Returns a string with the given number of a specific character prepended to the beginning of each line.</td></tr><tr><td></td><td>RegexReplace</td><td>Within the source input string, replaces strings that match a regular expression pattern with a specified replacement string.</td></tr><tr><td></td><td>RemoveCharacter</td><td>Removes a specified character from a string</td></tr><tr><td></td><td>RemoveCharacters</td><td>Deletes a specified numer of characters in a string starting an index position (0 origin)</td></tr><tr><td></td><td>RemoveLetters</td><td>Returns a string with any letter characters removed.</td></tr><tr><td></td><td>RemoveNumeric</td><td>Returns a string with any numeric characters removed.</td></tr><tr><td></td><td>RemoveRepeats</td><td>Returns a string with all characters repeated in a row removed.</td></tr><tr><td></td><td>RemoveSegment</td><td>Returns a string with the first occurence of the specified string segment removed.</td></tr><tr><td></td><td>RemoveVowels</td><td>Returns a string with any vowel character removed.</td></tr><tr><td></td><td>ReplaceFirstOccurence</td><td>Returns a string with the first occurence of the specified value replaced with a new value.</td></tr><tr><td></td><td>ReplaceLastOccurence</td><td>Returns a string with the last occurence of the specified value replaced with a new value.</td></tr><tr><td></td><td>ReplaceLeadingCharacters</td><td>Returns a string with the first given number of characters replaced with a new character.</td></tr><tr><td></td><td>ReplaceString</td><td>Replaces all occurences of an old string value with new string value</td></tr><tr><td></td><td>ReplaceTrailingCharacters</td><td>Returns a string with the last given number of characters replaced with a new character.</td></tr><tr><td></td><td>ReplaceWithEmptyString</td><td>Replaces all occurences of an old string value with an empty string value</td></tr><tr><td></td><td>ReverseCharacters</td><td>Returns a string with characters in reverse order.</td></tr><tr><td></td><td>Split</td><td>Gets a string by spliting a string and selecting from an index position (0 origin)</td></tr><tr><td></td><td>SplitWithCharacterLimit</td><td>Splits a string into an array each no longer than the given character limit and selecting from an index position in the result (0 origin).</td></tr><tr><td></td><td>Substring</td><td>Gets a substring from a string starting at an index position (0 origin)</td></tr><tr><td></td><td>SubstringOfLength</td><td>Gets a substring of a specified length from a string starting at an index position (0 origin)</td></tr><tr><td></td><td>SubstringOfRange</td><td>Returns a segment of a string, marked by the start and end index (exclusive).</td></tr><tr><td></td><td>SwapCases</td><td>Returns a string with the opposite letter casing for each character.</td></tr><tr><td></td><td>SwapCharacters</td><td>Returns a string the swapped characters at specified indices.</td></tr><tr><td></td><td>ToLowercase</td><td>Converts a string to lowercase</td></tr><tr><td></td><td>ToUppercase</td><td>Converts a string to UPPERCASE</td></tr><tr><td></td><td>TrimAll</td><td>Removes all whitespace from a string</td></tr><tr><td></td><td>TrimLeadingCharacters</td><td>Removes all leading occurences of a specified character from a string</td></tr><tr><td></td><td>TrimTrailingCharacters</td><td>Removes all trailing occurences of a specified character from a string</td></tr><tr><td></td><td>UrlDecode</td><td>Decodes a Url</td></tr><tr><td></td><td>UrlEncode</td><td>Encodes a Url</td></tr><tr><td></td><td>WordWrap</td><td>Returns a string that is no longer than the maximum width given in pixels. Excess words are moved to a new line.</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.appstrategy.com/apprules-r-documentation/platform/platform-features/actions/action-categories/actions-fields-field.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.