Blocks

Blocks are used in Maps to represent individual operations. For example, the Query Block, allows you to create an operation similar to a SQL SELECT statement to define which source entity and source records should be included in the Map.

Blocks copied from the TIBCO Scribe® User Interface and pasted into another program, such as NotePad++, are pasted in the JSON format used by the TIBCO Scribe® API.

See an example of Blocks used in a Map in the TIBCO Scribe® User Interface below and review Working With Blocks in the TIBCO Scribe® Help for additional information.

Maps support a maximum of 250 Blocks.

Considerations

In some cases there are special considerations or use cases for specific Blocks that you should know about before you use them in a model.

POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/renameblock

Block names cannot exceed 50 characters. If you create a Block with a name that is longer than 50 characters the Map does not compile and the Solution status remains at Incomplete.

Batch Processing

If Batch Processing is enabled, error handling is automatically disabled. See Batch Processing and Block Properties Error Handling Tab in the TIBCO Scribe® Help.

Fetch Block

When creating or modifying a Fetch Block, you can use the following additional property to control the order of the results for the Fetch Block: 

"sequences" : [{
"propertyName" : "<Name of the property in the root entity of the Fetch to sort by>",
"direction" : "Ascending"
}
]

The API accepts the sequences property, but it is not included in the model for the Fetch Block by default.

Endpoints

There are no specific endpoints for Blocks, however, Blocks and their associated properties are used in Maps endpoints. Endpoints that use Blocks include: 

Copy a Map within a Solution

Return a list of Maps

Return information about a Map

Modify Block name

Create an Advanced Map

Update an Advanced Map

Fields For Block Properties

*Denotes special Blocks that are only available for a specific Connector. See actionName in the table below for additional information.

Name
Type
Data Type

Description

Block Types

Response

actionName

response

string

Connector-defined name for the Block that displays in the TIBCO Scribe® User Interface.

  • None - Performs no operation, but the actionName field is part of the model for the Block.
  • Add - Creates a new record in a target datastore from a source record in the source datastore for specific entities. Available for HubSpot, Marketo, Pardot, and Eloqua Connectors. Blocks include: Add* Block.
  • Assign - Assign a Prospect to a Pardot User when Pardot is the target. Blocks include: Assign* Block.
  • Create - Creates a new record in a target datastore from a source record in the source datastore. Blocks include: Create Block, Insert Block.
  • Delete - Removes an existing record in a datastore. Blocks include: Delete Block.
  • Enrich - Insert data from InsideView into Source data before adding the record to the target. Blocks include: Enrich* Block.
  • InsertUpdate - Inserts the source record into the target. If the insert fails, updates the target record with no error. Insert failures are typically caused by violating the target table’s unique index.
  • Merge - Merge two Microsoft Dynamics CRM records. See TIBCO Scribe® Connector For Microsoft Dynamics CRM in the TIBCO Scribe® Help. Blocks include: Merge* Block.
  • NativeQuery - For Connectors that support native languages, use Native Query to write your own free form query that can join tables, restrict the source field list, or do a WHERE clause to filter data in a more flexible way. Data can be normalized without foreign keys, or de-normalized by ignoring existing relationships. Supported only for Microsoft SQL Server.
  • OptOut - Enables the option opt out of all emails on a Contact record in a HubSpot datastore. Blocks include: OptOut* Block.
  • Query - Retrieves data from a datastore. Blocks include: Query Block, Lookup Block.
  • Remove - Removes an existing record in a datastore. Available for HubSpot, Marketo, Pardot, and Eloqua Connectors. Blocks include: Remove* Block.
  • Submit - Inserts a Form record into a HubSpot datastore. Blocks include: Submit* Block.
  • Unassign - Unassign a Prospect from a Pardot User when Pardot is the target. Blocks include: UnAssign* Block.
  • Update - Updates existing records in a datastore. Blocks include: Update Block, Update/Insert Block.
  • UpdateInsert - Updates the existing record in the target with information from the source record. If the target record does not exist, the update fails without logging an error condition, and the information is inserted into the target as a new record.
  • Update Patch - Replaces exactly those property values that are specified in the request or mapped fields for an OData datastore. Blocks include: Update Patch* Block.
  • Update Replace - Replaces all property values with those specified in the request or mapped fields for an OData datastore. Any properties not included in the request, or any unmapped fields, are either cleared or set to default values for the OData service. Any data in fields with unsupported data types is lost. Blocks include: Update Replace* Block.
  • Upsert - Combines two operations, Update and Insert, in a single block. Updates an existing record if there is a matching record or Inserts a new record if there is no matching record. Blocks include: Upsert Block.
  • Upsert Patch - Replaces exactly those property values that are specified in the request or mapped fields for an existing record in an OData datastore. If the record does not exist, a new record is created with the property values specified. Blocks include: Upsert Patch* Block.
  • Upsert Replace - Replaces all property values with those specified in the request or mapped fields for an OData datastore. Any properties not included in the request, or any unmapped fields, are either cleared or set to default values for the OData service. Any data in fields with unsupported data types is lost. If the record does not exist, a new record is created with the property values specified. Blocks include: Upsert Replace* Block.
  • Void - Removes an existing record for one of the Sales Order entities in a Microsoft Dynamics GP datastore. Blocks include: Void* Block.
  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Insert
  • Lookup
  • Query
  • Merge*
  • OptOut*
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*

