F ACP Program Logs

The ACP log files are intended to tell the propagation story.

F.1 Verobse Log

The purpose of the verbose log is to provide information about specific changes made by ACP. The verbose log is produced only when the target data source is an Agile PLM instance. It logs the objects that are processed and reports the fields whose value has changed.

F.2 Console (stdout) Log

The purpose of the console output is to let you monitor the progress of ACP as it is running. ACP announces when it is starting and ending a configuration type. It also lets you know the status of processing for a single configuration type.

As each object of a configuration type is processed, ACP logs the name of the object to the console. Objects are processed in alphabetical order. The name of the object being processed provides a rough sense of the progress ACP has made on a single configuration type.

F.3 Anatomy of Console (stdout) Log

Item #	Description
1	Name of the ACP module running.
2	Version of ACP running.
3	Delete Objects Banner. This is the start of the Delete action processing.
4	Configuration Type. This is the name of the configuration type being processed within a program action (Delete, Rename, or Copy).
5	Not Configured. If the configuration type is not configured for the action being processed, the program reports that it is not configured.
6	Configuration Type Status: This is the action processing status for the configuration type. It will indicate if the processing "Completed" (no errors or warnings), ”Completed with warnings” (had warnings), or ”Completed with errors” had errors.
7	Delete Objects. Shows which object is currently being deleted.
8	Rename Objects Banner. This is the start of the Rename action processing.
9	Rename Objects. Shows which object is currently being renamed. It is also showing the name transformation.
10	Copy Objects Banner. This is the start of the Copy action processing.
11	Copy Objects. Shows which object is currently being copied. If it indicates "<Skipping>" before the name, this indicates that the object was not matched using the include/exclude patterns.
12	Program Completion Message. This is a human-readable message indicating if the program succeeded, failed, or completed with warnings.
13	Program Completion Code. This is the computer-readable equivalent to the Program Completion Message. Zero indicates the program completed with no errors or warnings. A positive number indicates the program completed with errors (and possibly warnings). A negative number indicates the program completed with warnings (and no errors).

F.4 Sample Console (stdout) Log

F.5 Error Log

The purpose of the error log is to provide detailed information regarding an error or warning reported by ACP.

Since ACP is not an interactive process, the error information must provide additional information in its error messages.

For instance, ACP provides process context. The process context provides information about which object was being processed when the error occurred. It may even provide more specific information about the object if ACP was currently processing subobject data for the object.

In addition to the process context, it tries to provide error context. The error context provides clues about exactly what ACP was trying to do at the time the error was encountered.

Finally, ACP provides the cause for the error. That is, it reports the error message reported to it. Sometimes the error message will come from the Agile PLM server and other times ACP will report an error itself.

F.5.1 Error Messages

This section lists FileLoad error messages you may encounter with applicable descriptions:

Attachment tab is invisible

Attachment tab of objects to which you want to add files is not active in Administrator. Attachment tab must be marked visible by Agile PLM administrator in Java Client.

Cannot find the file to be attached

Revise and correct the path and spelling of the attachment file name in the Index file entry. If you attached a URL, the supported protocols are FTP, HTTP, file, and HTTPS and there is no verification of the address.

Cannot find object <primary key>

The target object to receive the attachment cannot be located in the database. The object is the combination of the first three row fields: ObjectType, PrimaryKey, and SecondaryKey. Verify that the values for these fields are entered correctly in the Bad file and that an object of that name exists in the database. Add the object or modify the Index file as necessary.

Cannot find specified revision

The Item revision identifier in the Index file does not exist in the database, and Attach to latest revision was not selected in the FileLoad Options. Processing Attachments.

Cannot find the Index file or the Index file is empty

The path of the Index file is not correct (if you entered the Index file path manually) or the Index file you located is empty.

Cannot find the list value

All or some list values for flex List or Multilist fields are not valid.

Cannot perform this operation because the attachment is checked out

The file folder for the specified attachment is checked out, so the file is not uploaded. Make sure the file folder is checked in, and then use FileLoad again to upload the file.

