Difference between revisions of "PE-GPR/9.0.0/Help/cfgCustomers"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 1: Line 1:
 
{{Article
 
{{Article
 
|Standalone=No
 
|Standalone=No
|DisplayName=Import and manage Customer Profile data
+
|DisplayName=View the Customer Profile schema
|TocName=Import and manage Customer Profile data
+
|TocName=View the Customer Profile schema
|Context=Use the sections and options in the Data Loader Application object to configure the Customer Profile schema and to import customer-related data that you can then use to create Predictors. For upload, you must gather the desired data into a CSV file having with a consistent schema. After import, you can append data or update the data.
+
|Context=View the fields, datatypes, anonymization status and other aspects of the Customer schema.
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=PureEngage
 
|Platform=PureEngage
Line 11: Line 11:
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Create a Customer Profile
+
|sectionHeading=View the schema
|anchor=newCustProfile
+
|anchor=viewCustProfSchema
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=[[File:newCustProf.png|left|thumb|Select CSV file to upload data]]
+
|structuredtext=After Data Loader uploads the Customer Profile, you can use the GPR web application to view the schema.  
  
#Click the '''Settings''' gear icon [[File:GPMsettingsGear.png|50px]], located on the right side of the top menu bar, to open the '''Settings''' menu (appears on the left side of the window).
+
#Click the '''Settings''' gear icon [[File:GPMsettingsGear.png|50px|link=https://all.docs.genesys.com/File:GPMsettingsGear.png]], located on the right side of the top menu bar, to open the '''Settings''' menu (appears on the left side of the window).
 
#Click the''' Customer Profile''' tab to open the Customer Profile window.
 
#Click the''' Customer Profile''' tab to open the Customer Profile window.
#Click the '''Source File''' text box to browse for your CSV file, or drag and drop it into the text box.
 
 
The GPR web application automatically determines the separator type.  It reads the schema from the configuration you specified in the Data Loader Application object. See {{Link-SomewhereInThisVersion|manual=Deployment|topic=DL-CfgFile|display text=Configure Data Loader to upload data}} for details.
 
 
'''NOTE:''' You must reload this page to view updates made using the Predictive Routing API, such as appending data to the Customer Profile.
 
|FAQHeading=How do I upload customer data from a CSV file?
 
|Status=No
 
}}{{Section
 
|sectionHeading=Verify the Schema
 
|anchor=verifyCustProf
 
|alignment=Vertical
 
|structuredtext=At this stage, before the data is uploaded, review and configure your Customer Profile.
 
 
[[File:CustProfSetID.png|left|thumb|Verify Customer Profile Schema and Set ID]]
 
  
#GPR automatically identifies the correct field separator in your CSV file.
+
All of the columns in your schema are listed and include the following information:
#Scroll down the list of fields and ensure that the datatypes have been discovered correctly. If any are incorrect, select the correct datatype from the '''Type''' drop-down list.
 
#*GPR supports the following datatypes: Boolean, Numeric, List, String, Timestamp, and Dict. See {{Link-SomewhereInThisManual|topic=DataSetup#csvSetup|anchor=top|display text=Setting Up a CSV File - Requirements and Limitations}} for how to correctly prepare your data, including characters that are unsupported or need special handling.
 
#Click the '''X''' in a row to remove it from the Customer Profile. If you change your mind before you upload your data (that is, before you click the '''Create''' button on the window), scroll to the bottom of the list of fields and click in the '''None Selected''' text box. Choose the field to be restored, and click '''Add Back'''.
 
#Set the '''ID Field''', which is used as a key when joining customer with interaction data. The drop-down list contains all fields with the String datatype. <br /> '''NOTE:''' ID Fields with a numeric datatype are not supported.
 
#(Optional) Click in the '''PII Fields''' text box to select the fields that contain personally identifiable or sensitive information, such as Social Security numbers, passwords, names and addresses, phone numbers, and so on. Data in these fields is anonymized when you create the Customer Profile. See {{Link-SomewhereInThisManual|topic=DataSetup#anonymize|anchor=top|display text=Data Anonymization}} for important information about how data is anonymized. Note that you cannot anonymize the '''ID Field'''.
 
#Click '''Create''' to upload the data.
 
  
*If you try to upload a file that contains more than 100 columns, GPR generates an error message. Cancel out of the upload procedure, edit your CSV file to reduce the number of columns, and then repeat the upload procedure.
+
'''NOTE:''' Making changes on this page to a schema uploaded using Data Loader will cause a mismatch and prevent any subsequent updates using Data Loader.
*If you try to upload a file with too many columns using the GPR API, the error message appears in the Customer Profile '''Description''' field in the GPR application.
 
*If you try to upload more than 2.5 million rows to a Customer Profile, only the first 2.5 million rows are stored and the rest are discarded. A warning message appears on the Customer Profile '''Uploads''' tab specifying how many rows were discarded. The '''Append''' button is disabled until you delete some rows from the Customer Profile.
 
|Status=No
 
}}{{Section
 
|sectionHeading=View The Customer Profile Schema
 
|anchor=viewCustProfSchema
 
|alignment=Vertical
 
|structuredtext=After you create the Customer Profile, the Customer Profile schema appears. It shows all of the columns in your schema and includes the following information:
 
  
*'''Label''' and '''Type''' - The ''Label'' is the name of the column in the Customer Profile and the ''Type'' is the datatype for that field. You can adjust the datatype, if necessary.
+
*'''Label''' and '''Type''' - The ''Label'' is the name of the column in the Customer Profile and the ''Type'' is the datatype for that field.  
 
*The field specified as the '''ID Field''' field is marked with a dot in the radio button for that row.
 
*The field specified as the '''ID Field''' field is marked with a dot in the radio button for that row.
 
*'''Visible''' and '''Indexed''' - ''Visible'' fields appear in the display on the Customers tab (accessed from the top navigation bar). ''Indexing'' speeds access to values in that field. You can have up to 20 indexed fields.
 
*'''Visible''' and '''Indexed''' - ''Visible'' fields appear in the display on the Customers tab (accessed from the top navigation bar). ''Indexing'' speeds access to values in that field. You can have up to 20 indexed fields.
 
*'''Cardinality''' - The number of unique values that occur in that column. If there are more than 1000, this field shows the value as '''1000+'''. Click the cardinality value to open a pop-up window that displays the first 1000 unique values that occur in the field.
 
*'''Cardinality''' - The number of unique values that occur in that column. If there are more than 1000, this field shows the value as '''1000+'''. Click the cardinality value to open a pop-up window that displays the first 1000 unique values that occur in the field.
*'''Expression''' -  If you created a custom field (as described in {{Link-SomewhereInThisManual|topic=cfgCustomers#appendCustProf|anchor=top|display text=Append Data to the Customer Profile}}) the expression you used is indicated in this column.
+
*'''Expression''' -  If you created a custom field using an expression, the expression you used is shown in this column.
 +
*'''PII''' - A mark in this column indicates that the fields was configured to be anonymized upon upload. PII fields contain sensitive data or personally identifiable information.
  
 
You can sort the table by clicking any column header.
 
You can sort the table by clicking any column header.
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Add Data to the Customer Profile
+
|sectionHeading=Update Profile data
 
|anchor=appendCustProf
 
|anchor=appendCustProf
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=You can add data to the Customer Profile in either of two ways: by adding single fields, or by uploading additional CSV files. You can also create a custom field that is a expression built from existing Customer Profile fields.
+
|structuredtext='''NOTE:''' Although the GPR application presents buttons labeled '''Upload Data''' and '''Add New Field''', this functionality is deprecated. Changes to the data made in the GPR web application cause a mismatch between the schema configuration in the Data Loader <tt>Application</tt> object and the data presented in the GPR web application.
 +
 
 +
To ''update'' data in the Customer Profile schema, create a CSV file containing the new data—but using the same schema—and upload it using Data Loader.  
  
To add single fields:
+
If you need to ''change'' the schema for the Customer Profile, use the following procedure:
  
#Scroll to the bottom of the list of Customer Profile fields and click '''Add New Field'''. If you click in the text box, any fields you previously removed are listed. You can select them to be added back into the Customer Profile.
+
'''NOTE:''' Execute this procedure while the Predictive Routing is turned off or when the inbound call volume through GPR is low, to reduce impact on the scoring results.
#To add an entirely new field, type a new field name and press '''Enter'''. The custom field value must be an expression constructed from arithmetic operations, Python 3 built-in functions, and fields already included in the Customer Profile.
 
#*To access the built-in functions, press the '''SHIFT+@''' shortcut.
 
#Configure the desired field parameters, then click '''Save Schema''' (at the bottom of the window).
 
  
To add data using a CSV file:
+
#Open the '''[dataset-customers]''' section in the Data Loader <tt>Application</tt> object from GAX or any other Genesys configuration manager application.
[[File:AppendWindow.png|right|thumb|Select CSV file to append]]
+
#Set the '''upload-dataset''' option value to <tt>false</tt>.
 +
#From the GPR web application, open the Customer Profile from the '''Settings''' menu.
 +
#Delete the Profile by clicking the trashcan icon next to the Customer Profile heading.
 +
#In the Data Loader <tt>Application</tt> object, change the values in the '''[dataset-customers]''' and '''[schema-customers]''' sections as desired.
 +
# Set the '''upload-dataset''' option in the '''[dataset-customers]''' section to <tt>true</tt>.
  
#On the '''Settings''' menu '''Customer Profile''' tab, click '''Upload Data'''. The '''Append Data''' pop-up window opens.
+
After Data Loader uploads the new Customer Profile, you can check the schema from the GPR web application.
#Select the desired CSV file. It must comply with the schema for the Customer Profile. If you append a CSV file containing more columns than appear in the original schema, the extra columns are automatically discarded.
 
 
|FAQHeading=How do I add data to the Customer Profile?
 
|FAQHeading=How do I add data to the Customer Profile?
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 20:01, March 5, 2020

This topic is part of the manual Genesys Predictive Routing Help for version 9.0.0 of Genesys Predictive Routing.
Read this topic for other versions:

View the fields, datatypes, anonymization status and other aspects of the Customer schema.

Related documentation:

WARNING: Although the Predictive Routing web application includes data upload functionality, its use is deprecated in favor of data uploads using Data Loader. If you upload from the GPR web application, note that using both Data Loader and the UI to upload data creates conflicts and presents a high risk of data corruption.

View the schema

After Data Loader uploads the Customer Profile, you can use the GPR web application to view the schema.

  1. Click the Settings gear icon GPMsettingsGear.png, located on the right side of the top menu bar, to open the Settings menu (appears on the left side of the window).
  2. Click the Customer Profile tab to open the Customer Profile window.

All of the columns in your schema are listed and include the following information:

NOTE: Making changes on this page to a schema uploaded using Data Loader will cause a mismatch and prevent any subsequent updates using Data Loader.

  • Label and Type - The Label is the name of the column in the Customer Profile and the Type is the datatype for that field.
  • The field specified as the ID Field field is marked with a dot in the radio button for that row.
  • Visible and Indexed - Visible fields appear in the display on the Customers tab (accessed from the top navigation bar). Indexing speeds access to values in that field. You can have up to 20 indexed fields.
  • Cardinality - The number of unique values that occur in that column. If there are more than 1000, this field shows the value as 1000+. Click the cardinality value to open a pop-up window that displays the first 1000 unique values that occur in the field.
  • Expression - If you created a custom field using an expression, the expression you used is shown in this column.
  • PII - A mark in this column indicates that the fields was configured to be anonymized upon upload. PII fields contain sensitive data or personally identifiable information.

You can sort the table by clicking any column header.

Update Profile data

NOTE: Although the GPR application presents buttons labeled Upload Data and Add New Field, this functionality is deprecated. Changes to the data made in the GPR web application cause a mismatch between the schema configuration in the Data Loader Application object and the data presented in the GPR web application.

To update data in the Customer Profile schema, create a CSV file containing the new data—but using the same schema—and upload it using Data Loader.

If you need to change the schema for the Customer Profile, use the following procedure:

NOTE: Execute this procedure while the Predictive Routing is turned off or when the inbound call volume through GPR is low, to reduce impact on the scoring results.

  1. Open the [dataset-customers] section in the Data Loader Application object from GAX or any other Genesys configuration manager application.
  2. Set the upload-dataset option value to false.
  3. From the GPR web application, open the Customer Profile from the Settings menu.
  4. Delete the Profile by clicking the trashcan icon next to the Customer Profile heading.
  5. In the Data Loader Application object, change the values in the [dataset-customers] and [schema-customers] sections as desired.
  6.  Set the upload-dataset option in the [dataset-customers] section to true.

After Data Loader uploads the new Customer Profile, you can check the schema from the GPR web application.

Retrieved from "https://all.docs.genesys.com/PE-GPR/9.0.0/Help/cfgCustomers (2025-07-20 18:09:12)"
Comments or questions about this documentation? Contact us for support!