How to Connect to Flat File

Using Connector Xpress, input a Kettle transformation file, or a set of CSV files to define the attributes and associations between the elements. The output is the metadata file in the endpoint type which is used to generate the database structure in the cache based on the metadata.
imgc10-1-0
Using Connector Xpress, input a Kettle transformation file, or a set of CSV files to define the attributes and associations between the elements. The output is the metadata file in the endpoint type which is used to generate the database structure in the cache based on the metadata.
The following diagram shows the tasks that are required to connect to the endpoint, and who does each task.
Tasks for Connecting to the Endpoint
Tasks for Connecting to the Endpoint
To connect to a Flat File, perform the following steps:
Ensure that CA IAM CS Is Installed and Running
Check that CA IAM CS is installed and running.
CA IAM CS is installed with CA Identity Manager r12.6.5, unless you deselected the CA IAM CS option during installation. For details, search for Install CA IAM CS.
Install and Configure Connector Xpress
Ensure that you have installed Connector Xpress. 
Follow these steps:
  1. Start Connector Xpress, then follow these steps:
    1. Right-click Provisioning Servers in the right pane, then select Add Remote Server.
    2. In the Provisioning Server Details screen, specify the LDAP bind host and port for an on-premise connector server. Do not specify the host name and port for a Provisioning Server. 
    3. If you added a certificate to Connector Xpress previously, select Use TLS. 
      If you have not added a certificate yet, clear the Use TLS check box. Connector Xpress resets the port automatically.
    4. Complete additional fields as needed, then click OK. 
      Do not enter a value in the Tenant ID field. 
  2. If the Provisioning Server does not have a Connector Server configured, do the following tasks:
    1. Create a Connector Server configuration (see page 10).
    2. Set a managing Connector Server for the endpoint.
      The configuration determines how your Provisioning Server routes individual endpoints to Connector Servers.
  3. Enable the following roles:
    • Endpoint Manager
    • Provisioning Role Manager
    • Provisioning Role Membership Approver
    • Provisioning Synchronization Manager
  4. Set up the workflow for the task CreateEndpointTypeEvent:
    1. Map the SingleStepApproval workflow process.
    2. Set the approval task to Approve Endpoint Type Modification.
    3. Continue as for normal workflow setup.
  5. Repeat Step 4 for ModifyEndpointTypeEvent task.
  6. Repeat Step 4 for DeleteEndpointTypeEvent task.
    CA Secure Cloud includes notification email templates for the Create and Delete tasks. To see them, click System, Emails and search for *endpoint type*.
    There are two ports (non tls (ssl) and ssl) that a client can use to communicate with the standalone CA IAM CS.  To allow the Connector Xpress to access the standalone CA IAM CS, configure the firewall on your CA IAM CS server host to allow communication on these ports.
Create a Connector Server Configuration
To specify how your Provisioning Server routes endpoint types or individual endpoints to connector servers, you create a connector server configuration.
Follow these steps:
  1. Expand the server in the Provisioning Servers tree where you deployed your connectors.
  2. Right click on the CS Configs node and then select New CS Config.
    The Connector Server Configuration dialog appears.
  3. Complete the fields on the dialog, then click OK.
    You have added a connector server. You can now assign endpoint types and individual endpoints to a specific connector server.
Set Up Data Sources of CSV Type
A data source is a reference to schema-related information that Connector Xpress uses to map with a connector. You can connect to the data source to read its schema and then use Connector Xpress to map the schema to a new endpoint type.
When you create a Connector Xpress project, Connector Xpress prompts you to set up your data sources. 
Follow these steps:
  1. In Connector Xpress, click Tools, Data Sources.
  2. The Select Data Source for new Project dialog appears.
  3. Click Add.
    The Source Types dialog appears.
  4. Select CSV data source type from the list, then click OK.
    The Edit Source dialog appears, specific to the type of data source you are adding.
  5. Specify the data source details.
  6. (Optional) Click Test to verify your settings and authentication details.
  7. When the test has completed successfully, click OK.
    You have successfully configured the data source type you selected.
Create a Project
To create a connector, you can create projects that specify how connectors are configured and deployed to the Provisioning Server.
Follow these steps:
  1. Click Project, New.
    The Select Data Source for new Project dialog appears.
  2. Select the data source you want to use from the list, then click OK.
    The Enter Password for Data Source Dialog appears.
  3. Enter the password for the selected data source, then click OK.
    Connector Xpress does the following:
    • Displays a Mapping Tree containing a top-level Endpoint Type node. 
    • Creates a class named User Account by default in the Mapping Tree.
    • Displays the Endpoint Type Details dialog.
  4. Click Project, Save, or Save As.
    The Save Project As dialog appears.
  5. Specify the folder to save the connector project in, the file name and the file type for the saved connector, and click Save.
    Connector Xpress saves the project.
    We recommend that you use the default file extension (.con) and that you keep a copy of the project. You cannot view the stored procedure bindings after you deploy a connector, unless you open the Connector Xpress project file where your bindings are stored.
    Connector Xpress checks the name of the CSV file and information in it and creates a new project. Based on the information from the CSV file, it identifies the related classes, attributes, and its associations.
