Copyright © Cloud Software Group, Inc. All Rights Reserved

Important Files and Locations

This section explains the important files for Fulfillment Provisioning and the locations in the system.

Log Files Summary

 

The following table shows the log files used by Fulfillment Provisioning and the information recorded in them. All the log files are found in the node directory.

Log file	Information recorded
cartAdmin.00000.log	This log file will receive all administration messages such as element creation / configuration / deletion, that is all operations or status changes that happen for factory, type, and instance.
cartOrderTracing.00000.log	This log file will receive all order traces, that is traces that are related to work orders, and published through order method from Session-Base.
coordinator.log	This is an engine log.
journal.0.log	This log file records events related to the loading of the cps.def and the cpr.def files.
kpsa.100.log	All messages through message service not defined in event dictionaries.
fp::fp.log	This is an engine log.
kpsaOrderTracing.00000.log	Generated by Fulfillment Provisioning (prov), traces all Fulfillment Provisioning orders activity (except cartridge ).
logs.00000.log	All messages from Fulfillment Provisioning not related to service orders (except cartridge).

trace.ini

 

The trace.ini file is found in the <node>/conf directory.

# kpsa Trace File Writer Configuration File
#
# $Revision: 1.1.2.13 $ $Date: 2011-04-21 12:47:55 $
# this cfg_name is used in provhead - so do not change cfg_name
# feel free to change the remaining non key config parameters
#
[ traceFileWriter : logservice::FileWriterConfig ]
cfg_name=orderTracing
cfg_fileCount=0
cfg_maxFileSize=10000
cfg_maxFileCount=0
cfg_maxFileTime=0
cfg_flushFrequency=100
cfg_outputDir=./

The following table describes the parameters that can be used in the trace.ini file.

parameter	Description
cfg_fileCount	A number optionally used in filename, and automatically incremented with each use. See FileWriterImpl::newFileName for a description on how the filename is constructed. The default value on creation is zero.
cfg_flushFrequency	Number of write calls made before the buffered data is written to the file system. It controls buffering of messages. A higher flushFrequency may improve overall performance. Default value on creation is 100 if no config file exists. If a zero is entered in the file, then the default value in the code is used.
cfg_maxFileCount	Maximum number of files that the filewriter will leave on the file system. If the count of files created, exceeds this count, the oldest file created by this FileWriter is deleted from the file system. A value of zero indicates no maximum will be enforced. The default value on creation is zero.
cfg_maxFileSize	Maximum file size in kilobytes. When appending a record if the file size exceeds maximum file size, the file is closed. The next write opens a new file. A value of zero indicates no maximum will be enforced. The default value on creation is zero.
cfg_maxFileTime	Maximum file time in seconds. When a file is opened, a recurring timer with frequency of the value contained in GFileTimerFrequency starts. When the accumulated time exceeds cfg_maxFileTime, the file is closed. The next write opens a new file. A value of zero indicates no maximum will be enforced. The default value on creation is zero.
cfg_name	Name of this FileWriter instance to which the configuration object refers. This is the primary key.
cfg_outputDir	Output directory for the FileWriter instance. The outputDir is prefixed to the name to fully specify the file. A directory separator is inserted, if needed. See FileWriterImpl::newFileName for a description of how the filename is constructed. Default value is "./".

config.ini

 

The config.ini file can be found in <node>/conf directory. If the config.ini file does not exist then the attribute, flowFile, uses a default value of ./conf/provisioning.bpmn. The attribute indicates which file will be loaded when Fulfillment Provisioning is started.

[ agent : prov::ProvAgent ]
flowFile=./conf/provisioning.bpmn

[ config : basesodata::Config ]
extraDatasetAllowed = 1
collectionNamingAlgo = CnaFast

fwriter.ini

 

The fwriter.ini file is used to configure the cartridge log files, cartAdmin*.log and cartOrderTracing*.log. If the fwriter.ini file does not exist, Fulfillment Provisioning uses the defaults listed in the following table.

parameter	Default Value
cfg_fileCount	Default value on creation is zero.
cfg_flushFrequency	Default value on creation is 1, meaning every write writes to the file system.
cfg_maxFileCount	The default value on creation is zero.
cfg_maxFileSize	The default value on creation is zero.
cfg_maxFileTime	The default value on creation is zero.
cfg_outputDir	Default value is "./".

cfg_fileCount

Number optionally used in file name, and automatically incremented with each use. For a description of how the filename is constructed, refer to the component documentation for FileWriterImpl?::newFileName.

