Understanding Query Limit Settings

The below settings are located in the Admin Console under Data > Query Limit

• SQL Result Limit: Defines the maximum number of rows that can be processed during query execution before the final result is returned to the client.
• Result Limit: Specifies the maximum number of rows that can appear in the client (e.g., a report)

Typically, the SQL Result Limit is set higher than the Result Limit because Pyramid’s engine can process more data than a browser can display.

Impact of Adjusting Limits

While these limits can be modified in the Admin Console, increasing them can lead to higher memory usage by Pyramid’s Run-Time Engine (RTE). If performance issues arise, consider allocating additional memory resources to the machine running the RTE to handle the increased load.

How Are Query Limits Calculated?

• SQL Result Limit
  
  The SQL "Select Top" or "Limit" in the query is determined by the lower of the following two factors:

  • The admin-defined SQL Result Limit.

  • A calculated limit, based on the number of columns in the query:
    SQL Result Limit = (Admin "SQL Result Limit" × 4) / Number of Columns

For example, if the admin limit is 25 million rows and the query has 9 columns, the SQL Result Limit will be:

SQL Result Limit = 25M × 4 / 9 ≈ 11,111,111 rows

The 11,111,111 value will appear in the "Select Top" / "Limit" part of the query.

• Result Limit
  
  The number of rows displayed in the report is determined by the lower of the following two factors:
  • The admin-defined Result Limit.
  • The calculated limit, based on the number of columns in the query:
    Result Limit = (Admin "Result Limit" × 4) / Number of Columns

For example, if the admin limit is 500,000 rows and the query has 9 columns, the Result Limit will be:

Result Limit = 500,000 × 4 / 9 ≈ 222,222 rows

The 222,222 value represents the maximum number of rows that will be displayed in the report.

Note: If a query returns more rows than the limit specified in one of the above query limit settings, a warning icon will appear in the bottom right-hand corner of the screen with the message: "The SQL cell limit of (#max rows) was reached while processing this result".

Note: For how to determine the Number of Columns in a Query see below.

Discovery Row Limit Settings

The Row Limit settings allow users to override both the Result Limit and SQL Result Limit. These settings can be accessed as follows:

• Discovery > Query Ribbon > Query Settings
• The User Defaults settings, which are located on the Home page, Discovery, and the Admin Console

When the 'Amount of Shown Rows' value is set, it will override the default Result Limit setting in the Admin Console.

Enabling the 'Apply this limit to queries against the data source' option will enforce the 'Amount of Shown Rows' value on both the Result Limit and the SQL Result Limit.

How to Determine the Number of Columns in a Query

To understand how query limit settings impact your queries, it's crucial to determine the number of columns involved. However, the columns shown in the grid or under the (i) Information > Statistics section may not represent all the columns queried by the engine. For example, attributes sorted by another column (e.g., month name sorted by month number) may result in additional columns being queried.

To accurately determine the Number of Columns in a Query:

1. Inspect the SQL Query: Find the SELECT clause, which specifies the columns to be included in the result set.
2. Count the Columns: Each item in the SELECT clause (separated by commas) represents a column. These can include:
   • Aggregate functions like SUM, MIN, or MAX.
   • Individual column names.
   • Expressions or calculations.

Create Content in Pyramid

In this document we are showing how you can embed a present object from Pyramid into Salesforce, and do it in context with specific SFDC objects, such as Accounts, Contacts, Opportunities, and others.

When building your present that you want to embed, the only real difference between a normal present and a present you want to embed is that here you will need to create a target.

1.      On the left side of the designer page, click on the “Targets” tab.

2.      Click the “+” icon to add a target.

 3.      Double click on the newly created target to rename to what you want.

 4.       Connect your target to one of the slicers either visible or hidden on your page.

 Creating your Dynamic URL to embed into SFDC

This section is all about creating the URL that will be used in Salesforce to launch your dashboard in context of the Salesforce object.  Below is a link that lays out the steps to create this URL. 

Pyramid Help – Target Parameterization for Presentations

