Create a search page

The fastest way to create a new search page in a feature module is to use the OneCX generator. Some projects have their own generator based on the OneCX generator. It should be clarified before starting if this is the case for the project the app is generated for.

To run the generator, execute the following command:

nx generate <namespaceOfTheGenerator>/nx-plugin:search <nameOfTheFeature> [--standalone]

  • <namespaceOfTheGenerator>: For the OneCX generator, use @onecx. For a project specific generator, ask for the namespace of the generators.

  • <nameOfTheFeature>: The name of the feature the search page should be created in, e.g., theme

Next, the CLI will ask you whether you want to customize names for the generation. When answering yes, the next few questions will ask you about names for the API. This can be useful if you want to adapt to a legacy API. When modifying names, assure that you use the same custom names for all generated components of the feature (search, details, create-update, delete) for the data object name, and the api service name as these are shared.

Options:

  • --standalone: if you want to develop an application that does not depend on onecx-services.

After running the generator, the following actions must be taken:

  1. Configure search criteria

  2. Configure search results

  3. Configure result diagram

  4. Update Header Actions

  5. Update permissions

  6. Check for further actions

  7. Commit the changes