Set up config modifiers

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 modifier, 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 or copy the JSON path to define the scope of the config modifier schema and point to 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) Test your changes.
   1. Click the Test changes button to preview the impact this new config modifier would have on the selected log. Review the processing snapshots below to see what would change.

      
   2. Click the Run log inspector button to re-run all the operations in this log to see how the config modifier works with all the operations in a log.

      
10. Once you’re finished testing and previewing changes, click the Create button. In a production environment, a confirmation modal appears. Click the Apply button. This links the config modifier to the selected subscription and event type(s) for real-time traffic.

    One link per config modifier

    You can only link a config modifier once. However, if you want to re-use the config modifier settings or schema, you can always copy from an existing config modifier to create a new one.

    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.

Whenever you edit, you create a new version of the config modifier. You may want to promote or restore versions, in case of troubleshooting.

1. Within log inspector, click the config modifiers tab at the processing location you want to edit.
2. The processing snapshots and details display. To edit the config modifier, click the three-dots icon to the right of the config modifier name.
3. From the drop-down menu, select the Edit option.
4. The Settings form opens. Edit any of the fields.

   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.

   
5. (Recommended) Test your changes.
   1. Click the Test changes button to preview the impact the edits would have on the selected log. Review the processing snapshots below to see what would change.

      
   2. Click the Run log inspector button to re-run all the operations in this log to see how the config modifier works with all the operations in a log.

      
6. Once you’re finished testing and previewing changes, click the Apply button. In a production environment, a confirmation modal appears. Click the Apply button. This immediately applies the edited config modifier to the selected subscription and event type(s) for real-time traffic. If you click the Cancel button, any changes are discarded.

   
7. This creates a new version of the config modifier. If you’re editing a staging asset, you may need to re-promote to production.

Follow these instructions to review all the config modifiers in your environment at once.

1. Log in to the Redox dashboard.
2. From the side nav menu, click the Operations drop-down.
3. The Operations options expand. Click the Config modifiers option.

   
4. All existing config modifiers in the environment display.

   
   1. (Optional) Use the filters at the top of the page to narrow down the list of config modifiers.
      1. Name: Type in a config modifier’s name into the search bar.
      2. Connection: Pick from the list of available connections.
      3. Data model: Pick from the list of data models and FHIR® resources. You can only pick one data model or resource at a time.
      4. Source + destination: Pick from the list of source and destination combinations. This is useful if you’re searching for a specific config modifier link.

         Result tips

         These are AND filters, so all populated filters apply to the search.

         You can share the list of results with other users in the organization by sharing the URL of the page. The URL updates based on the applied filters, so the user you share with will see the same view you do.

         
   2. (Optional) Use the environment drop-down in the side nav menu to see config modifiers in different environments.

      
5. Click on a config modifier row to view more details.
6. The Settings page opens. Review the selector path, flavor, created date and user, updated date and user, and link. Remember that a config modifier can only have one link.
7. To review the config modifier in context of log inspector or to edit, click the link to open the Logs page with pre-selected filters applied.

   Default to all event types

   You might have a config modifier with a link to only one event type. When you open the Logs page, the log filters automatically default to all event types. This means you might see logs without the given config modifier linked to it, so you may need to filter more specifically to find the right log.

   

1. Follow the instructions for viewing existing config modifiers.
2. From the list of existing config modifiers, click on the config modifier you want to delete.
3. The Settings page opens. Click the Delete button.

   Can’t delete a linked config modifier

   You can’t delete a config modifier that’s linked to a subscription. The Delete button is grayed out if there are any active links.

   Make sure to delete any links first to delete a config modifier.

1. Follow the instructions for viewing existing config modifiers.
2. From the list of existing config modifiers, click on the config modifier with links you want to review or manage.
3. The Settings page opens. Under the Links section, an existing link will display or you can add a link.

   Only one link allowed

   You can only have one link per config modifier. To add a new link, you have to delete the existing link.

   1. To view an existing link in context, click the link to open related logs.
   2. To delete an existing link, click the Delete icon to the right of the subscription. A modal opens to confirm that you want to proceed. Click the Delete button to continue or the Cancel button to discard the changes.
   3. To add a new link, select a connection from the Connection drop-down.
      1. Next, click the Select subscription link.
      2. A modal opens with the available subscriptions for the selected connection. Use the Search field or the Connection drop-down to narrow down the available options. If needed, use the page options at the bottom of the modal to navigate through the pages. Then select the radio button of the subscription you want to link the config modifier to.
      3. Click the Select Subscription button.

After testing in staging, you can promote a config modifier to production. Learn about promoting assets.

1. Log in to the Redox dashboard.
2. From the Environments drop-down, select the Staging environment.

   
3. From the side nav menu, click the Operations drop-down.
4. The Operations options expand. Click the Config modifiers option.

   
5. All existing config modifiers in the environment display. Click on the config modifier you want to promote.
6. The Settings page opens. Click the Promote button.
7. A modal appears to let you know you’re exiting the staging environment and proceeding to the production environment. Click the Proceed button. Otherwise, click the Cancel button to discard the promotion.
8. The Settings page in the production environment opens.
   1. To make any changes to the config modifier, click the Edit button.
   2. The config modifier settings page opens in the staging environment. Open the logs for that config modifier, then follow the instructions to edit a config modifier.

      No edit button

      Config modifiers can only be edited within log inspector. This means you won’t see an Edit button on the settings page in the staging environment; instead, you have to open logs related to the config modifier to begin editing.

   3. Once changes are successfully made, re-promote the config modifier to keep the assets in sync across environments.
9. Next, add link(s) to subscriptions to apply the config modifier in your production environment.

You can restore a version of a config modifier that’s not currently in use. This may be helpful when troubleshooting to see where an error may have been introduced or to resolve an error by using a version that worked previously.

1. Follow the instructions for viewing existing config modifiers.
2. From the list of existing config modifiers, click on the config modifier you want to update.
3. The Settings page opens. Click the Restore button.
4. A modal appears to restore a version. From the drop-down, select a version to restore.

   Restore notes

   Restoring means activating a version that’s not in use. That means you can go backwards or forwards a version. However, you can’t restore a version that’s already in use.

5. The diff view renders to show what’s different between the current and selected version. Review the differences. When finished, click the Restore button.

   Versions after editing

   If you edit the config modifier after restoring a previously used version, a new version is created.

   For example, let’s say you were on version 3 and you restore version 2. Then you make and save edits to version 2. This creates version 4 of the config modifier. At that point, you can still restore to version 3 at any time.

6. For promoted assets, restoring a version only applies to the current environment. If you restore a version in staging, you may need to re-promote the asset if you want to apply it to production as well.