When you get the part of the URL where you need a specific value from Salesforce, you will need to identify the object name in Salesforce you want to use.  This can be found in the Advanced Settings section of Salesforce.  If you look in the Object Manager area, it gives you a list of all Objects you can use.  Just to reference how I wrote the Account Name object, see below.  If you are not sure, one way to do it is to ask ChatGPT and look for the URLEncode syntax in the results.

Account Name Object

[{!URLENCODE(Account.Name)}]

Taking that into consideration, below is the finished URL I put to call me dashboard from Pyramid.

https://explore.pyramidanalytics.com/direct?id=xxxxxxxxxxxxxxxxxxxxxxxx&&target[Wellness]=[Sheet1].[Wellness%20Specialist].[{!URLENCODE(Account.Name)}]

Create a Visualforce Page in Salesforce

To embed your dashboard into Salesforce, you will first have to create a new Visualforce Page.  This will create  the code that will be embedded in an iframe in Salesforce.

 When you create a new page, it can be as simple as the below example or as complex as you would like.

 Adding Visualforce Page

The last step is to add your Visualforce page to the layout of your Salesforce page you want it to appear in.  If you go to the object you want to embed into, you should see a Lightning Record Pages section.  Here is where I found you can easily add an iframe and insert your Visualforce Page.

Let us know if you have questions or need help.

Our video of the day looks at the newest widgets available in the Admin Hub from our recent release Pyramid 2023.10.

The Admin Hub displays the topology of the services in the Pyramid cluster, including high level diagnostic data. This enables system administrators to control and monitor the system health, tasks, and usage in Pyramid. 

You can customize the hub as needed by adding a range of widget presets showing information about the current licensing, pulse nodes, task status, users, and more. Customization lets you keep track of the metrics that are most important to you. 

The latest widgets available in the Admin Hub are: In Memory DB Status, Prints Today, and Exports to Excel Today.

The In Memory DB Status widget (image below) lets you monitor the status of IMDB servers in real time, helping you manage and understand the load and performance of the IMDB. The widget shows you the database name and resource usage information for the host machine's CPU, RAM, and HDD. You can also restart the service and download a log of database activities. 

The Prints Today widget (purple highlight below) allows you to track the number of items exported for printing. And Exports to Excel Today (green highlight below) enables you to track the number of items exported to Excel.

How to configure the Admin Hub 

Watch this short video to learn about the new Admin Hub Widgets. Click here for more details in our Help Pages.

Let us know how you like these small tips below.

From version 2023.11.130, Pyramid uses the ChatGPT-4 API engine and it requires access to the ChatGPT Plus account.

After setting up the ChatGPT Plus account, you must add usage limits to start working with the GPT-4 API.

Additional details on how to add tokens to the usage limits can be found in the following article:
https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4

Distributing Information on a regular basis is a key component of every BI Strategy. Sending e-mails in a fashion that is recognizable and individualized is a big help to drive adoption. Using Email Templates in Pyramid makes the process a lot easier. Email templates allow the customer to custom-design the look and feel of emails that will be sent to end-users. Please Note that Only Admins can create email templates to be used in the platform. Once created, the email template can be set as a default template for a tenant and will be automatically used for all emails used in that tenant.  

The Video below shows you how to build an E-Mail Template in Pyramid.

To learn more about an Email Template visit the Pyramid help pages for the topic.

Here is a step by step description of the process to create a basic Email Template for a publication that also has a jumper action to a defined URL.  

Preparation.

HTML is used to customize an email template; I will be using the basic template that has is included in the system and will be adding on to it.  I will add text to the paragraph, set up a few slicer values and link to a defined URL.

Below is the end result of our email Template. 

You can access the E-Mail Template section from the Admin Console in the Subgroup for design.

 Step one

This is the E-Mail Editor in Pyramid, you will find a list of the functionality in the list below.

1. The options on the left hand side are known as Tags. It's important to note that all tags have an opening and a closing. We have a Place Holder tag where we store variables to formatting tags and an image tag where you can input an image . 

2. The template can be created for distinct types of emails (Publication, Subscription....)
3. On the right side you see the preview section, can preview your template using a Desktop, Mobile and Plain Text Format. 
4. Once the template has been created , Test it by clicking on the Test Email

