POtoFile
Use this component to send a purchase order or other textual data to a file.
Intended use: Order Processing pipeline, Purchase Order Submit or Accept stage.
Configuration Values
You can determine where the POtoFile component retrieves the document and where it writes the result by setting component properties. Use the following boxes on the PO to File tab of the Component Properties dialog box to determine this information.
Box |
Description |
|---|---|
Source Field Name |
The name of the field on the order from which the component reads the purchase order data. The default is po_text. |
File Name |
The full path of the file the component writes the purchase order to. To locate the file, click Browse. |
File named in field |
The name of the field in the Order dictionary whose value is the name of the file the component writes the purchase order to; for example, save_filename. |
Temporary file, name saved in field |
Specifies that the component should save the text to a temporary file, and then save the name of the temporary file in the field that is identified in the text box. For example, saved_filename. |
Append to file instead of overwriting file |
When checked, indicates that the text should be appended to the indicated file. Otherwise, the file is overwritten if it exists. |
Values Read
The POtoFile component reads the value specified by the key in the Order dictionary indicated in the Source Field Name box.
Values Written
None.
Remarks
The File Name, File named in field, and Temporary file boxes are mutually exclusive; that is, you can select only one of the three.
Programmatic Use
To use this component outside a pipeline, you must configure it by assigning values to keys in the Configuration dictionary. The keys correspond to the indicated boxes in the Component Properties dialog box.
Key |
Box |
Description |
|---|---|---|
SourceFieldName |
Source Field Name |
String. |
SaveMode |
N/A |
Numeric. 0 for file name given; 1 for file name comes from SourceFieldName. |
FixedSaveFileName |
File Name |
String. |
SaveFileFieldName |
File name in field |
String. |
TempFileFieldName |
Temporary file, name saved in field |
String. |
IsAppendToFile |
Append to file instead of overwriting file |
Numeric. 0 for overwriting; 1 to append. |