You are on page 1of 48

Data Driven Applications Overview

Page 1 of 48

Data Driven Applications Overview


A data driven application (DDA) is a RedPrairie product application that is created for the client and/or Web framework using DDA technology provided in the shared application library (SAL) that is distributed with RedPrairie standard product a separate development environment is not required. DDA technology lets you define queries and maintenance applications, and perform actions on the data that is retrieved using Controller commands and data configurations. DDA technology lets project teams and customers use pre-defined data to dynamically draw the user interface elements and manage various types of applications. This can reduce project costs and the turnaround time required for the development of custom applications. What do you want to learn about? DDA Functionality Types of DDAs DDA Modality DDA Parent/Child Relationships Customization Levels DDA Toolbar DDA Development Process

2011 RedPrairie Corporation Comments on this topic?

DDA Functionality

These are the features that DDAs support: Action buttons on child DDAs and in the toolbar Appearance of DDAs matches the RedPrairie standard Command button execution of commands Context data is persisted between queries Data can be refreshed Dynamic queries with or without input data Filter groups (tabs and group boxes) for organizing submit and display fields Graphing support Grid or graph location is selectable Maintenance functions (such as using a DDA to add, change or remove data rows) Multiple row display operations Parent/child associations between DDAs

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 2 of 48

Child grids displayed on tabs on the parent DDA Data related to the top-level (parent) DDA is displayed on the same screen as the parent and can be maintained without having to drill down on a field in the parent Parent submit fields displayed on tabs when filter groups or child DDAs exist Sub-queries based on field-level data

2011 RedPrairie Corporation


Comments on this topic?

DDA Types

Each DDA is associated with a DDA type, which defines the type of service that the application will perform. These are the types of DDAs that can be defined: Action Bar Chart Cascading Dynamic DDA Filter Lookup Maintenance Mnt Change Mnt Create Mnt Remove Pie Chart Query Raw Query Single Row Select XML Tree

2011 RedPrairie Corporation


Comments on this topic?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 3 of 48

DDA Modality

Modality defines how the DDA is displayed within the client or Web framework . These are the types of modality that can be applied to a DDA: None Modeless Modeless with Refresh Modal Modal with Refresh If a DDA is invoked from a menu, it is always executed as Modeless with Refresh, and any other modality defined for the DDA is ignored. If a DDA is modal, and it has a action button on it that calls a modeless form, the second form takes over the display of the first form in the same modal form. You use the Target New Window attribute on the Data Driven Application Maintenance window to define modality for a DDA.

2011 RedPrairie Corporation


Comments on this topic?

DDA Parent/Child Relationships

You can define a parent/child relationship between DDAs; however, the functionality for establishing parent/child relationships is only available for these DDA types: Maintenance, Query and Single Row Select. A parent/child relationship is typically used to support actions (such add, modify or delete) on the data retrieved by the parent. The parent is the DDA that provides access to the child DDA . A child DDA, which can also contain action buttons, is displayed on a tab on the parent DDA. This is the order in which the system adds child DDA tabs to the parent DDA: Submit fields for the parent are painted on the first tab If tab-type filter groups have been defined for the parent, then those are drawn on the next tab(s) Child grids (with or without action buttons) are painted on subsequent tabs, the order of which is determined by the order in which they appear in the Children list on the Parent/Child window, or the Parent/Child tab of the Data Driven Application Maintenance window. When you specify a parent/child association for a DDA, you define the

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 4 of 48

child DDAs that will be accessible from the parent DDA fields on the parent DDA that you want to pass to the child DDA, and fields not on the parent DDA that you want to pass to the child DDA.

2011 RedPrairie Corporation


Comments on this topic?

Customization Levels

Each data driven application (DDA) is associated with a customization level (defined by the Customization Level attribute). The value for this attribute determines the level of the data that should be used from the database. Data that is distributed with the RedPrairie standard product is distributed with a customization level of 0. When you create a DDA in your RedPrairie product instance, it is automatically assigned an incremented customization level; usually incremented by 10. When the MCS framework is determining which database entry to use, it uses the customization level as one of the determining factors. Entries with a higher customization level take precedence over those with a lower customization level. The customization level is also used to preserve the customizations when the product instance is upgraded or enhanced. For example, during a product installation or upgrade, safetoload data is data that can be loaded at any time and it will not overwrite data that may have been added since the last time it was loaded. The data is made safe by a customization level (cust_lvl) column that is part of the primary key on the table. Bootstraponly data is data that will generally be customized by an implementation team. As a result, bootstraponly data is only loaded when the system is initially installed. This data is never loaded again as part of an upgrade, so as to prevent the changes made by the implementation team or the customer from being overwritten. This data includes, for example, policies, optional areas and menu groups.

2011 RedPrairie Corporation


Comments on this topic?

DDA Toolbar

The toolbar that appears on the Data Driven Application Maintenance window provides quick access to standard commands such as Exit, New, and Save, and includes additional functions for working with the development of DDAs. This table lists the standard and DDA-specific controls that appear on the Data Driven Application Maintenance window toolbar, and the action that takes place when you click the control.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 5 of 48

Control

Action Exits the current application. Creates a new record. Saves your work. Lets you delete the current record. Clears all of the information that was entered in the application. Note: Does not clear default information. Retrieves information from the database. Displays the previous record. Displays the next record. Shows or hides the grid view. (DDA-specific.) Displays the Run Command window that lets you retrieve the available column data that a Controller command returns. This information is helpful for determining which fields to include on a DDA. (DDA-specific.) Displays the DDA Export Parameters window that lets you export DDA configuration data to a collection of comma-separated-value (CSV) files. (DDA-specific.) Displays the Authorization window that lets you to modify the role and user authorizations and the menu group assignment for a DDA. (DDA-specific.) Displays the Copy Data Driven Application window that lets you copy an existing DDA and use it as a template for creating a new DDA. (DDA-specific.) Displays the DDA Filter Group Maintenance window that lets you define the attributes of a tab or group box. Displays help for the current window.

2011 RedPrairie Corporation


Comments on this topic?

DDA Development Process

These are the steps that you will take to develop a DDA: 1. 2. 3. Determine the goal of the DDA. For information, see DDA Types. Determine what child and action DDAs will be needed. For information, see DDA Parent/Child Relationships. Determine what filter groups (tabs and group boxes) will be needed, and create them for each DDA. For information, see Maintain DDA Filter Groups . Use the DDA creation wizard to create all of the necessary action and child DDAs, and authorize roles and users to access them. For information, see Add a DDA Using the Wizard . Use the DDA creation wizard to create the parent DDAs , authorize roles and users to access them, and assign the parent DDAs to menu groups. If you created filter groups (tabs and group boxes), then assign display and submit fields to filter groups. For information, see Modify the Submit Fields on a DDA or Modify the Display Fields on a DDA .

4.

5.

6.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 6 of 48

7.

Exit the RedPrairie and instance and then log in again to access the DDA and determine whether it performs as expected.

2011 RedPrairie Corporation


Comments on this topic?

Maintain DDAs

You can create a DDA using the DDA creation wizard, or by copying an existing DDA. When you create a DDA, you define the general attributes of the DDA, such as the framework in which it appears, the display name of the DDA, the Controller command that drives the DDA and any command qualifiers. miscellaneous attributes, such as the modality, which determines how the window is displayed within the client or Web framework.

Note: For more information, see DDA Modality . whether qualifiers are published prior to the DDA command being executed. position of the grid view or graph on the window. user-defined group name for the DDA. user-defined reference number for the DDA. whether query controls (the Profile and Criteria list boxes) are available.

Note: For more information, see Profiles and Criteria Schemes . whether the Find function is automatically executed when the DDA is opened. actions, such as those which will launch another DDA (for example, to add or modify a record) or execute a Controller command (for example, to delete a record). submit fields, that support the entry of search criteria. display fields, that support the display of data retrieved from the database. parent/child associations, that define the DDA(s) that will be accessible from another DDA.

Note: For more information, see DDA Parent/Child Relationships . menu group in which the DDA will appear. users and roles who will be authorized to access the DDA. After you create a DDA, you can modify its attributes, assign submit and display fields to filter groups, retrieve column data, export DDA configuration data to a collection of comma-separated value (CSV) files, and delete the DDA when necessary.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 7 of 48

