Maintaining Longview Client

Longview Client is the portal through which users can access Longview reports, Longview Apps, and other Longview components in one interface. After Longview Client is implemented for your system by Longview Professional Services, you can continue to maintain the files to keep your system up to date.

This chapter contains information on the following main topics:

• Understanding Longview Client
• Configuring the Longview client
• Configuring the module files
• Configuring categories
• Module icons
• Working with folders
• Working with links
• Working with symbol selectors
• Working with Longview attributes

Understanding Longview Client

Before you perform any maintenance tasks for Longview Client, you should understand the following concepts:

• Understanding client files
• Locating client files
• Understanding Longview GUIDs
• Using special characters
• Displaying items conditionally in the navigation pane
• Showing or hiding file extensions
• Showing category short names

Understanding client files

The backbone of Longview Client is a series of XML files. Longview Client files can have one of the following extensions:

• .lvclient – referred to as the client file, this is the file that is initially loaded by the client to determine the navigation layout
• .lvmodule or .xml file – referred to as a module file, this file adds additional content in the form of a module or category in the client. These files are often added via the <include> markup to allow them to be re-used across different client files.

The main file is the client file, which includes or “calls” at least one module file. Each module file included in the main client file represents a tab in Longview Client. The client file includes elements to reference up to 20 module files via system attributes (10 general client modules and 10 system client modules). The attribute values depend on your system type.

Framework Client Configuration

Longview Close Client Configuration

Longview Tax Client Configuration

In the following graphic, four modules are shown: Consolidate, Design, My Components, and Documentation.

Caution: Do not modify the out-of-box client or module files.

In XML, elements contain attributes with name/value pairs, such as the following:

<Include FileName="Consolidation.lvmodule"/>

where:

• Include is an XML element
• FileName is the name portion of an XML attribute.
• Consolidation.lvmodule is the value portion of the FileName XML attribute. The value may also be determined by an attribute as follows:

  <Include FileName="[[SYSTEM,ASLVClientModule01,DBDEFAULT]]"/>

As an administrative user of Longview Client, all XML attributes you can modify are optional. Where possible, this chapter lists available XML attributes, and you can choose to include or exclude them as appropriate to your system.

Locating client files

Typically, Longview Client files are stored within applications folder on the Data Server working directory, such as C:\Longview\DataServers\<LID>\applications; however, depending on your system implementation, your files may be in an alternate location or folder.

Depending on your system you will have different out-of-box files:

Caution: Do not modify the out-of-box client or module.

Understanding Longview GUIDs

Typically, a GUID (short for “globally unique identifier”) is a unique reference number used as an identifier. For Longview Client files, Longview GUIDs are alphanumeric and follow the naming conventions created by Longview Professional Services. As you add or modify items in client and module files, it is best practice to adhere to the Longview GUID naming conventions already in place. Regardless of the naming convention, every Longview GUID you include in your series of client and module files must be unique.

Using special characters

In XML, you must use XML character entities for the system to read special characters within your strings. Review the following table for a list of special characters and the way to include them within strings in your client and module files.

Displaying items conditionally in the navigation pane

As an administrative user, you can choose to display items in the navigation pane conditionally. You may want to, for example, display an item in the navigation pane based on a Longview attribute value using the Show XML attribute. The default if the Show XML attribute is not included in your series of client and module files is True, and all items display in the navigation pane. If the expression for the Show XML attribute is invalid, the system treats the expression as True and all items display in the navigation pane.

You can use the Show XML attribute for the following items:

• Folder elements.
• Link elements. For more information, see Working with links.
• Symbol selector elements. For more information, see Working with symbol selectors.

Syntax

To hide an item in the navigation pane, include the following at the end of the relevant line in your client or module file:

<... Show="Expression"/>

where:

• Expression is one of: True, False, or an attribute token.

<Folder Name="My Reports" Show="False">
 
<LongviewDocs Guide="LVWorkflow.pdf" Show="[[System,ASWorkflowInUse,DBDefault]]"/>
 
<LVApp Name="This is a Test" AppName="HelloWorld" GUID="LongviewCPM_App001" Show="[[USER, AUPowerUser, THIS]]"/>

Showing or hiding file extensions

