Creating a Company Planner board

After you plan a board, you set it up in the Company Planner Setup window.

Starting a new board

To create a new Company Planner board, follow these steps.

  1. Go to Operations > Company Planner Setup.
    The Company Planner Setup window opens.

  2. Click image1 Add Board.
    A new row appears in the Boards and Cells pane. By default:

    • The Description field shows (NEW).

    • A single cell row is added, with the Cell Type set to Grid.

    • The new board will be available to all users.

    image2

  3. In the Description field, enter a name for the board.

  4. In the Cell Options Editor pane at the bottom of the window, do the following:

    1. Enter a name in the Cell Name field.
      Your entry appears in the Cell Name field in the Boards and Cells pane. If you choose to show the cell name on the board, the system uses your entry.

      Note: The board you create shows the cells as panes or tabs. The name identifies the pane.

      This illustration shows the cells used in the default Tracking board.

      image3

      This illustration shows the board containing the cells.

      image4

    2. If needed, use the Cell Type drop-down list to select a different cell type. What you see in the Cell Options Editor pane depends on the cell type you are using. The cell type controls the tabs that appear and which options can be set. For a detailed list, see Choosing cell types.

  5. To add additional cells, click image5 Add Cell.
    A new row appears for each cell under the board in the Boards and Cells pane.

  6. If needed, you can:

    • Copy a cell

      If you need another cell that is the same type as one already in the board, you can copy the original cell.

      Note: You can also copy a cell from one board and use it in another board. To do so, copy the cell you need. Drag the copied cell to the board in which you want to use it.

      1. In the Boards and Cells pane, expand the board’s list of cells.

      2. Select the cell you want to copy.

      3. Click image6 Copy Cell.
        The duplicate cell is added to the list .

    • Delete a cell

      If you decide you do not need a cell you added to a board, you can delete it.

      1. In the Boards and Cells pane, expand the board’s list of cells.

      2. Select the cell you want to delete.

      3. Click image7 Delete Cell.
        The cell is removed immediately.

  1. Continue by setting cell options and adding subscriptions.

Setting cell options

What you see in the Cell Options Editor pane depends on the cell type you are using. The cell type controls the tabs that appear, and which options you can set. For a detailed list, see Choosing cell types.

With the board’s cells expanded in the Boards and Cells pane, select the row of the cell for which you want to set options.

image8

Select the needed tab and make entries appropriate for the cell type.

Setting Grid options for Grid cells

When you select the Grid cell type, the Grid Options tab is available.

image9

The Grid Options tab is not available for other types of cells.

Use this tab to set the following options for a Grid cell.

Required field: *

Field Definition

Planning Board *

Select the scroll view used in the cell.

This is a required field. All Grid cells must identify the planning board view used to populate the cell. You cannot save a board containing a Grid cell if you leave this field blank.

Edit button

Opens the Board Setup window. For details, see Creating and managing views.

If a Planning Board scroll is selected and you click Edit, the Board Setup window opens. You can modify the scroll.

Warning: Any changes made to the scroll apply everywhere the scroll is used, not just in that particular cell.

Show in Cell Title

Select the checkbox to show the board name in the cell title.

Refresh Time

Enter the number of minutes at which the data is refreshed.

Show Row Count

Select the checkbox to allow the title of the cell to show the number of rows returned.

Enable Runtime Edit

Select the checkbox to allow users to access the right-click shortcut menu to set retrieval restrictions.

Group

Define a group of grid cells in which only one row in any cell can be selected at any time.

If you have a row selected in one cell and select a row in a different cell, the row in the previous cell is no longer selected.

Key Field

Select a key (each column in the grid is a unique key).

If the user has selected a row or several rows in a grid and a grid refresh occurs, the rows containing the same key will be reselected after the refresh.

Right-click restrict

To enable, select the Enable Runtime Edit checkbox.

During runtime, this option brings up a scroll editor with restrictions. These restrictions are only temporary and do not save. For example, if the window contains a load scroll and you right-click, the shortcut menu includes the Restrict command. You can restrict the loads to a specific Bill To. This will refresh the grid with the loads for the specified Bill To. This restriction is only for that particular window and is not saved.

Setting Mapping options for Grid cells

When you select Grid cell type, the Mapping tab is available.

image10

The Mapping tab is not available for other types of cells. Do not confuse it with the Map Options tab. The Map Options tab applies to Map or Map Route cell types.

Use this tab to set mapping options relevant to Grid cells.

Field Definition

Map Data

You must select the checkbox before you can make entries in the rest of the fields.

Map Cell ID

Select a cell used in the board that is identified as a Map. The field’s drop-down list shows the cell’s cpd_Id field value.

ID Column

Select a column that is a unique identifier.

This will key a row to a map point. When a user clicks a map icon, the row can be selected if a key is defined and a subscription is set up.

Latitude Column

Select columns that define the latitude of each item.

Note: The data can be in degrees or seconds, based on your CityLatLongUnitsCityLatLongUnits General Info Table setting value.

Label Column

Select the column that will display as a label on the map point. Your selection may appear as a ToolTip. This option varies, depending on which map vendors you use.

Minimum Zoom Level

Set the zoom level. Options are:

  • Global

  • Regional

  • State

  • County

  • City

  • Street

Longitude Column

Select columns that define the longitude of each item.

Note: The data can be in degrees or seconds, based on your CityLatLongUnits General Info Table setting value.

Information Column

Select the column that displays when a user clicks a map icon. When you click the map icon, an information window opens for that icon.

It shows the information in the column that was selected using this option. For example, suppose that the information column is set to the destination company name. When the use clicks the icon on the map, the name of the destination company appears in the information window.

Default icon

Select a default icon to be used for the rows in the scroll.

Icon Column

Select a column that will allow each row to determine the icon that is displayed on that map for that row

Setting Mapping options for Map and RouteMap cells

When you select the Map or RouteMap cell type, the Map Options tab is available.

image11

The Map Options tab is not available for other types of cells. The Map Options tab applies to Map or Map Route cell types. Do not confuse with the Map Options tab.

Use this tab to set mapping options relevant to Map or RouteMap cells.

Field Definition

Initial Latitude

Specify the default latitude used when the map cell opens.

Initial Longitude

Specify the default longitude used when the map cell opens.

Initial Zoom

Specify the default zoom factor used when the map cell opens.

Default Map View

Specify the default detail used when the map cell opens.

You can have the map show a Satellite, a Street, or a Hybrid view.

Setting Report options for ReportViewer cells

When you select the ReportViewer cell type, the Report Options tab is available.

image12

The Report Options tab is not available for other types of cells.

When you select ReportViewer as the cell type in the Cell Options Editor pane, the Boards and Cells pane shows the cell type as SSRS.

Use this tab to set the following options for a ReportViewer cell.

Field Definition

Report Server URL

Specify the default latitude used when the report cell opens.

Note: The default entry in this field is https://localhost/ReportServer.

Report Path

Specify the default path to the report and the report name.

Show Parameters

Select the checkbox to show the input parameters in the report cell.

Show the parameter names and their sequence after the user browses for a report in the Parameters Grid. Only three additional parameters, corresponding to Arg1, Arg2, and Arg3 are allowed. This makes the parameter sequence important.

Note: After you save the report options, select a report from the browser. The parameters appear in the grid in this window.

Setting SQL options for SQLGrid cells

When you select the SQLGrid cell type, the SQL Options tab is available.

image13

The SQL Options tab is not available for other types of cells.

Use this tab to set the following options for a ReportViewer cell.

Required field: *

Field Definition

Refresh Time (in minutes)

Enter the number of minutes before the data is refreshed.

Show Row Count

Select the checkbox to show the number of returned rows in the cell title.

Query *

Enter the SQL query to be run, for example:

select * from carrier

Filter Query *

Enter the filter query, for example:

select * from carrier where car_id =` '{1}

{1} is an additional parameter that can be passed through this action.

To verify that your query retrieves the expected results, click image14 Test.

Setting Browser options for WebBrowser cells

When you select the WebBrowser cell type, the Browser Options tab is available.

image15

Use this tab to set the following options for a WebBrowser cell.

Field Definition

Use IE

Select this checkbox to have the application use Internet Explorer as the WebBrowser when opening the website.

Note: If you are using a different default browser, such as Chrome or Firefox, this setting will override your default.

Initial URL

Enter the URL that is loaded when the cell first loads.

For example:

https://www.google.com

Filter URL

Enter the URL that is loaded when the FilterData action is executed.

For example:

https://www.google.com/#safe=off&output=search&q={1}

Arguments 1, 2, and 3 replace the place holders {1}, {2}, and {3}

In the example, {1} is a parameter that can be passed through this action (Arg1). The value chosen in Arg1 will be substituted into {1} in the Filtered URL.

Adding subscriptions

Use this general process for subscriptions:

  • Decide what should happen when data is automatically retrieved
    Add a subscription to every cell that should refresh or perform another action.

  • Decide how the cells should change based on user interaction
    Add a subscription to each cell that changes based on an event.

To add a subscription, follow these steps.

  1. Go to Operations > Company Planner Setup.
    The Company Planner Setup window opens.

  2. In the Boards and Cells pane, expand the board to display its cells.

    image16

  3. Click the cell to which you want to add a subscription.

  4. In the Cell Options Editor pane, select the Subscriptions tab.

  5. Click image17 Add.
    A blank row is added.

    image18

  6. Make entries in the following fields:

    Field Definition

    Publisher

    Select the cell in which the event occurs.

    Note: The field shows the cells in your board in a drop-down list.

    Event

    Select the needed event.

    Notes:

    1. Not all event types are available in all cell types. For example, you cannot have a RowClicked event happen in a publisher cell that is a map. The appropriate events, based on the publisher cell type, appear in the Event field drop-down list. For descriptions of the events available in the system, see Understanding publisher events.

    2. If you select the CustomMenuCommand event, you must make an entry in the Menu Command field.

    Menu Command

    Identify the command associated with the CustomMenuCommand event.

    Note: You must create the command before you can specify it in a board. For details, see Defining custom commands to add to a menu or toolbar.

    Action

    Select an action.

    Note: Not all action types are available for all cell type/event type combinations. The actions appropriate to your entry in the Event field appear in the Action drop-down list. For descriptions of the available actions, see Understanding subscriber action types.

Specifying who can use the board

By default, all users have access to a new board. In the Company Planner Setup window, the All Users checkbox is selected automatically.

Selecting a group allows everyone in that group access to the board. If you do not want all members of a group to have access to a board, expand the list of users and clear the checkbox next to the group name. Select the checkbox for each individual who should have access.

When only some members of a group have access, the checkbox next to the group name is filled in, rather than displaying a checkmark.

image34

While you are in the process of creating a board, you may want to grant access only to yourself.

If needed, change the users/groups that will have access to the board in the Board Permissions pane.

  1. In the Company Planner Setup window, select the board.

  2. In the Permissions pane, clear the checkbox next to the group name.

  3. Select the checkbox of each user/user group that should have access to the board.

  4. Click image20 Save.

Editing an existing board

To edit a board, you can change cell options and revise subscriptions using the same procedures you followed when creating the board. Additionally, you can:

Copy a board

If you want, you can copy an existing board and change some parts of it to better suit your needs.

  1. In the Boards and Cells pane, select the board you want to copy.

  2. Click image35 Copy Board.
    The Copy Board message opens. It asks, "Do you want to copy selected board?"

  3. Click Yes to proceed.
    The new board appears at the bottom of the list. In the Description field, the system appends "Copy of" to the name of the original board.

    Note: If you decide not to copy the board, click No or Cancel.

Delete a board

If you decide you do not need a board you created, you can delete it.

  1. In the Boards and Cells pane, select the board you want to delete.

  2. Click image36 Delete Board.
    The Delete Board message opens. It asks, "Are you sure you want to delete this board?"

  3. Click Yes to proceed.
    The board is removed from the list.