You use Data Driven Application Maintenance to define a client and/or Web-based DDA for a RedPrairie product. What do you want to do? Add a DDA Using the Wizard Add a DDA Using the Copy Feature Modify a DDA Authorize Roles and Users for a DDA Maintain DDA Filter Groups Delete a DDA Export a DDA

2011 RedPrairie Corporation


Comments on this topic?

Add a DDA Using the Wizard


When you add a new DDA using the wizard, you define the framework in which it appears, the display name of the DDA, the Controller command that drives the DDA and the command qualifiers.

Note: It is good practice to create child and actions DDAs prior to creating a parent DDA, so that you can link to them during the creation of the parent DDA.

To add a DDA using the wizard 1. Start Data Driven Application Maintenance.

2. 3. 4. 5. 6.

Click

On the Add New window, in the ID box, type a unique identifier for the DDA. From the Type list, select the type of function that the DDA will perform. From the Usage list, select the framework in which the DDA will be executed. In the MLS Text box, type the title of the DDA that will appear in the user interface; for example, on the application window, navigation bar and Applications menu. In the Command box, type the Controller command that will return information to the DDA or execute the action for which the DDA was created. If desired, in the Qualifier box, type an argument that will be appended to the Command for the purpose of limiting the extent of the command. If desired, in the Group Name box, type the name of the group with which you want to associate this DDA. If desired, in the Reference box, enter a value that can be used to reference this DDA.

7.

8.

9. 10.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 8 of 48

11. 12.

Click Next. On the Run Command window, take one of these actions. If you want to... Then... Take these actions. Execute the Controller command to retrieve the available column data, 1. If desired, in the Initialize Qualifier box, type the qualifier that you want to apply to the command when it is initially executed. Click OK.

2. Continue creating a DDA without executing the Controller command, 13.

Click Cancel.

Continue with the procedure to select the submit fields for a new DDA.

2011 RedPrairie Corporation


Comments on this topic?

Add a DDA Using the Copy Feature

You can create a new DDA by copying an existing DDA using the Copy Data Driven Application window. When you create a new DDA from a copy, you enter a unique DDA identifier and, if desired, a DDA type. When you click OK, the new DDA is created and you can save or modify the DDA as required. To add a DDA using the copy feature 1. Start Data Driven Application Maintenance.

2.

Click

, and then in the grid view , select the DDA that you want to copy.

3. 4. 5. 6.

Click

On the Copy Data Driven Application window, in the New DDA ID box, type a unique identifier for the new DDA. From the Type list, select the type of DDA that you want to create, and then click OK. When a message appears stating that the copy was successful, click OK. The new DDA appears on the Data Driven Application Maintenance window. If desired, continue with the procedure to modify a DDA.

7.

2011 RedPrairie Corporation

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 9 of 48

Comments on this topic?

Modify a DDA

You can modify a DDA using the Data Driven Application Maintenance window. When you modify a DDA, you can change the DDA's general attributes, including the framework in which it appears, the display name of the DDA, the Controller command that drives the DDA and the command qualifiers. miscellaneous attributes, including the modality, which defines how the window appears within the client or Web framework

Note: For more information, see DDA Modality . whether qualifiers are published prior to the DDA command being executed position of the grid view or graph on the window user-defined group name for the DDA user-defined reference number for the DDA whether query controls (the Profile and Criteria list boxes) are available, and whether the Find function is automatically executed when the DDA is opened. actions, including adding, modifying or deleting the actions associated with the DDA. submit fields, including adding, modifying or deleting the submit fields that appear on the DDA. display fields, including adding, modifying or deleting display fields that appear on the DDA. parent/child associations, and the designation of fields that you want to pass to a child DDA. roles and users that will have access to the DDA, and the menu group in which the DDA will be displayed. You can also add filter groups (tabs and group boxes) to a DDA. What do you want to do? Modify the General and Miscellaneous Attributes of a DDA Modify the Action Attributes for a DDA Modify the Submit Fields on a DDA Modify the Display Fields on a DDA Modify the Parent/Child Associations for a DDA Authorize Roles and Users for a DDA Create a Menu Group for a DDA Associate a DDA with a Menu Group Maintain DDA Filter Groups

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 10 of 48

2011 RedPrairie Corporation


Comments on this topic?

Authorize Roles and Users for a DDA


Use this procedure to specify the roles and users that will have access to a DDA in a RedPrairie product.

Note: For more information, see Users and User Accounts and Roles and Role Assignments. .

To authorize roles and users for a DDA 1. 2. If you are not using the DDA wizard, then access the Authorization window. On the Authorization window, in the Roles Available list, take one of these actions: Select the role(s) that you want to authorize to access the DDA, and then click .

Note: To select consecutive roles from the list, select the first role, press and hold down Shift, and then select the last role. To select nonconsecutive roles, press and hold down Ctrl, and then select each role. Click 3. to authorize all of the roles to access the DDA.

In the Users Available list, take one of these actions: Select the user(s) that you want to authorize to access the DDA, and then click Click to authorize all of the users to access the DDA. .

4.

To remove any roles or users from the Assigned list, take one of these actions: Select the role(s) or user(s) that you want to remove from the Assigned list, and click Click to remove all of the roles or users from the Assigned list. .

5. 6.

When you have finished authorizing roles and users, click Next. Continue with the procedure to create a menu group for a DDA .

2011 RedPrairie Corporation


Comments on this topic?

Maintain DDA Filter Groups


A filter group is a named set of attributes that defines a tab or group box, which can be assigned to a DDA. After you

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 11 of 48

create a filter group, you can assign display or submit fields to it. You can also assign it to another filter group; for example, you can assign a group box to another group box or to a tab. You use the DDA Filter Group Maintenance to create filter groups. When you create a filter group, you can specify a unique identifier for the filter group. the title that will be displayed on the tab or group box defined by the filter group. the sequential order in which the filter groups appear on a data driven application. the type of filter group, either tab or group box. that the filter group appears on another (parent) filter group; for example, that a group box appears on a tab or another group box. that the filter group is attached to another filter group (for example, that it resides next to, above or below another filter group), the position of the attachment and the amount of offset between the two filter groups. the number of columns on the filter group. the tab order on the filter group. the border style, if any. the amount of offset between columns and between rows. After filter groups are defined, you can assign submit and display fields to filter groups. For details, see Modify the Submit Fields on a DDA or Modify the Display Fields on a DDA . You can also use DDA Filter Group Maintenance to modify and delete filter groups when necessary. What do you want to do? Add or Modify a DDA Filter Group Delete a DDA Filter Group

2011 RedPrairie Corporation Comments on this topic?

Retrieve DDA Column Data


When adding or modifying a DDA , you can execute the Controller command for the DDA to retrieve the available column data (fields) from the database. The column data can be retrieved into the Available list on the Submit Fields or Display Fields tabs on the Data Driven Application Maintenance window, making the fields available for assignment to the DDA. You use the Run Command window to define an initialize qualifier , if used, and execute the DDA Controller command. To retrieve DDA column data 1. If you have not already done so, start Data Driven Application Maintenance.

2. 3.

Click

, and then from the grid view, select the DDA for which you want to view column data.

Select the Submit Fields tab or the Display Fields tab.

4.

Click

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 12 of 48

5.

On the Run Command window, if desired, in the Initialize Qualifier box, type a qualifier to limit the extent of the DDA command. Click OK. If all of the fields are already displayed in the Available and Assigned lists, then there will be no change in the data. If the command retrieves fields that are not currently displayed, they will appear in the Available list.

6.

2011 RedPrairie Corporation


Comments on this topic?

Export a DDA
You can export a DDA configuration to a collection of comma-separated value (CSV) files that represent the column data that constitutes the DDA. You can then transfer and use the DDA configuration in another RedPrairie instance, as long as the underlying commands are compatible. The export function saves all of the DDA configuration data, including descriptions and MLS catalog entries. You use the DDA Export Parameters window to export a DDA configuration. To export a DDA 1. Start Data Driven Application Maintenance.

2.

Click

, and then from the grid view, select the DDA that you want to export.

