Skip to main content

Get Policies Node

The Get Policies node retrieves all active expatriate insurance policies from Athena based on the provided policy number. This non-visual node queries the backend service in the background and returns a collection of matching policies with detailed information.

info

To display policy information to the user, use the Show Policies node after retrieving the data with the Get Policies node.

Use Case​

Use the Get Policies node when:

  • You need to retrieve all active expatriate insurance policies from Athena based on a policy number.
  • You want to fetch detailed policy information for display or further processing in the flow.

Don't use the Get Policies node when:

  • The policy number is not available or has not been collected from the user.
  • You only need to validate a policy exists without retrieving the full policy details.

UI Examples​

Only output, no UI

Behavior​

  • Non-blocking: the node executes in the background without user interaction.
  • Requires input: expects a policy number provided from the conversation input.
  • Produces output: returns policy information (policy count, policy type, chosen policy, policy number, person type, product code and name, policy holder SSN and customer number, coverage type, product area and sub-code) stored in the value bag.
  • Renders: no UI elements.
  • Validation: returns "SearchDataNotProvided" status if the policy number is empty or null.
  • Output handling: returns Ok status with policy data if policies are found, Not status if no policies match the policy number, or SearchDataNotProvided if policy number is missing.

Node Metadata​

PropertyDescription
Node classGetPoliciesNode
MessageType124
CanBeEditedTrue
CanBeProcessedOnceFalse
RequireUserResponseNo

Input Properties​

PropertyDescription
policyNumber

Unique insurance policy number used to retrieve matching policies from the Athena system.

defaultValidationMessage

The default error message shown when the input is invalid or missing. This is used if no custom validation message is provided.

  • Default Values:
      • En:Please type in value
      • No:Skriv noe
      • Dk:Indtast værdi
      • Fi:Kirjoita kenttään
      • Se:Ange värde
sectionId

Groups this node visually under a specific section in TellUs. When multiple nodes share the same sectionId, they are displayed together under a shared header.

defaultValue

The initial value that is prefilled into the input field when the node is rendered. Useful for suggesting defaults or pre-populating known data.

isRequired

Determines whether the user must provide a value before continuing. If set to true, the form will not proceed without input.

  • Default Values:
      • En:true
  • Allowed Values:
      • true
      • false
isRequiredValidationMessage

The error message shown when a required field is left empty. This overrides the default validation message when isRequired is true.

  • Default Values:
      • En:Value is required
      • No:Verdi er påkrevd
      • Dk:Værdi er påkrævet
      • Fi:Arvo vaaditaan
      • Se:Värde krävs

Output Properties​

PropertyDescription
policyCount

Total number of active policies found for the provided policy number.

policyData

Complete array of all matching policies with detailed information including type, number, holder details, and product information.

policyType

Category or classification of the insurance policy.

chosenPolicy

The latest valid insurance policy selected from the retrieved policies based on end date.

policyNumber

The insurance policy number returned from the query result.

personType

Category of the policy holder.

productCode

Unique code identifying the insurance product.

productName

Name or title of the insurance product.

policyHolderSsn

Social security number of the policy holder.

policyHolderCustomerNumber

Unique customer reference number for the policy holder.

coverageType

Type of insurance coverage provided by the policy.

productArea

Business area or category of the insurance product.

productSubCode

Secondary code further categorizing the insurance product.

Editor Example​

Try it in the Atlas Editor

This link opens a prebuilt flow using this node in context. You can inspect how it's configured, how it's connected, and how it behaves in a real editor environment.

Node in TellUs