Create a Mapping to Create Endpoint Data
For more information about mapping attributes, classes, and associations, refer to the Connector Xpress section in the wiki.
When creating a CSV project from a prepared data source, Connector Xpress attempts to recognize the classes that are defined in the CSV files. Typically, only minimal corrections are required. If Connector Xpress does not recognize class or map correctly (such as a CSV file with group information representing account and class), provide full mapping.
This example shows the process to map an account class for a CSV data source.
Example: How you map an account class
To map an endpoint account class to the provisioning account class, an administrator would follow this process:
  1. Revise the native class to the provisioning mappings Connector Xpress made on the Mapped Classes dialog.
  2. Select account class in the left pane, and review the information in the Map Account Class dialog.
  3. If account class is mapped to an incorrect CSV file, select the proper file name from the drop-down list (File Name control).
  4. Review the field names, types, and content in Record Fields and Field Preview tables.
  5. Select the Attributes node under account node in the left pane, review attribute mapping, and make any required changes.
  6. Expand the Attributes tree in the left pane, and update individual attributes using the Attribute Details dialog. For example, change the attribute name, data type, and date format.
  7. Define direct and indirect associations as needed with the following steps: 
    Indirect Association is defined in a separate CSV file.
    1. Review the information in the Indirect Association dialog, and select the proper CSV file from the drop-down list.
    2. Select an attribute on the account, and select the corresponding field in the association file.
    3. Select an attribute in associated class, and select the corresponding field in the association file.
    4. Provide the names for new virtual attributes in the account class and associated class.
  8. Save the project.
Create an Endpoint Type
You can create an endpoint type using the loaded metadata.
You can only create an endpoint type when a Connector Xpress project is open.
Follow these steps:
  1. Open the Flat File project.
  2. In the Provisioning Servers tree, right-click the Endpoint Types node, then click Create new Endpoint Type.
    The Create New Endpoint Type dialog appears.
  3. Complete the fields on the dialog, then click OK.
    You have defined the name of your new endpoint type and added the endpoint type to the Endpoint Types node of the Provisioning Server you specified.
Set a Managing Connector Server from the Endpoint Type Node
You can select a connector server to manage a particular endpoint type or endpoint from the endpoint type node.
Follow these steps:
 
  1. In the Provisioning Servers tree, right-click the endpoint type you want to manage, then click Set Managing CS.
    The Select Connector Servers dialog appears.
  2. Select the Connector Server or Connector Servers from the list, then click OK.
    You have specified the Connector Server or Connector Servers you want to manage. Connector Xpress adds the endpoint type or endpoint to the managed branches of the selected Connector Servers.
Deploy the Connector
Once you have created a connector, you can deploy the metadata for that connector to a Provisioning Server.
This procedure assumes that you have created the connector server configuration.
Follow these steps:
  1. Open the existing project that contains the metadata you want to deploy.
    Connector Xpress opens the project and displays the metadata in the Edit pane of the Connector Xpress window.
  2. In the Provisioning Servers tree, expand the Provisioning Servers node and then choose the server where you want to deploy the connector.
    The Provisioning Server Password Required dialog appears.
  3. Complete the fields on the dialog to specify the password for the server, and click then OK.
  4. Expand the server, and then right-click Endpoint Types, then click Create New Endpoint Type.
    The Create New Endpoint Types dialog appears.
  5. Complete the fields on the dialog to define the name of your new endpoint type, then click OK.
    In some cases, a delay occurs before endpoint management screens are available. To check the status of the screen creation, use View Submitted Tasks in the User Console or configure a workflow process to send an email notification when the deployment completes. 
  6. Right-click on your new endpoint and select Acquire Endpoint.
    The Create New Endpoint dialog appears.
  7. Complete the fields on the dialog to specify the name and password for your new endpoint, then click OK.
  8. (Optional) Under the endpoints node, right-click on your new endpoint and select Explore/correlate Endpoint.
    The Explore/Correlate Endpoint dialog appears.
  9. Complete the fields on the dialog to specify how Connector Xpress explores and correlates the endpoint, then click OK.
    Connector Xpress deploys the connector to the Provisioning Server.
