CreateVisionData
The Oracle Communications Unified Assurance Create Vision Data application creates custom layers or entities in Vision. You can configure it to read data from an API request, input file, or SQL query. The application processes the input data through a set of rules and sends it to Vision to create a custom layers or entities.
You can run this application as a scheduled job using the Jobs UI.
Create Vision Data Setup
There are two default jobs for the Create Vision Data application: Create Vision Custom Layer and Create Vision Entities. You can enable the default jobs on the presentation servers, or create custom ones.
See Jobs in Unified Assurance User's Guide for information about the UI for creating and enabling jobs.
Create Vision Custom Layer Scheduled Job
The following table shows the settings for the default Create Vision Custom Layer job. Actual values are in bold, descriptions of values are in plaintext.
| Field | Value |
|---|---|
| Package | vision-app |
| Name | Create Vision Custom Layer |
| Program | bin/core/vision/CreateVisionData |
| Arguments | This field is blank. There is no default value. |
| Description | Create Custom Layer in Vision |
| Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
| Status | Disabled |
| Privileged | This option is not selected. |
| Minutes | 5 |
| Hours | * |
| Days | * |
| Months | * |
| WeekDays | * |
See Jobs in Unified Assurance User's Guide for general information about the settings for jobs.
See Using Application Primary/Backup Failover for more information about the different failover types.
Create Vision Custom Layer Configuration
The following table shows the settings for the default Create Vision Custom Layer job. Actual values are in bold, descriptions of values are in plaintext.
| Name | Value | Possible Values | Notes |
|---|---|---|---|
| BaseRules | vision/custom/base.rules | Text, 255 characters | The relative path to the Vision custom layer Base Rules file. |
| BranchDir | core/default | Text, 255 characters | The relative path to the rules directory. |
| IncludeRules | vision/custom/base.includes | Text, 255 characters | The relative path to the Vision custom layer Include Rules file. |
| LoadRules | vision/custom/base.load | Text, 255 characters | The relative path to the Vision custom layer Load Rules file. |
| LogFile | logs/CreateCustomLayer.log | Text, 255 characters | The relative path to the log file. |
| LogLevel | ERROR | OFF, FATAL, ERROR, WARN, INFO, DEBUG | The logging level for the application. |
| VisionEndpoint | Custom | Custom, Entities | The type of data to create in Vision. |
| VisionBundleCert | etc/ssl/BundleCA.crt | Text, 255 characters | The path to the BundleCA certificate. Used in conjunction with VisionUserCert and VisionUserKey to authenticate with Vision. |
| VisionUserCert | etc/ssl/User-api.crt | Text, 255 characters | The path to the User certificate. Used in conjunction with VisionBundleCert and VisionUserKey to authenticate with Vision. |
| VisionUserKey | etc/ssl/User-api.key | Text, 255 characters | The path to the User key file. Used in conjunction with VisionBundleCert and VisionUserCert to authenticate with Vision. |
| LayerName | Unified Assurance Devices | Text, 255 characters | The name of the custom layer to create in Vision. |
| RefreshRate | 300 | An integer | The refresh rate for the custom layer in Vision. |
| Host | This field is blank. There is no default value. | Text, 255 characters | (Optional) The hostname for Vision. Defaults to WebFQDN for installation. |
| Port | This field is blank. There is no default value. | An integer | (Optional) The port for Vision. |
| SourceType | This field is blank. There is no default value. | CSV, JSON, XML | (Optional) The data type returned by the source. Defaults to JSON for API requests and to CSV for file input. |
| URL | This field is blank. There is no default value. | Text, 255 characters | (Optional) The web address of the data source (API). |
| Key | This field is blank. There is no default value. | Text, 255 characters | (Optional) A comma-separated path of keys for data in JSON or XML response file. |
| SourceUser | This field is blank. There is no default value. | Text, 255 characters | (Optional) The username for the data source. Used in conjunction with URL and SourcePassword to authenticate with source. |
| SourcePassword | This field is blank. There is no default value. | Text, 255 characters | (Optional) The password for the data source. Used in conjunction with URL and SourceUser to authenticate with source. |
| SSLBundleCert | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the BundleCA certificate. Used in conjunction with URL, SSLUserCert, and SSLUserKey to authenticate with the source. |
| SSLUserCert | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the User certificate. Used in conjunction with URL, SSLBundleCert, and SSLUserKey to authenticate with the source. |
| SSLUserKey | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the User key file. Used in conjunction with URL, SSLBundleCert, and SSLUserCert to authenticate with the source. |
| File | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the input file. |
| DelimiterFile | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the file containing a delimiter. The default delimiter is , (comma). Used to set the delimiter to use with the input file. |
| SelectSQLFile | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path, relative to BranchDir, to the Select SQL file. |
| SourceSchemaName | This field is blank. There is no default value. | Text, 255 characters | (Optional) The database schema name to connect to. If not specified, the default of Assure1 is used. |
Create Vision Entities Scheduled Job
The following table shows the settings for the default Create Vision Entities job. Actual values are in bold, descriptions of values are in plaintext.
| Field | Value |
|---|---|
| Package | vision-app |
| Name | Create Vision Entities |
| Program | bin/core/vision/CreateVisionData |
| Arguments | This field is blank. There is no default value. |
| Description | Create/synchronize Devices from Unified Assurance with Entities in Vision |
| Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
| Status | Disabled |
| Privileged | This option is not selected. |
| Minutes | 0 |
| Hours | 3 |
| Days | * |
| Months | * |
| WeekDays | * |
See Jobs in Unified Assurance User's Guide for general information about the settings for jobs.
See Using Application Primary/Backup Failover for more information about the different failover types.
Create Vision Entities Configuration
The following table shows the settings for the default Create Vision Entities job. Actual values are in bold, descriptions of values are in plaintext.
| Name | Value | Possible Values | Notes |
|---|---|---|---|
| BaseRules | vision/entities/base.rules | Text, 255 characters | The relative path to the Vision entities Base Rules file. |
| BranchDir | core/default | Text, 255 characters | The relative path to the rules directory. |
| IncludeRules | vision/entities/base.includes | Text, 255 characters | The relative path to the Vision entities Include Rules file. |
| LoadRules | vision/entities/base.load | Text, 255 characters | The relative path to the Vision entities Load Rules file. |
| LogFile | logs/CreateEntities.log | Text, 255 characters | The relative path to the log file. |
| LogLevel | ERROR | OFF, FATAL, ERROR, WARN, INFO, DEBUG | The logging level for the application. |
| VisionEndpoint | Entities | Custom or Entities | The type of data to create in Vision. |
| VisionBundleCert | etc/ssl/BundleCA.crt | Text, 255 characters | The path to the BundleCA certificate. Used in conjunction with VisionUserCert and VisionUserKey to authenticate with Vision. |
| VisionUserCert | etc/ssl/User-api.crt | Text, 255 characters | The path to the User certificate. Used in conjunction with VisionBundleCert and VisionUserKey to authenticate with Vision. |
| VisionUserKey | etc/ssl/User-api.key | Text, 255 characters | The path to the User key file. Used in conjunction with VisionBundleCert and VisionUserCert to authenticate with Vision. |
| Host | This field is blank. There is no default value. | Text, 255 characters | (Optional) The hostname for Vision. Defaults to WebFQDN for installation. |
| Port | This field is blank. There is no default value. | An integer | (Optional) The port for Vision. |
| SourceType | This field is blank. There is no default value. | CSV, JSON, or XML | (Optional) The data type returned by the source. Defaults to JSON for API requests and to CSV for file input. |
| URL | This field is blank. There is no default value. | Text, 255 characters | (Optional) The web address of the data source (API). |
| Key | This field is blank. There is no default value. | Text, 255 characters | (Optional) A comma-separated path of keys for data in JSON or XML response file. |
| SourceUser | This field is blank. There is no default value. | Text, 255 characters | (Optional) The username for the data source. Used in conjunction with URL and SourcePassword to authenticate with source. |
| SourcePassword | This field is blank. There is no default value. | Text, 255 characters | (Optional) The password for the data source. Used in conjunction with URL and SourceUser to authenticate with source. |
| SSLBundleCert | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the BundleCA certificate. Used in conjunction with URL, SSLUserCert, and SSLUserKey to authenticate with the source. |
| SSLUserCert | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the User certificate. Used in conjunction with URL, SSLBundleCert, and SSLUserKey to authenticate with the source. |
| SSLUserKey | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the User key file. Used in conjunction with URL, SSLBundleCert, and SSLUserCert to authenticate with the source. |
| File | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the input file. |
| DelimiterFile | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path to the file containing a delimiter. The default delimiter is , (comma). Used to set the delimiter to use with the input file. |
| SelectSQLFile | This field is blank. There is no default value. | Text, 255 characters | (Optional) The path, relative to BranchDir, to the Select SQL file. |
| SourceSchemaName | This field is blank. There is no default value. | Text, 255 characters | (Optional) The database schema name to connect to. If not specified, the default of Assure1 is used. |
About Vision Data Rules
This application uses the Unified Assurance standard rules architecture in Perl syntax. For information about creating rules, see the following in Unified Assurance Developer's Guide:
-
Core for information about core rules functions.
-
Metrics for information about metric rules functions.
Administration Details
The following list shows the technical details you will need for advanced administration of the application:
-
Package: vision-app
-
Synopsis:
./CreateVisionData [OPTIONS] -
Options:
-c, --ComponentID N ComponentID -i, --Insecure Set where source API uses unsigned certificate -?, -h, --Help Print usage and exit -
Threaded: Single Threaded