Create and link a config modifier

A config modifier contains custom instructions for processing data at an indicated stage of log processing. Learn about config modifiers.

Typically, a project manager or engineer will create and link any config modifiers during an implementation project with a new connection.

1. Log in to the Redox dashboard.
2. From the navigation menu, click the Logs page.
3. By default, the search bar and filters display, along with any logs from the last seven days. Use search terms, filters, or both to find a log from the subscription you want to link a config modifier to. Click the relevant log in the list.
4. The log details display on the right, which includes the log ID and the processing stages the log went through. Click the Log inspector button. You won't see this option if you're not assigned to an engineer or support role.
5. Log inspector runs and opens a new page with the source, destination, timestamp, and operation details (review operation types). Operations display in their sequential processing order.
6. Select the config modifier tab at the processing location you want to link a config modifier to. Review our linking recommendations.

   Available locations and number of config modifiers

   You can apply config modifier(s) to the locations your organization manages (i.e., source-managed or destination-managed tabs):

   • If you manage either the source or destination, you can apply config modifiers in up to two locations for async exchanges (i.e., either SEND or RECEIVE) or four locations for sync exchanges (i.e., REQUEST or RESPONSE, for both directions).
   • If you own both the source and destination, you can apply config modifiers in up to eight locations.

   In log inspector, you’ll see both source-managed and destination-managed tabs for config modifiers. These appear for each relevant processing stage.

   If you don't manage both sides of the exchange, you won't see tabs for processing locations if your connection hasn’t linked any config modifiers there. If they have, you’ll see the config modifiers they’ve created, but you won’t have permission to create config modifiers in their location.

   For example, let’s say your organization manages the source in a sync exchange. The destination organization has one or more config modifiers linked to the REQUEST stages. This means you’ll see six config modifier tabs for the four locations you manage and the two locations where the destination organization linked config modifiers.

7. Any existing config modifiers for that processing location display. Click the Create new button or Copy from existing option from the drop-down menu.

   No create option

   If you don't see the option to create a new config modiifer, it means your organization doesn't own that processing location. You may view config modifiers that your connection has created and linked. However, you won't be able to edit or create config modifiers for their processing location(s).

8. The Settings form opens. Fill out these fields:
   1. Name: Enter a human-friendly name for your config modifier.
   2. Subscription: This field is automatically populated with the subscription that the link relates to. If you didn't mean to link a config modifier for this subscription, click the Cancel button. Then find a log for the subscription you want to add a config modifier to.
   3. Flavor: Select the radio button for either Put or Delete. Remember that Put either writes new data or replaces existing data in a payload, while Delete removes specific parts of a payload.
   4. Selector: Enter the JSON path of the field the modifier should act on. Learn how to choose or write a selector.
   5. Event types: By default, all event types are selected. If you want to apply the config modifier only to certain event types, click the field and select the relevant event type(s).

      Available event types

      The available event type(s) are based on the log you're currently viewing in log inspector. All event type(s) of the related subscription's data model or FHIR® resource display in the drop-down list.

      If you didn't mean to link a config modifier for this subscription, click the Cancel button. Then find a log for the subscription you want to add a config modifier to.

      If you select an event type that doesn't include the log you're currently viewing in log inspector, a warning displays. You can still create the config modifier, but the warning lets you know that the config modifier won't actually apply to the selected log.

      Editing selected event types

      If you're editing the config modifier, you can click the X to remove an event type. However, if you remove all the selected event types, this field resets to the default of all event types selected.

   6. Schema: (only for Put flavors) Enter the set of keywords with instructions for what changes to make when applying the config modifier. Learn how to build a config modifier.
9. (Recommended) Click the Run log inspector button to preview the impact this new or edited config modifier would have on the selected log. Review the processing snapshots below to see what would change.
10. Once you're finished testing and previewing changes, click the Save button. This links the config modifier to the selected subscription and event type(s) for real-time traffic. If you click the Cancel button, any changes are discarded.
11. Repeat this process for any other config modifiers you want to create for this processing location. You can have multiple config modifiers for different paths at the same processing location. However, you can only create one config modifier per path.