Edit the agent.xml file with the following configuration changesWithin the <task> tag, nest the following directives with your choice of how you want to save your records: All Records in One File One Record per File Records to Multiple Files
All Records in One FileIf you want to save all records in one file, use the following directives: Directive | Example | Use | Required? |
---|
<handler> | <handler>com.perspectium.replicator.file.XMLFileSubscriber</handler> File Type | Value |
---|
CSV | com.perspectium.replicator.file.CSVFileSubscriber | JSON | com.perspectium.replicator.file.JSONFileSubscriber | XML | com.perspectium.replicator.file.XMLFileSubscriber |
| The name of the file handler class | Yes | <file_name> | <file_name>records.csv</file_name> | The name of the file to which you want to save the records | Yes | <files_directory> | For Linux: <files_directory>/Downloads/subscribefiles</files_directory> For Windows: <files_directory>Users\Downloads\subscribefiles</files_directory> | The directory that contains the file of the saved records | Yes | <buffered_writes> | <buffered_writes>250</buffered_writes>
| A number of records to buffer before writing to file (to improve performance and not write to the file upon reading each record) | No | <exclude_xml_header> | | For use with the XMLFileSubscriber handler, this will only output the xml header tag (i.e. <?xml version=“1.0” encoding=“UTF-8”?>) once at the top of the file. That way you can treat the entire file as one XML file with multiple elements for parsing.
For example, with this configuration, the file will be: <?xml version=“1.0” encoding=“UTF-8”?> <incident></incident> <incident></incident> <cmdb_ci></cmdb_ci>
versus <?xml version=“1.0” encoding=“UTF-8”?><incident></incident> <?xml version=“1.0” encoding=“UTF-8”?><incident></incident> <?xml version=“1.0” encoding=“UTF-8”?><cmdb_ci></cmdb_ci> | No |
One Record Per File If you want to save one record per file, use the following directives: Directive | Example | Use | Required? |
---|
<handler> | <handler>com.perspectium.replicator.file.XMLFileSubscriber</handler> File Type | Value |
---|
CSV | com.perspectium.replicator.file.CSVFileSubscriber | JSON | com.perspectium.replicator.file.JSONFileSubscriber | XML | com.perspectium.replicator.file.XMLFileSubscriber |
| The name of the file handler class | Yes | <one_record_per_file> | | This directive will tell the agent to save each record into its own file instead of saving all records together in a single file. | Yes | <files_directory> | For Linux: <files_directory>/Downloads/subscribefiles</files_directory> For Windows: <files_directory>Users\Downloads\subscribefiles</files_directory>
| The directory that contains the file of the saved records | Yes | <file_prefix> | <file_prefix>record</file_prefix> | A prefix for the file name of each record. If this directive is not specified, “psp.replicator.” will be used as the prefix. | No | <file_suffix> | <file_suffix>.xml</file_suffix>
| A suffix for the file name of each record. If this directive is not specified, “.xml” will be used as the suffix. | No | <translate_newline> | <translate_newline>nbsp</translate_newline>
| This directive will replace record content newline entries with a non-breaking space. | No |
Anchor |
---|
| multiple_file |
---|
| multiple_file |
---|
|
Records to Multiple FilesIf you want to save your records to multiple files, use the following directives: Directive | Example | Use | Required? |
---|
<handler> | <handler>com.perspectium.replicator.file.XMLFileSubscriber</handler> File Type | Value |
---|
CSV | com.perspectium.replicator.file.CSVFileSubscriber | JSON | com.perspectium.replicator.file.JSONFileSubscriber | XML | com.perspectium.replicator.file.XMLFileSubscriber |
| The name of the file handler class | Yes | <buffered_writes> | <buffered_writes>250</buffered_writes>
| A number of records to buffer before writing to file (to improve performance and not write to the file upon reading each record) | Yes | <files_directory> | For Linux: <files_directory>/Downloads/subscribefiles</files_directory> For Windows: <files_directory>Users\Downloads\subscribefiles</files_directory>
| The directory that contains the file of the saved records | Yes | <file_prefix> | <file_prefix>record</file_prefix>
NOTE: Use the value $table_$d{yyyyMMdd}_$i to set a dynamic prefix value where yyyyMMdd can be modified to different date format. Code Block |
---|
| <file_prefix>$table_$d{yyyyMMdd}_$i</file_prefix> |
| A prefix for the file name of each record. If this directive is not specified, “psp.replicator.” will be used as the prefix. | No | <file_suffix> | <file_suffix>.xml</file_suffix> File Type | Value |
---|
CSV | .csv | JSON | .json | XML | .xml |
| A suffix for the file name of each record. If this directive is not specified, “.xml” will be used as the suffix. | No | <separate_files> | <separate<separate_files>table</separate_files> | Indicates that the files will be separated by table. | Yes | <enable_audit_log/> | <enable_audit_log/> | A self-closing directive that will generate an audit file. The audit file has information about when the records are processed, name of the file, and number of records processed. Audit files will be created in the directory as specified with the <files_directory> directive and saved in the format of: audit_<tablename>_<timestamp>.json Where <tablename> is the name of table that this audit file contains logs for (such as incident) and <timestamp> is the timestamp format as specified in <file_prefix>. If not timestamp is specified, then it uses the default format of yyyy-MM-dd_HHmmss. | No | <translate_newline> | <translate_newline>%13<newline>%13</translate_newline> NOTE: This is a required directive for JSON files. | This directive will replace record content newline entries with the value you input. | Varies
|
|