| Appsplus panel macro confluence macro | ||
|---|---|---|
| ||
**Delete Before Publishing**
|
In this article
...
In this article
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
You can use this Snap to ...upload a rich content stream to either a Requirement or a Paragraph revision.
...
Snap Type
The <Snap name> Snap is a Read/Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… PLM TC Requirement Upload Rich Content is a write-type Snap. The content must be provided as a binary input stream into the Snap.
Prerequisites
Valid client ID.
A valid account with the required permissions.
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Works in Ultra Pipelines if....
Does not support Ultra Pipelines.
Limitations
...
None.
and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input |
Document
Binary
Binary |
|
|
..
| The Object ID and Content-Type of the file that needs to be uploaded from the Teamcenter. The content must be provided as a binary input stream into the Snap. |
Output | Document |
Binary or Document
|
..
..
|
| The uploaded rich content file. | ||
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:
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:
...
| Info |
|---|
|
): Indicates a list that is dynamically populated based on the configuration.Field Name | Field Type |
|---|
Description | |
|---|---|
Label* Default Value: |
PLM TC Requirement Upload Rich Content |
PLM TC Requirement Upload Rich Content | 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. |
Object ID* Default Value: N/A |
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$._id | Dropdown | Select the UID (unique identifier) or the Teamcenter adapter ID of the object. |
Content Type* Default Value: |
docx |
Field 2
Default Value: <value> or None.
Example: <value>
String
docm |
String
Debug mode check box is not selected.
Dropdown | Specify the type of the HTML rich content to upload to the requirement/paragraph revision. The options available are:
|
Snap Execution Default Value: Execute only | Dropdown |
N/A
Select one of the following three modes in which the Snap executes:
|
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 |
|---|
|
...
Object ID does not exist | The object with the specified ID does not exist in the Teamcenter database. | Double-check the ID you are using to ensure it matches an existing object. |
Incorrect ID Format | The entered format of the object ID is incorrect. | Teamcenter object IDs often have a specific format, including a prefix that identifies the object type and a unique identifier. Make sure you are using the correct format for object IDs. |
Snap Pack History
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
Related Content
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3
Getting Started with SnapLogicSnap Support for Ultra Pipelines