Reasons to modify configuration files

There are several reasons you might need to modify configuration fields.

Generating endpoints for custom entities

The REST endpoint generator is a tool that generates CRUD endpoints for custom data model entities. The REST endpoint generator also creates schema definition files for the resources used by the generated endpoints. However, these files are incomplete. Developers must always add to the generated configuration in the resource definition files.

For more information on the REST endpoint generator, see The REST endpoint generator.

Extending base configuration resources

Cloud API has endpoints that perform CRUD operations on several data model entities in the base configuration. For example, the GET /common/v1/activities endpoint queries for instances of the Activity data model entity. Insurers can extend these data model entities by adding custom fields. Insurers may also want to expose these fields to the REST endpoints. Insurers can configure schema definition files and resource files to add custom resource properties that map to custom data model fields.

To extend a base configuration resource:

  1. If necessary, extend the underlying data model entity with new fields. For more information, see Configuration Guide.
  2. Configure the appropriate schema, mapping, and updater extension files. For more information, see Adding scalars, Adding compound datatypes, Adding foreign keys, and Adding one-to-ones.
  3. Add attributes to define additional property behaviors, if necessary. For more information, see Modifying endpoint behaviors.

Exposing base configuration fields to Cloud API

For the data model entities that are exposed in Cloud API, the base configuration does not expose every field in a given entity to Cloud API. There may be situations where you need to expose one or more of these fields to Cloud API.

For example, the User data model entity is exposed to Cloud API. The VacationStatus field is also exposed. But, the ExperienceLevel field is not. An insurer may want to expose the ExperienceLevel field to Cloud API.

The approach for doing this follows the same process as extending a base configuration resource. There are only two differences:

  • There is no need to extend the data model as the field in question already exists.
  • Guidewire recommends appending "_Ext" to the schema property name to avoid potential conflicts in future releases.

Integration graphs

Cloud API schemas are used to define the integration graphs used by Guidewire App Events . An integration graph is a data model graph that defines a set of business information to be sent to an external application as part of outbound integrations. For example, the Claim graph defines what information to send about a claim. Insurers may want to extend Cloud API schemas to ensure that certain information is included in the integration graph.

For more information on integration graphs, see Integration graphs and the App Events Guide.