/
SplitDocument

SplitDocument

Oct 01, 2015

What to use it for

Prerequisites for usage

Essential properties to set

Generates a set of documents from an incoming document. This is often used for incoming documents that have content for multiple recipients.

  • You can use the SplitDocument activity only on the following formats: EDIFACT, ANSI X12, TRADACOMS, and GENCOD. Other document formats cannot be split.
  • SplitDocument should always be followed by a ForEach<Document> Activity, because it results in multiple documents that each need to be processed.

Documents in one of the following formats: EDIFACT, ANSI X12, TRADACOMS, and GENCOD

None. Works with default settings.

Options for SmartBridge 3

Primary options

OptionWhat is itHow to use it
Current document

The variable or argument referring to the document this activity is operating upon.

In general, leave at the default value.

  • In most cases you do not need to modify this option.

    • With the default value, the Activity will process the original document.
  • Only enter a custom alphanumeric ID when necessary to be able to process a newly generated document.

 

 Read more »

The only situation in which you might need to modify this option, is when your Workflow produces several new documents based on one incoming original document. Activities that use a single document to produce several documents:

These Activities produce several documents, and some of those might require additional, specific processing.

To be able to indicate which documents require different processing, you will need to have done the following:

  • Have SmartBridge assign an ID to the newly produced documents.
  • Within in the current Workflow, create a specific sequence of Activities for these documents.
  • Assign the documents to their sequence, by referring to their IDs.

Split format

Specifies the format of the documents to be split.

Select an option from the dropdown list:

  • EDI (default)
  • FlatFile
  • XML
Collection of split documents

Option to save the results to a variable, for use later in the Workflow. 

 Click here to expand...

Refer to this variable in the ForEach<Document> Activity: Its CurrentDocument field should reflect the name you used in this 'Collection of split documents'.

Enter a name for a new variable.

 

 Read more
Why do I need variables

You can use variables to create a more flexible and sustainable Workflow.

Variables are mostly used in advanced Activities such as the Diversity Activities. These Activities often have two parts:

  • One part is to identify where to get data that serves as input for the Activity.
  • One part is to identify where to store data that serves as output for the Activity.

For the Diversity Activities it is common to store the data resulting from the Activity into a variable. Once stored in the variable, you can re-use the stored value elsewhere in the Workflow, by referring to the variable.

To create a variable to store data
  1. Click on the Variables button, below the Workflow. a panel will appear, containing an editable table.
  2. In the table click on 'Create variable' to start creating a new variable.
  3. Provide a name for the variable, preferably a name that describes its contents. Use camel case.
  4. Indicate the type of variable (e.g. boolean, integer, string, etc.). You can find specific types using 'Browse for types...'.
  5. Moving to another row saves this data to a new entry.

You can now use the name of this variable into one of the fields of the current Activity, or in Activities that are next.

All options

 Click here to expand...

EDS options

 

Option

What is it

How to use it

Check Control Counters

 
  • Checked - (default)
  • Unchecked -

Check Control References

 
  • Checked - (default)
  • Unchecked -
Enqueue for grouping

Only relevant for EDI documents.

Specifies whether the documents that are the result of a split should be grouped before they will be distributed.

Select an option from the dropdown list:

  • Preserve - Use settings defined elsewhere.
  • No grouping - Do not group split documents.
  • Group - Group split documents.

Generate Interchange

 
  • Checked - (default)
  • Unchecked -

Split Interchanges

 
  • Checked - (default)
  • Unchecked -

Split Segments

 
  • Checked - (default)
  • Unchecked -

 

Flat file options

Option

What is it

How to use it

Encoding name

Setting to understand the encoding of the document that you are splitting.

Specifies the encoding (character set) that should be used when processing the flat file.

Enter a character set.

Split line begins with

Use to recognize a split line.

Specifies the characters that mark the beginning of a split line.

Enter the characters that mark the beginning of a split line.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

Split line contains

Use to recognize a split line.

Specifies the characters that should be present in the line that marks the beginning of a split line.

Enter the characters that mark the beginning of a split line.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

Replicate # header lines

Use when you want to copy header lines to the split documents.

Specifies how many lines from the header of the input file need to be copied to the beginning of each new split document.

Enter a integer of 0 or higher.

Header string

Use when you want to add new strings to split documents.

Specifies the string that should be used as a header for each of the split results.

Enter a string, i.e. one or more words in alphanumeric characters.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

In case you set 'Replicate # header lines' to 1 or higher, the header string is preceded by the lines of the input header.

General options

 

Options

What is it

How to use it

Preserve original document properties

This setting only works for FlatFile documents.

Specifies whether the original document properties should be copied to the documents that result from the split.

Select an option from the dropdown list:

  • Checked - Copy the original document properties to the documents that are the result of a split.
  • Unchecked - Do not copy the original document properties to the resulting documents.

Split format

Specifies the format of the documents that will be split.

Select an option from the dropdown list:

  • EDI (default)
  • FlatFile

Input options

 

Options

What is it

How to use it

File mask

The splitter will only process files that match this mask.

 

 

Misc

Option

What is it

How to use it

CreatedDocumentIds

This option exposes the list of generated document internal identifiers which should be assigned to the InitialChildData property of the ReplicatorActivity.