ancestorReplyBlockId

response

string

Used in hierarchical results to identify the parent Block for the results of this Block.

  • Build Reply

blockType

response

string

Type of operation performed by the Block. See Working With Blocks in the TIBCO Scribe® Help.

Types include: 

  • None
  • AddWith (not used, for future support of hierarchical data)
  • BuildReply - Build Reply Block
  • Comment - Comment Block
  • Continue - Continue Block
  • Delete - Delete Block, Void* Block, Remove* Block, OptOut* Block
  • Fetch - Fetch Block
  • ForEach - For Each Result Block
  • ForEachChild - For Each Child Block
  • Group - Group Block
  • IfElse - If/Else Block
  • Insert - Create Block, Insert Block, Add* Block, Submit* Block, Upsert Patch* Block, Upsert Replace* Block, Merge* Block, Enrich* Block, Assign* Block, Unassign* Block
  • InsertWith (not used, for future support of hierarchical data)
  • Lookup - Lookup Block
  • Loop - Loop Block
  • LoopExit
  • MapExit - Map Exit Block
  • NativeQuery - Native Query Block
  • Operation
  • Query - Query Block
  • SendReply - Send Reply Block
  • Update - Update Block, Update Patch* Block, Update Replace* Block
  • UpdateInsert - Update/Insert Block
  • UpdateWith
  • Upsert - Upsert Block
  • Wait - Wait Block
  • WaitForMessage - Wait For Message Block
  • WaitForRequest - Wait For Request Block
  • Add*
  • Assign*
  • Build Reply
  • Comment
  • Continue
  • Create
  • Delete
  • Enrich*
  • Fetch
  • For Each Child
  • For Each Result
  • Group
  • If/Else
  • Insert
  • Lookup
  • Loop
  • Loop Exit
  • Map Exit
  • Merge*
  • Native Query
  • OptOut*
  • Query
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait
  • Wait For Message
  • Wait For Request

bulkCountPerOperation

response

string

If Batch Processing is enabled on a Block by setting the useBulk property to true, this field indicates the size of the batch of records sent by the Agent to the target datastore. See Batch Processing in the TIBCO Scribe® Help.

  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Insert
  • Merge*
  • OptOut*
  • Remove*
  • Submit*
  • Unassign*
  • Update
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*

cacheResults

response

boolean

Indicates whether the data returned by the Lookup should be cached for use later in the Map. Default is false. See the Caching section of the Lookup Block topic in the TIBCO Scribe® Help.

  • true - Caches data
  • false - Does not cache data.
  • Lookup

category

response

string