In the Demo shown in the Video I will use <span style="text-transform:capitalize" >Good Day [FN] [LN] </span>

to capitalize the first letter of each word in the sentence. 

To add a link to the image i will use this html tag  <a> </a> and format it including a link and an image in the tag. 

  <a href="https://www.pyramidanalytics.com/" >  <img width='500 px'  src=  "... "  />'  </a>

See the full demo in the video above.

If you have questions or suggestions for this article, please leave a comment below.

In a recent customer scenario we encountered some unexpected performance issues when connecting to a AWS RDS Aurora MySQL 5.7.12  as data source. Data Connection was slow and also the queries in a Direct Access were very slow.

After some digging in the AWS documentation we found two parameters that can have a significant influence on on the Connection and Query Performance. As they are NOT compatible with Aurora

usePipelineAuth

when usePipelineAuth is enabled (active by default), Queried that are send using pipeline (all queries sent, then all results are read) this normally allows a faster connection creation, but is not compatible with Aurora.

useBathMultisend

also useBathMultisend is active on default and will send queries in Batch. But is not compatible with Aurora.

So, how do you turn off the two variables, and avoid them to caus slow connection; we expirenced the response time and connectivity to improve significantly

In your Pyramid Installation

Admin>data>Data sources>MySQL

?usePipelineAuth=false&useBatchMultiSend=false

Now the Parameters are switched off and the performance on Aurora should improve.

Sneak: How to use the Schedule and Subcription Manager

The Tips&Tricks Series is produced by the Customer Success Team. It highlights several easy to follow instructions and range from simple tasks to more advanced use cases.

How to use the Shedule and Subscription Manager

The Schedule and Subscription Manager in the Content system is a personalized interface for users to manage their own schedules and subscriptions from across the platform in a singular toolset. The manager is designed to give the user a birds-eye view of:

• All their various scheduled tasks that they have created for themselves in Publish and Model
• All the items they have subscribed to in Discover, Present and Publish
• All data alerts they have created in Discover and Present

1. Accessing the Manager: The manager can be found in the content management system, by clicking on the menu dots (green arrow) and choosing the last button in the pop-up list. Once opened, the user will see 4 tabs for each of the scheduled item types (red box).

   

   
   In each tab, the user will see similar content:
   - Actions: there are 4 actions per item Stop, Start, Edit and Delete
   - Name: the name of the schedule or subscription
   - Type: the source of the scheduled item (Discover, Present, Model, Publish)
   - Source: the name of the source file that the schedule or subscription is based on. Click the item to jump to its location in the content explorer
   - Description: any description attached to the schedule
   - Start Date: the first time the schedule or subscription was run
   - End Date: the final time the schedule or subscription was run

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Sneak: How to get a list of all objects in Present and Publish

The Tips&Tricks Series is produced by the Customer Success Team. It highlights several easy to follow instructions and range from simple tasks to more advanced use cases.

How to get a List of all Objects used in Present and Publish

When to Use: To get a list of all Discover objects being used by Present and Publish objects (i.e. SQL version of Lineage).

SELECT DISTINCT
 pp.ContainerID
, pp.ContainerName
, pp.ContainerType
, i.id AS ContentID
, i.name AS ContentName
, CASE i.item_type WHEN 3 THEN ‘Discover’ ELSE ‘Illustration’ END AS ContentType
FROM (
SELECT id AS ContainerID
, name AS ContainerName
, CASE WHEN (item_type = 4 AND sub_type = 2) THEN ‘Presentation’ ELSE ‘Publication’ END
 AS ContainerType
FROM content_tbl_item
WHERE (item_type = 4 AND sub_type = 2)
OR (item_type = 4 AND sub_type = 3)
) pp --Get List of Present and Publish Objects
INNER JOIN content_tbl_container_data cd ON pp.ContainerID = cd.container_id
INNER JOIN content_tbl_document d ON cd.id = d.container_data_id
INNER JOIN content_tbl_item_usages iu ON d.id = iu.parent_id
INNER JOIN content_tbl_item i ON iu.child_id = i.id
ORDER BY ContainerName, ContentName

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Sneak: Working with multiple Python and/or R Environments. Recover in Model Definition Files

