Jaspersoft Commands for Clarity PPM Administrators (On-Premise Only)

ccppmop158
As an administrator, use the following commands to manage the Jaspersoft advanced reporting content for 
Clarity PPM
.
 
 
First-Time Installation and Upgrades
This is the command we execute on any PPM version system to install jaspersoft content for the first time. 
admin content-jaspersoft <contentpackId> -userName superuser -password superuser
Run this command only to import the content for the first time in the 
Clarity PPM
 environment. Also use this command during release and patch upgrades.
 
This command performs the following actions:
 
  • Verifies whether the organization that you defined on the CSA Reporting subtab already exists.
    • If the organization already exists, this command exits with an appropriate message. It does not execute the import because it is a new install.
    • If the organization does not exist, this command creates the organization defined in the CSA Reporting subtab and continues.
  • Creates a zip file specific for the organization in a temporary folder by replacing the org name with given in CSA
  • Imports the content from the temporary zip file
  • Creates the CA PPM folder and its subfolders in the organization’s repository
  • Creates the Advanced Reporting roles
  • Creates the PMO Accelerator roles. These roles determine content permissions and begin with the CSK_ prefix.
  • Updates the domains with the Data Warehouse schema owner name specific to the database
  • Uploads the UI Themes
  • Creates the user profile attributes
  • Update e-mail notification settings (available with Jaspersoft 6.2.1 and newer)
  • Creates the Jaspersoft administrator user. The default user is 
    ppmjasperadmin
    . In on-premise environments, this user can be changed on the CSA Reporting subtab before importing. After importing this user should not be modified. The Create and Update Jaspersoft Users job and the Load Data Warehouse job, which dynamically update domains, require this user.
  • Create shared folder and set permissions of that folder
  • Set permissions on themes, other folders and public folder
  • Creates cmn_install_history entry which will be used to track install history and also identify the upgrade mode
 When the default settings such as Organization name, Admin user name, Key store, Database configurations, or JASPERSOFT folder level permissions change, do not try to fix them by reimporting the content. Execute the related commands to fix them.
Upgrades
This command is used to install the jaspersoft content upgrade. This command needs to be executed on top of patch releases or release upgrades:
admin content-jaspersoft <contentpackId> -userName superuser –password superuser upgrade
Run this command only to import the content for the first time in the 
Clarity PPM
 environment. Also use this command during release and patch upgrades.
 
This command performs the following actions:
 
  • Verifies if the organization defined in the CSA Reporting subtab already exists.
    • If the organization does not exist, it exits with an appropriate message. It does not create the organization which means it does not execute the import because it is an upgrade, not a new install.
    • If the organization does exist, it creates a zip file specific for the organization in a temporary folder and continues.
  • Imports the content from the temporary zip file
  • Updates the CA PPM/Reports folder and its subfolders in the organization’s repository.
  • Retains the CA PPM folder, default subfolders, and their permissions.
  • Updates the out-of-the-box Jaspersoft Advanced Reporting items, in the CA PPM folder and subfolders. Items include domains, reports, input controls, templates, images, etc
  • It should not matter what is in the zip file being imported because no content is going to be deleted. If the zip file includes content previously imported, update the content with the content from the zip file. If the zip file includes new content, import the new content without modifying the content previously imported. In summary, always only update the content which is coming from the zip file
  • Updates the domains being imported with the Data Warehouse schema owner name specific to the database
  • If content contains domains then Dynamic Domain routine will run
  • Uploads the UI Themes
  • Verify if the Jaspersoft administrator user already exists or if the Jaspersoft administrator user was modified in CSA and needs to be recreated
  • Verify if the Shared folder already exists or needs to be recreated. If the Shared folder exists skip it, do not modify it. Permissions should not be modified
  • Creates cmn_install_history entry after the import. This table tracks install history and also identify the upgrade mode
Jaspersoft Sender Email Address
The sender email address is the address that appears when JasperSoft sends an email notification for a scheduled report. JasperSoft lets you set the sender email address at the JasperSoft Reporting Server (JRS) level, but not at the tenant (organization) level.
  •  
    SaaS Environments
    : The following address is the default sender email address value for the JasperSoft reporting server for CA PPM On Demand (SaaS) implementations:
  •  
    On-Premise Environments
    : The following address is the default sender email address value for the JasperSoft reporting server for on-premise implementations:
    [email protected]_domain.com
    For information about changing this default value during installation, see 
    Installing
    .
    To change the default value after installation, perform the following steps:
    1. Locate and open the js.quartz.properties file in a text editor.
    2. Edit the 
      report.scheduler.mail.sender.from
       property to include your sender email address and save the file.
    3. Restart the JRS.
Maintenance
Update User Profile
Updates the jasperadmin user profile attributes using properties.xml entries.
admin update jasperParameters
Run this command when changes occur in one or more of the following items:
  • the configuration of 
    Clarity PPM
     
  • the database username or password
  • the data warehouse username or password
  • the key store
Synchronize 
Clarity PPM
 and Jaspersoft Environments
