Versions Compared

Key

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

Appsplus panel macro confluence macro
data{"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**Delete Before Publishing**

  • Always use title casing for Heading formats 1 and 2.

  • Always use active voice.

  • Do not use "Please" anywhere in the document.

  • Screenshots

    • Always use the New Form UI.

    • Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide.

    • Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.

    • See Image Style Guide for details.

  • Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to determine the list of dataset elements to ...prepare for the file download operation.

...

Snap Type

The <Snap name> Teamcenter Get Downloadable Files Snap is a Read/Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates…

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

None.

Support for Ultra Pipelines

 

Limitations

None.

fetches datasets and files to download from the Teamcenter instance.

Prerequisites

None.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • ..

Requires the EDI data and internal ID as a JSON document
  • Teamcenter Info

  • Teamcenter Upload File

The object ID, Teamcenter type and the file attributes that needs to be fetched from the Teamcenter.

Output

Document

Binary

Binary or Document

  • Min: 1

  • Max: 1

  • ..

  • ..

The EDI transaction ID and order confirmation
  • Teamcenter Get Relations

  • Teamcenter Info

The downloaded file from the Teamcenter.

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 pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline pipeline Execution: Stops the current Pipeline pipeline execution if the Snap encounters an error.

  • 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 Pipelinespipelines.

Snap Settings

...

{"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

Drop-down lists/Option Buttons (radio buttons):

You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.

  • <State what the option should do in this field>. The available options are: <bullet list of LoVs>
    Specify the Salesforce API to be used. The available options are:...

  • Select the <category> that you want to use. Available options are...
    * Option 1<italicized>. <third person singular form of the verb>
    * Option 2<italicized>. <third person singular form of the verb>
    Select the API that you want to use. Available options are:
    Bulk API. Sends the Snap execution request details as a bulk API call.
    REST API. ...
    OR
    Select one of the three following modes in which the Snap executes:
    * Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.

Check boxes:

  • If selected, <Snap behavior>.
    If selected, an empty file is written when the incoming document has no data.

  • If selected, <behavior>. If not selected/Otherwise, <behavior>
    Use "If not selected" if the first sentence is long.
    If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
    If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.

  • Select to <action>
    Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
    Select to execute the Pipeline during validation.

    Text Fields

    • Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
      Enter the name for new account.
      Specify the account ID to use to log in to the endpoint.
      Required if IAM Role is selected.
      Do not use this field if you are using batch processing.

    Numeric Text Fields

    • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
      The number of records in a batch.
      The number of seconds for which you want the Snap to wait between retries.
      The number of seconds for which the Snap waits between retries.
      Use the following special values:
      * 0: Disables batching.
      * 1: Includes all documents in a single request.

    Notes in field descriptions

    • Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

      • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

      • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

    Info
    Info
    • Asterisk ( * ): Indicates a mandatory field.

    • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

    • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

    • Upload icon ((blue star) ): Indicates that you can upload files.

    Number of records

    Specify advanced parameters that you want to include in the request.

    Field Name

    Field Type

    Field Dependency

    Description

    Label*

    Default ValueELT Database Account Teamcenter BOM Structure Create
    ExampleELT RS AccountTeamcenter BOM Structure Create

    String

    None.

    The 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.

    Object ID*

     

    Default Value: N/A
    Example: Array

    String/Expression

    None

    Select the UID (unique identifier) or the Teamcenter adapter ID of the object.

    Primary Relationship Path*

    Default Value:  N/A
    Example: Relation → Parent

    String/Expression

    Sampling Type is Number of records.

    Enter the number of records to output.

    fieldset Name

    Field 1*

    Default Value<value> or None.
    Example<value>

    String

    Debug mode check box is not selected.

    Field 2

    Default Value<value> or None.
    Example<value>

    String

    NoneNone

    Specify the relation to be expanded for related Dataset Elements from JSON input of the Snap.

    Primary Relations

    Default Value: N/A
    Example: TC_Attaches

    Specify the relations you want the Snap to expand to the dataset elements. Each atribute must be specified as a new row. Click (blue star) to add a row.

    Relation*

    String/Expression

    None

    The name of the relation to be expanded.

    Include Relation

    Checkbox

    None

    Select this checkbox to include the relation element into the output document.

    Configure Output

    Default Value: deselected

    Checkbox

    None

    Select this checkbox if you want the Snap to specify the configuration of the Teamcenter properties in the output.

    Type

     

    Default Value: N/A
    Example: Diameter

    String/Expression

    Configure Output

    Specify the name of the Teamcenter type.

    Expand attributes path

    Default Value: N/A
    Example: attributes1 → item_response

    String/Expression

    Configure Output

    Specify the path of the expand attributes in the input document.

    Expand Attributes

    Specify the attributes you want the Snap to fetch from Teamcenter software. Each attribute must be specified as a new row. Click (blue star) to add a row.

    Name*

    Default Value: N/A
    ExampleItem_response

    String/Expression

    Configure Output

     Specify the name of the attribute.

    Snap Execution

    Default ValueExecute Only
    Example: Validate & Execute

    Dropdown list

    N/A

    Select one of the following three modes in which the Snap executes:

    • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline pipeline runtime.

    • Execute only: Performs full execution of the Snap during Pipeline pipeline execution without generating preview data.

    • Disabled: Disables the Snap and all Snaps that are downstream from it.

    Troubleshooting

    ...

    Error

    ...

    Reason

    ...

    Resolution

    ...

    Account validation failed.

    ...

    The Pipeline ended before the batch could complete execution due to a connection error.

    ...

    Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    Examples

    Excluding Fields from the Input Data Stream

    We can exclude the unrequired fields from the input data stream by omitting them in the Input schema fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:

    <screenshot of Pipeline/Snap and description>

    Download this Pipeline. 

    Downloads

    Info
    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts, as applicable.

    3. Provide Pipeline parameters, as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    Insert excerpt
    Teamcenter BOM Structure Add
    Teamcenter BOM Structure Add
    nameTroubleshooting
    nopaneltrue

    Snap Pack History

    Expand
    titleClick here to expand...
    Insert excerpt

    ...

    Teamcenter Snap Pack
    Teamcenter Snap Pack
    nameXYZ Snap Pack History
    nopaneltrue

    ...

    Related Content

    ...

    Endpoint Doc Link 1

    ...

    Endpoint Doc Link 2

    ...

    ...