3. 4. 5. 6. 7.

Click Click OK.

. The DDA Export Parameters window appears displaying the information for the selected DDA.

When a message appears asking if you want to continue with the export, click Yes. When a message appears stating that the export was successful, click OK. On the server PC for the RedPrairie product instance in which you are working, locate the configuration files in this folder: $LESDIR/dda_exports/<DDA APPLICATION ID>.

2011 RedPrairie Corporation


Comments on this topic?

Delete a DDA
If you delete a standard product DDA , it can be restored by reinstalling the server software from the RedPrairie product installation CD-ROM. A custom DDA, however, is not included on the product installation CD-ROM. Therefore, before deleting a custom DDA, consider exporting the DDA first so that it can be restored from the export if it is needed in the future. For more information, see Export a DDA.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 13 of 48

To delete a DDA 1. Start Data Driven Application Maintenance.

2.

Click

, and then from the grid view, select the DDA that you want to delete.

3. 4.

Click

When a message appears asking if you want to delete the DDA, click OK.

2011 RedPrairie Corporation


Comments on this topic?

Database Archives

A system's database is typically designed for execution purposes rather than historical record keeping. In order to keep a system's execution tables lean for performance purposes, database archiving functionality lets you save historical data in a database archive. Some of the best candidates for database archiving include shipment information receipt information daily transactions, and order activity. Before you begin working with database archives, it is recommended that you take a few moments to learn about the types of database archives, and the database archive process. Use Database Archive Maintenance to add and maintain database archives.

2011 RedPrairie Corporation


Comments on this topic?

Maintain Database Archives

Database archives let you save historical data, such as shipment information, receipt information, daily transactions and

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 14 of 48

order activity in a database archive. Use Database Archive Maintenance to add and maintain database archives. What do you want to do? Add a Database Archive Modify a Database Archive Delete a Database Archive

2011 RedPrairie Corporation


Comments on this topic?

File Loading

You can manually load data from a comma-separated value (.csv) file into a RedPrairie database using the Load File Operations window. This lets you quickly add a large amount of information to your RedPrairie database at one time, instead of adding each individual piece of information using a maintenance application or host transaction download. This is especially useful if you have already added the information to one of your other third party applications that lets you export information to a .csv file. Load File Operations uses the logic in an associated control file to determine whether data is being added or updated, and lets you load data into a database from .csv files that are located on a local client workstation, or the application server.

IMPORTANT: The location of the control file is determined by a system policy (SYSTEM-INFORMATION/PRODUCTLAYERS/DATA-PATHS) that lets you specify the folder(s) in which control files are located for the database tables. For more information, see SYSTEM-INFORMATION_PRODUCT-LAYERS_Policy_Overview.

When you use Load File Operations to load data, the data is added or updated; it is not deleted. For example, if a record exists in the database, but not in the .csv file, when the .csv file is loaded, the record is not removed from the database. If you need to manually remove records from the database, you must do so using SQL commands. Before you begin performing load file operations, it is suggested that you take a few minutes to learn about these concepts. What do you want to learn about? File Loading Usage Examples Valid .csv Data File Attributes Example of a .csv Data File

2011 RedPrairie Corporation

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 15 of 48

Comments on this topic?

Perform Load File Operations

The Load File Operations window lets you load data into a database from .csv files that are located on a local client workstation or the application server.

IMPORTANT: Use this procedure with caution. Loading data into a database, if done improperly, can result in unexpected system behavior. It is suggested that you back up your data before attempting this procedure.

To perform load file operations 1. 2. Start Load File Operations. Take one of these actions. Then... Take these actions. Know the name of the table into which you want to load data from a file,

If you...

1. 2.

In the Table Name box, type the name of the database table. Click .

Do not know the table name, or you want to select the data file from the grid view,

Click , and then in the grid view, select the table name.

Note: The control file associated with the table appears in the Control File box.

3.

Take one of these actions. Then... In the File Name box, type the folder and name of the file. Take these actions.

If you... Know the folder and name of the file that you want to load,

1. 2.
Want to browse to the file that you want to load,

Click Browse. On the File Name window, browse to the file that you want to load. Click Open.

3.

Note: You may have several files to load; however, you can only load one at a time.

Note: The Load File button becomes available.

4.

Take one of these actions. If the data file that you want to load is located on the... Application server, Client workstation, Then select... Server. Client.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 16 of 48

5.

If desired, in the Field Delimiter box, type the symbol that separates the values in the file that you are loading into the database table. Click Load File. The file loading process begins and may take several seconds or minutes (depending on the size of your file). When a message appears stating that the file load was successful, click OK. Information about the file loading process appears in the File Load Results box.

6.

7.

2011 RedPrairie Corporation


Comments on this topic?

Jobs

A job is a command that is configured to run in the background while your RedPrairie application server instance is operating. Jobs are executed within a thread of the RedPrairie server, and they are managed by the server's job manager. A job can be timer-based; that is, configured to run at set intervals. For example, you can configure a job to run every 600 seconds. schedule-based; that is, configured to run at a predefined time. For example, you can configure a job to run every 1st and 15th of the month at midnight. Jobs are configured in Job Maintenance, and they are stored in the database.

Note: Prior to version 2010.1.x, jobs were configured in Schedule Agent Operations and stored in the registry file.

After jobs are configured, you can use the RedPrairie Console to monitor the status of, and stop and start the scheduling of jobs. For more information, see Manage Jobs and Tasks. Before you configure jobs, it is suggested that you take a few minutes to learn about these concepts. What do you want to learn about? Job Configuration in a Clustered Environment Job-Specific Environment Variables Job Tracing

2011 RedPrairie Corporation


Comments on this topic?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 17 of 48

Tasks

A task is either a program or a Java thread that starts when your RedPrairie application server starts, and it continues to run in the background as configured while your server instance is operating. A task can be run as a completely separate program, which runs in parallel with the RedPrairie application server (process-based task). Process-based tasks are executables (programs) that can be implemented in any programming language. as a separate Java thread, which runs within the application server itself (thread-based task). The task manager instantiates thread-based tasks using a Java class, which implements the Java runnable interface.

Note: A Java thread-based task will use fewer system resources than a process-based task.

IMPORTANT: If you are creating a process-based task in the C programming language on an AIX server, and the task calls srvInitialize(), then you must define a unique LIBPATH environment variable for the task. For detailed information, see Add or Modify a Task.

Tasks are configured in Task Maintenance, and they are stored in the database.

Note: Prior to version 2010.1.x, tasks were configured and stored in the registry file.

After tasks are configured, you can use the RedPrairie Console to monitor the status of tasks, and to stop and start tasks. For more information, see Manage Jobs and Tasks. Before you configure jobs, it is suggested that you take a few minutes to learn about these concepts. What do you want to learn about? Task Configuration in a Clustered Environment Task-Specific Environment Variables Task Tracing Thread-Based Task Testing

2011 RedPrairie Corporation


Comments on this topic?

Maintain Jobs

You use Job Maintenance to create and schedule jobs. When you create a job, you specify a unique ID for the job. provide a descriptive name for the job.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 18 of 48

enter the command that executes the job. optionally, define log file and trace level details. specify a node ID if working in a clustered environment. indicate whether the job is timer- or schedule-based, and then define the timing or schedule for the job. enabled to start. able to start even though another instance of that job is currently running. optionally, define an environment variable value that is specific to the job. Once you have created jobs, you can use Job Maintenance to modify job attributes, and delete jobs.

IMPORTANT: Maintaining jobs is a system administrative task that requires knowledge of RedPrairie development concepts and experience in RedPrairie command development.

What do you want to do? Add or Modify a Job Delete a Job

2011 RedPrairie Corporation


Comments on this topic?

Maintain Tasks

You use Task Maintenance to create tasks. When you create a task, you specify a unique ID for the task. provide a descriptive name for the task. indicate whether the task is thread- or process-based enabled to start, and able to restart if terminated. enter the program that executes the task (for process-based tasks). enter the class name that executes the task (for thread-based tasks). identify the directory from which the program to run process-based tasks will execute. optionally, define a log file name and location.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 19 of 48

specify a node ID if working in a clustered environment. optionally, define an environment variable value that is specific to the task. Once you have created tasks, you can use Task Maintenance to modify task attributes, and delete tasks.