Run this command when changes in the 
Clarity PPM
 environment are not synchronized with Jaspersoft.
admin jaspersoft syncPPMContext -userName superuser -password superuser
 
This command performs the following actions:
 
  • Verifies properties like url and username if they are changed then it will not update user profile attributes
  • If the ppmjasperadmin does not exist in Jaspersoft or Clarity it will create in both the systems
  • If new keystore is generated in between then the profile attributes will be encrypted using new keystore.
  • If profile attributes related to database properties changed then those profile attributes values will be updated
  • If there are any additional profile needs to be added that will be added
  • Updates the domain schema names for all OOTB domains
If only database properties were changed, then updateJasperParameters should work.
Export
admin jaspersoft export [-properties propertiesFile] -fromUserName username -fromPassword password -fromURL JaspersoftSrcUrl -fileName contentFile [-overwrite] [-orgName orgId1,<orgId2>,..]] /[-allOrgs] [-includePublic] [-includeServerSettings] 
 
This command performs the following actions:
 
Verifies the URL, username and password are valid
Verifies the provided organization list exist
If organizations are not passed considers to export all organizations
If includePublic flag is set, exports the public folder content
If includeServerSettings flag is set, exports the server side settings
Exports the provided organizations/all orgs whole content
Zips into provided filename
If overwrite flag is not given and if file already exists throws error message
Note :-
Use this command to export the content from on JASPERSOFT instance to import into another JASPERSOFT instance via this CLI
Don’t use the content exported via this command in JASPERSOFT UI import
Import
admin jaspersoft import [-properties propertiesFile] -toUserName username -toPassword password -toURL JaspersoftDsUrl -fileName contentFile [-silent] [-orgName orgId1,<orgId2>,..]] ]
 
This command performs the following actions:
 
Verifies the URL, username and password are valid
Verifies the provided organization list exist in zip file
Provided organization list and organizations in zip should match
Content zip file should be exported via CLI export command
Prompts for Organizations confirmation, if silent flag passed considers as create by default
If Yes is the confirmation then creates the organizations in the JASPERSOFT instance
Imports the content
Imports public folder content if zip contains it
Imports server side settings if zip contains it
Note:-
Don’t reimport on already existing org, this will override the content
Don’t use zip file generated via JASPERSOFT UI
Migrate (Export and Import)
migrate performs the two tasks, export and import
admin jaspersoft migrate [-properties propertiesFile] -toUserName username -toPassword password -fromUserName username -fromPassword password -toURL JaspersoftDsUrl -fromURL JaspersoftSrcUrl [-orgName orgId1,<orgId2>,..]] /[-allOrgs] [-includePublic] [-includeServerSettings] [-silent] ]
 
This command performs the following actions:
 
If allOrg argument passed then it exports and imports all arguments
If migrate run on already imported content tenant will not be recreated
Content will be reimported if org is already exist
If org is not existed then new org will be created
Include Public and Include server settings will be migrated if arguments are provided
Note:-
Don’t migrate on already existing org, this will override the content
Try to avoid all orgs option, sometimes resource contention will cause adverse effect on JASPERSOFT instance
Repair Domain Corruption
Run this command only when your domains are corrupt. Domain corruption prevents the Load Data Warehouse job from running.
admin content-jaspersoft <contentpackId> -userName superuser –password superuser restoreDomains
 
This command performs the following actions:
 
  • Verifies if the organization defined in the CSA Reporting subtab already exists.
  • If the organization does not exist, it exits with an appropriate message. It does not create the organization which means it does not execute the import because it is an upgrade, not a new install
  • Creates a zip file specific for the organization in a temporary folder
  • Imports the content from the temporary zip file
  • Replaces all the OOTB domains which are under ca ppm/domains folder
  • Updates the domains being imported with the Data Warehouse schema owner name specific to the database
  • Runs the dynamic domain updates
Run this command when the Load Data warehouse job fails by complaining Domain updates are failing. While working on adhoc views using domains if it fails to fetch data and configuring columns, check domains definition and if it reports any error then run this command.
List Domains
This command checks the user profile attribute and get list of email domains supported.
admin jaspersoft email listDomains
Add Domains
This command adds the email domains to the supported domain list.
admin jaspersoft email –addDomains
  • The Jaspersoft server sends email only for these supported domains. Other domain-specific email is rejected.
  • The server verifies if the domains that you add are already in the supported list; only new ones are added.
  • The list of trusted domains cannot exceed 1200 characters.
Remove Domains
This command removes the email domain in the supported domain list.
admin jaspersoft email –removeDomains
  • Emails will be sent via JASPERSOFT only for the supported domains. Removed domain specific emails will be rejected
  • Checks if provided domains are present in domains list
  • If available removes them otherwise ignores
Advanced Reporting Notifications
This command enables or disables the notification system in JASPERSOFT instance.
If enabled, then notifications like email or alert will be sent out from JASPERSOFT else nothing will be communicated to outer world.
admin jaspersoft email disableNotifications|enableNotifications