Versions Compared

Old Version 3

changes.mady.by.user Shilpa

Saved on

compared with

New Version Current

changes.mady.by.user Shilpa

Saved on

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 upload a file to ...the Teamcenter software.

...

Snap Type

The <Snap name> PLM TC File Upload Snap is a Read/Write/Parse/Transform/Flow/Formatwrite-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… uploads the file to your Teamcenter software.

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

None.

Support for Ultra Pipelines

 

Limitations

None.

Known Issues and Limitations

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

  • ..

Requires the EDI data and internal ID as a JSON document

  • N/A

The dataset name, dataset type, dataset relation, file name and relation of the file that you want to be uploaded.

Output

Document

Binary

Binary or Document

  • Min: 1

  • Max:

  • ..

  • ..

The EDI transaction ID and order confirmation

  • 1

  • PLM TC File Download

The uploaded file in your Teamcenter instance.

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

Snap Settings

...

data{"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/info","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.

...

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 fieldsetfield set.

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

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

Field Name

Field Type

Field Dependency

Description

Label*

Default Value: 

ELT Database Account

PLM TC File Upload
Example:

 ELT RS Account

TC File Upload

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.Number of records

pipeline.

Parent Id

Default Value: N/A
Example: Client details

String/Expression

Specify the _id or an UID of the parent element where you want to save the created object.

Dataset Name

Default Value:

 

 N/A
Example: Doc_teamproject

String/Expression

Sampling Type is Number of records.

Enter the number of records to output.

fieldset Name

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

Field 1

Specify the name of the dataset. Datasets are used to manage data files created by other software applications.

Dataset Type

Default Value: N/A
Example: Folder

String/Expression/Suggestion

Specify the type of the dataset. The dataset type manages the filetype and the authoring applications in the Teamcenter software.

Dataset Relation

Default Value: N/A
Example: Contents

String/Expression/Suggestion

Specify the relationship of the dataset with the file you want the Snap to upload.

File Name*

Default Value: 

<value> or None.

N/A
Example:

 <value>

doc_images

String

Debug mode check box is not selected.

Field 2

/Expression

Specify the name of the file.

Reference Name

Default Value: 

<value> or None.

N/A
Example:

 <value>

upload_images

String

None

/Expression

Specify the name of the reference.

Snap Execution

Default Value: Execute 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
PLM TC BOM Structure Add
PLM TC BOM Structure Add
nameTroubleshooting
nopaneltrue

Snap Pack History

Expand
titleClick here to expand...

Insert excerpt

...

PLM TC Snap Pack

...

PLM TC Snap Pack
nopaneltrue

...

Related Content