XlsToCsvTranslation
What to use it for | Prerequisites for usage | Essential properties to set |
|---|---|---|
Use XlsToCsvTranslation to transform XLS documents to CSV documents. | XLS documents. |
|
Options for SmartBridge 3
Primary options
| Option | What is it | How to use it |
|---|---|---|
| Current document | The name or ID of the cloned document to be used for processing. 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 name for documents resulting from a Clone Activity, SmartBridge is then able to identify these clones. This enables you to assign these specific documents to other Activities, for further processing. |
Recommended: Leave empty when you are not using a Clone Activity. |
| Spreadsheet name | In case the Excel contains several spreadsheets ('tab'), use this option to indicate from which spreadsheet you want to use the data. | Enter the exact name of the spreadsheet (tab). 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. This setting overrules the 'Spreadsheet position' settings, which does the same but is more generic. |
| Output filename | Filename for the CSV that you want to produce. Optionally, you can provide a full (absolute) path to the file. |
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. |
All options
Analyzer Options
Option | What is it | How to use it |
|---|---|---|
Preserve existing values | "Do you want to complement or overwrite existing values?" Read more Sometimes a document might be carrying a couple of document property values resulting from an analysis at an earlier moment. A secondary analysis might find additional property values. If you want to add values to additional properties that were previously empty while preserving existing values, then set to true. If you only care about new property values and do not care about values from an earlier analysis, set to false. Document Format will always be overwritten. | Indicate your choice:
|
Do not clear values | "Do you want to keep known values or overwrite them, even when it results in empty values?" Read more Sometimes a document might be carrying a couple of document property values resulting from an analysis at an earlier moment. A secondary analysis might find that some of those properties are empty. If you want keep the properties that previously had values, then set to true. If you only care about new property values and do not care about values from an earlier analysis, then set to false. | Indicate your choice:
|
Use Inhouse analyzer | Specifies whether the Workflow should analyze Inhouse documents (using Inhouse document structures), or skip it. | Indicate which of the two applies:
|
Use flat file analyzer | Specifies whether the Workflow should analyze flat files (using Flat file document structures), or skip it. | Indicate which of the two applies:
|
Use EDI analyzer | Specifies whether the Workflow should analyze EDI files, or skip it. This applies to these EDI formats: EDIFACT, ANSI X12, TRADACOMS or GENCOD. | Indicate which of the two applies:
|
Use XML analyzer | Specifies whether the Workflow should analyze XML files, or skip it. When turned off, no XML document structures will be used during the analyzing process. | Indicate which of the two applies:
|
| Recognize PDF | Specifies whether the Workflow should analyze PDF files, or skip it. | Indicate which of the two applies:
|
| Recognize Excel | Specifies whether the Workflow should analyze Excel files, or skip it. | Indicate which of the two applies:
|
Document properties
Use these properties to change the properties of a document.
Option | What is it | How to use it |
|---|---|---|
Document format | Assign a different document format to the document, which replaces the current value. | Enter a document format. |
Document type | Assign a different document type to the document, which replaces the current value. | Enter a document type. |
Document subtype | Assign a different document subtype to the document, which replaces the current value. | Enter a document subtype. |
Sender short name | Assign a different sender to the document, which replaces the current value. | Use the selectbox to select one of the partners known to the system. |
Recipient short name | Assign a different recipient to the document, which replaces the current value. | Use the selectbox to select one of the partners known to the system. |
Processing priority | Specify the processing priority to be assigned to the document. | Enter an integer.
|
Communication subject | Option to indicate the subject of the communication. Click here to expand... You can regard this option as generic metadata for any kind of communication. The most common option is subject information used in SMTP or SMI ('subject line'). However, you could also send subject information over FTP(S), which is used for navigating directories (where the subject is reflected in the directory names). | Enter a value. |
Test indicator | Specifies if the document is a test document. This can be used later in the Distribution Channel selection, or in the selection of a new Process if requested so in the Workflow. |
|
Content grouping parameter | Define an extra value that can be used in the grouping process. This only applies to EDIFACT documents. Click here to expand... In case you indicated that documents should be grouped, SmartBridge will, by default, group documents per recipient. In some cases you might need more granular grouping, such as: Group all orders for the same recipient. This requires you to set a content grouping parameter, to indicate what additional property you will use for grouping documents. | Use a Macro to indicate which additional property should be used for grouping documents.
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.
|
Document property options
Use these properties to control if and how the Activity should modify the properties of the processed document. The changes are effective immediately after the Activity is finished.
Option | What is it | How to use it |
|---|---|---|
Change document properties | Specify whether you want to change some of the document properties after executing the Activity. Analyze document settings (see above) can overrule this setting. | To enable or disable this option:
|
Use NULL values | Indicate what SmartBridge should do with an empty value (or 'null') in the document properties settings. | To enable or disable this option:
|
Enqueue for grouping | Specify whether the document should be grouped before sending, or not.
| Select an option from the dropdown list:
|
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.
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:
|
Misc
| Option | What is it | How to use it |
|---|---|---|
| DisplayName | Name of the Activity. | Leave at default, or edit the name to clarify the difference with a similar Activity. |
Status report options
Option | What is it | How to use it |
|---|---|---|
Generate status report | Setting to enable SmartBridge to send your ERP system a status report after this Activity has finished processing the document. Click here to expand... This option is only useful in specific cases. Some business processes require that the systems involved inform each other about the current status of a process. A common example are some SAP ERP configurations that require status reports from other systems. These status reports report the result of crucial stages in the process, such as translations or sending. | Indicate your choice:
|
Translation Properties
| Option | What is it | How to use it |
|---|---|---|
| Action if file exists | Option to indicate what should happen in case the destination folder already contains a file with the same name. | Select an option from the dropdown list:
|
| Always use string qualifier | Option to put a string qualifier around each value.
| (Un)check the option:
|
| Column delimiter | Character or combination of characters that represents the spacing between column. | Enter a (combination of) character(s) that will be used to indicate the end of a column. Common options:
|
| Encoding name | The encoding to use for processing the flat file. | Leave empty, or optionally enter a character set.
|
Output filename | The name of the output file. |
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.
|
| Row delimiter | Character that represents the end of a row. | Enter a character that will be used to indicate the end of a row. Common options:
|
| Skip rows | In case the Excel starts with one or more rows that do not contain relevant data (e.g. header rows), use this option to indicate how many rows to skip to get to the relevant data. | Inter a positive integer, or leave empty to not skip rows. |
Spreadsheet name | In case the Excel contains several spreadsheets ('tab'), use this option to indicate from which spreadsheet you want to use the data. | Enter the exact name of the spreadsheet (tab).
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.
This setting overrules the 'Spreadsheet position' settings, which does the same but is more generic. |
| Spreadsheet position | In case the Excel contains several spreadsheets ('tab'), use this option to indicate from which spreadsheet you want to use the data. This is an alternative to the 'Spreadsheet name' option. | Enter a positive integer that represents the index of the tab to use.
|
| String qualifier | Character that represents the start and end of a sequence of characters (i.e. a string). | Enter a character that will be used to indicate the start and the end of a string. Common options:
|
Options for SmartBridge 2
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:
|
|
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:
Recommended: True |
Excel Configuration
| Option | What is it | How to use it |
|---|---|---|
| Action if file exists | Option to indicate what should happen in case the destination folder already contains a file with the same name. | Select an option from the dropdown list:
|
| Always use string qualifier | Option to put a string qualifier around each value.
| (Un)check the option:
|
| Column delimiter | Character or combination of characters that represents the spacing between column. | Enter a (combination of) character(s) that will be used to indicate the end of a column. Common options:
|
| Encoding name | The encoding to use for processing the flat file. | Leave empty, or optionally enter a character set.
|
Output filename | The name of the output file. |
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.
|
| Row delimiter | Character that represents the end of a row. | Enter a character that will be used to indicate the end of a row. Common options:
|
| Skip rows | In case the Excel starts with one or more rows that do not contain relevant data (e.g. header rows), use this option to indicate how many rows to skip to get to the relevant data. | Inter a positive integer, or leave empty to not skip rows. |
Spreadsheet name | In case the Excel contains several spreadsheets ('tab'), use this option to indicate from which spreadsheet you want to use the data. | Enter the exact name of the spreadsheet (tab).
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.
This setting overrules the 'Spreadsheet position' settings, which does the same but is more generic. |
| Spreadsheet position | In case the Excel contains several spreadsheets ('tab'), use this option to indicate from which spreadsheet you want to use the data. This is an alternative to the 'Spreadsheet name' option. | Enter a positive integer that represents the index of the tab to use.
|
| String qualifier | Character that represents the start and end of a sequence of characters (i.e. a string). | Enter a character that will be used to indicate the start and the end of a string. Common options:
|
Document property options
Use these properties to control if and how the Activity should modify the properties of the processed document. The changes are effective immediately after the Activity is finished.
Option | What is it | How to use it |
|---|---|---|
Analyze Document | Specify whether the document should be reanalyzed immediately after the Activity has finished processing (but before continuing to the next Activity). When enabled, this setting overrules the Change document properties settings. | To enable or disable this option:
|
Change document properties | Specifiy whether you want to change some of the document properties after executing the Activity. Analyze document settings (see above) can overrule this setting. | To enable or disable this option:
|
Use NULL values | Indicate what SmartBridge should do with an empty value (or 'null') in the document properties settings. | To enable or disable this option:
|
Enqueue for grouping | Specify whether the document should be grouped before sending, or not.
| Select an option from the dropdown:
|
Analyzer Options
Option | What is it | How to use it |
|---|---|---|
Preserve existing values | "Do you want to complement or overwrite existing values?" Read more Sometimes a document might be carrying a couple of document property values resulting from an analysis at an earlier moment. A secondary analysis might find additional property values. If you want to add values to additional properties that were previously empty while preserving existing values, then set to true. If you only care about new property values and do not care about values from an earlier analysis, set to false. Document Format will always be overwritten. | Indicate your choice:
|
Do not clear values | "Do you want to keep known values or overwrite them, even when it results in empty values?" Read more Sometimes a document might be carrying a couple of document property values resulting from an analysis at an earlier moment. A secondary analysis might find that some of those properties are empty. If you want keep the properties that previously had values, then set to true. If you only care about new property values and do not care about values from an earlier analysis, then set to false. | Indicate your choice:
|
Use Inhouse analyzer | Specifies whether the Workflow should analyze Inhouse documents (using Inhouse document structures), or skip it. | Indicate which of the two applies:
|
Use flat file analyzer | Specifies whether the Workflow should analyze flat files (using Flat file document structures), or skip it. | Indicate which of the two applies:
|
Use EDI analyzer | Specifies whether the Workflow should analyze EDI files, or skip it. This applies to these EDI formats: EDIFACT, ANSI X12, TRADACOMS or GENCOD. | Indicate which of the two applies:
|
Use XML analyzer | Specifies whether the Workflow should analyze XML files, or skip it. When turned off, no XML document structures will be used during the analyzing process. | Indicate which of the two applies:
|
| Recognize PDF | Specifies whether the Workflow should analyze PDF files, or skip it. | Indicate which of the two applies:
|
| Recognize Excel | Specifies whether the Workflow should analyze Excel files, or skip it. | Indicate which of the two applies:
|
Status report options
Option | What is it | How to use it |
|---|---|---|
Generate status report | Setting to enable SmartBridge to send your ERP system a status report after this Activity has finished processing the document. Click here to expand... This option is only useful in specific cases. Some business processes require that the systems involved inform each other about the current status of a process. A common example are some SAP ERP configurations that require status reports from other systems. These status reports report the result of crucial stages in the process, such as translations or sending. | Indicate your choice:
|
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. |
Recommended: Leave empty when you are not using a Clone Activity. |
In SmartBridge 3 this option is replaced with 'Input Options'.
Excel Activities
-
Page:
-
Page:
-
Page:
-
Page:
More about Document Structures
-
Page:
-
Page:
-
Page:
-
Page: