/
WriteToLog

WriteToLog

Oct 01, 2015

What to use it for

Prerequisites for usage

Essential properties to set

Use this activity to write entries to the service log.

You also need to modify an XML file. For more details, read 'Create custom logs with the WriteToLog Activity'.

An installed logging application.

None. Works with default settings.

Options for SmartBridge 3

Primary options

These options should correspond with the logging application settings that are explained at 'Create custom logs with the WriteToLog Activity'.

Option

What is it

How to use it

Logger nameThe name for the custom logging application. You will need to refer to this name in the configuration file.
  • Recommended: Only use alphanumeric characters, no special characters or spaces (except the lower dash).  Example: OutgoingOrders.

  • Possible, but discouraged: Using Macros.

 Click here to expand...

It is not recommended to use macros when defining the value of the 'Logger name'. Else, in step 2 you would have to create a specific logger for all possible results of the macro substitution. For example, if you would use {RecipientName} as part of the 'Logger name', you will need to create a logger for each of the partners which might be a recipient of the document.

Log level

The level of detail of the log message.

Use the dropdown list to indicate how detailed the log file should be:

  • Error - Only log errors.
  • Warning - Log errors and warnings.
  • Info - Log errors, warnings, and status messages (default)
  • Debug - Log everything that happens.

Message

The message to be written in the service log file.

Enter a custom message.

 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.

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

Log entry

These options should correspond with the logging application settings that are explained at 'Create custom logs with the WriteToLog Activity'.

Option

What is it

How to use it

Logger nameThe name for the custom logging application. You will need to refer to this name in the configuration file.
  • Recommended: Only use alphanumeric characters, no special characters or spaces (except the lower dash).  Example: OutgoingOrders.

  • Possible, but discouraged: Using Macros.

 Click here to expand...

It is not recommended to use macros when defining the value of the 'Logger name'. Else, in step 2 you would have to create a specific logger for all possible results of the macro substitution. For example, if you would use {RecipientName} as part of the 'Logger name', you will need to create a logger for each of the partners which might be a recipient of the document.

Log level

The level of detail of the log message.

Use the dropdown list to indicate how detailed the log file should be:

  • Error - Only log errors.
  • Warning - Log errors and warnings.
  • Info - Log errors, warnings, and status messages (default)
  • Debug - Log everything that happens.

Message

The message to be written in the service log file.

Enter a custom message.

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

Pages about logging, updates, and notifications