testTransformScope

The "testTransformScope" property defines the behavior of this action. It is a required enumerated string with one of the following values:

  • "allRecords" returns immediately and creates a background thread that asynchronously creates a test table, copies all records to it, and runs the transform steps on all records in that table.
    • This option applies only to the "testIntegrationTableTransformSteps" action.
    • Once records are copied to the test table, it applies the transform steps.
    • You can stop this action by calling this action with "testTransformScope": "stop".
    • It regularly updates the "transformStatus" and the "transformPercentComplete" properties, which are returned by the "describeIntegrationTables" action.
    • If the test table's background thread is already running, the action returns an error indicating the "testIntegrationTableTransformSteps" action is already running on the integration table. The user can decide if he wants to wait or stop the action.
  • "stop" immediately stops the background thread assigned to the test table.
    • If no background thread is running, the action does nothing and returns an error.
    • The action may be stopped while it is creating the test table, copying records to the test table, or running transform steps on the test table's records.
    • It always deletes the test table because the action is incomplete. Otherwise, the action could leave the test table in an unexpected state, such as not being created, incompletely copying records, or incompletely transforming records.
  • "firstRecord" returns the first record's fields before and after being modified by the transform steps.
    • It returns two properties: "recordBeforeBeingTransformed" and "recordAferBeingTransformed".
    • It runs synchronously and does not change the record in the database.
    • You can repeatedly run this scope because it will not affect your data, does not interfere with the "rerunIntegrationTableTransformSteps" action, and does not interfere with the test table's background thread.
  • "lastRecord" returns the last record's fields before and after being modified by the transform steps.
    • It returns two properties: "recordBeforeBeingTransformed" and "recordAferBeingTransformed".
    • It runs synchronously and does not change the record in the database.
    • You can repeatedly run this scope because it will not affect your data, does not interfere with the "rerunIntegrationTableTransformSteps" action, and does not interfere with the test table's background thread.
  • "specificRecords" returns the specified record's fields before and after being modified by the transform steps.
    • Each record has an "id" field containing an integer number that uniquely identifies it. The action uses the "id" property to specify the ID number of the record.
    • It returns two properties for each record listed in the "ids" property: "recordBeforeBeingTransformed" and "recordAferBeingTransformed".
    • It runs synchronously and does not change the record in the database.
    • You can repeatedly run this scope because it will not affect your data, does not interfere with the "rerunIntegrationTableTransformSteps" action, and does not interfere with the test table's background thread.

The "logTransformOverwrites" property, when true, causes the action to log attempts by JavaScript to overwrite a field value.

Was this article helpful?

Give feedback about this article

Related Articles