FAQs: Best Practices Validator Utility

Owned by Rajeev Rai
Sept 10, 2024
2 min read

  1. What is the Best Practices Validator Utility?

    • The Best Practices Validator Utility is a tool designed to enforce best practices across various operational domains, including file events, FTP events, naming conventions, and transactions. It validates configurations and logs the results for review.

  2. How do I download and set up the Best Practices Validator Utility?

    • You can download the utility from the provided link. After downloading, extract the BestPractices.zip file. The folder will contain the necessary components, such as the configuration properties file and the BestPracticeUtility.jar file.

  3. What are the key objectives of the Validator Utility?

    • The key objectives include ensuring compliance with standards, optimizing system performance, providing comprehensive validation, and enabling proactive error detection.

  4. How do I configure the Properties file for the utility?

    • Modify the configuration.properties file to set parameters such as customer information, username, password, and domain URL or IP. This setup is crucial for the utility to authenticate and perform validations.

  5. What types of validation can the utility perform?

    • The utility can validate several aspects including:

      • File Event Validation

      • FTP Event Validation

      • Naming Convention Validation

      • Transaction Validation

  6. How do I execute the Best Practices Validator Utility?

    • Open the Command Prompt, navigate to the folder containing the BestPracticeUtility.jar file, and run the command java -jar BestPracticeUtility.jar. Ensure Java is installed and properly set in the system's environment variables.

  7. Can I execute the utility from Adeptia's JRE Bin Folder?

    • Yes, for users running Adeptia, you can execute the utility from Adeptia’s JRE bin folder using a specific command for optimized performance.

  8. Where can I find the validation results?

    • After execution, the utility generates an Excel report containing the validation results. This file will be located in the same folder where the utility was executed.

  9. What configurations should I set for File Event Validation?

    • You need to set RUN_FOR_FILE_EVENT_VALIDATION to TRUE and configure other options such as polling frequency, event expiry date/time, and receiver email IDs.

  10. How can I ensure that my FTP event configurations adhere to best practices?

    • Set RUN_FOR_FTP_EVENT_VALIDATION to TRUE and define parameters like polling frequency and stable time to ensure proper validation.

  11. How does the utility check for naming convention compliance?

    • The utility checks if the naming conventions of different entities comply with best practices by setting RUN_FOR_NAMING_CONVENTION to TRUE and specifying any excluded entities or project names.

  12. What transaction settings does the utility validate?

    • The utility validates settings such as logging level, repository action, and log retention actions, ensuring transactions are configured according to best practices.