/
AnsiX12Envelope

AnsiX12Envelope

Oct 01, 2015

What to use it for

Prerequisites for usage

Essential properties to set

Sometimes a document does not have a complete or valid ANSI X12 envelope.

Use AnsiX12Envelope to fix the envelope segments of a ANSI X12 document. It can also generate a unique interchange control number, or replace the complete interchange header.

 Enveloping method

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.
Enveloping method

Select whether you merely want to add a reference code, or want to completely replace existing header data.

Select an option from the dropdown list:

  • HeaderReplacement - Replace the whole header with the settings below (default).
  • ReferenceGenerationOnly - Only generate a reference code.

All options

 Click here to expand...

Input Options

Option

What is it

How to use it

Current document

Use CurrentDocument to indicate which data you want to process with the current Activity.

This option only becomes relevant in case a preceding Activity generated new documents.

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.

Interchange header (ISA)

Option

What is it

How to use it

Enveloping method

Select whether you merely want to add a reference code, or want to completely replace existing header data.

Select an option from the dropdown list:

  • HeaderReplacement - Replace the whole header with the settings below (default).
  • ReferenceGenerationOnly - Only generate a reference code.

Data element separator

Specifies which character the document should use to separate data elements.

To specify non-printable character codes, you can use the following macro: {Char}

  • Example:
    • {Char:0x1D}
  • Default: 
    • *

Authorization qualifier

 
  • Default: 
    • 00

 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.

Authorization id

 

 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.

Security info qualifier

 
  • Default:
    • 00

 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.

Security info

 

 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.

Sender id qualifier

 
  • Default: 
    • ZZ

 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.

Sender id

 

Example: Use a macro like {Sender:ZZ} to obtain a sender partner identifier defined for code qualifier ZZ.

  • Default: 
    • {Sender:ZZ}

 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.

Receiver id qualifier

 
  • Default: 
    • {ZZ}

 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.

Receiver identifier

 

Example: Use a macro like {Recipient:ZZ} to obtain a recipient partner identifier defined for code qualifier ZZ.

  • Default: 
    • {Recipient:ZZ}

 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.

Interchange date

Date value in an ANSI X12 acceptable format.

The ANSI X12 standard dictates the allowed date formatting. Use the following macro to generate the required date formatting:

{DT(yyMMdd)}

Other values will be used as provided, but are not allowed by the EDIFACT standard and are therefore not recommended.

  • Default: 
    • {DT(yyMMdd)}

Interchange time

Time value in an ANSI X12 acceptable format.

The ANSI X12 standard dictates the allowed time formatting. Use the following macro to generate the required current time formatting:

{DT(HHmm)}

Other values will be used as provided, but are not allowed by the EDIFACT standard and are therefore not recommended.

  • Default: 
    • {DT(HHmm)}

Repetition separator

 
  • For version 4030 or higher, you will need to specify a separator.
  • In other cases: Leave at U (default)

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1E}

Interchange control version nr.

 
  • Default: 
    • 00400

 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.

Interchange control number

 
  • Leave empty.
  • Or use the macro {GenerateCounter} to instruct the system to generate a unique control number.
  • Not recommended: Entering a self-defined number.
  • Default: 
    • {GenerateCounter}

 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.

Acknowledgment requested

 
  • Default: 
    • 0

 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.

Test indicator

Indicate how to distinguish production documents from test documents.
  • P = production (default)
  • T = test

 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.

Composite element separator

 

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1F}
  • Default: 
    • \

Segment terminator

Assign a character that will represent the end of a segment.

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1C}
  • Default: 
    • ~

Output options

Option

What is it

How to use it

Each segment on a new line.

Specifies whether the resulting EDI file should have line breaks after each segment.

Select an option from the dropdown list:

  • Checked/True – Add line breaks after each segment.
  • Unchecked/False – Do not add line breaks after a segment.

Options for SmartBridge 2


 Click here to expand...

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

Interchange header (ISA)

 

Option

What is it

How to use it

Enveloping method


Select whether you merely want to add a reference code, or want to completely replace existing header data.

Select an option from the dropdown list:

  • HeaderReplacement - Replace the whole header with the settings below (default).
  • ReferenceGenerationOnly - Only generate a reference code.

Data element separator

Specifies which character the document should use to separate data elements.

To specify non-printable character codes, you can use the following macro: {Char}

  • Example:
    • {Char:0x1D}
  • Default: 
    • *

Authorization qualifier

 
  • Default: 
    • 00

 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.

Authorization id

 

 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.

Security info qualifier

 
  • Default:
    • 00

 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.

Security info

 

 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.

Sender id qualifier

 
  • Default: 
    • ZZ

 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.

Sender id

 

Example: Use a macro like {Sender:ZZ} to obtain a sender partner identifier defined for code qualifier ZZ.

  • Default: 
    • {Sender:ZZ}

 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.

Receiver id qualifier

 
  • Default: 
    • {ZZ}

 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.

Receiver identifier

 

Example: Use a macro like {Recipient:ZZ} to obtain a recipient partner identifier defined for code qualifier ZZ.

  • Default: 
    • {Recipient:ZZ}

 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.

Interchange date

Date value in an ANSI X12 acceptable format.

The ANSI X12 standard dictates the allowed date formatting. Use the following macro to generate the required date formatting:

{DT(yyMMdd)}

Other values will be used as provided, but are not allowed by the EDIFACT standard and are therefore not recommended.

  • Default: 
    • {DT(yyMMdd)}

Interchange time

Time value in an ANSI X12 acceptable format.

The ANSI X12 standard dictates the allowed time formatting. Use the following macro to generate the required current time formatting:

{DT(HHmm)}

Other values will be used as provided, but are not allowed by the EDIFACT standard and are therefore not recommended.

  • Default: 
    • {DT(HHmm)}

Repetition separator

 
  • For version 4030 or higher, you will need to specify a separator.
  • In other cases: Leave at U (default)

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1E}

Interchange control version nr.

 
  • Default: 
    • 00400

 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.

Interchange control number

 
  • Leave empty.
  • Or use the macro {GenerateCounter} to instruct the system to generate a unique control number.
  • Not recommended: Entering a self-defined number.
  • Default: 
    • {GenerateCounter}

 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.

Acknowledgment requested

 
  • Default: 
    • 0

 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.

Test indicator

Indicate how to distinguish production documents from test documents.
  • P = production (default)
  • T = test

 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.

Composite element separator

 

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1F}
  • Default: 
    • \

Segment terminator

Assign a character that will represent the end of a segment.

To specify non-printable character codes, you can use the following macro: {Char}

  • Example: 
    • {Char:0x1C}
  • Default: 
    • ~

Output options

Option

What is it

How to use it

Each segment on a new line.

Specifies whether the resulting EDI file should have line breaks after each segment.

Select an option from the dropdown list:

  • Checked/True – Add line breaks after each segment.
  • Unchecked/False – Do not add line breaks after a segment.

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


 

 

On this page

 

ANSI X12 Activities

Envelope Activities

 

 

More about Document Structures