Get string value from object

Function: Get string value from object

This function allows you to extract a specific piece of text (a string value) from a larger collection of information, often referred to as an "object." You tell the system which object to look at, what kind of information structure it follows, and precisely which part of that structure you want to retrieve.

Input

• Object: This is the main collection of data you want to work with. Think of it as a record or an item that holds various pieces of information.
• Data format: This defines the blueprint or structure of your object. It tells the system what kind of information the object contains and how it's organized (e.g., a "User Profile" format might define fields like "Name," "Email," "Address").
• Data format attribute: This is the specific field or property within your object's data format whose text value you want to retrieve (e.g., if your object is a "User Profile," you might want the "Email Address" attribute).

Output

• Data name: The name of the variable where the extracted text value will be stored. By default, this will be named FOUND_DATA_VALUE, but you can change it to something more descriptive like CustomerEmail or ProductName.

Execution Flow

Real-Life Examples

Example 1: Getting a User's Email Address

Imagine you have a user's profile information and you need to get their email address.

• Inputs:
  • Object: Current User Profile (This would be the entire user record you're currently working with.)
  • Data format: User Profile Schema (This defines that a user profile has fields like Name, Email, Phone, etc.)
  • Data format attribute: Email Address (This is the specific field within the user profile you want.)
  • Data name: UserEmail
• Result: The email address of the current user (e.g., "[email protected]") is stored in a variable named UserEmail.

Example 2: Extracting a Product Name from an Order Item

Suppose you're processing an order and need to display the name of a specific product included in that order.

• Inputs:
  • Object: Order Item Details (This represents one product line item within an order.)
  • Data format: Product Schema (This describes the structure of product information, including a "Product Name" field.)
  • Data format attribute: Product Name (The specific field holding the product's name.)
  • Data name: OrderedProductName
• Result: The name of the product from the order item (e.g., "Wireless Bluetooth Speaker") is stored in a variable named OrderedProductName.

Example 3: Finding a Customer's Shipping City

You have a customer's full address details and need to isolate just the city for a shipping label.

• Inputs:
  • Object: Customer Shipping Address (The complete address record for a customer.)
  • Data format: Address Schema (This defines the structure of an address, including fields like Street, City, State, Zip Code.)
  • Data format attribute: City (The specific field containing the city name.)
  • Data name: ShippingCity
• Result: The city from the customer's shipping address (e.g., "New York") is stored in a variable named ShippingCity.