IMPORTANT: Maintaining tasks is a system administrative task that requires knowledge of RedPrairie development concepts and experience in RedPrairie command development.

What do you want to do? Add or Modify a Task Delete a Task

2011 RedPrairie Corporation


Comments on this topic?

Manage Jobs and Tasks


You use the Web-based, RedPrairie Console to view the status of the jobs and tasks that are configured for your environment. More specifically, you can view a list of all jobs and tasks along with their attributes and session details stop and start the scheduling of jobs, and stop and start tasks.

IMPORTANT: You must have the administrative password to access the Console. This is not your RedPrairie login password. It is a unique password for the Console, and it was defined during the application server installation.

What do you want to do? Monitor Jobs and Tasks Stop and Start Jobs and Tasks

2011 RedPrairie Corporation Comments on this topic?

Reports
You can generate and maintain standard and custom reports that allow you to view the status of activities within your facility.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 20 of 48

Example of a Reporting Report Before you begin working with the reports, it is recommended that you take a few moments to learn how reports are generated, and how you can change the appearance of the report.

2011 RedPrairie Corporation


Comments on this topic?

Label Compliance
As part of your daily routine, you need to print labels and reports at different times as you process inventory through your warehouse. If you are using RedPrairie Warehouse Management or RedPrairie Parcel , label compliance lets you specify a label(s) and/or report(s) to print for an order at specified breakpoints (exit points) in the warehouse process during the order's lifetime. For example, you can configure the system so that when a shipment is staged, the customer's case labels and pallet labels are automatically printed along with the carrier's bill of lading. when a package is manifested, the customer's packing list is automatically printed.

Note: If you are using RedPrairie Warehouse Management or RedPrairie Parcel , label formats for the top 100 retailers are included. Other RedPrairie products do not currently support label functionality.

The system handles compound entities that have their own label formats and documents; for example, for a particular combination of customer and carrier type, print the customers LTL ship label. Label compliance gives you the ability to configure the system to flexibly choose the correct type and number of labels and/or reports to automatically print at the exact points in the warehouse process when those labels and/or reports are needed and at the exact printer(s) where they need to be printed. Before you begin using label compliance, it is suggested that you learn about these concepts. What do you want to learn about? Document types Report formats Label formats Compliant configurations Printing exit points Precedence Document groups Load levels Printing location

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 21 of 48

Setup and configuration

2011 RedPrairie Corporation


Comments on this topic?

Reports/Labels Client Applications


There are several RedPrairie client applications that you can use to perform report functions. If you are using RedPrairie Warehouse Management or RedPrairie Parcel , there are several RedPrairie client applications that you can use to perform label functions.

Note: Other RedPrairie products do not currently support label functionality.

Before you begin working with these applications, it will be helpful if you learn what each application lets you do. What do you want to learn about? Report Maintenance Report Operations Report Archive Label Format Maintenance Document Type Maintenance Compliant Configuration Maintenance

2011 RedPrairie Corporation


Comments on this topic?

Define and Maintain Report Options


Report options identify the report ID a description for the report the report layout the printer at which the report will print the product to which the report applies optionally, the number of days to store the report in the report archive if applicable, whether to log an Event Management event when the report is generated, and the event name, if logging an Event Management event for the report.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 22 of 48

Once you define the report options in Report Maintenance, you can preview and print reports in Report Operations. What do you want to do? Define Options for a Custom Report Modify Options for a Report Delete a Report

2011 RedPrairie Corporation


Comments on this topic?

View a Report
Use this procedure to view reports.

Note: If you have defined custom reports for this RedPrairie product in Report Maintenance, then those reports are also accessible for viewing.

Note: Permission for users to view and print reports is granted in Authorization Maintenance.

To view a report 1. Start Report Operations.

2. 3.

Click

, and then from the grid view, select the report that you want to view.

If a list of parameters appears, and you want to limit the amount of information that will appear in the report, then type or select the parameter values that apply. For example, in Warehouse Management, if you selected the Inventory report, and you want to view details for a specific location, then select the location from the Location Lookup box, or in Workforce Management, if you selected the Quality Audit report, and you want to view details for a specific aisle area, then select the aisle area from the Aisle Area Lookup box. Click Preview. On the Report Preview window, you can take these actions. Then... Click .

4.

If you want to... View the table of contents for the report,

The table of contents appears. You can click on any entry to view it in the report. Click Export.

Export the report information to a file or a folder,

Note: You can save the report information as a Microsoft Excel (.xls) document, an HTML or HTML Frames (.mht) document, in portable document (.pdf), or rich text document (.rtf) format. Click and then select the page layout that you want to view. to return to the single page view.

View multiple pages of the report on the Report Preview window,

Note: Click

Split the Report Preview

Click and drag the splitter bar towards the bottom of the Report Preview window.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 23 of 48

window into two separate views,

Note: For example, you can view multiple pages of a report as thumbnails in one view, while viewing a single page of the report in the other view. You can then double-click on a thumbnail to view that page in the single-page view. Click .

Locate a specific word or phrase in the document,

On the Find window, in the Find What: box, type the word or phrase. Then select the appropriate match options and click Find Next.

5.

Take one of these actions. Then... Click to cut the current page to the clipboard. Select the location to paste the page, right-click and then from the Shortcut menu, select Paste. Note: You can paste the report in a textual or graphical format.

If you want to...

Copy report information into another application or report,

Print the report to a local printer connected to your PC, Close the Report Preview window,

Click . On the Print window, select the print options, and then click Print. Click .

2011 RedPrairie Corporation


Comments on this topic?

Print a Report
Use this procedure to print reports on a printer connected to the Reporter server.

Note: If you have defined custom reports for this RedPrairie product in Report Maintenance, then those reports are also accessible for printing.

Note: Permission for users to view and print reports is granted in Authorization Maintenance.

To print a report 1. Start Report Operations.

2. 3.

Click

, and then from the grid view, select the report that you want to print.

If a list of parameters appears, and you want to limit the amount of information that will appear in the report, then type or select the parameter values that apply. For example, in Warehouse Management, if you selected the Inventory report, and you want to view details for a specific location, then select the location from the Location Lookup box, or in Workforce Management, if you selected the Quality Audit report, and you want to view details for a specific aisle area, then select the aisle area from the Aisle Area Lookup box. Click Print. On the Report Print window, select the print options, and then click Print.

4. 5.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 24 of 48

2011 RedPrairie Corporation


Comments on this topic?

View an Archived Report


Use this procedure to view archived reports.

Note: Permission for users to view and print reports is granted in Authorization Maintenance.

To view an archived report 1. Start Report Archive.

2. 3.

Click

, and then from the grid view, select the report that you want to view.

If a list of parameters appears, and you want to limit the amount of information that will appear in the report, then type or select the parameter values that apply. For example, in Warehouse Management, if you selected the Inventory report, and you want to view details for a specific location, then select the location from the Location Lookup box, or in Workforce Management, if you selected the Quality Audit report, and you want to view details for a specific aisle area, then select the aisle area from the Aisle Area Lookup box. Click Preview. When the report appears, you can take these actions. Then... Click .

4.

If you want to... View the table of contents for the report,

The table of contents appears. You can click on any entry to view it in the report. Click Export.

Export the report information to a file or a folder,

Note: You can save the report information as a Microsoft Excel (.xls) document, an HTML or HTML Frames (.mht) document, in portable document (.pdf), or rich text document (.rtf) format. Click and then select the page layout that you want to view. to return to the single page view.

View multiple pages of the report on the Report Preview window,

Note: Click

Click and drag the splitter bar towards the bottom of the Report Preview window. Split the Report Preview window into two separate views, Note: For example, you can view multiple pages of a report as thumbnails in one view, while viewing a single page of the report in the other view. You can then double-click on a thumbnail to view that page in the single-page view. Click .

Locate a specific word or phrase in the document,

On the Find window, in the Find What: box, type the word or phrase. Then select the appropriate match options and click Find Next.

5.

Take one of these actions. Then...

If you want to...

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 25 of 48

Copy report information into another application or report,