Tips & Tricks created by the Pyramid Customer Success Team

This How To has been create based on the The Tips&Tricks Series featured in out monthly User Newsletter. To make it easier to keep them as a reference, these Tip & Tricks come as printable PDFs.

How to update Python and/or R Environments

This tip shows your how to update your R or Python environment in Pyramid. Packages used within environments need updating depending on the different types of functionality an end user wants to be able to access. To update packages, follow these steps.

1. Choose your Environment

Select the environment you want to edit in the list, and click on edit.

2. Select your Package

In edit screen, click on the Packages tab, select the package that needs to be updated and click on edit.

3. Update Package

In edit package screen, type in the version you want to update. Validate to make sure it is the right version, and click on OK, and the package will then get updated.

4. Deploy Package

Click on save, and it then updates the environment. Once the status is green, it’s ready for use with the updated package.

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Sneak: Working with multiple Python and/or R Environments. Recover in Model Definition Files

Tips & Tricks created by the Pyramid Customer Success Team

The Tips&Tricks Series is produced by the Customer Success Team. It highlights several easy to follow instructions that will help you to boost your BI Skills.

To make it easier to keep them as a reference, these Tip & Tricks come as printable PDFs. Make sure to subscribe to this category to never miss more Tips and Tricks

How to Recover a Model Definition File

How to Recover Model Definition File - This step by step guide shows how to recover a Model Definition in the Admin Console.

1. Access the Source Manage

Go to Admin Console > Data > Source Manager

2. Select Database and Model

Find the database and model you need model definition file for, and click on the model.

3. Export Model

 Go to General Tab > Export > Save As which will allow you to export the model definition file into content manager.

4. Open Model Definition

Go to Content Manager folder where you saved your file, and open your model definition file.

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Sneak: Working with multiple Python and/or R Environments. Recover in Model Definition Files

Tips & Tricks created by the Pyramid Customer Success Team

This How To has been create based on the The Tips&Tricks Series featured in out monthly User Newsletter. To make it easier to keep them as a reference, these Tip & Tricks come as printable PDFs.

How to Add Python and/or R Environments

This tip shows your how to add a new Python environment in Pyramid, apart from what came with the original install. There sometimes comes the need to have multiple python environments. e.g.

• the latest and greatest version of packages
• to collaborate with a colleague in their own environment/Pyramid install
• you are delivering an application to a client and want to ensure that everything work’s perfectly in their environment
• or that you may need other Python applications that only work with certain versions of Python

To aid/help with these scenarios, you can add a new Python environment in Pyramid, apart from what came with the original install. To do so, you must have admin rights on the platform.

1. Access Environments

Go to Admin Console > AI and ML > ML Environments

2. Add new Environment

Click on Add Environment.

3. Configure new Environment

Fill out environment details in the wizard, most importantly, the version you want to add. Click Apply.

4. Check readiness

Once environment is added, it will process, and once it’s green, it means it’s ready for use.

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Sneak:  How to create interactions between content items that are querying different data models.

Tips & Tricks created by the Pyramid Customer Success Team

The Tips&Tricks Series is produced by the Customer Success Team. It highlights several easy to follow instructions that will help you to boost your BI Skills.

To make it easier to keep them as a reference, these Tip & Tricks come as printable PDFs. Make sure to subscribe to this category to never miss more Tips and Tricks

Tip #1

You may want to create interactions between content items (data discoveries, slicers, dynamic content, or custom formulations) that are querying different data models.

For such interactions to work, the hierarchies and member elements being used as a filter must also exist in the data model of the target visualization. If the corresponding hierarchies and member elements are identically labeled in both data models, then you can create an interaction as usual.

However, if the corresponding hierarchies and/ or member elements are not identically labeled in each data model, then it’s necessary to create a model mapping.

If you have questions about these tips (or improvements) please let us know in a comment.

Sneak: Working with multiple Python and/or R Environments. Recover in Model Definition Files

Tips & Tricks created by the Pyramid Customer Success Team

The Tips&Tricks Series is produced by the Customer Success Team. It highlights several easy to follow instructions that will help you to boost your BI Skills.

