Date Time Extractor

Overview

The Date Time Extractor is a Transform-type Snap used to extract components from datetime data and add them to the result field. This Snap helps prepare the data for aggregation or analysis, such as calculating total sales by month or quarter.


Date Time Extractor Snap Overview

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has exactly one document input view. The input should contain datetime fields for processing.
Output This Snap has exactly one document output view. It generates fields containing extracted datetime components.
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value:

Example: Date Time Extractor
Field String

Required. Select the datetime field in the input document. This is a suggestible field that lists all fields in the incoming dataset.

Default value: None.

Example:
Component String

Choose the component to extract from the input field. Available options include:

  • Date
  • Date String (yyyy-MM-dd)
  • Date Time String (YYYY-MM-dd-HH:mm:ss)
  • Date Time String (YYYY-MM-dd HH:mm:ss.SSS)
Note:
  • When setting a map path as a path of the date-time fields, the Snap checks all the fields in the map and converts them to the selected date-time pattern.
  • When setting a root path as a path of the date-time field, the Snap checks all fields in the root object and converts them to the selected date-time pattern. However, we recommend you use the root path only once, and if a second component is added, then the second component is converted to the specified DateTime format, ignoring the first component.
  • Year
  • Quarter
  • Month
  • Day
  • Hour
  • Minute
  • Second
  • Millisecond
  • Year and Month (yyyy-MM)
  • Week of Year
  • Day of Year
  • Day of Week
  • Day of Week String (Sunday)
  • Month of Year String (January)
  • Epoch
  • Epoch Millisecond

Default value:

Example: Date
Result Field String

Required. Specify the result field in the output map. If this field does not exist, a new field is created.

Default value:

Example: None
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & execute