Click to cut the current page to the clipboard. Select the location to paste the page, right-click and then from the Shortcut menu, select Paste. Note: You can paste the report in a textual or graphical format.

Print the report to a local printer connected to your PC, Close the Report Preview window,

Click . On the Print window, select the print options, and then click Print. Click .

2011 RedPrairie Corporation


Comments on this topic?

Print an Archived Report


Use this procedure to print archived reports to a printer connected to the Reporting server. To print an archived report 1. Start Report Archive.

2. 3. 4.

Click

, and then from the grid view, select the report that you want to print.

Click Print. On the Report Print window, select the print options, and then click Print.

2011 RedPrairie Corporation


Comments on this topic?

Maintain Label Formats

Label Format Maintenance lets you maintain the different formats of labels that you print in your facility; for example, a generic case label, customer A's case label, and client A's/customer B's case label. When you use Label Format Maintenance to define a label format, you specify a name and description for the label format an optional media file to associate with the label whether the label format requires an RFID-enabled printer, and

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 26 of 48

the default printer at which the label will be printed. What do you want to do? Add or Modify a Label Format Delete a Label Format

2011 RedPrairie Corporation Comments on this topic?

Maintain Document Types

If you are using RedPrairie Warehouse Management or RedPrairie Parcel , you can use Document Type Maintenance to create and maintain document types, such as pallet label, Bill of Lading report and storage location label.

Note: Other RedPrairie products do not currently support label functionality.

What do you want to do? Add a Document Type Modify a Document Type Delete a Document Type

2011 RedPrairie Corporation Comments on this topic?

Maintain Compliant Configurations

If you are using RedPrairie Warehouse Management or RedPrairie Parcel , you can use Compliant Configuration Maintenance to create and maintain compliant configurations.

Note: Other RedPrairie products do not currently support label functionality.

What do you want to do? Add a Compliant Configuration Modify a Compliant Configuration Delete a Compliant Configuration

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 27 of 48

2011 RedPrairie Corporation Comments on this topic?

Manually Print a Label


Use this procedure to manually print a label.

Note: Label functionality is available if you are using RedPrairie Warehouse Management or RedPrairie Parcel . Other RedPrairie products do not currently support label functionality.

To manually print a label 1. 2. Start Print Label Operations. If you want to narrow the list of labels from which to select, in the search criteria boxes, type, look up or select the appropriate information.

3. 4.

Click

, and then from the grid view, select the label that you want to print.

If you want to select a printer other than the default to which to print the label, from the Default Printer list, select the printer. In the label argument box(es), type, look up or select the appropriate information to uniquely identify the item for which you want to print a label. For example, if you choose to print a storage location label, the system will display a Storage Location box in which you can type or look up the specific storage location for which you want to print a label.

5.

6.

Click

7.

When you are finished printing labels, click

2011 RedPrairie Corporation


Comments on this topic?

Manually Print a Compliant Document

Use this procedure to manually print a report or label based on its compliant configuration(s). To manually print a compliant document 1. 2. Start Compliant Label Print Operations. In the Inventory ID box, type the inventory identifier, such as Load Number, Load UCC, Case Identifier and Sub-Load UCC Code, for which you want to print a compliant report(s) or label(s).

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 28 of 48

3.

From the Exit Point list, select the point in the warehouse process at which the report(s) or label(s) that you want to manually print have been configured to automatically print. The system generates a list of the report(s) and label(s) that match the compliant configuration(s). Select the check box(es) next to the report(s) and/or label(s) that you want to manually print. From the Default Printer list, select the printer to which to print the selected report(s) and/or label(s). Click Print.

4. 5. 6.

7.

When you are finished printing compliant documents, click

2011 RedPrairie Corporation


Comments on this topic?

View Label Formats

Use this procedure to view details about the label formats stored in the system.

Note: Label functionality is available if you are using RedPrairie Warehouse Management or RedPrairie Parcel . Other RedPrairie products do not currently support label functionality.

To view label formats 1. 2. Start Label Format Maintenance. If you want to narrow the list of label formats to be viewed, in the search criteria boxes, type, look up or select the appropriate information. For example, if you only want to view the label formats associated with a specific default printer, then from the Default Printer list, select the printer.

3.

Click

, and then from the grid view, select the label format that you want to view.

4.

When you are finished viewing the label format(s), click

2011 RedPrairie Corporation


Comments on this topic?

View Document Types

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 29 of 48

Use this procedure to view details about the document types stored in the system.

Note: Label functionality is available if you are using RedPrairie Warehouse Management or RedPrairie Parcel . Other RedPrairie products do not currently support label functionality.

To view document types 1. 2. Start Document Type Maintenance. If you want to narrow the list of document types to be viewed, in the search criteria boxes, type, look up or select the appropriate information. For example, if you only want to view report document types, then from the Document Type Code list, select Report.

3.

Click

, and then from the grid view, select the document type that you want to view.

4.

When you are finished viewing the document type(s), click

2011 RedPrairie Corporation


Comments on this topic?

View Compliant Configurations

Use this procedure to view details about the compliant configurations stored in the system.

Note: Label functionality is available if you are using RedPrairie Warehouse Management or RedPrairie Parcel . Other RedPrairie products do not currently support label functionality.

To view compliant configurations 1. 2. Start Compliant Configuration Maintenance. From the Document Type list, select the document type of the compliant configuration that you want to view.

3.

Click

, and then from the grid view, select the compliant configuration that you want to view.

4.

When you are finished viewing the compliant configuration(s), click

2011 RedPrairie Corporation

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 30 of 48

Comments on this topic?

Security
To log in, users must have a valid user authorization within the system. User authorization consists of a user ID a locale ID security options (including a password and account status information) address information (optional) roles, and menu options. Authorization Maintenance lets you secure information within your system. You can limit a user's access to client functions by assigning roles to each individual user. A role defines which client applications (or menu options) a user can start. In addition, you can restrict a user's ability to view specific information within a client application window. For example, system administrators typically maintain users within your system by starting Authorization Maintenance. You may want to restrict a system administrator from seeing pay rate information for other users, but need to allow them to start the application. By defining limited executable parameters, you can restrict a system administrator's view of the pay rate field, while still allowing the administrator to start the application. To understand how the security functions within your system work, it will be helpful if you learn more about these concepts. What do you want to learn about? Users and User Accounts Roles and Role Assignments

2011 RedPrairie Corporation


Comments on this topic?

Change a Password
Passwords are used as a security device to ensure the integrity of the information within your system. Therefore, it is important that they remain confidential. If you have reason to believe that a password is no longer confidential, then it is recommended that it be changed. To change a password 1. 2. 3. 4. From the Tools menu, select Change Password. On the Change Password window, enter the password that you want to change. Enter the new password. Re-enter the new password to confirm the spelling.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 31 of 48

5. 6.

Click OK. When the message appears stating that the password was updated successfully, click OK.

2011 RedPrairie Corporation


Comments on this topic?

Change a Locale ID
If there is more than one locale defined in your system, you can easily change the attributes that appear in the GUI to meet your language requirements. To change locales

IMPORTANT: You can change locale IDs while your system is running; however, to apply the changes you must exit the system and then log in again.

1. 2.

From the Tools menu, select Change Locale. From the list of available locales, select the locale ID for the locale that you want to use.

2011 RedPrairie Corporation


Comments on this topic?

Tracing
The RedPrairie tracing functionality helps you, along with RedPrairie customer support, identify and solve system issues. A trace captures the events that take place within the system whenever a process or task is performed, and then displays the results in a log file. You can analyze the log file to learn about a process or form flow within an application identify system configuration issues identify user issues, and learn how your system performs a task. When you perform a trace, you can specify the filename for the trace log file and any additional information that you want included (such as application flow messages or system performance statistics). The system saves the log file in the LES director in the Log directory for that environment on the application server.

Note: By default, your user ID is used when naming the trace log file. It is recommended that you change the default filename to something more specific about the trace and to prevent accidentally saving a new trace over your existing.

What do you want to learn about?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 32 of 48

Tracing Options Command Profile Log File

2011 RedPrairie Corporation Comments on this topic?