Grouping for Block types including:

  • Source - Perform operations on source Connections.
  • Target - Perform operations on target and source Connections.
  • Control - Determine the flow of execution for a Map, such as a For Each Result Block, For Each Child Block, Continue Block or an If/Else Block.
  • Documentation - Stores comments in a Comments Block or Groups Blocks together, but does not execute any action.

All

childBlockId

response

string

This field is not used.

  • Continue

childPropertyName

response

string

Name of the ID field for a child entity in a Parent/Child relationship. See relationships.
  • Query
  • Fetch

connectionId

response

string

GUID/UUID of the source or target Connection for the Block.
  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Fetch
  • Lookup
  • Insert
  • Merge*
  • Native Query
  • OptOut*
  • Query
  • Remove*
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update/Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait For Message

containerIndex

response

string

Index number of the container Block that contains this Block. If multiple Blocks are nested, this number counts from the outside in starting with 0. For example, the first For Each Result Block has a containerIndex of 0. If you place an If/Else Block inside the For Each Result Block, the If/Else Block has a containerIndex of 1. This field displays only on the object within the container, not on the container itself.

  • Continue
  • Map Exit

description

response

string

User-specified description of the Block.

All

elseLabel

response

string

User-specified name for the Else portion of an If/Else Block.

  • If/Else

entity

response

string

Name of the entity being accessed by the Block.

  • Add*
  • Assign*
  • Build Reply
  • Create
  • Delete
  • Enrich*
  • Fetch
  • Insert
  • Lookup
  • Merge*
  • Native Query
  • OptOut*
  • Query
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait For Message
  • Wait For Request

entityName

response

string

Name of the related entity. See relationships.
  • Fetch
  • Query

expressionItems

response

array

Array of one or more conditions in an If/Else Block. Fields include: 

  • conditionOperator - Operator used to compare the leftExpression to the rightExpression. Operators include: Equal, Does not equal, Greater than, Greater than or equal to, Less than, Less than or equal to.
  • leftExpression - First value used in the comparison for a condition in the If/Else Block.
  • logicalOperator - Connects multiple conditions to create complex conditions. Options include: AND or OR. Default is AND.
  • rightExpression - Second value used in the comparison for a condition in the If/Else Block.
  • id - GUID/UUID of the expressionItems. Used by the TIBCO Scribe® user interface to control the display order of the expressionItems.
  • If/Else

fatalExitErrorMessage

response

string

Content for the error message for the Block. Used when the isFatalExit Block property is enabled.

  • Map Exit
  • Send Reply

fieldMappings

response

array

Array of field mappings for the Block. Contains target fields paired with a formula for each one. Field-mapping fields include:

  • targetDataType - Data type expected by the target field, such as string, boolean, or integer.
  • targetField - Name of the target field.
  • targetFormula - Formula used to update the target field.
  • id - GUID/UUID of the field mapping. Used by the TIBCO Scribe® user interface to control the display order of the field mappings.
  • path - Name of the entity or related entity associated with the fields being mapped. For hierarchical data, the complete path displays.
  • fieldConditionalType - Conditional mapping type set for this field. Types include:
    • None - No condition is set.
    • IsFieldSet - If the field name or property is not included in the results from the source, nothing is written to the target for this field. If this option is not enabled, a NULL value is written to the target, and may overwrite existing data.

      Note: This option can only be enabled for fields that are mapped with a field name. If the field contains a formula, an error is generated. Validation errors are not returned automatically. To view validation errors, use the POST validation and GET validation calls.

    • SkipNullAssignment - If the field or formula results in a NULL, do not write to the target.
    • ConditionalExpression - Uses the formula in the conditionalExpression field to evaluate the data from the source and determine whether to write that data to the target based on the results of the formula. The formula must resolve to a boolean. If the result is True, the source value is written to the target. If the result is False, the source value is not written to the target.
  • conditionalExpression - The formula to be evaluated when the fieldConditionalType is set to ConditionalExpression. For example, this formula: 

    "IF(Leads.LOCEMP=\"Company\",\"True\",\"False\")"

    If the source Leads.LOCEMP field equals Company, the result of the formula is True and Company is written to the target. If the field equals anything else, the result is False, and nothing is written to the target.

  • Add*
  • Assign*
  • Build Reply
  • Create
  • Enrich*
  • Insert
  • Merge*
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*