To make it easier to keep them as a reference, these Tip & Tricks come as printable PDFs. Make sure to subscribe to this category to never miss more Tips and Tricks

Tip #1

How to Update/Add Python and/or R Environments - This tip shows your how to add a new Python environment in Pyramid, apart from what came with the original install. Requires Admin Rights

Tip #2

How to Update/Add Python and/or R Packages - Packages used within environments need updating depending on the different types of functionality.

Tip #3

How to Recover Model Definition File - This step by step guide shows how to recover a Model Definition in the Admin Console.

If you have questions about these tips (or improvements) please let us know in a comment.

P.S. We will post previous Tip&Tricks as well as all new ones to keep this information active and available to all users.

Suppose you encounter issues connecting to your Pyramid environment, and the login issue is intermittent. In that case, likely, sometimes one of the domain controllers that your LDAP address returns is not allowing the login.
In your server logs, you could also see if there is any error mentioning an issue with connecting to your LDAP.
You can find the logs where your Pyramid web server is installed under C:\Program Files\Pyramid\log.

First, you can check which is not functioning by going to your environment URL and adding /diagnostic.
There you will see if there are any errors regarding LDAP.

There are two possible workarounds for this situation.

1. Point Pyramid directly to one working domain controller:

You could also see under the LDAP test if any domain controllers are shown as "invalid".

If it is "invalid", then until your IT gets it fixed, you can point to a specific domain controller by choosing another " valid " domain controller.
Copy the domain controller and paste it into the LDAP address, as shown below.

The downside of this solution is that If this specific domain controller becomes invalid, it will not be possible to connect to Pyramid and fix it.

2. Hard coding a known working domain controller in the local host file on each Pyramid task, runtime, and web server:

This is the preferred option.

Hardcode your LDAP address to point directly to a domain controller in the local host file of each Pyramid sever (Task, Runtime, and WEB) in the deployment.
Please see the below example:

Add an entry into the local host file of each pyramid server that points to your LDAP address to only one "valid" domain controller.

E.g., if your LDAP is LDAP://DC=my,DC,company,DC=.com
then you should add it to the host file and save

192.168.2.1 my.company.com

*where the IP is an IP of one of your "valid" domain controllers.
(move through each domain controller listed, and once you find one that works, ping the name to get its IP)

Compared to the first solution, the upside of this solution is that if there is a problem with the domain controller you have used, you can update the host file manually to a different "valid" domain controller.

As mentioned, these solutions are only workarounds.
To avoid future issues, you will need to find the root cause of the problem and fix it.

Here are some tips for troubleshooting the domain controller and avoiding future issues:

• Check the event logs: Check the event logs on the domain controller for any errors or warnings that might indicate the cause of the issue.
• Run network diagnostic tools: Use tools like ping, traceroute, and nslookup to test the connectivity and DNS resolution of the domain controller.

In the Admin, when assigning Pyramid roles to AD Groups, the role fails to propagate to the user, when the AD group contains special characters, such as "/".

Symptoms:

The user doesn't have permissions to content he should be able to see.

Reviewing the Assigned roles to that user, you would see that the '(Group)' role is missing.

In the admin logs:

"user dan failed its user groups update. message - Failed to retrieve groups for user: 4df48b4e-377a-4ec6-b102-176c1fef75f2 (dan) Caused by: Failed to retrieve groups for user: 4df48b4e-377a-4ec6-b102-176c1fef75f2 (testingAdmin) at pyramid.infra.auth.ldap.ADLdapGroupsForUsersIterator.getUserGroups"

Solution:

Check that none of the AD groups assigned to the users has a slash(\) in it. (Or any other special characters).
If it does, please rename the AD group, to remove that special character, then check again in Pyramid to see if the users get the required roles.

Please note that the get users groups run periodically, so to run it immediately run a provisioning job.  

Below are the locations of all the different Pyramid logs:

Pyramid Admin console Logs

These are records kept in the Pyramid repository and are accessible from the Admin console.

1. System logs - Collecting Errors / Warning / Information / Debug / Trace
   Log duration and what type of logging is configurable in the admin console.