Tracing Options
The RedPrairie products let you specify the additional information that you want included with your trace file (such as application flow messages or system performance statistics). You can also specify the filename for the saved trace log file. You use the Trace Options window to specify the trace log filename and the additional options. You can access the Trace Options window from the Tools menu by selecting Tracing and then Trace Options.

Note: You can also configure your user preferences to prompt you for the trace options when enabling the trace. For information about user preferences, see User Preferences .

2011 RedPrairie Corporation Comments on this topic?

Command Profile Log File


A command profile log file is a separate log file that is saved whenever you perform a trace. In this log file, the trace log file and the information on the other options included in the trace (such as application flow messages or system performance statistics) are saved together. This lets you view all of the trace information from a single source.

Note: The command profile log file using the same name as the trace log file but has the file extension of .cmdprf instead of .log. The command profile is typically saved in the same location as the trace log file.

You use the Command Profiler window to view the command profile log file. This window appears after you opened a saved command profile log file from the Open Command Profile window or when you click Yes to view the trace that you just performed.

IMPORTANT: The command profile log file is the recommend file to use when viewing and analyzing trace information.

2011 RedPrairie Corporation


Comments on this topic?

Initiate a Trace
To initiate a trace

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 33 of 48

1.

From the Tools menu, select Tracing, and then take one of these actions. Then select...

If your user preferences are... Set to always prompt you for trace options when performing a trace,

Tracing Enabled. Note: For information about user preferences, see User Preferences Window . Not set to prompt you for trace options when performing a trace, 2. 3. Trace Options.

On the Trace Options window, in the Server File Name box, type a name for the log file. In the Server Trace Flags list, take one or more of these actions. Then select the check box for... Application Flow Messages. SQLLib Calls.

If you want the trace to include... Commands being executed by an application, Execution of SQL statements (such as selects, commits and rollbacks), Server processing functions (such as finding, parsing and executing commands and C functions),

Server Flow Messages.

Processing of arguments (such as the event ID, triggering system, destination system, IFD ID Server Arguments. and IFD version), Database and cache performance statistics (such as the amount of time spent in Performance Statistics. preparation, execution and retrieving data from the database and cache), Identifiers for the processes, All commands, arguments, statements and messages, Display Process ID in All Messages. Command Profiling.

Note: Clear the check box to no longer view the information.

4. 5.

Click OK. If a message appears asking if you want to activate tracing now, click Yes.

Note: To verify that the tracing has been activated, from the Tools menu, select Tracing, and then verify that a check mark appears next to Tracing Enabled.

6. 7. 8.

Perform the task(s) that you want to trace. When the task(s) are completed, turn off the trace. When a message appears asking if you want to view the log file, click Yes. The Command Profiler window appears and the command profile log file for the trace is displayed.

Note: If you click No, you can view the trace information at a later date. For detailed information on opening the command profile log file for a saved trace, see Open a Saved Trace .

9.

View the log file. For detailed information on displaying specific information for analysis, see View a Trace .

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 34 of 48

2011 RedPrairie Corporation


Comments on this topic?

Open a Saved Trace


You use the Open Command Profile window to open the command profile log file for the saved trace. You access the Open Command Profile window from the Tools menu by selecting Tracing, View Trace, and then Open Trace. To open a saved trace 1. 2. If you have not already done so, initiate a trace. For detailed instructions, see Initiate a Trace . From the Tools menu, select View Trace File, and then take one of these actions. If you want to open the command profile log file for the trace that was... The last performed,

Then... Select View Last Trace File. The Command Profiler window appears and the command profile log file for the trace is displayed. Take these actions. 1. Select Open Trace File. On the Open Command Profile window, in the grid view, select the command profile log file that you want to open. Click Open. The Command Profile window appears and the command profile log file for the trace is displayed. 2. 3.

Not the last performed,

3.

View the log file. For detailed information on displaying specific information for analysis, see View a Trace .

2011 RedPrairie Corporation


Comments on this topic?

View a Trace
You use the Command Profiler window to view the command profile log file for a trace. In addition, you can search for and display specific information for analysis. This window appears when you opened a saved trace or when you clicked Yes after generating a trace. To view a trace 1. If you have not already done so, open the command profile log file for a trace. For detailed instructions, see Open a Saved Trace .

Note: The command profile log file is opened immediately after performing the trace and clicking Yes when asked if you wanted to open the file.

2.

On the Command Profiler window, review the log file information.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 35 of 48

3.

If desired, take one or more of these actions. If you want to... View commands that took a specific amount of time to execute, View commands that failed to execute, Then... In the Filter area, take these actions. 1. 2. In the Filter Time (ms) box, type the execution time in milliseconds. Click Filter. The results appear in the left pane.

In the Filter area, select the Display Only Bad Statuses check box. The results appear in the left pane. In the Filter area, take these actions. 1. Select the Display Only Full Scan Queries check box. If a message appears indicating that you must first scan for bad queries and asking if you want scan for the queries now, click Yes. The results appear in the left pane.

View full scan queries,

2.

In the Find area, take these actions. 1. 2. Search for specific text, In the Find What box, type the text for which you to locate. From the Search In list, take one of these actions: If you want to look in the command profile information (left pane), then select cmd_prf. If you want to look in the trace information (right pane), then select trc_fil. 3. Click Find Next. Repeat this step to find all occurrences of the text.

Take these actions. 1. Print the trace log file, 2. 3. 4. From the Tools menu, select View Trace File. The trace log file information appears in a new window. From the File menu, select Print. On the Print window, select the print options, and then click Print. Click Exit. The Command Profiler window appears.

Take these actions. 1. Copy information to the clipboard, 2. 3. 4. From the Tools menu, select View Trace File. The trace log file information appears in a new window. Select the information that you want to copy, and then from the Edit menu, select Copy. Click Exit. The Command Profiler window appears. Open the document into which you want to paste the information, and then from the Edit menu, select Paste.

Take these actions. 1. 2. 3. 4. From the Tools menu, select View Trace File. The trace log file information appears in a new window. Select the text that you want to change, and then from the Settings menu, select Font. On the Font window, select the font that you want to apply, and then click OK. Click Exit. The Command Profiler window appears.

Change the window font,

Take these actions. 1. Change the printer font, 2. From the Tools menu, select View Trace File. The trace log file information appears in a new window. Select the text that you want to change, and then from the Settings menu, select Printer Font.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 36 of 48

3. 4.

On the Font window, select the font that you want to apply, and then click OK. Click Exit. The Command Profiler window appears.

4.

When you have finished viewing the trace log file, from the File menu, select Exit.

2011 RedPrairie Corporation


Comments on this topic?

User Authorization Overview


User authorization is the process of defining the users that can access the system, the functions that they can perform and the data that they can access. Before you begin setting up user authorizations, it is suggested that you learn about these concepts. What do you want to learn about? Setup Tasks Users and User Accounts Roles and Role Assignments Menu Options Data Access Groups Standard Permissions Custom Permissions

2011 RedPrairie Corporation Comments on this topic?

User Authorization Setup Tasks

These are the tasks you must perform to set up user authorizations. 1. 2. Create roles and identify the menu options. Optionally, assign standard permissions and custom permissions to roles. If no standard permissions are assigned to a role, then by default the role has full access. For more information, see Maintain Roles and Role Assignments. Create user accounts and assign roles to the user accounts. For more information, see Maintain User Accounts .

3.

If desired, you can also

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 37 of 48

modify menu options. See Maintain Menu Options. create custom permissions and assign them to roles. See Maintain Custom Permissions or Define and Assign a Control-Specific Custom Permission. create data access groups and assign them to Collaboration Portal users. See Maintain Data Access Groups.

Note: Data access group restrictions are limited to Collaboration Portal users. Collaboration Portal is comprised of these Web-enabled applications: Carrier Portal, Client Portal, Customer Portal , Store Portal, Tracking Portal and Vendor Portal.

2011 RedPrairie Corporation


Comments on this topic?

Users and User Accounts

A user is someone who accesses the system using a PC or RFT, or remotely accesses the system from the Internet using a Web service. In addition, for time and attendance purposes a user is someone for whom time tracking and gross pay calculations are performed. Every user must be identified in the system with a user account and then assigned specific system privileges. When a user logs in, the system builds a list of the functions that the user can perform based on the user account settings. Any changes made to the available functions for a user account will not take effect until the next time the user logs in. From Authorization Maintenance, access User Maintenance to maintain user accounts and access to your system.

