Trax .NET
View as MarkdownEdit on GitHub

Reference

operations: effect mutations

Package Trax.Api.GraphQLSurface GraphQL schemaSource OperationsMutations.cs

Fields of OperationsMutations that change the effects registered in the API process.

setEffectEnabled

Turns an observational effect on or off in the API process, through IEffectSettingsService.SetEffectEnabled in Trax.Scheduler, the call the operations console's Effects page makes. The change is in memory: it does not reach the scheduler or worker processes where trains usually run, and a restart restores the configured state.

mutation {
  operations {
    setEffectEnabled(
      fullName: "Trax.Effect.Provider.Json.Services.JsonEffectFactory.JsonEffectProviderFactory"
      enabled: false
    ) {
      success
      count
      message
    }
  }
}
ParameterTypeRequiredDescription
fullNameString!YesThe effect factory's full type name, as operations.effects reports it in fullName. Matched exactly.
enabledBoolean!Yestrue to turn the effect on, false to turn it off

Returns: OperationResponse. success is false, and nothing changes, when no effect has that name, the effect was registered as not toggleable, or the host registers no effect registry. On success count is 1.

configureEffect

Writes settings of a configurable effect in the API process, through IEffectSettingsService.ConfigureEffect in Trax.Scheduler, the call the dashboard's Configure dialog makes. effects lists each effect's fields: their names, how each is edited and what to type. Send only the settings you change; a setting not listed is not written, so a change made elsewhere to it is kept.

mutation {
  operations {
    configureEffect(
      fullName: "Trax.Effect.Provider.Parameter.Services.ParameterEffectProviderFactory.ParameterEffectProviderFactory"
      values: [
        { name: "SaveOutputs", value: "false" }
        { name: "MaxParameterBytes", value: null }
      ]
    ) {
      success
      count
      message
      errors { field message }
    }
  }
}
ParameterTypeRequiredDescription
fullNameString!YesThe effect factory's full type name, as effects reports it. Matched exactly
values[EffectSettingValueInput!]!Yes1 to 1000 { name: String!, value: String }, each setting at most once

Each value is text read as the setting's type: numbers in invariant culture with . for the decimal point and no thousands separators, a date or time with no offset as UTC, a boolean as true or false, an enum by member name. Null or blank is no value for a setting that accepts null, the empty string for a text setting that does not, and refused for anything else. A SET_IN_CODE setting cannot be written. A [TraxSensitive] setting can be written, though it is never read back.

It is all or nothing: every value is read and checked against the setting's validation attributes before any is written, and when one is refused, or a setter throws part way, nothing is written.

Returns: ConfigureEffectResponse:

FieldTypeDescription
successBoolean!Whether the settings were written
countInt!How many settings were written; 0 on failure
messageString!One line for an operator
errors[EffectSettingError!]!{ field, message } for each refused setting: no such setting, set in code, given twice, not readable as its type, or failing its validation. Empty on success, and on a failure that is not one setting's, such as an unknown effect or one with no settings

The change is in memory and applies to the next run in this process. It does not reach the scheduler or worker processes where trains usually run, and a restart restores the configured settings.

See also