Once you have created a script and before you can run the script, you must define which source files will be used.
To create a script definition:
1.Open General Configuration from the Desktop.
2.Select the Script Definition tab.
The Scripts Definition|Search page appears.
3.Click 'Create New'.
The Script Definition|Edit page appears.
4.Enter a name for the script definition in the 'Name' field.
5.Enter a brief description of the script definition in the 'Description' field.
6.Enter the name of the folder/group that you want to put the script definitions in. This allows you to easily search of them via the Script Definition|Search page.
7.Select the script that you want to use from the 'Application Script' dropdown.
Only scripts that have a 'Content Type' of Application Scripting will appear.
8.Click 'Add Source'.
The sources section expands.
9.Enter the name of the source file that has been saved to the server.
10.Enter the name of the header column in the 'Key Column' field.
11.If the script uses multiple source files (and they have all been added to the sources section), select the parent file from the 'Parent Source' dropdown.
12.Enter the parent column of the source file in the 'Parent Source Column' field.
13.Select the source file location from the 'Default Source Location' dropdown:
▪Business Intelligence: The source was extracted from Business Intelligence.
▪File: The source is a file.
▪HTTPS Server: The source file is located on an HTTPs server.
When the data management job is created, users will be prompted to enter a 'Source File Name', 'Username' and 'Password'. The 'Source File Name' should be the server name and path to the source file in the format serverName/pathToFile (https.audienceview.com/HTTPSfolder/source.csv).
The 'Username' and 'Password' are the valid credentials for the remote server.
▪SFTP Server: The source file is located on an SFTP server.
When the data management job is created, users will be prompted to enter a 'Source File Name', 'Username' and 'Password'. The 'Source File Name' should be the server name and path to the source file in the format serverName/pathToFile (sftp.audienceview.com/SFTPfolder/source.csv).
The 'Username' and 'Password' are the valid credentials for the remote server.
▪User Input: The source can be input by the user on the Utilities - Data Management|Schedule page.
14.Enter the name of the BI query that you want to use by default in the 'Default BI' field or click to search for a saved list..
15.For every source file that you want to add, repeat the process from Step 8.
16.Optionally, you can create field groups:
▪Click 'Add Group'.
The fields grouping section expands.
a.Enter the system field that the information is pulled from (_01_user_name) in the 'Name' field.
b.Enter the text used to identify the criteria on the user’s screen in the 'Label' field.
c.Select how you want the field to be validated from the 'Type' dropdown:
oCollection
oData
oEnter the order in which you want the groups to appear, in ascending order, in the 'Order' field.
17.Optionally, you can add additional fields/information, providing that they exist in the script:
a.Click 'Add Field'.
The execution fields section expands.
b.Enter the system field that the information is pulled from (_01_user_name) in the 'Name' field.
c.Enter the text used to identify the criteria on the user’s screen in the 'Label' field.
d.Select the type of execution field you are configuring from the 'Field Type' dropdown:
oStandard: The field will be displayed and work as it would.
oParent: The field will be linked to any Child fields that are configured and assigned to it. Changing the value of a Parent field will altert he options available under the Child field.
oChild: The field(s) linked to the Parent field. The Parent field selection determines what Child option are available.
Information For example, if a Parent field is configured as 'Country' (bound to a list containing Canada and USA entries), and two Child fields are configured to be 'Province/State' (each bound to a separate list), when a country is selected, and 'Update Details' is clicked, the 'Province/State' field will be refreshed and the appropriate list will be available. All of the Child fields belonging to the same Parent field must have the same 'Name' and 'Label'. |
e.If you are configuring a Child field, select the Parent field from the 'Parent Field' dropdown.
f.If you are configuring a Child field, enter the 'Key' for the list entry that must be selected from the Parent field to make the Child field available in the 'Parent Value' field.
g.Select how you want the field to be validated from the 'Type' dropdown:
obigInteger
obinary
ocurrency
odateTime
oduration
ofixedInteger
oguide
ointeger
opassword
ophoneNumber
ostring
h.Select the field's 'Subtype'
i.Select a predefined list to bind to the field from the 'List' dropdown or click to search for and select a list.
j.Enter the maximum number of fields that can be populated with values in the 'maxValues' field.
If the value is set higher than 1, then will appear allowing users to add additional fields.
k.If a list is selected in the 'List' field, the 'Default Value' will be populated with the lists' options (once the script definition has been saved). Select the the default option of the field.
l.Select a group from the 'Group' dropdown to help categorize fields.
This dropdown is populated with the groups created in the fields grouping section.
m.Enter the order in which you want the fields to appear, in ascending order, in the 'Order' field.
n.If you want the field to appear on a new row in the job criteria section of the Utilities - Data Management|Schedule page, select the 'Display on New Row' checkbox.
o.If you want the field to be required, select the 'Required' checkbox.
18.For every field that you want to add, repeat the process from Step 16.
19.Click 'Create'.
A window confirms that the script definition was created.
20.Click 'OK'.
Once you have created a script definition, you can schedule and run the script using the Utilities - Data Management pages.