2011 RedPrairie Corporation


Comments on this topic?

Roles and Role Assignments

A role is a category used to group menu options (such as client applications, reports orRF screen) for the purpose of maintaining user authorizations. Once roles are created, they are assigned to the appropriate user account(s) to control the tasks users are authorized to perform. As an example, you can create a Shipping Supervisor role to identify all of the menu options that are needed to fulfill the duties required for that job, and then assign that role to the user account for the shipping supervisors in your facility. Roles are organized in a hierarchical structure that uses parent/child relationships to control your ability to assign roles to other users. This structure restricts the levels of authorization that one user may assign to another user, ensuring that users are not given authorization they should not have.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 38 of 48

When you create a role, it is considered a child role. You assign a parent role to the child role to define its position within the hierarchy. When assigning the parent role, only the roles to which you are assigned are available for selection. This ensures that you can only create a role at a level in the hierarchy that is lower than or equal to your highest assigned role level. Similarly, when assigning a role to another user, you are only allowed to assign a role at a level in the hierarchy that is lower than (but not equal to) your highest assigned role level.

IMPORTANT: The Super role is the exception to the preceding statements. A user assigned to the Super role can assign the Super role to other users.

For example, if a user is assigned to the role Shipping Supervisor, and this is the highest role level in the hierarchy to which that user is assigned, that user can create a child role Shipping Clerk and assign it the parent role of Shipping Supervisor. The shipping supervisor can now assign the Shipping Clerk role to another user, but cannot assign the Shipping Supervisor role to another user. Only a user with the role that is the parent for the Shipping Supervisor role is authorized to assign the Shipping Supervisor role. From Authorization Maintenance, access Role Maintenance to maintain roles and role assignments. What do you want to learn about? Option Types

2011 RedPrairie Corporation


Comments on this topic?

Menu Options

A menu option is a client application, report, RFT operation or Web service. You can assign a menu option to a role to define authorization for the menu option. If you are logged in with the Super user account you can also assign a menu option to a specific user to configure who is authorized to access the menu option. limit a user's ability to access certain information within a menu option. For example, you might not want a user to see certain columns or to access certain drill-down information. By including executable parameters for an application, you can restrict users and secure your system's information.

Note: Alternatively, you can use standard and custom permissions to limit user access. For details, see Standard Permissions and Custom Permissions .

From Authorization Maintenance, access Role Maintenance to assign menu options to roles. If logged in with the Super user account, from Authorization Maintenance, access Menu Option Maintenance to further define menu options and their assignments.

2011 RedPrairie Corporation


Comments on this topic?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 39 of 48

Data Access Groups

A data access group is a named set of data, such as a list of customers, to which you can assign specific Collaboration Portal users for the purpose of limiting these users' access to that set of customer data within your Transportation Management system. When you define a data access group, you specify the type of data such as customer, customer type, customer address, client or carrier that you can assign to a data access group. Once data access groups are created and data items assigned, you then assign the appropriate users.

Note: Data access group restrictions are limited to Collaboration Portal users. Collaboration Portal is comprised of these Web-enabled applications: Carrier Portal , Client Portal , Customer Portal , Store Portal , Tracking Portal and Vendor Portal .

Data access groups are used when you want to limit users' access to the specific data needed to fulfill their job responsibilities. For example, if you want users that work with customers A and B to view and access only this customer data, you can create a "Customer" type data access group and assign customers A and B to it. Authorized users can then be assigned to the data access group. Users' data access is the sum of all data access groups to which they are assigned. Users without any data access group assignments will have full visibility to your system data from Collaboration Portal as defined by their role assignments. From Authorization Maintenance, access Data Access Group Maintenance and Assign Customer/Address to Data Access Group to maintain data access groups and data assignments.

2011 RedPrairie Corporation


Comments on this topic?

Standard Permissions

Standard permissions are permissions that can be assigned to a role to restrict the actions (such as creating, updating and deleting a record) that a role can perform on a specific application or an all applications assigned to the role. By default, a role has full access to all of its assigned applications (the Full Access standard permission is assigned). If you remove Full Access and assign another standard permission(s) to a role, then the role is limited to that standard permission (s). For example, you can assign the Read Only permission to allow the role access to assigned applications and the ability to retrieve data, but prevent the role from maintaining any data or performing any actions within those applications.

Note: Custom permissions can also be assigned to a role to give the role access to a specific form or to information and/or functionality on a specific application or form. For more information, see Custom Permissions.

A standard permission can be assigned to a specific application assigned to a role. For example, you can assign the Order Maintenance application to a role, but assign only the Create and Update standard permissions to it. As a result, users assigned to the role can create and update orders, but not delete them (the Delete button will be unavailable). This table lists the standard permissions that you can assign to a role, or to one or more applications assigned to a role.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 40 of 48

Standard Permission Create Create Address Delete Edit Chart Full Access Print Chart Read Only Save Chart Update Update Address

Description Lets users create a new record. Lets users create a new address record. Lets users delete a record. Lets users view and edit a chart. Lets users perform all available actions. Lets users print a chart. Lets users view a list of records. Lets users save changes made to a chart. Lets users update an existing record. Lets users update and save an existing address record.

From Authorization Maintenance, access Role Maintenance to assign standard and custom permissions to roles. If logged in with the Super user account, from Authorization Maintenance, access Menu Option Maintenance to assign standard permissions to an application assigned to a role.

2011 RedPrairie Corporation


Comments on this topic?

Custom Permissions

A custom permission is a user-defined permission that provides access to a specific form or information and/or functionality on a specific application or form. Access is granted for all roles to which the custom permission is assigned, and denied for all roles to which it is not assigned. Custom permissions can be defined for a specific application or form to grant access to a form within an application. access to a control, such as a button or check box. access to information, such as a tab or field. the ability to maintain the editable grid, such as update the information in a cell and/or add/delete rows. the ability to edit, save and/or print charts. the ability to create and/or update addresses. When you define a custom permission for an application or form, you can select to hide the control (such as the button, field, check box or tab) for those roles to which the permission is not assigned. Once a custom permission is defined, you must assign it to the role(s) that you want to have the permission. For more information, see Assign Custom Permissions to a Role.

IMPORTANT: Any role that does not have the custom permission assigned to it will be denied the permission and, if specified, the control will be hidden from those roles.

You use

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 41 of 48

Custom Permission Maintenance to maintain custom permissions, or Permission Control Association Setup to maintain control-specific custom permissions for an application or form and assign the permission to a role(s).

2011 RedPrairie Corporation


Comments on this topic?

Maintain User Authorizations

Use Authorization Maintenance to create roles create user accounts create data access groups, and assign user functionality. What do you want to do? Maintain Roles and Role Assignments Maintain User Accounts Add a User Account Using the Copy Feature Maintain Menu Options Maintain Data Access Groups Maintain Custom Permissions Define and Assign a Control-Specific Custom Permission

2011 RedPrairie Corporation


Comments on this topic?

Maintain Roles and Role Assignments

You use Role Maintenance to maintain the roles in your facility. You can specify an identifier for the role.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 42 of 48

a description of the role. the parent role to which this role is assigned. whether this role is active in the system. the name of the authorization group (the group of users that this role is authorized to maintain) associated with the role, if applicable. the data table associated with this role. After roles are defined you can use Role Maintenance to assign menu options, users, standard permissions and custom permissions; and to modify and delete roles when necessary. Alternatively, you can define a control-specific custom permission and assign it to a role(s) using the Permission Control Association Setup window accessible from a shortcut key sequence (Ctrl+Shift+F6). For instructions, see Define and Assign a Control-Specific Custom Permission . What do you want to do? Add or Modify a Role Delete a Role Define or Modify Menu Option Associations for a Role Define or Modify User Associations for a Role Assign Standard Permissions to a Role Assign Custom Permissions to a Role

2011 RedPrairie Corporation


Comments on this topic?

Maintain User Accounts

