SetDocumentProperties
What to use it for | Prerequisites for usage | Essential properties to set |
|---|---|---|
With SetDocumentProperties you can specify new values for one or more document properties. Some situations in which this can be useful:
| None. | None. |
Options for SmartBridge 3
Primary options
| Option | What is it | How to use it |
|---|---|---|
| Current document | The variable or argument referring to the document this activity is operating upon. |
Recommended: Leave empty when you are not using a Clone Activity. |
| Document format | Option to assign a different document format. | Enter a document format, using alphanumeric characters. Examples: XML, PDF, ZIP |
| Document type | Option to assign a different document type. | Enter a document type, using alphanumeric characters. Examples: order, invoice |
| Document subtype | Option to assign a different document subtype. | Enter a document subtype, using alphanumeric characters. Example: D96a |
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
| Option | What is it | How to use it |
|---|---|---|
| Assign distribution channel | SmartBridge by default assigns a Distribution Channel based on the final document properties resulting from a Workflow. Use this option to, instead, assign a Distribution Channel based on the document properties known at the time of this Activity. | To enable or disable this option:
|
| Assign group owner as recipient | This option is relevant when you use Partner Groups. Indicate whether the group owner should receive the document, instead of (one of) the group recipients. Click here to expand... Partner Groups are often used for organizations with several departments that are part of a single Holding entity. A Partner Group has an Owner, and a group contains Partners. Suppose a Partner is the appropriate recipient for despatch advices, but the Owner is the appropriate recipient for invoices. You could then have SmartBridge look up the associated Owner of a Partner, using the Partner Groups settings, and have the invoice send to the Owner, who will pay on behalf of the Partner. | To enable or disable this option:
|
| Assign group owner as sender | This option is relevant when you use Partner Groups. Indicate whether the group owner should be set as document sender. Click here to expand... Partner Groups are often used for organizations with several departments that are part of a single Holding entity. A Partner Group has an Owner, and a group contains Partners. Suppose a Partner is the appropriate sender of despatch advices, but the Owner is the appropriate sender of invoices. You could then have SmartBridge look up the associated Owner of a Partner, using the Partner Groups settings, and have the invoice send by the Owner, on behalf of the Partner. | To enable or disable this option:
|
| Document number | Change the document number. | Add an alphanumeric value and/or use Macros.
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.
|
| Enqueue for grouping | Specify whether the document should be grouped before sending, or not.
| Select an option from the dropdown:
|
| 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:
|
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:
|
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 |
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:
|
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.
|
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 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'.