This information applies to version 1.6.0.3

Creating a data source

As an administrator, you can use the data sources tool to create and configure a data source.

Before you begin

Ensure that your data source contains data in a format that can be received by the system, and that can be processed and updated as required. For more information about data source formats, see the Integrating with data sources section.

If you want to configure data sources that acquire data from an Esri server, you must set the value of the EnableEsriDatasource system property to true. If you want to configure data sources that acquire data from a secured Esri feature service, you must also import the certificate for either the ArcGIS server, or for ArcGIS Online. For more information, see the related links.

About this task

Fields that are marked with an asterisk in the data sources tool are always required.

You can specify translated text options for any field that contains text to be displayed as a label in the user interface. Enter the default text for the label. Then, enter text for any language that you require from the languages that are supported. The language that is displayed depends on the locale that is selected either in the user profile, or in the browser. If a language preference is set, the user profile setting overrides the browser language setting.

If you select the Common Alerting Protocol (CAP) as the format for acquiring data, you can specify that CAP messages that are received through the data source are displayed either on the geospatial map, or on the location map. The elements that are defined in the CAP specification are mapped to data source properties. Some data source options are preselected, and some data source properties are mapped to CAP elements automatically. You cannot change these automatic settings.

Procedure

For more information about the following steps, see the subsequent topics in the section.

  1. To access the data sources configuration tool, click Administration > Solution Administration > Configuration Tools > Data Sources.
  2. To create a data source, click Create.
  3. In the Create Data Source window, enter values for Data source label, and Data source unique text identifier. You cannot reuse the unique text identifier for any other data source.
  4. If you want the data source to be a boundary area, select Yes from the Boundary area list.
  5. Select a value from the Geometry list. The options that are displayed depend on the value that you selected for Boundary area. Also, the value that you select here affects the options that are displayed in the Acquisition method list.
  6. To specify whether you want to either map the properties yourself, or use a predefined mapping, such as CAP, select a value from the Data source definition list. The value that you choose affects the options that are displayed in the Acquisition method list.
  7. Choose a value from the Acquisition method list.
    If you chose User defined source to database mapping from the Data source definition list, the following options are displayed:
    Upload a CSV file
    In step 8, you will be prompted to browse to the location of the CSV file that you want to upload. The CSV file that you select is copied to the appropriate directory on the application server.
    Connect to a database
    In step 8, you will be prompted to enter the database type, host name or IP address, port, user ID, password, database name, and database table.
    Acquire data from an Esri server
    This option is displayed only if you have enabled Esri data sources. For more information about enabling Esri data sources, see the related link. In step 8, you will be prompted to enter the ArcGIS feature service URL. The ArcGIS feature service URL is the URL for your ArcGIS feature service.
    If you are using a secured ESRI feature service, for example, a service that must be accessed using either ArcGIS online credentials, or ArcServer credentials, then you must also enter an ArcGIS token service URL, a user ID, and a password. You use the ArcGIS token service URL to acquire the authentication token for accessing the ArcGIS server.
    • For a local ArcGIS server, the token service URL is similar to the following example: your_arcgis_server:port/arcgis/tokens/generateTokens.
    • For ArcGIS Online, the token server URL is similar to the following example: ArcGISOnlineURL/sharing/rest/generateToken.
    If you chose Predefined column mapping from the Data source definition list, one or more of the following options are displayed, depending on the other criteria that you selected:
    Common Alerting Protocol (CAP)
    To create a data source that receives CAP messages, select the appropriate option to be able to display the CAP messages either on the geospatial map, or on the location map.
    User interface entry
    To create a data source that can be used to create data items through either the maps, list, or REST API only, select one of these options. If you select one of these options, all the data source properties are preassigned. Use this option to quickly create new data items either on the maps, or in the list.
    • If you want to create data items on the geospatial map, select User interface entry for geospatial maps. The location for each data item is contained in a well-known text (WKT) format string.
    • If you want to create data items on the location map, select User interface entry for location maps. An area property is assigned to the data source.
  8. Choose the appropriate option depending on the value that you selected for Data source definition:
    • If you chose Predefined column mapping, click OK to save the data source, and go straight to step 11.
    • If you chose User-defined source to database mapping, click Next to go to Step 2 of 3: Connection Information, and then enter the appropriate information for your chosen acquisition method.
  9. Click Next to go to Step 3 of 3: Data Ingestion, and choose which properties you want to be imported into your data source. All the properties are selected by default.
  10. Click OK to save the data source.
  11. In the list of data sources, click the name of the data source that you created. Icons that are displayed next to the data source indicate whether data flow into the data source has been started.
    Red square
    When the icon is displayed next to the name of a data source, the icon indicates that data flow into the data source has not been started. You must configure one or more settings before data flow into the data source can be started.
    Green triangle
    When the icon is displayed next to the name of a data source, the icon indicates that data flow into the data source has been started. You can view data items from the data source, and add data items to the data source.
  12. On the Minimal Properties tab, configure the settings as appropriate. If you used any of the user-defined source to database mappings except for a database view connection, data flow into the data source is not started until you complete the settings on the Minimal Properties tab. However, if you used either a database view connection mapping, or any of the predefined column mappings, data flow is automatically started into the data source.
  13. Optional: Configure the settings on the Security, Routing, and Appearance tabs according to your requirements.
    Note: If you do not configure security for your data source, the default is that only you, the wpsadmin user, and the CityWideAdmin group, have access to view the data items.

Results

When a green triangle icon is displayed next to the name of the data source, data flow into the data source has been started.

What to do next

You can assign actions to data sources by using the component customization tool that is in the Solution Administration view. For more information, see the Customizing components section.

To enable data items to be displayed on a map, configure your data source for display in the filter in the Operations view. Click Configuration Tools > Filter. For more information about filter configuration options, see the link at the end of the topic.

This information applies to version 1.6 onlyThis information applies to version 1.6.0.1 onlyThis information applies to version 1.6.0.2

Creating a data source

As an administrator, you can use the data sources tool to add and configure a data source.

Before you begin

Ensure that your data source contains data in a format that can be received by the system and that can be processed and updated as required. For more information about data source formats, see the Integrating with data sources section.

About this task

In the data sources tool, the first four tabs only are mandatory for the creation of a data source. The remaining tabs are optional for the creation of a data source in the system and can be completed later. If you do decide to complete your data source configuration later, note the information at the end of step 11.

Fields that are marked with an asterisk in the data sources tool are always required. Defaults are provided by the system for most fields except for a few fields where user input is mandatory.

You can specify translated text options for any field that contains text to be displayed as a label in the user interface. Enter the default text for the label. Then, enter text for any language you require from the languages that are supported. The language that is displayed depends on the locale that is selected either in the user profile, or in the browser. If a language preference is set, the user profile setting overrides the browser language setting.

If you select the Common Alerting Protocol (CAP) as the format for acquiring data, you can specify that CAP messages that are received through the data source are displayed either on the geospatial map, or on the location map. The elements that are defined in the CAP specification are mapped to data source properties. Some data source options are preselected, and some data source properties are mapped to CAP elements automatically. You cannot change these automatic settings.

Procedure

For more information about the following steps, see the subsequent topics in the section.

  1. To access the data sources configuration tool, click Administration > Solution Administration > Configuration Tools > Data Sources.
  2. To start the data sources tool that guides you through the steps to create a data source, click Create.
  3. On the Acquire tab, choose one of the following data source acquisition methods, and enter the information that is required to connect to the data source.
    Upload a CSV file

    This information applies to version 1.6 onlyThis information applies to version 1.6.0.1 onlyFor the directory path, enter /opt/IBM/ioc/csv. Before you can upload a CSV file, you must copy the CSV file to the /opt/IBM/ioc/csv directory that is on the application server.

    Browse to the location of the CSV file that you want to upload. The CSV file that you select is copied to the appropriate directory on the application server.

    Connect to a database
    Enter either the host name or IP address, port, user ID, password, database name, and database table.
    Common Alerting Protocol (CAP)
    To create a data source that receives CAP messages, select the appropriate option to be able to display the CAP messages either on the geospatial map, or on the location map.
    User interface entry
    To create a data source that can be used to inject data items through either the maps, list, or REST API only, select one of these options. If you select one of these options, all the data source properties are preassigned. A data source is created that is not connected to an external source.
    • If you want to display injected data items on the geospatial map, select User interface entry for geospatial maps. The location is contained in a well-known text (WKT) format string.
    • If you want to display injected data items on the location map, select User interface entry for location maps. An area property is assigned to the data source.
  4. Click Next to go to the Basics tab.
  5. Supply the basic information that is required for your data source. You must enter a name and a unique identifier. A description is optional. Accept the defaults, or change the settings in the general information fields.
  6. Click Next to go to the Minimal Properties tab.
  7. In each of the minimal property fields, select a property from your data source to assign to the minimal property that is required by the system. Change the default settings as appropriate for your data source.
  8. Click Next to go to the Key & Full Properties tab.
  9. From your data source properties list, select the properties that you want to define as key properties. Define other property characteristics as appropriate for your data source.
  10. Complete the fields in the Property Details box as required, or accept the defaults.
  11. Optional: From the remaining tabs, select the fields that you want to change. You can provide input to fields on the following tabs.
    • Security
    • Routing
    • This information applies to version 1.6 onlyThis information applies to version 1.6.0.1 onlyActions
    • Appearance
    Note: If you do not configure security for your data source, the default is that only you have access to view the data items. If you select a point geometry format for your data source and you do not configure appearance, data items from your data source cannot be displayed in the user interface.

    You can assign actions to data sources by using the component customization tool that is in the Solution Administration view. For more information, see the Customizing components section.

  12. To add your data source to the solution, click OK.

Results

In the administration view, you can see the data source that you added on the list of data sources. This list is available for data source configuration and for filter panel configuration.

What to do next

You can update or complete the configuration of a data source later. To enable data items to be displayed on a map, configure your data source for display on the filter panel in the operations views. Click Configuration Tools > filter panel. For more information about filter panel configuration options, see the link at the end of the topic.