To interact with Prevedere® as part of a chain, such as to retrieve predictive analytics or import client data, add a command using a Prevedere connector.
To enable these commands, an IT admin first creates a Prevedere connector.
Get client dimensions
To retrieve a list of dimensions, add a Get Client Dimensions command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Dimensions | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get correlation
To retrieve a correlation between leading and fixed indicators, add a Get Correlation command.
Properties
| Property | Detail |
|---|---|
| Fixed provider | Enter the name or ID of the fixed provider to include in the correlation. If an ID, also check Fixed provider by ID?. |
| Fixed provider By ID? | If Fixed provider is an ID, check this box. |
| Fixed provider ID | Enter the ID of the provider to use within Fixed provider. |
| Leading provider | Enter the name or ID of the leading provider to include in the correlation. If an ID, also check Leading provider by ID?. |
| Leading provider By ID? | If Leading provider is an ID, check this box. |
| Leading provider ID | Enter the ID of the provider to use within Leading provider. |
| Calculation | Select the calculation to use with the correlation. |
| Frequency | Select the frequency of the correlation. |
Outputs
| Output | Output type |
|---|---|
| Correlation | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get forecast models
To retrieve a list of forecast models, add a Get Forecast Models command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Forecast models | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get forecast risk
To retrieve a forecast risk for a model, add a Get Forecast Risk command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve a forecast risk for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the forecast to. |
Outputs
| Output | Output type |
|---|---|
| Forecast risk | File |
Exit Codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get forecast risk growth
To retrieve a forecast risk growth for a model, add a Get Forecast Risk Growth command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve a forecast risk growth for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the forecast to. |
Outputs
| Output | Output type |
|---|---|
| Forecast risk growth | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get forecast statistics
To retrieve forecast statistics for a model, add a Get Forecast Statistics command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve forecast statistics for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the forecast to. |
Outputs
| Output | Output type |
|---|---|
| Forecast statistics | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get forecast by model
To retrieve a forecast for a model, add a Get Forecast by Model command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve a forecast for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the forecast to. |
Outputs
| Output | Output type |
|---|---|
| Forecast | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get Indicator
To retrieve an indicator for a provider, add a Get Indicator command.
Properties
| Property | Detail |
|---|---|
| Provider | Enter the name or ID of the provider to retrieve an indicator for. If an ID, also check Provider by ID?. |
| Provider by ID? | If Provider is an ID, check this box. |
| Provider ID | Enter the ID of the provider to use within Provider. |
Outputs
| Output | Output type |
|---|---|
| Indicator | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get indicator series
To retrieve an indicator series for a provider, add a Get Indicator Series command.
Properties
| Property | Detail |
|---|---|
| Provider | Enter the name or ID of the provider to retrieve an indicator series for. If an ID, also check Provider by ID?. |
| Provider by ID? | If Provider is an ID, check this box. |
| Provider ID | Enter the ID of the provider to use within Provider. |
| Calculation | Select the calculation to use with the indicator series. |
| Frequency | Select the frequency of the indicator series. |
| Start date | Enter the start date of the series. |
| End date | Enter the end date of the series. |
| Offset | Enter the offset to apply to the series. |
Outputs
| Output | Output type |
|---|---|
| Indicator series | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get Model Contribution
To retrieve a model's contribution, add a Get Model Contribution command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve a contribution for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the contribution to. |
Outputs
| Output | Output type |
|---|---|
| Model contribution | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get Model Impact
To retrieve a model's impact, add a Get Model Impact command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve an impact for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the impact to. |
Outputs
| Output | Output type |
|---|---|
| Model impact | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get providers
To retrieve a list of providers, add a Get Providers command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Providers | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Get raw model
To retrieve raw model data, add a Get Raw Model command.
Properties
| Property | Detail |
|---|---|
| Model | Enter the name or ID of the model to retrieve the raw data for. If an ID, also check By ID?. |
| By ID? | If Model is an ID, check this box. |
| As of date | Enter the date to scope the raw model to. |
| Use frequency | To use the frequency in the raw model, check this box. |
| Exclude indicators | To exclude indicators from the raw model, check this box. |
Outputs
| Output | Output type |
|---|---|
| Raw model | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Import client data
To import a comma-separated values (CSV) file of client data into a dimension group, add an Import Client Data command.
Properties
| Property | Detail |
|---|---|
| Dimension group | Enter the name or ID of the dimension group to import the data into. If an ID, also check By ID?. |
| By ID? | If Dimension Group is an ID, check this box. |
| Delete existing data? | To delete any existing client data from the dimension group upon import, check this box. |
| Replace existing data? | To replace any existing client data that matches imported data, check this box. |
| Data | Upload a CSV with the client records to import. |
Outputs
| Output | Output type |
|---|---|
| Success | String |
| Message | String |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |
Validate client data
To validate client data before an import, add a Validate Client Data command.
Properties
| Property | Detail |
|---|---|
| Dimension group | Enter the name or ID of the dimension group to validate the data for. If an ID, also check By ID?. |
| By ID? | If Dimension group is an ID, check this box. |
| Delete existing data? | To delete any existing client data from the dimension group upon import, check this box. |
| Replace existing data? | To replace any existing client data that matches imported data, check this box. |
| Data | Upload a CSV with the client records to validate. |
Outputs
| Output | Output type |
|---|---|
| Success | String |
| Message | String |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | There was an error executing the command |
| 2 | Error | Error authenticating |