• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
    • Text Templates
    • Templated Reporting System
    • HTML, Markdown, and JavaScript Integration
    • Action Invoker
      • Overview
      • Execution Environments
      • Security, Resource Management, and Formatting Options
      • Base Actions
      • Application Namespace
      • Clipboard Namespace
      • Data Namespace
      • Dictionary Namespace
      • File Namespace
      • Hash Namespace
      • Localhost Namespace
      • Logic Namespace
        • Logic Action Invoker Namespace
        • Logic.eval Action
        • Logic.getSymbol Action
        • Logic.getSymbolMetadata Action
        • Logic.getSymbolValue Action
        • Logic.invoke Action
        • Logic.setSymbolValue Action
      • Message Namespace
      • Path Namespace
      • Settings Namespace
      • Sqlite Namespace
      • System Namespace
      • UI Namespace
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataManager>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

Logic.setSymbolValue Action

Format
CS.Logic.setSymbolValue(name := ..., value := ...)
ArgumentDescriptionTypes / Required
nameThe name of the symbol.string
required
valueThe new value for the symbol.string, number, array, object
required
Description
The Logic.setSymbolValue action modifies the value of the symbol with the specified name to a new value specified using the symbol's JSON representation.
You can also use the Symbol.setValueFromJson function to update a symbol's value.
The following table describes the value-related serialization routines available for CSPro objects and contains links to the description of the JSON representation for each object.
Documentation about all JSON representations feature will come in a future release.
ObjectValue -> JSONJSON -> ValueSerialization
numeric✔✔CSPro ⇄ JSON Conversions: Numeric Values
string, alpha✔✔CSPro ⇄ JSON Conversions: String Values
Array✔✔CSPro ⇄ JSON Conversions: Array Object
Audio✔✔CSPro ⇄ JSON Conversions: Audio Object
Block
Dictionary✔
Document✔✔CSPro ⇄ JSON Conversions: Document Object
File✔
Freq✔
function
Geometry✔✔CSPro ⇄ JSON Conversions: Geometry Object
HashMap✔✔CSPro ⇄ JSON Conversions: HashMap Object
Image✔✔CSPro ⇄ JSON Conversions: Image Object
Item
List✔✔CSPro ⇄ JSON Conversions: List Object
Map
Pff
Record
Report✔✔CSPro ⇄ JSON Conversions: Report Object
StringWriter✔✔CSPro ⇄ JSON Conversions: StringWriter Object
SystemApp✔✔
ValueSet✔✔
Return Value
The action returns undefined.
Exceptions
The action throws an exception if any of its arguments are not specified in a valid form, if no symbol has the specified name, or if the value is not specified in a way that can be converted to the symbol.
Example (JavaScript)
function sortList(symbolName) {
    // get the List object from CSPro
    const list = CS.Logic.getSymbolValue({
        name: symbolName
    });

    // sort the List, which is represented as an array
    list.sort();

    // update the CSPro object
    CS.Logic.setSymbolValue({
        name: symbolName,
        value: list
    });
}

sortList("usmca_countries");
See also: Logic Action Invoker Namespace, Logic.getSymbol Action, Logic.getSymbolMetadata Action, Logic.getSymbolValue Action, Symbol.setValueFromJson Function