Depending on your system implementation, file extensions may be shown or hidden by default in the navigation pane for Longview Apps and Longview reports. As an administrative user, you can override the default setting at the folder level or link level by adding the ShowExtensions XML attribute. The default if the ShowExtensions XML attribute is not included in your series of client and module files is True, and file extensions display in the navigation pane.

Syntax for folders

<Folder Name="Name" ShowExtensions="Value">                                

where:

• Name is the name of the folder to display, enclosed in double quotation marks.
• Value is whether to show or hide file extensions for all relevant items in the folder and can be TRUE to show file extensions or FALSE to hide file extensions.

<Folder Name="My Reports" ShowExtensions="True">                            
<Folder Name="My Reports" ShowExtensions="False">

Syntax for links

<ItemType ItemName="MyItem.ext" GUID="Id" ShowExtensions="Value"/>            

where:

• ItemType is type of item to link to and can be LVApp or ReportTemplates.
• ItemName is the name of the item to include and can be AppName for a Longview App or FileName for a Longview report.
• MyItem.ext is the name and relevant extension for the item to link to, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.
• Value is whether to show or hide file extensions for all relevant items in the folder and can be TRUE to show file extensions or FALSE to hide file extensions.

<LVApp AppName="NewEmployee.lvapp" GUID="LongviewCPM_NewEmp" ShowExtensions="True"/>
ShowExtensions="True"/>
<ReportTemplates FileName="MyReport.rtp" GUID="LongviewCPM_rtp001" ShowExtensions="True"/>

Syntax for Longview categories

<ListCategory Name="App Category Name" Types="Types" GUID="Id" ShowExtensions="Value"/>

where:

• App Category Name is the name of the Longview category as created Longview Analysis and Reporting, enclosed in double quotation marks.
• Types is a pipe ( | ) delimited list of items assigned to the category and can be Report and/or App, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.
• Value is whether to show or hide file extensions for all relevant items in the folder and can be TRUE to show file extensions or FALSE to hide file extensions.

<ListCategory Name="Admin" Types="Report|App" GUID="LongviewCPM_AdminCatExt" ShowExtensions="True"/>

Note: Longview does not support the modification of client and module files outside of the tasks outlined in this chapter.

Showing category short names

Depending on your system implementation, category short names may be shown or hidden in the navigation pane. The category short name is short text that can be displayed under the category image for ease of identifying categories quickly. By default, the ShowCategoryShortNames XML attribute is not included in your client file, which will use its default value of False. In this case, only the image for each category will be displayed in the navigation pane. To enable the display of category short names, the ShowCategoryShortNames XML attribute must be added to the <UI> element in your client or module file.

<UI ShowCategoryShortNames="Value">                        

where:

• Value is whether to show category short names if they are defined. Valid values are TRUE or FALSE. The short name for a category will only render if the ShortName XML attribute for the category element is also defined. For more information, see Understanding category elements.

<UI ShowCategoryShortNames="true">                

Debugging Longview Client Launch Issues

If the Longview Client fails to launch and you are having difficulty discovering the reason you can enable detailed logging to help solve the issue.

To enable detailed logging:

