Performing the Save As operation in text analyzer
Use the pxSaveAsTextAnalyzer API to save a text analyzer into a new class when creating a new IVA channel.
This API has the following input properties:
pxSaveAsTextAnalyzer API input properties
Parameter | Description |
Purpose | The text analyzer purpose. |
Description | The text analyzer description. |
AppliesTo | The applicable class of the text analyzer. |
ExistingRuleName | The name of the source text analyzer. |
ExistingRuleAppliesTo | The class of the source text analyzer. |
RuleSet | The target ruleset of the new text analyzer. |
RuleSetVersion | The target ruleset version of the new text analyzer. |
CopyModels | If set to true, the API checks whether the models in the text analyzer are accessible from the target Applies-To class. If not, the API copies the models together with the text analyzer. |
The following table presents how the pxSaveAsTextAnalyzer API behaves, based on various combinations of the source and target text analyzer class and the model class:
pxSaveAsTextAnalyzer API behavior in various scenarios
CopyModels setting | Source text analyzer class | Model class | Target class | Outcome |
true | Data-Decision-Request-Email | Data-Decision-Request | Data-Decision-Request-MCP | The model is not copied. |
true | Data-Decision-Request-Email | Data-Decision-Request-Email and Data-Decision-Request | Data-Decision-Request-MCP | The model is copied into the target class because it was specialized in the source class. |
true | Data-Decision-Request-Email | Data-Decision-Request-Email | Work- | The model is copied into the target class because the source model is not accessible from the target class. |
true | Data-Decision-Request-Email | Data-Decision-Request-Email | Data-Decision-Request-Email | The model is not copied because the source class and the destination class are the same. |
true | Data-Decision-Request-Email | Data-Decision-Request-Email | Data-Decision-Request-MCP (a model with the same name is already present) | The model is not copied because a model with the same name already exists in the target class. |
true | Data-Decision-Request | Data-Decision-Request | Data-Decision-Request-Email | The model is not copied because the target class is a child class of the parent. |
true | Data-Decision-Request-Email | Data-Decision-Request and Data-Decision-Request-Email | Data-Decision-Request-MCP | The Save As operation completes successfully but the target rule refers to a model from the Data-Decision-Request class. |
true | Data-Decision-Request-Email | Data-Decision-Request-Email | Work- | The Save As operation fails because the target rule is unable to find the model. |
Previous topic Configuring text analyzers Next topic Running text analyzers