Versions Compared

Old Version 36

changes.mady.by.user Denise McGettigan

Saved on

compared with

New Version Current

changes.mady.by.user Denise McGettigan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can add shortcut internal links

via Designer

that allow users to

navigate

move from the grid directly to a dashboard, favorite or different database

, e

.

g.

For example,

 

click on a

sales rep

Sales Rep and open that particular

'

Rep Scorecard

' dashboard, or

dashboard.

You can also add links to an external application

, e

.

g.

For example,

 

click on a customer to open that customer's account in your ERP system.  

Table of Contents
maxLevel3
minLevel2

Open Designer

Insert excerptUse DesignerUse Designernopaneltrue 

To add a link, click the link icon next to the relevant dimension.  

Image Removed

The following screen will appear:

Image Removed

Click the green plus icon to add one or more new links, and populate the fields as follows:

  • Name - the caption that is shown in Phocas.
  • URL - the link code. More details below. Note there is no validation at design time.  

Once a link has been added, the link icon turns blue. After creating or changing a link, you need to rebuild the database before the link becomes available.

How a link will appear in Phocas

The 'Code' field is displayed

Learn about how links are used in Phocas

In the example below, the Code property displays on the user's screen as a hyperlink in blue text

, as shown below

. If the dimension has a single link, clicking the code value will

run

open the link. If

it

the dimension has two or more links, as in this example, clicking the code shows a dropdown menu with all of the available

link labels shown

links.

Image Removed

Linking to Rebates

If you have Phocas Rebates, you can link to an individual rebate so that users can open the rebate directly from Phocas.

Use the URL /Rebates/Rebate/Index/%% 

Image Removed

How the link appears in Phocas

Image Removed

Internal link examples
Image Added

Add a link to a dimension

  1. In Designer, click the Link button next to the relevant dimension.  

    Image Added

  2. In the Links window, click the green plus button to add one or more new links, then enter the following details:

    • Name - The name that displays in the grid.

    • URL - The link code. See below for more information. Note there is no validation of the link at this stage. 

  3. Click Save. The link button (icon) turns blue to indicate a link was added.

  4. Rebuild the database to make the link available.

    Image Added

Expand
titleView examples of internal links

Internal links can be set up using a syntax starting with 'database', 'favourite' (spelt with a 'u) or 'dashboard', as outlined below, followed by name (or ID) and the required query.

 

Syntax

Example

Link to another database

database:Name|query

database:GL|Dimension=Customer&Mode=Variance&Customer=%%

Link to a dashboard

dashboard:Name|query

dashboard:Customer Score Card|Customer=%%

Link to a favorite

favourite:Name|query

favourite:Declining Products|Customer=%%

Note

Notes: 

  • If using ID instead of Name:  The ID is an identifier displayed as the last part of the URL.

  • Query is typically the name of the dimension you wish to filter on follow by '=%%'.  And, if required, the property relating to the dimension. 

  • The syntax you enter must use the UK English spelling, which is favourite with a 'u', even if Phocas displays the word spelt in the usual way everywhere else in the product.

  • On the 'database' link, the mode defaults to 'Period' so it doesn't need to be specified.

  • The names of the databases,

favourites

  • favorites and dashboards are case sensitive.  If a link doesn't become active, check the spelling.

Transaction property links

Link to Rebates

If you have Phocas Rebates, you can link to an individual rebate, so users can open the rebate directly from Phocas.

Use the URL /Rebates/Rebate/Index/%% 

Image AddedImage Added

Add a link to a transaction property

You can add links to transaction properties so that in

Use

Transaction mode, users can click on a property (

e.g., 'customer website', 'invoice' or even 'invoice line'

such as Customer Website, Invoice or even Invoice line) to open an external application at a specific place. For example, clicking on an

'invoice

Invoice line

'

transaction property would open that particular line in your accounting system. These links are only visible to the user when in

transaction

Transaction mode.

To do this:

Select the link icon next to a property.
Image Removed
  • Enter a name for the link (this is the name that will appear on the grid)
    • Enter the following syntax in the 'URL' field (these are %%property_name%% placeholders).

    %%property_name%%

    E,g.

    Dimension properties

    1. In Designer, click the Link button next to the relevant property.  

      Image Added

    2. In the Links window, click the green plus button to add one or more new links, then enter the following details:

      • Name - The name that displays in the grid.

      • URL - The link code. Enter the following syntax (placeholders):

        • To reference a property, use %%property_name%%. For example, Value=%%invoice_number%%&AnotherValue=%%duedate%%

    Image Removed
    On the grid, the user will see a link similar to those below, which, in this example, would take them to their accounting system
    Image Removed
        • Image Added

        • To reference other dimension properties within a transaction property link,

    enter the following syntax: 

        • use %%dimension|dimension_name|property_name%%

    Where

        • (where the word ‘dimension’ is static

    . E.g.:

        • ). For example, %%dimension|Ship To|Name%%

    External links

    2. Click Save. The link button (icon) turns blue to indicate a link was added.

    3. Rebuild the database to make the link available. On the grid, users will see a link similar to those below, which, in this example, would take them to their accounting system.

      Image Added

    As well as linking to other Phocas databases, this feature can be used to open external applications and webpages, using the same parameter passing method. This is particularly useful when the partner ERP system can be opened using URLs.

    The syntax is the same, except for the domain part:

    https://mywebsite.com/CustomerInquiry?CustomerID=%%

    This would replace

    Replace the %% placeholder with the customer code of the selected customer. To pass a property instead of the code, use the syntax %%PropertyName%%

    .

    Expand
    titleSystem setting links (advanced administrators only)

    Administrators with permissions to view system settings can enter a system setting, for example to reference a setting that is actually a URL.

    To do this:

    Enter the following syntax in the link dialog.

    %%setting|setting_name%%

     E.g.

    %%setting|DynamicsURL%%

    If the setting doesn’t exist then blank is returned. You can also chain many together, e.g.: %%setting|DynamicsURL%%%%setting|DynamicsSiteName%%

    x

    On this page

    Table of Contents
    maxLevel3
    minLevel2