Many Process steps and Components can use parameters to allow for dynamic configuration. Parameter Values can represent data from a document field, the current system date/time, a static value, the result of a Connector call or database query, or a variety of other values.
Some common uses:
- Connector (including Start step) - Provide values for parameters defined in the Operation or request Profile to use as selection criteria
- Message step - Insert dynamic content in email alerts.
- Exception step - Insert dynamic content in custom error messages.
- Program Command step - Use document values as query parameters in SQL calls.
- Set Properties step - Incorporate the current date and document values in file names or email subjects. Add multiple Parameter Values to concatenate a dynamic file name. For example, you could combine Profile Element (order number) + Static + Current Date + Static to create a file name like ORD12345_20071029.txt. See Set Properties for more details.
- Decision step - Compare two values to determine how to route documents. Query a database or Connector to determine if a record exists before performing an insert or update.
- Map Function - Specify inputs and outputs for Database Lookup, Connector, and Custom Scripting functions.
- Route step - Compare a document value or property against a list of conditions to determine how to route documents.
Although the list of available Parameter Value types and configuration options vary from step to step, they all share a few common concepts.
- Use the Add button (
) to add a parameter.
- Use the Edit button (
) to modify the selected parameter.
- Use the Delete button (
) to remove the selected parameter.
| Parameter Type |
Description |
| Connector Call |
Perform a lookup or query using an application Connector to return one or more values. The Output Parameter represents the field from the Operation response to return as the overall Parameter Value. The Input Parameters allow you to provide values for the Operation's inputs/filters. Refer to the specific Connector documentation for more information. Also see Understanding Connector Operations for how Operation inputs work. |
| Cross Reference Lookup |
Retrieve a value from a Cross Reference Table component given one or more inputs. See Cross Reference Tables for more information. |
| Current Data |
Insert the entire current document's data. |
| Date/Time |
Choose a date/time value.
- Date Mask - Choose or specify the format for the date value. Click here for more information.
- Date Type
- Current Date - The current system date/time.
- Relative Date - The current system date/time offset by the specified calculation.
- Last Run Date - The date/time when the given Process was last executed. This value is updated every time the Process executes, whether successfully or not. The value is represented in the local time of the machine where the Atom is installed (as opposed to GMT/UTC time). If the Process has not been run before, this value defaults to 12/31/1969 19:00:00.
- Last Successful Run Date - The date/time when the given Process was last executed successfully. This value is only updated when the Process finishes execution without an error. The value is represented in the local time of the machine where the Atom is installed (as opposed to GMT/UTC time).
|
| Document Property |
Retrieve the value of a Standard or User Defined Document Property, such as document file name, Cleanse Result Message, or Application Status Code. See Understanding Document Properties for more information |
| Process Property |
Retrieve the value of a Process Property. Be sure the name matches with the name used when setting the property. Optionally enter a Default Value if the Process Property doesn't exist or is blank. See Understanding Process Properties for more information. |
| Profile Element |
Use a value from a field in the current document. Choose a Profile Type, then select the Profile and Element to use. |
| Sequential Value |
Create and reference a counter that auto-increments every execution.
- Key Name - An arbitrary, unique name for the counter.
- Fix To Length - The length of the sequential value to be returned. The value will be padded with zeros (0's) to the specified length.
|
| SQL Statement |
Return the result of a user-defined database SQL statement, typically a SELECT statement. The statement call itself can use parameters (from Profiles, Tracked Properties, etc.) to dynamically specify query criteria.
- Output Column - The column number of the query results to return as the output parameter.
- Cache Values? - Store the results of the query in cache (temporary memory) for improved performance.
|
| Static |
Provide a hard-coded value. |
| Stored Procedure |
Return the result of a database stored procedure. The stored procedure call itself can use parameters (from Profiles, Tracked Properties, etc.) to dynamically specify query criteria.
- Output Column - The column number of the stored procedure results to return as the output parameter.
- Cache Values? - Store the results in cache (temporary memory) for improved performance.
|
| Unique Value |
Use a system-generated ten digit number to guarantee uniqueness. |
This page
Other pages
Account