2. Audit logs - Collecting entry logs of each user to the app. (We don't log Logout)
3. Transaction - Collecting information on each query that is run in the system.
4. Benchmark - Collecting info for each request in the system passing through the system and how long it took in each part of the system.

5. Install / Upgrade Logs - Important to help troubleshoot installation problems

To access the logs: Admin >> Logs >> System / Audit / Transaction / Benchmark.

*It is imperative that you select the correct time frame when utilizing the "Filter By Last" function.

servers / services Logs

We collect information from the following servers:
Some of it makes it into the system logs, but this file contains more detailed information.

1. DNC - Dot Net Connector, or the Windows connector, in short,
   used to connect to OLAP data sources.
2. Runtime engine
3. Task engine

Location:
Kept in the file system in the "log" folder, found on each Pyramid server in the deployment, which by default can be found here:

C:\Program Files\Pyramid\log

Satellite logs

Location:
By default 

C:\Program Files\Pyramid\satellite\log

IMDB Logs

The Pyramid IMDB (In Memory Data Base) logs

Location:
By default on the server that has the IMDB installed on:

C:\Program Files\Pyramid\imdb\irdb.log

It is also possible to limit the sizes of log files.

To do so, you will need to update the logback.xml file in each service you wish the change to be in.
Before any changes, please back up your logback.xml.

In your pyramid folder, open the folder of the service you want to edit->

 
/conf/logback.xml, and in the file add the following: <totalSizeCap>the value you want</totalSizeCap>

The changes will take place after you update the files.

Install / Upgrade Logs

The Pyramid Install/Upgrade logs can help identify installation issues.

Location:

C:\Users\<user_name>\AppData\Local\Temp

Or in a run box and type %temp% to take you to the user's temp folder.

*replace user_name with the user name of the user that did the Pyramid install.  
The install logs are being saved on two types of logs,

1. installerbuilder_install.log
2. pyramidinstaller.log

There might be more than one, One for each installation made.
Sort the logs by date modified to get the latest log.

If you are using  Pyramid 2020.20 and above, the maintenance tool is now built in to the product.  The default path to it is- C:\Program Files\Pyramid\core\maintenance.

For more info, please see our help article here. The clean up process is also now automated within the Pyramid application and you should not have the need to run it manually.  Only in cases where the general folder is very large should you need to run it. 

The following can be run on all Pyramid servers in your installation.
When the next major release of Pyramid comes out this process will be automatic for printing files created after it is installed/upgraded. 

The "general" folder contains files among other things, created during the printing process. If the "general" folder, found by default here (C:\Program Files\Pyramid\repository\general), has grown to a large size, it can be cleaned up to remove any redundant files using the following instructions.
The files that are deleted by the cleanup tool are the ones that are older than 48 hours.
The kind of files that are deleted are only the prints, which means only the ones that you have clicked export\print, get saved in the general folder, and when using the cleanup tool it will delete them.

1) Download the attached zip file and unzip it.

    NOTE: Please download the file that is relevant to your Pyramid version.

2)Open a command prompt(as admin) from the folder you unzipped the files to (This can be done by holding down the shift key and right-clicking.) and run the below command:

For cleanupTools 2018:
java -classpath "lib\*;conf\*;" com.pa.tools.PrintingDirectoryCleaner  path="C:\Program Files\Pyramid 2018\config.ini"

For cleanupTools 2020:
java -classpath "lib\*;conf\*;" com.pa.tools.cleanup.PrintingDirectoryCleaner  path="C:\Program Files\Pyramid\config.ini"

For Linux

