Maintainability Best Practices

Best Practice

Step to perform

Image Link

Standardize Data Formats:

Satndard Formats: Use widely accepted EDI standards (e.g., EDIFACT, X12) to ensure compatibility and ease of integration.
Document and standardize data formats and codes to avoid inconsistencies.

1. Verify the EDI File from the EDI schema Testing Option.

2. Under EDI>EDI layout> Edit the Schema > Test

Regularly Update EDI Maps and Schemas

Maps and Schemas: Keep EDI maps and schemas up-to-date with any changes in business processes or trading partner requirements.
Implement a version control system to track changes and manage different versions of maps and schemas.

1. Updating the Maps through Configure>Data Transformation>Data Mapping.

2. For Updating Schemas Configure>EDI >EDI layouts

Implement Robust Testing Procedures:

Test Procedures: Establish a comprehensive testing framework for new mappings, transactions, and partner integrations.

1. Conduct regular regression testing to ensure that updates do not disrupt existing processes.

2. It will Include Unit Testing,Regression Testind and Fuctional testing.

NA

Manage Trading Partner Relationships:

Partners Configuration: Keep an updated list of trading partners and their contact information.
Regularly review and validate trading partner agreements and data exchange protocols.

1. Partner>Add/Edit Partner.

2. Validate the EDI Configuration Setting.

Modular and Reusable Components:

Templates: Utilize templates within Adeptia to standardize the structure and logic of EDI transactions. Templates can streamline development, enforce consistency, and simplify maintenance across multiple transactions.

1. Develop templates for standardizing EDI transaction structures and processing logic.

2. Ensure templates include necessary mappings, validations, and transformations applicable to your specific EDI requirements.

Base Map Creation:This is particularly useful for ensuring consistency, reducing redundancy, and simplifying maintenance efforts.
It is suggested that we can reuse the Same Map if the validations and the Layouts are same for different partners , In simple term we can say that we can re utilize the same Map again and again if needed.
Design EDI maps that can be reused across multiple trading partners and transactions to minimize redundancy and streamline maintenance.

1. Develop Base Map from Configure>Data Transformation>Data Mapping.

2. Create a Mapping with the Name Base Map.

3. Use the Base Map for Other mapping from the Import Map Option Under Mapping Development.

NA

Version Control

Versioning: Implement version control for EDI configurations, including mappings, Process, and integration rules. Adeptia typically supports versioning to track changes, manage updates, and revert to previous configurations if needed.

Define naming conventions and documentation practices to clearly identify versions and changes.

NA

Error Handling and Monitoring:

Error Management:Define error handling workflows to manage exceptions, retries, and notifications for failed transactions.

1. Go to the dashborard section in Adeptia.

2. Go to refernece section you can see the error msg

3. Check the emails notifications to be sent to relevant stakeholders

NA

Monitoring: Regularly monitor transaction logs, performance metrics, and error reports to identify potential issues or bottlenecks.

1. Log in to Adeptia and navigate to the dashboard section.

2. .Select Accordingly for X12 or Edifact.
   3.Arrange the dashboard layout to highlight the most critical information