Cannot perform this operation because the object <Object number> has been incorporated

The attachment table is read-only because the Item is incorporated by an ECO. To add attachments to incorporated Items, make sure Attach Files To Incorporated Items is checked in the FileLoad Options dialog box.

Failed to attach files

Reason for rejection unknown or the result of multiple errors. Make sure the object exists in the database, check the Index file entry, and retry. Ensure that you have the appropriate privileges.

Empty files are not valid to be added.

Attached files are 0 (zero) in size.

File Servers may be down. Please check the File Server Configuration

The Agile File Manager server is down. Go to the system where File Manager is installed and start it. On Windows, this involves starting the Apache Tomcat service.

Invalid date format

The date format in flex Date fields is not in accordance with the Date/Time formats in the user's profile.

Invalid number

The value for flex Numeric fields is not numeric (for example, it could include a letter string).

Invalid object type

Be sure the Index file row starts with a valid object type keyword. Object Type Keywords.

Invisible attribute fields

The specified flex field is not visible. Flex fields must be enabled (that is, made visible) in the Administrator panel.

Not a legal attachment type. Must be FILE or URL or INPLACE.

If you use FileLoad in Web Client, the AttachType (attachment type) field value must be FILE or URL. If you use FileLoad in Java Client, a third attachment type, INPLACE, is supported.

Number of fields provided is less than the minimum required.

Each Index file row must have at least six delimited fields. Empty fields must be marked by a double set of delimiter characters.

Note: When using the tab as the delimiter, be sure there is no tab after the last field in each row.

Primary Key (2nd) field empty

The second field - PrimaryKey - is always required. It must always contain, depending on the base class, a valid object number or name. Primary and Secondary Keys.

The attribute fieldname was not found in the Attachments tab.

This message indicates that the specified flex field name cannot be found. Flex fields must be enabled (that is, made visible) in the Administrator panel. Also, if the Attribute Name-Value separator in Index files is not correct, the field name cannot be properly identified.

The number length exceeds Maxlength.

The string length for flex Numeric fields exceeds the Maxlength defined in Administrator.

The number value is not between Min Value and Max Value.

The value for flex Numeric fields is not between Min Value and Max Value defined in Administrator.

The string length is not between 0 and Maxlength.

The string length for flex Text fields exceeds the Maxlength defined in Administrator

The user has insufficient privileges.

The user has insufficient privileges to attach files to objects.

Unable to connect to Agile Application Server.

Make sure the Application Server is running and you are logged in with the Checkin privilege.

F.5.2 Anatomy of the Error Log

Item #	Description
Header	Program name, version, and data sources.
1	Start of Error or Warning Message. Signifies the start of a single error or warning.
2	Process Context. The process context section provides clues about what object ACP was processing at the time of the error or warning.
3	Propagation Action, Configuration Type, Configuration Object Context. These three lines of process context provide all of the information you need to know exactly which object was being processed and which action was being performed.
4	Additional Context. Additional context will vary with each error or warning. It attempts to describe within an object what information ACP was working with.
5	Error or Warning Context. The error or warning context provides information about what ACP was doing at the time the error or warning occurred.
6	Error or Warning Cause. The error or warning cause is the specific message issued by the application at the point where the error or warning was detected.
7	End of Error or Warning Message. Signifies the end of a single error or warning.

F.5.3 Sample Error Log

F.6 Process Log

The purpose of the process log is to capture all of the information pertaining to processing.

All command-line parameters, program properties, and control file settings are written to the process log. This helps to validate the correctness of the settings in place.

As objects are processed, an entry is logged for the object along with the action taken by ACP and the result of the action.

Finally, the process log summarizes the processing in a set of statistics providing counts and also the amount of time it took to process.

F.6.1 Anatomy of the Process Log