When you use User Maintenance to identify a user account, you specify a unique user and login ID. the user's first and last names. an optional media file associated with the user. a locale and client ID. an authorization group name. If a RedPrairie Enterprise product (for example, Web Visibility ) is licensed and installed, you can specify the name of the group of users or roles that the current user has authorization to maintain. security options that let you configure access to the system by enabling a user's ability to sign on automatically using the Microsoft Windows network user ID and password, or with a RedPrairie system password.

Note: When using a RedPrairie system password, you can also set a password expiration date and/or a

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 43 of 48

requirement to change the password when the user logs into the system for the first time. defining a user's account status as active, inactive or expired. defining a user's account expiration date. requiring external authentication, which validates the user's ability to access the system by using Lightweight Directory Access Protocol (LDAP). indicating that a role is a Super user. address information. the roles, reports and menu options assigned to this user. Workforce Management options (if Workforce Management is licensed and installed) by defining a user group, work team, supervisor and report card association whether the user is a supervisor whether the user is unmeasured a hire date a schedule a rate of pay, and comments. Time & Incentives options (if Time & Incentives is licensed and installed) by defining a personal identification number eligibility for and associated differential pay eligibility for incentive pay and payroll generation, and associated wage scales. Warehouse Management options (if Warehouse Management is licensed and installed) by defining which warehouse(s) the user is authorized to access which warehouse is the default for the user, and whether count back is required for the user. the data access groups assigned to this user (if Transportation Management is licensed and installed). After user accounts are defined you can use User Maintenance to modify user attributes and delete user accounts when necessary. What do you want to do? Add or Modify a User Account Delete a User Account

2011 RedPrairie Corporation


Comments on this topic?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 44 of 48

Add a User Account Using the Copy Feature


Authorized users can quickly add one or more new user accounts using an existing user account as a template. Using the Copy User window to create a new user account requires only the entry of a unique user ID, login ID, last name and first name. Once that information is entered and Create User is clicked, the fields are cleared and the information for another user account can immediately be added. This feature is especially useful when you need to add multiple users with the same role, such as a group of workers hired for a specific short-term assignment. To add a user account using the copy feature 1. Start Authorization Maintenance.

2. 3.

Click

On the Copy User window, from the Copy User list, select the user account to use as the template from which to copy. In the New User Information area, in the User ID box, type a unique identifier for this user.

4.

IMPORTANT: If using OS user authentication, the User ID must be the same as the user's Microsoft Windows network user identifier.

5.

If desired, in the Login ID box, type an alternative identifier for the User. If provided, this identifier appears on screens and reports in place of the User. In the Last Name and First Name boxes, type the user's last and first names. Click Create User. The user account is added and the fields in the New User Information area are cleared. Repeat steps 37 as needed until you have added all required user accounts. When you are done adding user accounts, click Finish. If you need to further define a user account, see Add or Modify a User Account.

6. 7. 8. 9. 10.

2011 RedPrairie Corporation


Comments on this topic?

Maintain Data Access Groups

You use Data Access Group Maintenance to maintain data access groups for your Collaboration Portal users.

Note: Data access group restrictions are limited to Collaboration Portal users. Collaboration Portal is comprised of these Web-enabled applications: Carrier Portal , Client Portal , Customer Portal , Store Portal , Tracking Portal and Vendor Portal .

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 45 of 48

When you create a data access group, you specify the name of the data access group, and type of data that the group contains. Additionally, you can specify if a limited number of users will be assigned to the data access group, and the maximum number of users that can be assigned. After data access groups are defined you can use Data Access Group Maintenance to assign users and restrictions to data access groups, and to modify and delete data access groups when necessary. What do you want to do? Add or Modify a Data Access Group Delete a Data Access Group Define or Modify Customer Type, Client or Carrier Data Access Group Restrictions Define or Modify Customer Data Access Group Restrictions Define or Modify Customer Address Data Access Group Restrictions Define or Modify User Associations for Data Access Groups

2011 RedPrairie Corporation


Comments on this topic?

Maintain Menu Options

When you use Menu Option Maintenance to maintain the menu options for your facility you can specify a system name for the menu option the description for the menu option the data table associated with the menu option the category that describes the type of menu option the executable name that lets users start the menu option the parameters that are processed by the executable name the image that appears next to a menu group on the navigation bar, and whether the menu option is active in the system. After menu options are defined you can use Menu Option Maintenance to assign roles and users, and to modify and delete menu options when necessary. What do you want to do?

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 46 of 48

Add or Modify a Menu Option Delete a Menu Option Define or Modify Role or User Associations for a Menu Option

2011 RedPrairie Corporation


Comments on this topic?

Maintain Custom Permissions

When you use Custom Permission Maintenance to maintain custom permissions you specify a unique identifier for the custom permission the identifier of the application and form to which the permission applies the control ID of the control (such as a button, field, check box or tab) to which the permission applies (or "----" if the permission is not specific to a control)

Note: To obtain a control ID, access the application or form on which the control appears, set the focus on the control, and then press Ctrl+Shift+F6. On the Permission Control Association Setup window, in the Control List area, the control ID is highlighted. a description of the permission whether to hide the control for roles that are not authorized to use it, and the global actions, if any, associated with the control. After custom permissions have been defined, you can use Custom Permission Maintenance to modify and delete custom permissions when necessary. You also use Role Maintenance to assign custom permissions to the roles that you want to have access to the functionality defined in the permission.

IMPORTANT: Any role that does not have the custom permission assigned to it will be denied the permission and, if specified, the control will be hidden from those roles.

Alternatively, you can use Permission Control Association Setup (accessible from a shortcut key sequence) to define control-specific custom permissions for an application or form, and assign them to a role(s). For instructions, see Define and Assign a Control-Specific Custom Permission . What do you want to do? Add or Modify a Custom Permission Delete a Custom Permission Assign Custom Permissions to a Role

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 47 of 48

2011 RedPrairie Corporation


Comments on this topic?

Define and Assign a Control-Specific Custom Permission

Use this procedure to define a custom permission for a control (such as a button, field, check box or tab) on the currently displayed window or form, and assign the permission to a role(s). Some windows have multiple child controls associated with a single parent control. For example, on Part Maintenance, there are several child controls associated with the cmdNew function; these controls let the user create a new item record, footprint, alternate item number and serial type number respectively. If you assign a custom permission to the parent control (cmdNew) the permission includes all of its child controls. If you assign a custom permission to a child control, the permission applies to that single function. You use a shortcut key sequence (Ctrl+Shift+F6) to access Permission Control Association Setup. Alternatively, you can define a control-specific custom permission using Custom Permission Maintenance, but if you use that method, you will need to know the name of the parent or child control that you want to define. For instructions, see Maintain Custom Permission . To define and assign a control-specific custom permission 1. Start the RedPrairie application and/or access the form that contains the control for which you want to define a custom permission. Press Ctrl+Shift+F6. The Permission Control Association Setup window appears displaying a list of controls for the application or form. If you want to view the child controls associated with a parent control, then in the Control List area, click expand the parent control. to

2.

3.

4.

Select the parent or child control for which you want to define a permission. If you select a parent control, all of its child controls are included in the permission.

Note: If a permission has already been assigned to the control, it appears in the Associated Permissions area grid view. You can define multiple custom permissions for a control.

5. 6. 7. 8.

Click New. The control appears in the grid view. In the Permission ID box, type a unique identifier for the permission. In the Description box, type a meaningful description of the permission. If you want the control to be hidden from roles to which the custom permission is not assigned, then select the Hide control if permission not assigned check box; otherwise, clear it. If you want to associate a global action with the custom permission, then select one or more of the related global actions.

9.

Note: If the permission is associated with a global action, then users who are not authorized for the custom permission will not be authorized to perform the global action on the application/form for which the permission is defined.

file://C:\Temp\~hh80D.htm

7/14/2011

Data Driven Applications Overview

Page 48 of 48

10. 11.

Click Save. If desired, assign the custom permission to a role(s).

IMPORTANT: Any role that does not have the custom permission assigned to it will be denied the permission and, if specified, the control will be hidden from those roles.

12. 13.

If desired, delete a custom permission. When you are finished defining and assigning control-specific custom permissions, click Exit.

2011 RedPrairie Corporation


Comments on this topic?

file://C:\Temp\~hh80D.htm

7/14/2011

You might also like