Explore and Correlate an Endpoint
After you deploy a connector, you can explore and correlate endpoint content in the Provisioning Manager.
Follow these steps:
  1. Log into the Provisioning Manager as an administrator.
  2. From the Endpoints drop-down menu, select an endpoint. 
  3. Under the endpoints node, right click on your new endpoint and select Explore/Correlate.
    The Explore and Correlate Endpoint dialog appears.
  4. Select the Explore endpoint for managed objects and Correlate accounts to global users check boxes.
  5. Select the Create global users as needed option and click Start.
  6. After the exploration completes, the Provisioning Manager displays the count of global users created.
  7. To view the global users created, select Users from the menu bar. 
  8. Right click on a user and click List Accounts.
    The List Accounts for Global User dialog appears. 
  9. Click Search. The account for the global user appears.
  10. Right-click on a user and click Properties.
    The User Account dialog appears, which shows the user and account details.
Connect to the Endpoint in CA Identity Manager or CA Secure Cloud
For the details about the following steps, search for the following topics based on the CA product:
  • For CA Secure Cloud and CA Identity Manager 12.6 releases, search for Integrating Managed Endpoints in the CA Identity Manager bookshelf.
  • For CA Identity Manager 12.5 releases, search for Managed Endpoint Accounts in the CA Identity Manager bookshelf.
Follow these steps:
  1. Set up the endpoint route:
    1. Log in to the User Console and navigate to Task, System, Manage Connector Server.
    2. Select the connector server entry to which you want to add a route.
    3. Right-click the connector entry and select Add Routes from the popup menu.
    4. Check the route or routes that you want to add, and click OK.
  2. Import the role definition file.
  3. Create correlation rules. 
  4. Select Flat File from the drop-down list box on Create a new endpoint of Endpoint Type, and click Ok.
  5. Add the endpoint to the environment. In the Endpoint tab, complete the following mandatory fields:
    • Endpoint Name
      Specifies the name of the new Flat File endpoint. The endpoint name is the name that appears in the Provisioning Manager. Commas and semi-colons are not allowed.
    • File Location
      Specifies the location of the input CSV file in the form of "file://" URL format or other supported formats.
    • User Name
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Password
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Domain
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Kettle Transformation File
      Specifies the location of the Kettle transformation file.
    • Kettle Parameters
      Specifies the Kettle transformation attributes. 
      The Kettle transformation file contains a set of parameters displayed as ‘${parameter_name}’. Actual values that replace such parameters during transformation can be added using the Kettle Parameters endpoint attribute. If not attributes are specified, default values are used.
      Kettle parameters may appear as default values in some endpoint attributes. For example, the parameter File Location may have the value ‘${csv_folder}’ when you create a new endpoint. In such cases, this value must be replaced with the actual value manually.
    • CSV File Encoding
      Specifies the encoding format for the CSV file.
    • File has changed
      Specifies that it triggers reloading of input CSV files manually. 
  6. In the Modification tab, complete the following fields:
    • Modify Support Enabled
      Lets you modify objects on a CSV endpoint. The modifications to these objects are stored in a database. To use the export and email notification options, you must select this check box. 
    • Export CSV files
      Schedule CSV files export. 
    • Export CSV log files
      Schedule export of CSV logs (journals).
    • Output Location
      Specifies output location in URL format. The omitted CSV files are dumped in the following default location:
      JCS_HOME/private/output/csv/endpoint_type/endpoint/
    • User Name
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Password
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Domain
      Credentials for access to CSV files. It is ignored in the case of file URL type.
    • Log from date/time
      Specifies the start date and time to log all changes. This field is active only when the Export CSV log files option is enabled.
    • Log to date/time
      Specifies end date and time to log all changes. This field is active only when the Export CSV log files option is enabled.
    • Export Files immediately
      Allows you to enable or disable dumping CSV files manually.
    • Schedule Export 
      Allows you to enable or disable scheduling of CSV import.
    • Cron Expression
      Specifies the cron expression to schedule CSV export. For example, "0 15 10 * * ? *" specifies that the CSV export occurs every day at 10:15 Hours.
    • Enable Email Notification
      Allows email notifications.
    • Email Address
      Separate multiple addresses with a comma. 
  7. In the High Availability tab, complete the following fields:
    • Database type
      Specifies the database type.
    • JDBC URL
      Specifies the location of the database in the URL form.
    • Username
      Specifies database credentials.
    • Password
      Specifies database credentials. 
  8. Click Submit.
  9. Create an explore and correlate definition. Explore and correlate the endpoint.