Best Practices for SuiteCloud Developer Assistant
The following best practices are intended to help minimize errors and enhance the quality of results you receive from SuiteCloud Developer Assistant. Keep in mind that these best practices may not completely prevent inaccuracies or hallucinations from large language models (LLMs).
Security and Compliance
Never share sensitive credentials
Don't include passwords, private keys, internal company details, or other sensitive data in prompts to the SuiteCloud Developer Assistant.
Authentication ID management
Store authentication IDs (auth IDs) securely and never share them in chat, code comments, or public repositories.
VPN and firewall
Always follow your company's security guidelines when connecting to AI tools.
Incident response
Immediately report security incidents, data exposure, or suspected issues using Oracle incident reporting channels.
Don't use the Administrator role for automation or integration
Never use the Administrator or any full-privilege role for routine automation, API integration, or tool access. Instead, assign only the minimum privileges required for these tasks. Only grant access to features, integrations, and tools that are necessary for current business or development needs. Regularly review and reduce permissions as applicable.
Verify extension versions
Ensure the SuiteCloud Developer Assistant, SuiteCloud, and Cline extensions are up to date and sourced from authorized repositories.
Prompt Quality and Usage
Be specific in prompts
Clearly describe what you need (for example, script type, SDF custom object names, and expected error-handling). Specificity improves code quality and accuracy.
Iterate on unclear outputs
If generated content isn't accurate, refine your prompt for clarity or context and submit it again.
Include project context
Provide context (for example, SuiteCloud Development Framework (SDF) structure) so the assistant can better tailor its responses.
Validate generated code
Always review and test code or configuration output before using it in a production environment or sharing with a team.
Intended use and limitations
Use the SuiteCloud Developer Assistant feature only for its intended business or development purposes. Don't attempt to use it for any activity that is unethical, illegal, or outside the defined project or organizational scope. Be aware that dangerous or inappropriate prompts are blocked by the system, and there may be usage limits in place to ensure responsible and secure use.
Code and Solution Quality
Adhere to best practices
Ensure the generated SuiteScript or SDF XML follows Oracle coding conventions and architectural principles.
Unit testing
Test all generated objects, scripts, or changes in a test environment before deploying them to a production environment.
Documentation
Accompany generated code with necessary comments and documentation (including how the code works and why it works the way it does).
Version control
Commit all generated artifacts to version control systems following organizational branch and environment naming guidelines to avoid accidental overwriting.
Ensure careful review before deployment
Never deploy assistant-generated code directly to a production environment. Always review and get code peer-reviewed where possible.
Life cycle security
Maintain and update security practices throughout the entire software life cycle, from layout to deployment and maintenance.
Logging and traceability
Ensure all automation, integration, and AI tool actions are logged, including who, what, and when, to support traceability and accountability.
Integration and Configuration
Auth ID alignment
Create and use appropriate auth IDs for each environment (for example, test, sandbox, and production).
Change default ports carefully
When changing ports (to resolve conflicts), communicate with your team and document the new configuration.
Monitor service status
Regularly check extension status in Visual Studio Code, check logs for errors, and resolve promptly.
Troubleshooting and Support
Use official docs and support
Reference the official documentation in the Help Center for help and updates.
Error states
If you encounter an issue, follow the provided troubleshooting steps. Check the extension settings, Cline settings, and NetSuite prerequisites.
Feedback mechanism
If you identify bugs, inaccuracies, or missing capabilities, submit feedback as outlined. For more information, see Providing Feedback.
Continuous Learning and Feedback
Stay informed
Attend training sessions, read update notes, and participate in feedback cycles as SuiteCloud Developer Assistant evolves.
Collaboration
Share your experience and prompt strategies with peers to build a collective knowledge base of effective usage patterns.
Review official documentation and release notes
Always consult the latest official documentation and release notes before starting work to ensure you are informed about current features, updates, and important changes.
Unit Testing Best Practices
Review and refine generated tests
Always read and understand the generated tests. Update the tests for accuracy and completeness.
Validate test coverage
Use code coverage tools to verify that generated tests adequately cover business logic, including edge and error cases.
Maintain test readability
Edit automated tests for clear names, structure, and comments. Treat them as you would handwritten tests.
Check for sensitive information
Ensure the tool does not insert hardcoded credentials, PII, or confidential business data in any test code, mock or test data.
Refine prompts for better results
Provide clear, detailed prompts (including example inputs and outputs, as well as requirements) to help the SuiteCloud Developer Assistant generate higher-quality tests.
Keep tests up to date
If production code changes, revisit and regenerate tests as needed, then review changes for correctness.
Peer review generated tests
Whenever possible, treat AI-generated tests like any other code. Subject them to peer review for correctness and security.
Ensure thorough review before deployment
Never use AI-generated tests to validate production deployments without human review.
Adhere to Oracle policies
Ensure that your use of the SuiteCloud Developer Assistant complies with Oracle's security, privacy, and compliance guidelines.