Quick Guide¶
If you're already familiar with most of the steps involved in Base Server development, you can use this quick guide as a reference or entry point. Here you will also find links to more information about the steps that are part of the process.
Setup / Prerequisites¶
You need:
- An IFS Cloud development environment consisting of an application server and a database.
- IFS Developer Studio installed on your machine, you'll find it here.
Next thing you need to do is to create a development project in IFS Developer Studio. There are a couple of different project types depending on what type of development you will be engaging in (e.g. customization, localization, extension, or core). More information on how to set up projects in Developer Studio can be found here.
Development Process¶
- Create (or refine) a Model of type entity, enumeration or utility
- For an entity model, add attributes, code generation properties, associations, start and end state, etc.
- For an enumeration model, add enumeration values, code generation properties, etc.
- For a utility model, usually nothing needs to be added after creation.
- Generate code in order to get
- the implementation file (.plsql)
- the views file (.views)
- the database object file (.storage)
- the deployable files (.api/.apy).
- Generation can be done separately, but every time you save changes to the model, the generation starts automatically.
- Write implementation code
- Additional methods or changed behavior of a template generated method are written in the plsql file.
- Additional views or modifications of the generated view are written in the views file.
- Additional changes to the model are written in the Model file.
- Changes to the database are written in.upg file, .cdb file and storage file. The.cre file is generated from the model file and storage file. See Database Upgrade Scripts how to write.cdb and.upg.
-
Deploy the code to the database
- The deployable files (.api /.apy) are always regenerated in the deployment process before they are actually deployed.
- Make sure that the tables and indexes are deployed before the deployable files are deployed.
- Grant the presentation objects to a permission set and refresh the security cache.
-
Scan server messages and translate them by using the Translation Manager, refer to the Translation process.
- Scan source files (if not central scanning environment is used).
- Create field descriptions.
- Translate text and field descriptions (performed by translation agency).
- Create language and translation files.
- Deploy the language and translation files into the database. The files are not deployable as is, either you import them using IFS Solution Manager or you include and deploy them as a delivery using the IFS Cloud Installer.
- Test the code
- Use the context menu options Model Compliance Test and Static Code Analysis on the project in Developer Studio.
- Perform unit testing.
- Use the available Tracing and Diagnostics support.
- Test Performance.
- Verify support for Custom Objects and Fields. Entities not compatible with these framework functionalities should be added to the Exclude Logical Units from having Custom Fields list as described in section Supporting Custom Functionality.