fieldsToLookup

response

array

Array of fields in the selected entity for which the Lookup should return data. Selecting only the fields you need reduces the amount of data returned and improves performance. See Lookup Block in the TIBCO Scribe® Help.
  • Lookup

filterItems

response

array

Array of one or more items used to filter source data in a Block, such as a Query, or Fetch Block. See Block Properties Filter Tab and Formula Editor Operators in the TIBCO Scribe® Help. Fields include: 

  • compareValue - Value you are seeking as a comparison to the Source data.
  • comparisonOperator - Operator used to compare the Source data to the compareValue. Operators include: Equal, Does not equal, Greater than, Greater than or equal to, Less than, Less than or equal to.
  • fieldName - Name of the field in the entity used as a filter.
  • logicalOperator - Connects multiple filters to create complex filters. Options include: AND or OR. Default is AND.
  • id - GUID/UUID of the filterItem. Used by the TIBCO Scribe® user interface to control the display order of the filterItems.
  • Delete
  • Fetch
  • Lookup
  • Query
  • OptOut*
  • Remove*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Void*

firstChildBlockContainer1Id

response

string

GUID/UUID of the first Block contained within the If section of an If/Else Block.

  • If/Else

firstChildBlockContainer2Id

response

string

GUID/UUID of the first Block contained within the Else section of an If/Else Block.

  • If/Else

firstChildBlockId

response

string

GUID/UUID of the first Block contained within this Block in the Map. For example, if a Create Block is inside a For Each Result Block, the Create Block is the child of the For Each Result Block. In this example, this is the GUID/UUID of the Create Block.

  • Group
  • Fetch
  • For Each Child
  • For Each Result
  • Loop

hasBeenTested

response

boolean

Indicates whether the free form Query has been tested against the source datastore.

  • true - Has been tested.
  • false - Has not been tested.
  • Native Query

id

response

string

GUID/UUID of the Block.

All

insertActionName

response

string

Name of the action performed by this Block. In some cases, the name of the Block and the name of the action being performed are not the same. See actionName for a list of actions.
  • Update/Insert

isFatalExit

response

boolean

Indicates whether error handling is enabled for the Block when a data error is detected. The fatalExitErrorMessage property controls the content of the message. See Map Exit Block in the TIBCO Scribe® Help for additional information.

  • true - Error handling is enabled. TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing the Solution.
  • false - Error handling is disabled. TIBCO Scribe® ignores the error and continues with the next Map.
  • Map Exit
  • Send Reply

isRowError

response

boolean

Indicates whether error handling is enabled for the Block. The rowErrorMessage property controls the content of the message.

  • true - Error handling is enabled. TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing that record.
  • false - Error handling is disabled. TIBCO Scribe® ignores the error and continues processing the record.
  • Continue

isOnErrorMessage

response

boolean

Indicates whether error handling is enabled for the Block. The onErrorMessage property controls the content of the message.

  • true - Error handling is enabled. TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing that record.
  • false - Error handling is disabled. TIBCO Scribe® ignores the error and continues processing the record.
  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Fetch
  • Insert
  • Lookup
  • Merge*
  • OptOut*
  • Remove*
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*

isOnMoreThanOneMessage

response

boolean

Indicates whether TIBCO Scribe® should consider it an error when more than one matching record is found. The onMoreThanOneMessage property controls the content of the message. See Lookup Block in the TIBCO Scribe® Help for additional information.

  • true - If more than one record is found, TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing that record.
  • false - If more than one record is found, TIBCO Scribe® does not consider it an error and returns the data for one of the matching records.
  • Lookup

isOnNoMatchMessage

response

boolean

Indicates whether TIBCO Scribe® should consider it an error when no matching records are found. The onNoMatchMessage property controls the content of the message.

  • true - If no match is found, TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing that record.
  • false - If no match is found, TIBCO Scribe® does not consider it an error and continues processing the record.
  • Delete
  • Fetch
  • Lookup
  • OptOut*
  • Remove*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Void*

