Managed connection factory properties, WebSphere Adapter for Flat Files

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Flat Files > Reference > Configuration properties > Outbound configuration properties
Managed connection factory properties

Managed connection factory properties specify information the adapter needs at run time for outbound communication with the local file system.

The following table lists the managed connection factory properties for outbound communication. You set the managed connection factory properties using the external service wizard and can change them using the IBM Integration Designer Assembly Editor, or after deployment through the IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console.
A more detailed description of each property is provided in the sections that follow the table. For information about how to read the property details tables in the sections that follow, see Guide to information about properties.
The external service wizard refers to these properties as managed connection factory properties and the IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console refers to them as (J2C) connection factory properties.

Managed connection factory properties
Property name Description
In the wizard In the Process Administrative Console
Adapter ID
AdapterID

Identifies the adapter instance for PMI events and for logging and tracing.
Default target file name OutputFileName Specifies the name of the file that is created in the output directory, or a WebSphere Application Server environment variable that represents this file.
Disguise user data as "XXX" in log and trace files HideConfidentialTrace Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Generate a unique file GenerateUniqueFile Specifies that the adapter creates a unique file during Create, Append, and Overwrite operations.
Prefix for the unique file name uniqueFilePrefix Specifies the predefined prefix that is added to the generated unique file name during outbound operations.
Output directory OutputDirectory Specifies the full path name of the directory where the adapter creates files during outbound operations, or a WebSphere Application Server environment variable that represents this directory.
Sequence file FileSequenceLog Specifies the full path name of the file where sequences are stored during outbound Create operations, or a WebSphere Application Server environment variable that represents this file.
Staging directory StagingDirectory The full path name of the temporary directory where the adapter writes the initial output files for Create and Overwrite operations during outbound processing, or a WebSphere Application Server environment variable that represents this directory.
Suffix for the unique file name uniqueFileSuffix Specifies the predefined suffix that is added to the generated unique file name during outbound operations.

Adapter ID (AdapterID)

This property identifies a specific deployment or instance of the adapter.

Adapter ID details
Required Yes
Default 001
Property type String
Usage This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, FFRA, to form the component name used by the Log and Trace Analyzer tool.
For example, if the adapter ID property is set to 001, the component ID is FFRA001.
If you run multiple instances of the same adapter, ensure that the first nine characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter.

For example, when you set the adapter ID property of two instances of WebSphere Adapter for Flat Files to 001 and 002. The component IDs for those instances, FFRA001 and FFRA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to FFRAInstance0.
For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized Yes
Bidi supported No

Disguise user data as "XXX" in log and trace files (HideConfidentialTrace)

This property specifies whether to replace user data in log and trace files with a string of X's to prevent unauthorized disclosure of potentially sensitive data.

Disguise user data as "XXX" in log and trace files details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files.
For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized No
Bidi supported No

Default target file name

The name of the file that is created in the output directory, or a WebSphere Application Server environment variable that represents this file.

Default target file name details
Required No
Default None
Property type String
Usage If a value for OutputFileName is specified in the record object, this value is overridden. You can use a WebSphere Application Server environment variable to represent the default target file name. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${OUTPUT_FILENAME}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported Yes

Generate a unique file

Specifies that the adapter creates a unique file during the Create operation.

Generate unique file property details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage During Create operations, if this property is set to True, the adapter creates a unique file and ignores any value set for the Filename property.
If a value is not specified for this property on the wrapper, then the value specified here is used.
Globalized Yes
Bidi supported No

Prefix for the unique file name

The prefix for the unique file name that you predefine for outbound operations.

Prefix for the unique file name details
Required No
Default None
Property type String
Usage You can define the prefix to be added when the adapter generates the unique file name during the outbound operations. The length of the prefix must be of minimum three letters.
For example, abc can be used as a predefined prefix for the unique file name.
If you do not specify the prefix, the adapter automatically adds the prefix ffa to the file name.
Globalized No
Bidi supported No

Output directory

The full path name of the directory where the adapter creates files during outbound operations, or a WebSphere Application Server environment variable that represents this directory.

Output directory details
Required No
Default None
Property type String
Usage The output directory is used by the adapter to write the final output files. You can use a WebSphere Application Server environment variable to represent the output directory. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${OUTPUT_DIRECTORY}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported Yes

Sequence file

This property specifies the full path name of the file where sequences are stored during outbound Create operations, or a WebSphere Application Server environment variable that represents this file.

Sequence file details
Required No
Default None
Property type String
Usage When the adapter receives a Create request, it checks the file sequence log to see whether a file with the specified name exists. If there is a file with that name, the adapter uses the file sequence number to create a file name.
For example, if the output file name in the request is Customer.txt, the adapter creates a file with the name Customer. n.txt, where n is the sequence number. If the output file name does not have an extension, the sequence is appended at the end of the file name; for example, Customer n. All sequences begin with 1.
If this property is not specified, and the adapter receives a request to create a file with a name that exists, the adapter generates a DuplicateRecordException error.
The sequence number continues to increment after an adapter restart. You can reset the file sequence by changing the sequence value in the sequence file.

If s :