/opt/pyramid/java/bin/java -classpath lib/*:classes/*: com.pa.tools.PrintingDirectoryCleaner  path="/opt/pyramid/config.ini"
 

*change the path location to reflect the drive that you have Pyramid installed on.

3) Once the tool has finished removing any files that are not needed, you will see the below summary screen at which point the command prompt can be closed.

**Please note, you may need to set up your Java paths as below if the above commands fail.**

This link explains how to do this, however, use the below paths, not the ones in the link.

https://javatutorial.net/set-java-home-windows-10

For 2018-

PATH
C:\Program Files\Pyramid 2018\java8\jre\bin;
JAVA_HOME
C:\Program Files\Pyramid 2018\java8\jre;

For 2020-
JAVA_HOME
C:\Program Files\Pyramid\java
PATH
%JAVA_HOME%\bin

1) Login to the Pyramid server and open the task Manager. Right click on a column and add the "PID" and "command line" columns.

2) Run the below two commands from an elevated command prompt. Replace the PID of the process with the PID of your process that you want to take a memory dump of.

"C:\Program Files\Pyramid 2018\java8\jre\bin\java" -classpath "C:\Program Files\Pyramid 2018\java8\lib\tools.jar" sun.tools.jcmd.JCmd 10432 Thread.print >threadDump.txt

"C:\Program Files\Pyramid 2018\java8\jre\bin\java" -classpath "C:\Program Files\Pyramid 2018\java8\lib\tools.jar" sun.tools.jcmd.JCmd 10432 GC.heap_dump C:\\heapdump.bin

For Pyramid 2020 run the following command:

"C:\Program Files\Pyramid\java\bin\jcmd" 1956 GC.heap_dump c:\heapDump.hprof
 

The first command will create a text file called "threadDump.txt" in the directory from where the command was run. The second command will create a file on the C: drive called "headdump.bin".

Place both files in a folder and zip them to reduce their size. We would also like to know from which process they came from. To tell this, look at the "command prompt column" to see which pyramid service they are.

In the example below we can see the process of the te =Task Engine, rte=Runtime Engine and rte =Router.

Once you have each of the two files for each process you want to take a memory dump for, please send them to us.

1. Download and install Postman (free) on your Pyramid task engine server.
    
2. Open the task manager on the Pyramid server which is running the task engine.
   Click on "Details" tab and right-click on any column header to add "Command line"  
    
3. Look for all the "pyramidPrinter.exe" processes which have a port number and note the port numbers down.
    
4. Enable debugging mode for all the ports, which will create a .ZIP file to send to us.
   To do this open Postman and connect as follows:
   Select Post and use the URL "http://localhost:11000/enableDebugFile".
   This needs to be done for each port you noted down from the task manager, so in this case, we would enable it for port 1002,1001,1003 and 11000
   
   Please note, that it will always be using "HTTP" even if you are using SSL to access your Pyramid site.
   Therefore it is always best to install Postman on the Pyramid task engine server itself.
    Once you have enabled debugging for all the ports, please then print the visual that is not print correctly. Only print what is not working, not the whole book for example.
   
   The debug mode will then create a .ZIP file in the following location on the Task server "C:\Program Files\Pyramid 2018\repository\general".
   If you installed Pyramid on another drive, then use that path.
   
   If you cannot find the above path, you can check the config.ini file that can be found here: "C:\Program Files\Pyramid 2018\config.ini".
   Open it in notepad and look for the line "generaldirlocal" which will show you the location of the repository folder.
   
   The file(s) will look something like the example below:
   
   
   There may be more than one, so please send us them all.
   (Please note that the ZIP file does contain data from the visual printed)
   Please also send us screenshots of what the render should look like and what it looks like after it has been printing, clearly pointing out the differences.
    
5. After you have the ZIP files, please disable debugging on all ports using the below command: http://localhost:11000/disableDebugFile
   
   In our example we would run the above post four times, one for each port number, so for this example, it would be 10002,10001,10003 and 11000
    

We hope this helps.

In the example below we can see that only the Type "Error" is turned on.

In total there are 5 types of logging that can be enabled. Error, Warn,Info,Debug and Trace.

When choosing a Log level type Pyramid will record that level type and the one above it. For example if "Warn" is chosen, Pyramid will record "Warn" and "Error" type logging.

Choosing anything below Error may result in degraded performance. It will usually only be turned on at the request of the Pyramid support team.  

To view the logs navigate to Admin>Logs>System

Under the log Level it is possible to choose which type of log to view. When choosing a Log level type to view, Pyramid will show that level type and the one below it.

So choosing "Error" will only show "Error" logs, where as Choosing "Warn" will show the log level for "Warn" and "Error" together.