isOnOneOrMoreMessage

response

boolean

Indicates whether TIBCO Scribe® should consider it an error when more than one matching record is found. The onOneOrMoreMessage property controls the content of the message. See Lookup Block in the TIBCO Scribe® Help for additional information.

  • true - If more than one record is found, TIBCO Scribe® declares the record as failed, writes a message to the History log, and stops processing that record.
  • false - If more than one record is found, TIBCO Scribe® does not consider it an error and returns the data for one of the matching records.
  • Lookup

isRequired

response

boolean

In a query join, indicates whether the related entity is required. See relationships.

  • true - Required, as in an Inner Join
  • false - Not required, as in an Outer Join
  • Fetch
  • Query

label

response

string

User-specified name for the Block.

All

maxWaitDurationInMs

response

string

The amount of time in milliseconds that the Map should pause before continue to process records. The maximum duration is 600,000 milliseconds (10 minutes).

Note: If you manually stop a running Solution that contains a Wait Block, the Solution does not stop until the wait time has elapsed.

  • Wait

name

response

string

TIBCO Scribe® generated name for the Block for use in the Formula Editor.

All

nextAction

response

string

Indicates what the Continue Block should do next. Default is Continue to NextSourceRow. Options include: 

  • NextSourceRow - Skip the remainder of this Map for the current record and process the next source record from the start of the Map.
  • NextChildRow - When the Continue Block is inside a For Each Child Block, stop processing the current child record and skip to the next available child record. If there are no more children in this Block, TIBCO Scribe® continues executing the Map after the end of the For Each Child Block.
  • Continue - When the Continue Block is inside a Loop Block, skip the remainder of the loop for this iteration and resume at the first Block inside the loop.
  • Continue

nextBlockId

response

string

GUID/UUID of the next Block in the Map.
  • Add*
  • Assign*
  • Build Reply
  • Comment
  • Continue
  • Delete
  • Enrich*
  • Fetch
  • For Each Child
  • Group
  • If/Else
  • Insert
  • Lookup
  • Loop
  • Loop Exit
  • OptOut*
  • Map Exit
  • Merge*
  • Native Query
  • Query
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait
  • Wait For Message
  • Wait For Request

onErrorMessage

response

string

Content for the error message for the Block. Used when the isOnErrorMessage Block property is enabled.

  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Fetch
  • Lookup
  • Insert
  • Merge*
  • OptOut*
  • Remove*
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*

onMoreThanOneMessage

response

string

Content for the error message for the Block when more than one matching record is found. Used when the isOnMoreThanOneMessage Block property is enabled. See Lookup Block in the TIBCO Scribe® Help for additional information.

  • Lookup

onNoMatchMessage

response

string

Content for the error message for the Block when no matching records are found. Used when the isOnNoMatchMessage Block property is enabled.

  • Delete
  • Fetch
  • Lookup
  • OptOut*
  • Remove*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Void*

onOneOrMoreMessage

response

string

Content for the error message for the Block when one or more matching records are found. Used when the isOnOneOrMoreMessage Block property is enabled. See Lookup Block in the TIBCO Scribe® Help for additional information.

  • Lookup

originalBlockLabel

response

string

TIBCO Scribe® label for the Block before it was modified by the user. See label.

All

parentBlockId

response

string

GUID/UUID of the Block that contains this Block in the Map. For example, if a Create Block is inside a For Each Result Block, the For Each Result Block is the parent of the Create Block. In this example, this is the GUID/UUID of the For Each Result Block.

  • Assign*
  • Build Reply
  • Comment
  • Continue
  • Create
  • Delete
  • Enrich*
  • Fetch
  • For Each Child
  • Group
  • If/Else
  • Insert
  • Lookup
  • Loop
  • Loop Exit
  • Map Exit
  • Merge*
  • Native Query
  • OptOut*
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait
  • Wait For Message
  • Wait For Request

parentPropertyName

response

string

Name of the ID field for a parent entity in a Parent/Child relationship. See relationships.
  • Fetch
  • Query

