Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On In  this Pagearticle

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Format

Description:

This Snap reads

Overview

Excel Multi Sheet Formatter is a Format-type Snap that reads the documents from multiple input views, formats the data to XLSX format and converts them into specified sheet for each input view and writes out binary data.

Prerequisites

None.

Support for Ultra Pipelines

Does not work in Ultra Pipelines.

Limitations and Known Issues

None.

  • Expected upstream Snaps: Any Snap that provides a document output view, such as Mapper or Structure or a JSON Generator Snap. 
  • Expected downstream Snaps: [None] or any Snap that has a binary input view, such as File Writer or JSON Parser.
  • Expected input:

    Snap Input and Output

    Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
    InputDocument
    Min: 1
    Max: 
    • Mapper
    • Structure
    • JSON Generator 
    Document data to be formatted in to excel format. 
    OutputBinary
    Min: 1
    Expected output:
    Max: 1
    • File Writer
    • JSON Parser
    This Snap provides the result of the formatted excel content in the binary output view
    .Prerequisites:

    None.

    Support and limitations:Does not work in Ultra Pipelines
    .
    Account: 

    Accounts are not used with this Snap.

    Views:
    InputThis Snap has exactly one document input view.
    OutputThis Snap has exactly one binary output view.
    ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

    Settings

    Label

    Required. The


    Snap Settings

    Specifies Required. This option specifies whether or not the Snap should If the property is not selected, an empty array will be written Anaplan Read

    Field

    Field Type

    Description


    Label*


    String

    Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your

    pipeline.

    Pipeline.

    Default Value: Excel Multi Sheet Formatter
    ExampleExcel Multi Sheet Formatter

    Sheet mapping


    Use this field set to define the mapping of input view to excel sheet name. This field set contains the following fields:

    • Input view name
    • Sheet name
    Input view nameString

    Select the name of the input view mapped to use from the list of views added to the Snap.

    Sheet name

    Name the sheet.

    Default Valueinput0
    Exampleinput1

    Sheet nameString/Expression

    Specify the name of the Excel sheet to map the input view data.
    This property accepts expressions to allow pipeline Pipeline parameters only.

    Default Value: [None]
    Example: Members

    Write header*Checkbox

    Select this checkbox to enable the Snap to write the header to the output.

    Default valueValue: Selected

    Ignore empty streamCheckbox

    Select this checkbox to write nothing to the output view in case no documents were received on the input view. If the property is selected, the the Snap will write nothing

    If you deselect this checkbox, an empty array is written to the output view in case no documents were received on the input view.

    Default valueValue: Not selected

    Multiexcerpt include macro
    nameSnap Execution
    page

    Convert numeric string to numberCheckbox

    This property sets the behavior of the Snap when a value in the input document is a numeric string.

    Select this checkbox to enable the Snap to convert the value to a numeric-type cell.

    When you deselect this checkbox, the Snap sets the value to a string-type cell.

    Default ValueSelected

    Translate date and time typesCheckbox

    This property sets the behavior of the Snap when a value in the input document is a date and/or datetime type.

    Select this checkbox to enable the Snap to convert the date and time type values to Excel date numeric type with date format style.

    Default ValueNot selected

    Snap Execution


    Dropdown list
    Multiexcerpt include macro
    nameSnap_Execution_Introduced
    pageAnaplan Read

    Example


    Reading csv Files and Providing Input Data to the Excel Multi Sheet Formatter Snap

    The following image shows a sample pipeline that reads two csv files and providing the document data as input to Excel Multi Sheet Formatter Snap. 

    The following image displays the Excel Multi Sheet Formatter Snap properties, where input0 maps to a sheet named by the pipeline parameter sheetname and input1 maps to sheet2

    Insert excerpt
    Transform Snap Pack
    Transform Snap Pack
    nopaneltrue