To generate file sequencing for a particular request type, set the output directory and the file name at the managed connection level.
When the adapter is working in a clustered environment, make sure that the sequence file is on a mapped drive that is accessible by all the clusters. The adapter must have write permission for the sequence log file, or an IOException error is returned.
In Windowss, such as, Windows 7, Windows Vista, and Windows Server 2008, there are issues faced in the mapped drive connection. Due to this issue, in a clustered environment, where the nodes are running on different machines, the files in the mapped event directory might not be processed correctly during outbound operations. For more information about working with mapped drives, refer to articles on mapped drive connection to network sharing, for your operating system.
If the FileSequenceLog property is specified and the GenerateUniqueFile property is enabled, the GenerateUniqueFile property takes precedence over the FileSequenceLog property.
The directory path and file name, if specified in the business object, take precedence over the values specified at the managed connection level.

You can use a WebSphere Application Server environment variable to represent the sequence file. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${SEQUENCE_FILE}. See the topic on creating an environment variable in this documentation.
Important: Unless they are part of a cluster, two adapter instances must not use the same sequence file, because it might result in delayed processing of batch requests.
Globalized Yes
Bidi supported Yes

Staging directory

The full path name of the temporary directory where the adapter writes the initial output files for Create and Overwrite operations during outbound processing, or a WebSphere Application Server environment variable that represents this directory.

Staging directory details
Required No
Default None
Property type String
Usage If this property is specified, the output file is first written to a staging directory and then renamed to the output directory. The adapter temporarily stores the initial output files for Create and Overwrite operations in the staging directory to avoid write conflicts during outbound processing.
You can use a WebSphere Application Server environment variable to represent the staging directory. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${STAGING_DIRECTORY}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported Yes

Suffix for the unique file name

The prefix for the unique file name that you predefine for outbound operations.

Suffix for the unique file name details
Required No
Default None
Property type String
Usage You can define the suffix (file extension) to be added when the adapter generates the unique file name during the outbound operations.
If you do not specify the file extension, the adapter automatically adds the .tmp extension to the file name.
Globalized No
Bidi supported No

Outbound configuration properties

Related concepts:

WebSphere Application Server environment variables
Create the required local folders

Related tasks:

Defining WebSphere Application Server environment variables

Related reference:

Guide to information about properties
Connection properties for the wizard
Resource adapter properties
Interaction specification properties
Globalization
Activation specification properties

Property name	Description
In the wizard	In the Process Administrative Console
Adapter ID	AdapterID	Identifies the adapter instance for PMI events and for logging and tracing.
Default target file name	OutputFileName	Specifies the name of the file that is created in the output directory, or a WebSphere Application Server environment variable that represents this file.
Disguise user data as "XXX" in log and trace files	HideConfidentialTrace	Specifies whether to disguise potentially sensitive information by writing X strings instead of user data in the log and trace files.
Generate a unique file	GenerateUniqueFile	Specifies that the adapter creates a unique file during Create, Append, and Overwrite operations.
Prefix for the unique file name	uniqueFilePrefix	Specifies the predefined prefix that is added to the generated unique file name during outbound operations.
Output directory	OutputDirectory	Specifies the full path name of the directory where the adapter creates files during outbound operations, or a WebSphere Application Server environment variable that represents this directory.
Sequence file	FileSequenceLog	Specifies the full path name of the file where sequences are stored during outbound Create operations, or a WebSphere Application Server environment variable that represents this file.
Staging directory	StagingDirectory	The full path name of the temporary directory where the adapter writes the initial output files for Create and Overwrite operations during outbound processing, or a WebSphere Application Server environment variable that represents this directory.
Suffix for the unique file name	uniqueFileSuffix	Specifies the predefined suffix that is added to the generated unique file name during outbound operations.

Required	Yes
Default	001
Property type	String
Usage	This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, FFRA, to form the component name used by the Log and Trace Analyzer tool. For example, if the adapter ID property is set to 001, the component ID is FFRA001. If you run multiple instances of the same adapter, ensure that the first nine characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter. For example, when you set the adapter ID property of two instances of WebSphere Adapter for Flat Files to 001 and 002. The component IDs for those instances, FFRA001 and FFRA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to FFRAInstance0. For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized	Yes
Bidi supported	No

Required	No
Possible values	True False
Default	False
Property type	Boolean
Usage	If you set this property to True, the adapter replaces user data with a string of X's when writing to log and trace files. For inbound processing, the value of this property is set at the resource adapter level. For outbound processing, the value can be set both at the resource adapter level and the managed connection factory level. After you use the external service wizard to configure the adapter for outbound processing, you can set the resource adapter and managed connection factory properties independently. If you use the IBM Integration Designer assembly editor or the administrative console to reset these properties, ensure that you set them consistently, to prevent inconsistent marking of the log and trace entries.
Globalized	No
Bidi supported	No

Required	No
Default	None
Property type	String
Usage	If a value for OutputFileName is specified in the record object, this value is overridden. You can use a WebSphere Application Server environment variable to represent the default target file name. Specify the name of the environment variable in braces, preceded by a $ symbol. For example: ${OUTPUT_FILENAME}. See the topic on creating an environment variable in this documentation.
Globalized	Yes
Bidi supported	Yes