Item #	Description
1	Start of Program banner. Signifies the start of a single run of ACP.
2	Name of the ACP module running.
3	Version of ACP running.
4	The date and time that the current run of ACP was started.
5	Program Properties Section. The properties are a means to influence the business logic that ACP uses regarding configuration types. The amount of influence on business logic varies by configuration type.
6	Control Setting Section. The configuration values specified in the control file.
7	Configuration Type Name. Each configuration type has its own subsection within the Control Setting Section.
8	File Prefix Setting. This is the file prefix used for the XML files generated by ACP export. The same prefix will be used by ACP import. ACP allows this setting to be configured; however, it should never need to be changed.
9	Objects Per File Setting. This is the number of objects ACP export will write to a single XML file for the configuration type. The default for all configuration types is 1000. Should you have a configuration type that exceeds 1000 and you want to write all of the objects to a single file, you can set the value in the control file.
10	Include Patterns: The list of include patterns configured for the configuration type. These are the regular expressions used to match the object names of the current configuration type.
11	Dependent Configuration Type. Some configuration types have dependent configuration types. The dependent configuration types exist to allow a configuration type to be processed in multiple passes. Typically, dependent configuration types will have the same name as the configuration type they depend on with a suffix such as ”(Associations)”.
12	Not Configured (Primary Configuration Type). If a configuration type is not configured to be propagated, then it is marked as not configured to make it clear that it is not being propagated.
13	Not Configured (Dependent Configuration Type). Dependent configuration types assume the same configuration information as the configuration type they depend on. If the primary configuration type is not configured, then neither will the dependent configuration type be configured.
14	Sub-object Mappings. Some configuration types allow for sub-object mappings. The sub-object mapping section shows what type of sub-object is being mapped, the name of the object whose sub-objects are being mapped and then the list of mappings.
15	Configuration Type Attributes. Some configuration types may have attributes in addition to the common attributes (file_prefix and objects_per_file). For example, lists have the case_sensitive_list_entries.
16	Exclude Patterns. The list of exclude patterns configured for the configuration type. These are the regular expressions used to match the object names of the current configuration type. If the object name matches an exclude pattern, ACP will skip the object.
17	Name Maps. The list of name mappings for the configuration type that ACP will use to rename objects in the target instance.
18	Delete Names. The list of objects for the configuration type to delete from the target instance.
19	Ignore Reference Patterns. Some configuration types allow ignore reference patterns to be specified. These patterns are used to quash error messages when an object with a name matching one of the patterns cannot be resolved.
20	Program Actions. The program actions section simply indicates which program actions are configured. The available actions are Copy, Rename, and Delete.
21	Configuration Type Detail. Each configuration type that is propagated has a detailed section showing the action taken for each object of that configuration type. The name of the configuration type is listed at the beginning of the section. Configuration types that have not been configured will not have a detail section. A separate configuration type detail section exists for each program action (Copy, Rename, and Delete) if configured.
22	Action. The actual action taken by ACP. Skipped - Was excluded by the include/exclude patterns specified. Created - The object is new in the target. Updated - The object already existed in the target. Renamed - The object's name has changed in the target. Deleted - The object has been deleted from the target.
23	Result. Indicates how the action performed. No Action Taken - The target object remains unchanged. Succeeded - The target object has been changed successfully. Warning - The target object has been changed successfully, but there were notes to be aware of. Failed - An error has occurred while processing the object. The object may or may not have been updated.
24	Configuration Object. The name of the configuration object being processed.
25	Pattern Matching Statistics. The pattern matching statistics help you understand how well your patterns (regular expressions) match the objects in the source instance.
26	Copy Statistics (also Rename Statistics and Delete Statistics). The copy statistics section summarizes the object processing for the configuration type. It is an easy way to find out how many objects were propagated and also the number of objects that are available to propagate.
27	No objects found. Indicates that no objects were found for the configuration type. This provides a clear statement to this effect rather than not having anything listed at all.
28	Error Messages. A brief description of error messages appear in the Process Log. Refer to the Error Log for more detailed information about errors.
29	End of Program banner. Signifies the end of a single run of ACP.

F.6.2 Sample Process Log