Skip to main content



Overriding RuleApp Endpoints at Runtime

Database Connection String​

note

Be sure to specify the ConnectionString override first.

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <ConnectionString>new connection string</ConnectionString>
                <OverrideType>DatabaseConnection</OverrideType>
                <Name>endpoint name</Name>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "ConnectionString": "new connection string",
        "OverrideType": "DatabaseConnection",
        "Name": "endpoint name"
      }
    ]
  }
}

Mail Server Connection​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>MailServerConnection</OverrideType>
                <Name>endpoint name</Name>
                <ServerAddress>mail server</ServerAddress>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "MailServerConnection",
        "Name": "endpoint name",
        "ServerAddress": "mail server"
      }
    ]
  }
}

Web Server Address​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>WebServiceAddress</OverrideType>
                <Name>endpoint name</Name>
                <ServiceUriOverride>mail server</ServiceUriOverride>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "WebServiceAddress",
        "Name": "endpoint name",
        "ServiceUriOverride": "mail server"
      }
    ]
  }
}

Web Service WSDL Uri​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>WebServiceWsdlUri</OverrideType>
                <Name>endpoint name</Name>
                <WsdlUri>wsdl uri</WsdlUri>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "WebServiceWsdlUri",
        "Name": "endpoint name",
        "WsdlUri": "wsdl uri"
      }
    ]
  }
}

Web Service MaxReceivedMessageSize​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>WebServiceMaxReceivedMessageSize</OverrideType>
                <Name>endpoint name</Name>
                <WebServiceMaxReceivedMessageSize>message size in
                    bytes
                </WebServiceMaxReceivedMessageSize>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "WebServiceMaxReceivedMessageSize",
        "Name": "endpoint name",
        "WebServiceMaxReceivedMessageSize": message
        size
        in
        bytes
      }
    ]
  }
}

XML Document Path​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>XmlDocumentPath</OverrideType>
                <Name>endpoint name</Name>
                <XmlPath>xml path</XmlPath>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "XmlDocumentPath",
        "Name": "endpoint name",
        "XmlPath": "xml path"
      }
    ]
  }
}

XML Schema​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>XmlSchema</OverrideType>
                <Name>endpoint name</Name>
                <XsdPath>xsd path</XsdPath>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

 {
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "XmlSchema",
        "Name": "endpoint name",
        "XsdPath": "xsd path"
      }
    ]
  }
}

XML Schema Validation​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>XmlSchemaValidation</OverrideType>
                <Name>endpoint name</Name>
                <EnableXsdValidation>true/false</EnableXsdValidation>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "XmlSchemaValidation",
        "Name": "endpoint name",
        "EnableXsdValidation": "true/false"
      }
    ]
  }
}

Inline Table​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>InlineTable</OverrideType>
                <Name>endpoint name</Name>
                <TableSettings>inline table</TableSettings>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "InlineTable",
        "Name": "endpoint name",
        "TableSettings": "inline table"
      }
    ]
  }
}

Inline XML Document​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>InlineXmlDocument</OverrideType>
                <Name>endpoint name</Name>
                <Settings>settings</Settings>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "InlineXmlDocument",
        "Name": "endpoint name",
        "Settings": "settings"
      }
    ]
  }
}

Inline Value List​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>InlineXmlDocument</OverrideType>
                <Name>endpoint name</Name>
                <Settings>settings</Settings>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "InlineXmlDocument",
        "Name": "endpoint name",
        "Settings": "settings"
      }
    ]
  }
}

SQL Query​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>SqlQuery</OverrideType>
                <Name>endpoint name</Name>
                <Query>query</Query>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "SqlQuery",
        "Name": "endpoint name",
        "Query": "query"
      }
    ]
  }
}

REST Service X.509 Certificate Path​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <OverrideType>RestServiceX509CertificatePath</OverrideType>
                <Name>endpoint name</Name>
                <RestServiceX509CertificatePassword>new connection string</RestServiceX509CertificatePassword>
                <RestServiceX509CertificatePath>new connection string</RestServiceX509CertificatePath>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "OverrideType": "RestServiceX509CertificatePath",
        "Name": "endpoint name",
        "RestServiceX509CertificatePassword": "certificate password",
        "RestServiceX509CertificatePath": "path to cert"
      }
    ]
  }
}

REST Service Authentication Type​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <AuthenticationType>None/Basic/NTLM/Kerberos/Custom</AuthenticationType>
                <Name>endpoint name</Name>
                <OverrideType>RestServiceAuthenticationType</OverrideType>
                <RestServiceDomain>domain</RestServiceDomain>
                <RestServicePassword>password</RestServicePassword>
                <RestServiceUserName>userName</RestServiceUserName>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "AuthenticationType": "None/Basic/NTLM/Kerberos/Custom",
        "Name": "endpoint name",
        "OverrideType": "RestServiceAuthenticationType",
        "RestServiceDomain": "domain",
        "RestServicePassword": "password",
        "RestServiceUserName": "userName"
      }
    ]
  }
}

REST Service Root URL​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <Name>endpoint name</Name>
                <OverrideType>RestServiceRootUrl</OverrideType>
                <RestServiceRootUrl>new url</RestServiceRootUrl>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "Name": "endpoint name",
        "OverrideType": "RestServiceRootUrl",
        "RestServiceRootUrl": "RestServiceRootUrl"
      }
    ]
  }
}

REST Service Allow Untrusted Certificate​

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <Name>endpoint name</Name>
                <OverrideType>RestServiceAllowUntrustedCertificates</OverrideType>
                <AllowUntrustedCertificates>true</AllowUnTrustedCertificates>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "Name": "endpoint name",
        "OverrideType": "RestServiceAllowUntrustedCertificates",
        "AllowUnTrustedCertificates": "true"
      }
    ]
  }
}

REST Operation URI Template

Sample XML​


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <Name>data element name</Name>
                <OverrideType>RestOperationUriTemplate</OverrideType>
                <RestServiceRootUrl>new uri template</RestServiceRootUrl>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "Name": "data element name",
        "OverrideType": "RestOperationUriTemplate",
        "RestServiceRootUrl": "new uri template"
      }
    ]
  }
}

REST Operation Body​

Sample XML


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <Name>data element name</Name>
                <OverrideType>RestOperationHeaders</OverrideType>
                <RestOperationHeaders>
                    <HttpHeader>
                        <HeaderName>header name1</HeaderName>
                        <HeaderValue>header value1</HeaderValue>
                    </HttpHeader>
                    <HttpHeader>
                        <HeaderName>header name2</HeaderName>
                        <HeaderValue>header value2</HeaderValue>
                    </HttpHeader>
                </RestOperationHeaders>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "Name": "data element name",
        "OverrideType": "RestOperationHeaders",
        "RestOperationHeaders": [
          {
            "HeaderName": "header name1",
            "HeaderValue": "header value1"
          },
          {
            "HeaderName": "header name2",
            "HeaderValue": "header value2"
          }
        ]
      }
    ]
  }
}

REST Operation Headers​

Sample XML


<Request>
    ...
    <RuleEngineServiceOptions>
        <Overrides>
            <Override>
                <Name>data element name</Name>
                <OverrideType>RestOperationBody</OverrideType>
                <RestServiceRootUrl>new body</RestServiceRootUrl>
            </Override>
        </Overrides>
        ...
    </RuleEngineServiceOptions>
    ...
</Request>

Sample JSON​

{
  "RuleEngineServiceOptions": {
    "Overrides": [
      {
        "Name": "data element name",
        "OverrideType": "RestOperationBody",
        "RestServiceRootUrl": "new body"
      }
    ]
  }
}