cfg_flushFrequency

Number of write calls before the buffered data is written to the file system. It controls buffering of messages. A higher flushFrequency may improve overall performance.

cfg_maxFileCount

Maximum number of files that the Filewriter will leave on the file system. On creation, if a file would exceed this count, the oldest file created by the FileWriter is deleted from the file system. A value of zero indicates no maximum will be enforced.

cfg_maxFileSize

Maximum file size in KB. If the file size exceeds this size, the file is closed and a new file is opened. A value of zero indicates no maximum will be enforced.

cfg_maxFileTime

Maximum file time in seconds. When a file is opened, a recurring timer with frequency GFileTimerFrequency starts. When the accumulated time exceeds maxFileTime, the file is closed. The next write will open a new file. A value of zero indicates no maximum will be enforced.

cfg_outputDir

Output directory for this FileWriter instance. The outputDir is prefixed to the name to fully specify the file. See FileWriterImpl?::newFileName for a description of how the filename is constructed.

cartAdmin.xxxxxx.log

 

Generated by Cartridge, traces cartridge loading, configuration, and non-order related activity.

* Configurable in fwriter.ini file:

[ admin : logservice::FileWriterConfig ]
cfg_name = CART_AdminTopic
cfg_maxFileSize = 300000
cfg_maxFileTime = 300000
cfg_maxFileCount = 10
cfg_flushFrequency = 0
cfg_fileCount = 10

* Hardcoded values:
o cfg_name: "CART_AdminTopic"
o cfg_filenameFormat: "cartAdmin.%5C.log"
o cfg_writeFormat: "%D|%T|%M\n"

cartOrderTracing.xxxxx.log

 

Generated by Cartridge, traces all cartridge orders activity.

* Configurable in fwriter.ini file:

[ ordertracing : logservice::FileWriterConfig ]
cfg_name = CART_OrderTracingTopic
cfg_maxFileSize = 300000
cfg_maxFileTime = 300000
cfg_maxFileCount = 10
cfg_flushFrequency = 0
cfg_fileCount = 10

* Hardcoded values:
o cfg_name: "CART_OrderTracingTopic"
o cfg_filenameFormat: "cartOrderTracing.%5C.log"
o cfg_writeFormat: "%D|%T|%M\n"

journal.x.log

 

Generated by Fulfillment Provisioning Catalog, traces the catalog's loading and configuration.

* Configurable parameters:
o cfg_maxFileSize: (JournalMaxSize - KOP default value: 0)
o cfg_outputDir: (JournalPath - KOP default value: ./)

* Configuration instructions:
swnode setpm KOP/Application/KOP/JournalMaxSize=42
swnode setpm KOP/Application/KOP/JournalPath=/path/to/logs

* Hardcoded values:
o cfg_name: "KOPFileWriter"
o cfg_filenameFormat: "journal.%C.log"
o cfg_maxFileCount: 99
o cfg_messageFormat: "%D|%M\n"

kpsaOrderTracing.xxxxx.log

 

An example trace.ini file is shipped with the Fulfillment Provisioning release.

* Configurable in trace.ini file:

[ traceFileWriter : logservice::FileWriterConfig ]
cfg_name=orderTracing
cfg_fileCount=0
cfg_maxFileSize=10000
cfg_maxFileCount=0
cfg_maxFileTime=0
cfg_flushFrequency=0
cfg_outputDir=./

* Hardcoded values:
o cfg_name: "orderTracing"
o cfg_filenameFormat: "kpsaOrderTracing.%5C.log"
o cfg_writeFormat: "%D %T|%M\n"

kpsa.xxxxx.log

 

Generated by Fulfillment Provisioning (prov), traces Fulfillment Provisioning loading and all non-order related activity.

* Configurable in trace.ini file:

[ kpsa : logservice::FileWriterConfig ]
cfg_name=kpsaFileWriter
cfg_fileCount=
cfg_flushFrequency=
cfg_maxFileCount=
cfg_maxFileSize=
cfg_maxFileTime=
cfg_outputDir=

* Default values:
o cfg_fileCount: 100
o cfg_maxFileSize: 1000
o cfg_maxFileTime: 0

* Hardcoded values:
o cfg_name: "kpsaFileWriter"
o cfg_filenameFormat: "kpsa.%C.log"
o cfg_messageFormat: GWriteFormat

Copyright © Cloud Software Group, Inc. All Rights Reserved