1. Navigate to the local Longview folder (Documents\Longview\<Identifier>
2. Open the logs folder. If there is no logs folder create one.
3. Create a new text file named “LongviewClient.log”.
4. Launch the Longview Client.
5. Review the contents of the log file.

Configuring the Longview client

You can customize the Longview Client to specify what will be displayed. This includes the ability to customize:

• The modules or “circles” at the top left of the navigation pane, and within the menu icon.
• The categories within the navigation pane.
• Folders and Links within the categories.

This section provides information on these main topics:

1. Understanding the client file
2. Longview Close and Plan modules
3. Customizing the client file
4. Understanding the module files
5. Customizing the module files

Understanding the client file

The client file uses the ‘Include Filename’ tag to include modules in the Longview Client. These modules are defined using system attributes.

<client>
    <Config>
        <description>[[SYSTEM,ASLVClientDescription,DBDEFAULT]]</description>
        <procedure>[[SYSTEM,ASLVClientProcedure,DBDEFAULT]]</procedure>
        <rootpath>[[SYSTEM,ASLVClientRootPath,DBDEFAULT]]</rootpath>
        <userid/>
        <groupid/>
        <serverid/>
        <defaulthelp>[[SYSTEM,ASLVClientDefaultHelp,DBDEFAULT]]</defaulthelp>
        <helpmappings>[[SYSTEM,ASLVClientHelpMappings,DBDEFAULT]]</helpmappings>
    </Config>
  <Include FileName="[[SYSTEM,ASLVClientOptions,DBDEFAULT]]"/>
  <UI ShowCategoryShortNames="true">
    <Include FileName="[[SYSTEM,ASLVClientModule01,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule02,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule03,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule04,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule05,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule06,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule07,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule08,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule09,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientModule10,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem01,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem02,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem03,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem04,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem05,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem06,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem07,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem08,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem09,DBDEFAULT]]"/>
    <Include FileName="[[SYSTEM,ASLVClientSystem10,DBDEFAULT]]"/>
  </UI>
</client>

These system attributes can be adjusted to point to any custom module file if required.

Longview Close and Plan modules

Longview Close and Plan includes 6 out-of-box module files:

Longview Tax modules

Longview Tax includes out-of-box module files. Only module files to which you have purchased a license will be visible in your Longview Tax client

Solutions Framework modules

Solutions Framework includes out-of-box module files:

Customizing the client file

If the content within the Longview.lvclient file needs to be modified, a custom client file will need to be created. Since the content is full attribute driven the client file should only be updated if you need more than 20 module files. Otherwise, you should modify the system attributes to point to custom module and options files as required.

Note: The standard client file provided should not be modified or renamed. Instead, a new client file should be created, and the content updated accordingly. This will avoid the client file being overwritten when an upgrade is performed.

To customize the client file:

1. Navigate to the applications folder in your Data Server working directory. For example, C:\Longview\DataServers\Longview\applications.
2. Create a copy of the client file.
3. Rename the copy of the client file to a new custom name.
4. Update the system attribute SLVClientConfigFileName to point to the name of the new client file.
5. Edit the new client file as required. The Include FileName tags allow you to include modules within the Longview Client.

Understanding the Longview Close module files

Each of the module files (Consolidation.xml and Planning.xml) support configuration of folders and entities symbol selection without the need to customize the module files.

Each module contains the following categories:

1. Processes: holds process maps used to direct the user through various steps to complete system processes.
2. Data Collection: holds apps used to input or import data into the system.
3. Reporting: holds apps and reports used to review or analyze results.
4. Workflow: holds the application used for setting and reporting on the status of a data area in the Longview application and provides a mechanism to notify users of status.
5. Administration: holds apps and reports used to manage the system.

Within the processes, data collection and reporting categories is support for up to ten folders. These folders allow you to group related items into a logical collection. Each folder also contains an entity selector that allows the user to select an entity symbol to be used with each app or report within the folder if activated. The contents of each folder are determined by the category a process map, app or report is published to.

The name of the folder and the entity symbol selection option is configured via the Configure Categories app.

The consolidate module

The consolidate module contains up to ten folders each for process maps, data collection and reporting. The Administration category is defined by a shared Administration.xml file used for both consolidation and planning.

<Folder Name="[[SYSTEM,ASlvclientCategoryCONSDC01,DBDEFAULT]]" Expand="False">
  <SymbolSelector Name="SymbolSelector"    
    Dimension="[[SYSTEM,SGPEntitiesDimension,DBDEFAULT]]" 
    Symbolspec="[[SYSTEM,ASlvclientEntitySymbolSpecDC,DBDEFAULT]]" 
    SelectionType="[[SYSTEM,ASlvclientCategoryCONSDC01ST,DBDEFAULT]]" 
    MultipleSelection="False" ReadAccessSelection="False" 
    DefaultText="Select an entity" DefaultAttribute="UGPD2InputDefault" 
    DefaultAttributeType="User" ContentType="NameAndDescription"/>
  <LVApp Category="CONSDC01" GUID="CONSDC01" />
</Folder>

The planning module

The planning module contains a budget and forecast folder within the process maps, data collection and reporting categories. Within each folder up to ten sub-folders can be configured.

<Folder Name="Budget" Expand="True">
  <Folder Name="[[SYSTEM,ASlvclientCategoryBDGTDC01,DBDEFAULT]]" Expand="False">
    <SymbolSelector Name="SymbolSelector" 
      Dimension="[[SYSTEM,SGPEntitiesDimension,DBDEFAULT]]" 
      Symbolspec="[[SYSTEM,ASlvclientEntitySymbolSpecDC,DBDEFAULT]]" 
      SelectionType="[[SYSTEM,ASlvclientCategoryBDGTDC01ST,DBDEFAULT]]" 
      MultipleSelection="False" ReadAccessSelection="False" 
      DefaultText="Select an entity" DefaultAttribute="UGPD2InputDefault" 
      DefaultAttributeType="User" ContentType="NameAndDescription"/>
    <LVApp Category="BDGTDC01" GUID="BDGTDC01" />
  </Folder>
</Folder>

The administration category

The administration category is shared by the consolidation and planning modules and is defined in the Administration.xml file. The administration category defines several pre-defined folders to organize administration apps. Configured administration apps can be added to the administration category by publishing the app to specific categories.

Folder contents are specified using categories:

Note: The contents of the Security and Monitoring folder are pre-defined and not configured by publishing to specific categories.

Understanding the Longview Tax module files

Each of the module files (LongviewTaxProvision.lvmodule, LongviewTaxPlanning.lvmodule, LongviewTaskManagement.lvmodule, LongviewGlobalTransparency.lvmodule and LongviewTransferPricing.xml) contain the following categories:

1. Processes: holds process maps used to direct the user through various steps to complete system processes.
2. Data Collection: holds apps used to input or import data into the system.
3. Reporting: holds apps and reports used to review or analyze results.
4. Workflow: holds the application used for setting and reporting on the status of a data area in the Longview application. This module is used for Tax Provisioning and Tax Planning modules only.
5. Administration: holds apps and reports used to manage the system.

Within the processes category there is support for up to ten folders. These folders allow you to group related items into a logical collection. Each folder also contains an entity selector that allows the user to select an entity symbol to be used with each app or report within the folder if activated. The contents of each folder is determined by the category a process map is published to.

The name of the folder and the entity symbol selection option is configured via the Configure Categories app.

Understanding the Solutions Framework module files

The consolidate module contains up to ten folders each for process maps, data collection and reporting. The Administration category is defined by a shared Administration.xml file used for both consolidation and planning.

The out-of-box module file (LongviewCPM.xml) contains up to ten folders each for process maps, data collection and reporting for each of Consolidation, and Planning. The Administration category is defined by the Administration.xml file. The file otherwise contains the same content as Longview Close and Plan modules.

Customizing the module files

If the content within any of the modules in the Longview Client need to be changed, custom module files will need to be created.

Note: The standard module files provided should not be modified or renamed. Instead, a new module file should be created, and the system attributes updated accordingly. This will avoid any module files being overwritten when an upgrade is performed.

To create a custom module file:

1. Create a new module file under the applications folder in your Data Server working directory.

   Note: A copy of a standard module can be used as a starting point for a custom module. See Locating client files to find the module file you want to customize.

2. Edit the new module file to include the required categories, folders, and links to be displayed in the Longview Client.
3. Update the system attributes to point to the customized module file.

Configuring the module files

Out-of-box module files are configured using the Configure Categories app.

To access configure categories:

1. Within the Design module, select the Administration category.
2. Click Configure Categories.
3. The Configure Categories table appears.

Configuring categories

Depending on your implementation the configure categories table will appear with:

• A combination of the Consolidate tab and the Budget and Forecast tabs.
• A combination of Tax Provision, Task Management, Global Transparency, Tax Planning and Longview Transfer Pricing

Note: Any changes made to existing categories will not be reflected until the navigation pane is refreshed.

Any changes made to existing categories will not be reflected until the navigation pane is refreshed. Each of the tabs works in the same way but configures different folders within the Longview client.

The configure category table contains the following columns:

To activate a category:

1. Check the Active column.
2. Enter a description for the folder (mandatory).
3. Select the symbol selection type (mandatory).
4. Click Apply.

The category will be added to the list of publish categories available, and the related system attributes will be updated. The folder will appear in the client navigation once a process map, app or report is published to that category.

To deactivate a category:

1. Open Longview Analysis and Reporting.
2. Click on the Categories tab.
3. Select the category to deactivate.
4. Press the Delete key.

Note: You will only be able to delete a category that has no reports, process maps or apps published to it.

Module icons

If you are customizing your Longview modules, you may want to include a different module icon. The following icon set is provided:

Working with categories

In Longview Client, folders contain groupings of links. Depending on the category and your system, you may see several folders within a category. You can click a folder to expand or collapse it in the navigation pane. You may also see a Symbol Selector above a grouping of folders or directly underneath a folder. You can select a symbol that applies to all links underneath the Symbol Selector.

In the following graphic, Review is a folder containing links to several Longview Apps and reports.

This section contains information on the following main topics:

• Understanding category elements

Understanding category elements

The <Category> element is a single XML element with the optional Name, Image, ShowExtensions and ShortName XML attributes. If you include a category without the Name XML attribute, “Untitled” displays as the category name. You must include at least one link for the category to display. Category elements must have a <Module> element as their parent.

<Category Name="My Category" Image="My Image.png" ShortName="My ShortName">
  <MyContent/>
</Category>

where:

• My Category is the Name XML attribute of the category enclosed in double quotation marks.
• My Image is the Image XML attribute of the category enclosed in double quotation marks.
• My Shortname is the ShortName XML attribute of the category enclosed in double quotation marks. This attribute is used in conjunction with the ShowCategoryShortNames XML attribute for the <UI> XML element. If the ShortName is defined and the ShowCategoryShortNames attribute is true, the value for My Shortname will appear under the image for the category. If My Shortname is too long, it will be displayed with ellipses (...). This feature can help users quickly identify the categories in the navigation pane. For more information, see Showing category short names.
• MyContent is the name of at least one folder or link to include within the category. For more information, see Adding folders and Adding links.

<Category Name="Period End Review" Image="Icons\Calendar.png" ShortName="End Rev">
  <Folder Name="Review" Expand="False">
    <ListCategory Name="CONSR" Types="APP|REPORT" GUID="CONSR" />
  </Folder>
</Category>

Working with folders

In Longview Client, folders contain groupings of links. Depending on the category and your system, you may see several folders within a category. You can click a folder to expand or collapse it in the navigation pane. You may also see a Symbol Selector above a grouping of folders or directly underneath a folder. You can select a symbol that applies to all links underneath the Symbol Selector.

In the following graphic, Review is a folder containing links to several Longview Apps and reports.

This section contains information on the following main topics:

• Understanding folder elements
• Adding folders
• Modifying folders
• Deleting folders

Understanding folder elements

The <Folder> element is a single XML element with the optional Name, Expand and Style XML attributes. If you include a folder without the Name XML attribute, “Untitled” displays as the folder name. You must include at least one link for the folder to display. Folder elements must have a <Category> element or another folder as their parent.

<Folder Name="My Folder" Expand="Expand" Style="Heading">          
  <MyLink/>
</Folder>

where:

• My Folder is the Name XML attribute of the folder to add or modify, enclosed in double quotation marks.
• Expand is whether the folder is initially expanded and can be True to expand or False to collapse the folder, enclosed in double quotation marks. The default if you do not include the Expand attribute is False.
• Heading specifies that the folder should be styled as a top-level folder. If the XML attribute Style is not present, the folder appears with normal styling.
• MyLink is the name of at least one link to include within the folder. For more information, see Adding links.

<Folder Name="Admin" Expand="True">
  <ReportTemplates Category="Admin" GUID="LongviewCPM_Admin_Reports"/>            
</Folder>

Adding folders

You can add a folder to an existing category. A folder must contain at least one link for the folder to display. Folders appear in the navigation pane in the order they are listed in the module file.

To add a folder to an existing category:

1. Open the relevant module file in your preferred text editor.
2. Locate the category in which you want to add the new folder.
3. In the appropriate place, add the <Folder> element and include at least one link. For more information, see Understanding folder elements and Adding links.
4. Save your changes.
5. Launch Longview Client and verify that the new folder appears as expected.

Modifying folders

You can modify an existing folder.

To modify an existing folder:

1. Open the relevant module file in your preferred text editor.
2. Locate the <Folder> element you want to modify.
3. Make the necessary changes. For more information, see Understanding folder elements and Adding links.

   Note: If you remove the Name XML attribute of a folder, “Untitled” displays as the folder name.

4. Save your changes.
5. Launch Longview Client and verify that the new folder appears as expected.

Deleting folders

You can delete an existing folder.

Caution: Deleting a folder removes all links contained within the folder. To restore a deleted folder, you must recreate the folder, including all links.

To delete an existing folder:

1. Open the relevant module file in your preferred text editor.
2. Locate the <Folder> element you want to delete.
3. Delete all content from the beginning of the relevant <Folder> element to the end of the relevant </Folder> element.
4. Save your changes.
5. Launch Longview Client and verify that the new folder does not appear.

Working with links

In Longview Client, links are typically grouped together in a folder but can also appear under a category. The following graphic shows several folders directly under a category Period End:

This section contains information on the following main topics:

• Understanding link elements
• Adding links
• Modifying links
• Deleting links

Understanding link elements

You can include links to the following items in Longview Client:

• Longview Apps
• Longview categories
• Longview components
• Longview Dashboard panels
• Longview Documentation
• Longview process maps
• Longview reports
• Longview tools and editors
• URLs

Link elements must have a <Category> or <Folder> element as their parent.

For Longview Apps and Longview reports, you can optionally show or hide file extensions. You can also specify whether to show or hide file extensions for all Longview Apps and Longview reports assigned to a Longview category. For more information, see Showing or hiding file extensions.

Longview Apps

You can create a link to a Longview App using the following code:

<LVApp AppName="AppName.lvapp" Name="Name" GUID="Id"/>                

where:

• AppName is the name of the .lvapp to include, enclosed in double quotation marks.

  Note: To include all Longview Apps assigned to a category, use the ListCategory element. For more information, see Longview categories.

• Name is the name of the link to display, enclosed in double quotation marks. This parameter overrides the optional ShowExtensions XML attribute, if included. For more information, see Showing or hiding file extensions.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<LVApp AppName="NewEmployee.lvapp" Name="New Employee" GUID="LongviewCPM_NewEmp"/>

Longview categories

You can create a series of links to all Longview Apps, and reports assigned to an existing category using the following code:

<ListCategory Name="App Category Name" Types="Types" GUID="Id"/>           

where:

• App Category Name is the name of the Longview category as created in Longview Analysis and Reporting, enclosed in double quotation marks.
• Types is a pipe ( | ) delimited list of items assigned to the category and can be Report and/or App, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

<ListCategory Name="Admin" Types="Report|App" GUID="LongviewCPM_AdminCat"/>

Longview components

You can create links to all Longview components to which a user has access using the following code:

<LongviewComponents GUID="Id"/>                            

where:

• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

Review the following table for the code to use to create a link to a single Longview component.

Note: To include all Longview Apps assigned to a category, use the ListCategory Users can see links only to the components to which they have access.

For more information, see Adding links.

<LongviewComponents GUID="LongviewCPM_My_Components"/>
<AddinOffice Name="My Workbook" FileName=“myworkbook.xlsx"/>
<ApplicationAdministrator Name="Hierarchy Maintenance" Section="Symbols"/>
<AnalysisReporting Name="Launch Longview A&R"/>
<DashboardDesigner Name="Launch Longview Dashboard Designer"/>
<JournalEntries Name="Launch Longview JEs"/>
<ServerManager Name="Launch Longview Server Manager"/>
<WorkflowDesigner/>

Longview Dashboard panels

You can create a link to a Longview Dashboard panel using the following code:

<LongviewPanel Name="Name" Panel="Panel" GUID="Id"/>                

where:

• Name is the name of the link to display, enclosed in double quotation marks.
• Panel is the name of the existing Longview Dashboard panel, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<LongviewComponents GUID="LongviewCPM_My_Components"/>
<LongviewPanel Name="Workflow" Panel="Approval_Workflow" GUID="LongviewCPM_WorkflowPanel"/>

Longview Documentation

You can create a link to a Longview Documentation PDF using the following code:

Note: Users can always see all documentation links, regardless of the components to which they have access.

<LongviewDocs Guide="Guide Name"/>                    

where:

• Guide Name is the name of the PDF to include, enclosed in double quotation marks, and can be one of the following:

Note: To display all PDFs, exclude Guide="guide name", for example: <LongviewDocs/>.

For more information, see Adding links.

<LongviewDocs Guide="LVDeveloperGuide"/>                       
<LongviewDocs/>

Longview process maps

You can create a link to a Longview process map using the following code:

<ProcessMap Name="Name" ProcessID="ProcessID" GUID="Id"/>                

where:

• Name is the name of the link to display, enclosed in double quotation marks.
• ProcessID is the ID of the process map to display, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<ProcessMap Name="High-Level Budget Process" ProcessId="P1" GUID="PMap1"/>

Longview reports

You can create a link to a Longview report using the following code:

<ReportTemplates FileName="File.rtp" Name="Name" GUID="Id"/>                

where:

• File is the name of the .rtp to include, enclosed in double quotation marks.

  Note: To include all reports assigned to a category, use the ListCategory element. For more information, see Longview categories.

• Name is the name of the link to display, enclosed in double quotation marks. This parameter overrides the optional ShowExtensions XML attribute, if included. For more information, see Showing or hiding file extensions.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<ReportTemplates FileName="MyReport.rtp" Name="My Report" GUID="Longview_rtp001"/>

Longview tools and editors

You can create a link to a Longview tool or editor using the following code:

<Item Name="Name" GUID="Id"/>                                        

where:

• Item is the tool or editor and can be one of the following:

  DataLocks Mappings

  Events Publisher

  EventsStatus UserSubmissions

• Name is the name of the link to display, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<Mappings Name="Mappings" GUID="LongviewCPM_Mappings"/>

URLs

You can create a URL using the following code:

<Url Name="Name" Address="Website Address" GUID="Id"/>                 

where:

• Name is the name of the link to display, enclosed in double quotation marks.
• Website Address is the address for the URL, enclosed in double quotation marks.
• Id is the Longview GUID for the link, following your system’s naming conventions and enclosed in double quotation marks. For more information, see Understanding Longview GUIDs.

For more information, see Adding links.

<Url Name="Longview eLearning Library" Address="https://longview.administratelms.com/" GUID="LongviewCPM_eLearningLibrary"/>

Adding links

You can add a link to an existing folder or category. Links appear in the navigation pane in the order they are listed in the module file.

To add a link to an existing folder:

1. Open the relevant module file in your preferred text editor.
2. Locate the folder or category in which you want to add the new link.
3. In the appropriate place, add the relevant link code. For more information, see Understanding link elements.
4. Save your changes.
5. Launch Longview Client and verify that the new link appears as expected.

Modifying links

You can modify an existing link.

To modify an existing link:

1. Open the relevant module file in your preferred text editor.
2. Locate the link you want to modify.
3. Make the necessary changes. For more information, see Understanding link elements and Adding links.
4. Save your changes.
5. Launch Longview Client and verify that the link appears as expected.

Deleting links

You can delete an existing link.

Caution: Deleting a link cannot be undone. To restore a deleted link, you must recreate the link.

To delete an existing link:

1. Open the relevant module file in your preferred text editor.
2. Locate the link you want to delete.
3. Delete all content from the beginning of the relevant link element to the end of the relevant link element.
4. Save your changes.
5. Launch Longview Client and verify that the link does not appear.

Working with symbol selectors

In Longview Client, it is sometimes helpful to include a symbol selector so users can select a symbol to populate down through a series of folders or links. You can include a symbol selector above a series of folders or under a specific folder.

The following graphic shows a symbol selector for the ENTITIES dimension above a folder, and a symbol selector for the ACCOUNTS dimension under a folder.

Note: You cannot include a nested symbol selector for the same dimension as a top-level symbol selector.

This section contains information on the following main topics:

• Understanding symbol selector elements
• Adding symbol selectors
• Modifying symbol selectors
• Deleting symbol selectors

Understanding symbol selector elements

The <Symbol Selector> element is a single XML element with many optional XML attributes. Symbol selector elements must have a <Category> or <Folder> element as their parent.

<SymbolSelector Name="Name" Dimension="DimensionName" Symbolspec="Spec" SelectionType="SelectionType" MultipleSelection="Multiple" ReadAccessSelection="ReadAccess" DefaultText="WatermarkText" DefaultSelection="SymbolName" DefaultAttribute="AttributeName" DefaultAttributeType="AttributeType" ContentType="ContentType" />
  <AttributeFilters>
</SymbolSelector>

where:

• Name is currently not used.
• DimensionName is the dimension containing the symbols to include in the symbol selector, enclosed in double quotation marks.
• Spec is the level of symbols to display in the symbol selector hierarchy in relation to the specified symbol, for example, SymbolName### or SymbolName#99, enclosed in double quotation marks.
• SelectionType is the type of symbols users can select and can be either Parent or Leaf, enclosed in double quotation marks.
• Multiple is whether users can select multiple symbols or not and can be TRUE or FALSE, enclosed in double quotation marks.
• ReadAccess is whether users can select read-only symbols and can be TRUE or FALSE, enclosed in double quotation marks.
• WatermarkText is the text to display when no symbols are selected, enclosed in double quotation marks.
• SymbolName is the initial symbol to display in the symbol selector, enclosed in double quotation marks.
• AttributeName is the name of an attribute for which to display the default value, enclosed in double quotation marks.
• AttributeType is the type of attribute, if AttributeName is specified, and can be one of SYMBOL, SYSTEM, or USER, enclosed in double quotation marks.
• ContentType is whether to display symbol names or symbol names and descriptions, and can be either NAME or NAMEANDDESCRIPTION, enclosed in double quotation marks.
• AttributeFilters is an attribute filter in the format
  Copy

  <AttributeFilters Operator="Operator">
  <AttributeFilter Spec="FilterType{AttributeName{Operation{Value"/>
  </AttributeFilters>

  where:

  • Operator is the type of filter and can be AND or, enclosed in double quotation marks.
  • FilterType is the method to use to search the hierarchy for symbols matching the filter criteria and can be one of ALL, PARENT, LEAF, or ROOT.
  • AttributeName is the name of an attribute.
  • Operation can be EQ for exactly equal to or NE for not equal to.
  • Expression is a character string. If the expression contains spaces, enclose the expression in the XML character entity for double quotation marks (&quot;) such as &quot;expression with spaces&quot;. If the expression is a list, separate multiple items with a pipe ( | ).

    For non-list attributes, the filter behaves as follows:

    • Attribute EQ Expression—Matches only if the attribute is an exact match of the expression.
    • Attribute NE Expression—Matches if the attribute is not an exact match of the expression.

    For list attributes, the filter behaves as follows:

    • Attribute EQ Expression—Matches if the attribute is an exact match of the expression, or is a list of values, any one of which exactly matches the expression.
    • Attribute NE Expression—Matches if the attribute is empty or a list of values, none of which exactly matches the expression.

<SymbolSelector Name="SymbolSelector" Dimension="Entities" Symbolspec="" SelectionType="All" MultipleSelection="False" ReadAccessSelection="False" DefaultText="Select an entity" DefaultAttribute="UD2InputDefault" DefaultAttributeType="User" ContentType="NameAndDescription">
<AttributeFilters Operator="AND">
<AttributeFilter Spec="Leaf{ZGPNativeCurrency{EQ{CAD"/>
</AttributeFilters>
</SymbolSelector>

Adding symbol selectors

You can add a symbol selector to an existing category or folder.

To add a symbol selector:

1. Open the relevant module file in your preferred text editor.
2. Locate the element below which you want to add the new symbol selector.
3. In the appropriate place, add the <Symbol Selector> element. For more information, see Understanding symbol selector elements.
4. Save your changes.
5. Launch Longview Client and verify that the new symbol selector appears as expected.

Modifying symbol selectors

You can modify an existing symbol selector.

To add a symbol selector:

1. Open the relevant module file in your preferred text editor.
2. Locate the symbol selector you want to modify.
3. Make the necessary changes. For more information, see Understanding symbol selector elements.
4. Save your changes.
5. Launch Longview Client and verify that the symbol selector appears as expected.

Deleting symbol selectors

You can delete an existing symbol selector.

Caution: Deleting a symbol selector cannot be undone. To restore a deleted symbol selector, you must recreate the symbol selector.

To delete a symbol selector:

1. Open the relevant module file in your preferred text editor.
2. Locate the symbol selector you want to delete.
3. Delete all content from the beginning of the symbol selector element to the end of the symbol selector element.
4. Save your changes.
5. Launch Longview Client and verify that the symbol selector does not appear.

Working with Longview attributes

In some cases, you may want to include a Longview attribute token to display relevant values to users in Longview Client. You can include Longview attribute tokens within any XML element in your module files. You may want to, for example, display a user’s current group in a folder name, such as the following:

<Folder Name="[[USER,UGPCurrentGroup,THIS]] Home">                        

For more information on Longview attribute token syntax, see Attribute tokens.