prevBlockId

response

string

GUID/UUID of the previous Block in the Map.
  • Add*
  • Assign*
  • Build Reply
  • Continue
  • Comment
  • Delete
  • Enrich*
  • Fetch
  • For Each Child
  • For Each Result
  • Group
  • If/Else
  • Insert
  • Lookup
  • Loop
  • Loop Exit
  • Map Exit
  • Merge*
  • Native Query
  • OptOut*
  • Remove*
  • Send Reply
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*
  • Wait
  • Wait For Message
  • Wait For Request

queryText

response

string

Query statement entered into a Native Query Block when accessing a source datastore using a custom query.

  • Native Query

queryTextHash

response

string

Refers to the contents of the queryText.

  • Native Query

relationships

response

array

Array of parent and/or child relationships configured in the Block. Parent record relationships allow you to associate a single master record with a number of related records. For example, you can associate a Sales Order or parent record with multiple Sales Order Items or child records.See Parent/Child Relationships in the TIBCO Scribe® Help. Properties include:
  • Fetch
  • Query

relationshipAlias

response

string

TIBCO Scribe® generated name for the relationship that combines the name of the selected entity and the related entity. The alias also indicates whether this is a Parent or a Child of the selected entity. For example, if the entity is Account and the Child of Account is activityparty, then the relationshipAlias is account_activityparties. The selected entity is referenced first, the Child is referenced second and is plural because there could be more than one Child record. See relationships.
  • Fetch
  • Query

relationshipNameForChild

response

string

TIBCO Scribe® generated name for the relationship that combines the name of the selected entity and the related child entity. See relationshipAlias.
  • For Each Child

relationshipType

response

string

Indicates whether this is a Parent, a Child, or a many to many, relationship to the selected entity for this Block. For example, if you are Querying the Sales Order entity, then a Sales Order Item would be related as a Child record of the Sales Order. See relationships.
  • Fetch
  • Query

requestData

response

array

Array of fields and values returned from a source datastore: 

  • dataType - Data type expected from the source, such as string, boolean, or integer.
  • name - Name of the source field.
  • sampleValue - Sample field value.
  • Wait For Request

rowErrorMessage

response

string

Content for the error message for the Continue Block when it returns a record error. Used when the isRowError Block property is enabled. See Continue Block in the TIBCO Scribe® Help for additional information.

  • Continue

skipNullAssignments

response

string

If enabled, when a mapped field or formula results in a NULL value, the NULL value is not written to the target. If all mapped fields result in NULL values, no updates are made and a record error is generated:

  • true - Enabled
  • false - Disabled
  • Add*
  • Assign*
  • Build Reply
  • Create
  • Enrich*
  • Insert
  • Merge*
  • Submit*
  • Unassign*
  • Update
  • Update/Insert
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*

statusOfMetadata

response

string

Message indicating whether the Query has been tested and if the metadata has been retrieved. Messages include: 

  • Test is required for Native query text.
  • Native query has been tested.
  • Metadata successfully retrieved for Native query.
  • Native Query

useBulk

response

boolean

Indicates whether Batch Processing is enabled for the Block. The bulkCountPerOperation property controls the size of the batch of records. See Batch Processing in the TIBCO Scribe® Help.

  • true - Batch Processing is enabled.
  • false - Batch Processing is disabled.
  • Add*
  • Assign*
  • Create
  • Delete
  • Enrich*
  • Insert
  • Merge*
  • OptOut*
  • Remove*
  • Submit*
  • Unassign*
  • Update
  • Update Patch*
  • Update Replace*
  • Upsert
  • Upsert Patch*
  • Upsert Replace*
  • Void*

x

response

string

X coordinate on the Map palette for the location of the first Block in the Map.
  • Group
  • Native Query
  • Query
  • Wait For Message
  • Wait For Request

y

response

string

Y coordinate on the Map palette for the location of the first Block in the Map.
  • Group
  • Native Query
  • Query
  • Wait For Message
  • Wait For Request

 

See

Endpoints

API Basics

Reprocess Failed Records

Maps