N/a, this field is read only.

 

 

Output options

Option

What is it

How to use it

Enqueue for grouping

Only relevant for EDI documents.

Specifies whether the documents that are the result of a split should be grouped.

Select an option from the dropdown list:

  • Preserve - Use settings defined elsewhere.
  • No grouping - Do not group split documents.
  • Group - Group split documents.

XML file options

Options

What is it

How to use it

Preserve envelope footerTo indicate whether the resulting files should contain the data included in the footer of the envelope, in case there is one.
  • Checked - Add the envelope footer to the resulting documents.
  • Unchecked - Do not add the footer.
Preserve XML envelopeTo indicate whether the resulting files should contain all the XML content of the envelope that surrounds the document contents.
  • Checked - Add the envelope to resulting files.
  • Unchecked - Do not add the envelope to resulting files.

XPath of the elements to split

Define an Xpath to split an XML document at every element that matches this Xpath. This will create separate files for each element.Enter an Xpath.

Options for SmartBridge 2

 Click here to expand...

All options

 

Activity

Every Workflow Activity needs to have a name, and be configured to be either on or off. These generic properties are part of the Activity properties.

Option

What is it

How to use it

Name

 

A unique name for the Activity. Names are used for two reasons:

  • So you are able to identify the activity throughout the Workflow.
  • More importantly, a name is essential in case you want one Activity to refer to another, specific Activity.
  • Leave the generated name (default)
  • Or enter a unique name.

Description

Description of the activity, to give others some context about the Activity.

Enter an optional description.

Enabled

 


Specifies if the Activity should be enabled or not.

Disabled Activities will be skipped during Workflow execution and validation.

Select option from the dropdown:

  • True – Enables the Activity (default).
  • False – Disables the Activity.

Recommended: True

General options

 

Option

What is it

How to use it

Split format

Specifies the format of the documents that will be split.

Select an option from the dropdown items:

  • EDI (default)
  • FlatFile

Preserve original document properties

This setting only works for FlatFile documents.

Specifies whether the original document properties should be copied to the documents that result from the split.

Select an option from the dropdown items:

  • True - Copy the original document properties to the documents that are the result of a split.
  • False - Do not copy the original document properties to the resulting documents.

 

EDI (EDS) options

 

Option

What is it

How to use it

Check Control Counters

 
  • True
  • False

Check Control References

 
  • True
  • False

Split Interchanges

 
  • True
  • False

Split Segments

 
  • True
  • False

Generate Interchange

 
  • True
  • False

 

Flat file options

 

Option

What is it

How to use it

Encoding name

Setting to understand the encoding of the document that you are splitting.

Specifies the encoding (character set) that should be used when processing the flat file.

Enter a character set.

Split line begins with

Use to recognize a split line.

Specifies the characters that mark the beginning of a split line.

Enter the characters that mark the beginning of a split line.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

Split line contains

Use to recognize a split line.

Specifies the characters that should be present in the line that marks the beginning of a split line.

Enter the characters that mark the beginning of a split line.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

Replicate # header lines

Use when you want to copy header lines to the split documents.

Specifies how many lines from the header of the input file need to be copied to the beginning of each new split document.

Enter a integer of 0 or higher.

Header string

Use when you want to add new strings to split documents.

Specifies the string that should be used as a header for each of the split results.

Enter a string, i.e. one or more words in alphanumeric characters.

 Supports dynamic values from Macros »

Instead of using static values you can also use dynamic values.

With so called Macros you can have SmartBridge dynamically replace (part of) the value with properties extracted from a document (e.g. recipient), or with system settings (e.g. date). See the Macros for Workflows for more details and examples.

In case you set 'Replicate # header lines' to 1 or higher, the header string is preceded by the lines of the input header.

 

Input options

 

Option

What is it

How to use it

File mask

The splitter will only process files that match this mask.

 

 

Output options

Option

What is it

How to use it

Enqueue for grouping

Only relevant for EDI documents.

Specifies whether the documents that are the result of a split should be grouped.

Select an option from the dropdown list:

  • Preserve - Use settings defined elsewhere.
  • No grouping - Do not group split documents.
  • Group - Group split documents.\

Document identification

In case you use the Clone Activity, SmartBridge will use this property to identify cloned documents.

Option

What is it

How to use it

Document Key

Only relevant for Workflows that contain a CloneDocument Activity.

The key of the cloned document to be used for processing.

 Click here to expand...

When creating a clone of the document (using the CloneDocument activity) you need to specify whether SmartBridge should process the clone or the original. When you have specified a Document Key, SmartBridge will assign the Document Key to cloned documents. With the Document Key assigned to cloned documents, you will be able to refer to the clones for further processing.

  • Leave empty if the activity should process the original document (default).
  • Enter or assign the Clone Document Key if the activity should process a clone document.

Recommended: Leave empty when you are not using a Clone Activity.

In SmartBridge 3 this option is replaced with 'Input Options'.

Misc

Option

What is it

How to use it

CreatedDocumentIds

This option exposes the list of generated document internal identifiers which should be assigned to the InitialChildData property of the ReplicatorActivity.

N/a, this field is read only.

 

 

 

 

 

On this page

Iteration-related Activities

EDIFACT Activities

Activities that create documents