{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"outline":{"value":"true"},"_parentId":{"value":"17242121"},"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"03f5aaee-c47f-40c8-a0da-b50613d19cb1"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"fd151534-0b6c-4d26-94ab-82910615aa43"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"About Custom Reports","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom Reports","type":"text","marks":[{"type":"strong"}]},{"text":" is a built-in HTML Templating Engine using HTML Coding and external frameworks to allow Users to write their unique Reports using PCR-360 data and format them however your Organization desires. Before writing a Report, a User should be familiar with HTML programming and should first read the external documentation for ","type":"text"},{"text":"Smarty","type":"text","marks":[{"type":"link","attrs":{"href":"https://smarty-php.github.io/smarty/4.x/designers/language-basic-syntax/"}}]},{"text":" and ","type":"text"},{"text":"Bootstrap 4.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://getbootstrap.com/docs/4.0/getting-started/introduction/"}}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom Reports was created within PCR-360 to empower users to customize their organization's customer experience. Your organization can make the Reports available on CustomerCenter or directly on specific backend application forms. PCR has structured the Custom Report creation process to best mimic the workflow needed to build the Report.","type":"text"}]},{"type":"paragraph","content":[{"text":"Additionally, Custom Reports allow Users to run a Report and save the output directly to the server so that that report can be shared with others without having to re-run the Report and not have to worry about the data within the Report changing.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example Custom Report is available at the bottom of this article.","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Writing a Custom Report","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":1483,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":24579,"__fileMimeType":"image/png","width":2068,"alt":"image-20241216-154121.png","id":"1bfdb12f-c374-4580-80b9-5277e581bdeb","collection":"contentId-17242121","type":"file","__fileName":"image-20241216-154121.png","height":178}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The Admin > Reports > Custom Reports menu option brings the User to the Custom Reports grid. From this grid a User can [Add], [Edit Selected], and [Delete Selected] Custom Reports. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Creating a New Report","type":"text"}]},{"type":"paragraph","content":[{"text":"A Custom Report is comprised of multiple components. Every Custom Report has a unique ","type":"text"},{"text":"Identifier","type":"text","marks":[{"type":"em"}]},{"text":", a Report ","type":"text"},{"text":"Name ","type":"text","marks":[{"type":"em"}]},{"text":"and ","type":"text"},{"text":"Roles ","type":"text","marks":[{"type":"em"}]},{"text":"assigned to access the Report.","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom Reports are also comprised of ","type":"text"},{"text":"Logic","type":"text","marks":[{"type":"em"}]},{"text":" (for querying system Data), ","type":"text"},{"text":"Parameters","type":"text","marks":[{"type":"em"}]},{"text":" (for determining Report content), a ","type":"text"},{"text":"Template","type":"text","marks":[{"type":"em"}]},{"text":" for formatting the Report, ","type":"text"},{"text":"Options","type":"text","marks":[{"type":"em"}]},{"text":" (for adding a Report Title, Footer, and additional CSS), ","type":"text"},{"text":"Attachments","type":"text","marks":[{"type":"em"}]},{"text":" (for external files to be used within the Report) and details to define it for ","type":"text"},{"text":"Batch Processing","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom Reports also maintains a short term log of any ","type":"text"},{"text":"Debug","type":"text","marks":[{"type":"em"}]},{"text":" information, which is useful for refining the Logic of the Report and checking for possible errors within that Logic.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Logic Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":23036,"__fileMimeType":"image/png","width":852,"alt":"Logic Section","id":"43d437d9-53f3-42e9-8aec-9e0d1f4691c7","collection":"contentId-17242121","type":"file","__fileName":"New_Custom_Report_Logic_Form.png","height":635}},{"type":"caption","content":[{"text":"Logic Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"Custom Reports utilizes the internal PCR-360 ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Custom Logic","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://pcr360.atlassian.net/wiki/display/PCR360/.Custom+Logic+v2019.5"}}]},{"text":" functionality that is also available to ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Custom Events","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}},{"type":"strong"},{"type":"link","attrs":{"href":"https://pcr360.atlassian.net/wiki/x/Ed8QAQ"}}]},{"text":", ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Custom API","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}},{"type":"strong"},{"type":"link","attrs":{"href":"https://pcr360.atlassian.net/wiki/x/OO0QAQ"}}]},{"text":" and ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Custom Validations","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}},{"type":"strong"},{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"(2024.1) Custom Validation","versionAtSave":"5"},"href":"https://pcr360.atlassian.net/wiki/spaces/pcr360wiki/pages/17241923"}}]},{"text":". ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Custom Report Functions","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"assign: Assigns a variable from the Logic to be used in the Template","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"/**\n * @param string $name - name of the assigned variable in the Smarty Template\n * @param array $value - value of the assigned variable in the Smarty Template\n * @return void\n */\n$this->assign('variableName', $variableValue);","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"loadReport: Loads another Report based on the Report Identifier","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"/**\n * @param string $identifier - another report's identifier\n * @param array $params - array of parameters used to render the other report\n * @return string - the Rendered Report\n */\n$report = $this->loadReport('customReportIdentifier', ['paramName' => $parameterValue]);","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"barcode: Generates an HTML IMG tag of a barcode","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"/**\n * @param string $code - string text to encode\n * @return string - barcode IMG tag\n */\n$barcodeImgTag = $this->barcode('test test');","type":"text"}]},{"type":"paragraph","content":[{"text":"addError: Forces the Report to render an Error Message instead of the Report","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"/**\n * @param string $message - string error message to display instead of rendering report\n * @return void\n */\n$this->addError('Some error in the Report Logic');","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The Logic Tab is used for querying PCR-360 data. The Logic section has two parameters available for use in the ","type":"text"},{"text":"(2024.1) Custom Logic","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"(2024.1) Custom Logic","versionAtSave":"4"},"href":"https://pcr360.atlassian.net/wiki/spaces/pcr360wiki/pages/17241783"}}]},{"text":": ","type":"text"},{"text":"$params","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"$user","type":"text","marks":[{"type":"em"}]},{"text":". ","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"$params","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":3}}],"content":[{"text":"A key/value paired array of parameters that were passed ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"into the Report are available within this array. Any changes to this array are also assigned to be accessed from the Smarty HTML Template.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":"if(isset($params[\"reportParameter\"]) && $params[\"reportParameter\"] === true)","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"$user","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":3}}],"content":[{"text":"A key/value paired array of User information about the currently logged in User. The example below shows the options that are available within this array. This data enables Custom Reports to be specifically tailored to the User viewing the Report.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":"$user = [\n 'isSysAdmin' => TRUE\n 'isCoordinator' => FALSE\n 'isCustomerCenterOnly' => FALSE\n 'attributes' => [\n\t\t'USERS_RECID' => 494,\n\t\t'USERID': \"demo\",\n 'CONTACTS_RECID' => 1\n 'NAME' => 'Pcr Demo'\n 'FIRST_NAME' => 'Pcr'\n 'LAST_NAME' => 'Demo'\n 'DEPT_HIERARCHY_RECID' => NULL\n 'TENANTS_RECID' => 0\n 'EMAIL' => 'demo@pcr.com'\n ]\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Debug Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":31685,"__fileMimeType":"image/png","width":856,"alt":"Debug Section","id":"89aec22f-1603-4922-b26b-0fb784877ff2","collection":"contentId-17242121","type":"file","__fileName":"New_Custom_Report_Debug_Form.png","height":640}},{"type":"caption","content":[{"text":"Debug Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Only data sent to the debug() function is displayed in the Debug section. Debug information only exists for 24 hours before it is automatically cleared out by the system. For more information on the debug() function, please see our article on ","type":"text"},{"text":"Syntax.","type":"text","marks":[{"type":"link","attrs":{"href":"https://pcr360.atlassian.net/wiki/x/Bd8QAQ"}}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":46514,"__fileMimeType":"image/png","width":856,"alt":"Parameters Section","id":"a5b8e2ed-e43a-4723-8fbb-3d85a1af4986","collection":"contentId-17242121","type":"file","__fileName":"Custom_Report_Parameters_Form.png","height":640}},{"type":"caption","content":[{"text":"Parameters Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":"A User can click the [Add] button to define each Parameter for the Report.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":600,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":12572,"__fileMimeType":"image/png","width":632,"id":"493e0729-ff84-4609-98b3-74e9def77510","collection":"contentId-17242121","type":"file","__fileName":"Add_New_Build_Parameters_Form.png","height":230}}]},{"type":"paragraph","content":[{"text":"Parameters require a ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"em"}]},{"text":" to be accessed within the Report Logic, as well as a ","type":"text"},{"text":"Description","type":"text","marks":[{"type":"em"}]},{"text":" to allow the User to know what they are entering. Parameters must also be defined as a specific ","type":"text"},{"text":"Input Type","type":"text","marks":[{"type":"em"}]},{"text":", much like ","type":"text"},{"text":"User-Defined Fields","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"(2024.1) User Defined Fields","versionAtSave":"6"},"href":"https://pcr360.atlassian.net/wiki/spaces/pcr360wiki/pages/17242890"}}]},{"text":" are. Parameters can also be assigned an ","type":"text"},{"text":"Order","type":"text","marks":[{"type":"em"}]},{"text":" value to determine the order in which they are presented to be populated by the Report generator. Finally, all Parameters have a ","type":"text"},{"text":"Display ","type":"text","marks":[{"type":"em"}]},{"text":"checkbox to determine if that Parameter value will be shown in the Report's Preview.","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Input Types accepted:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Checkbox","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This is the only type of Input that can not be defined as ","type":"text"},{"text":"required","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":", as checkboxes are either Checked or Not Checked.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Currency","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Date","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Date/Time","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Decimal","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Drop Down","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When a Drop Down Input is assigned, the User will need to define the ","type":"text"},{"text":"Value","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"Text","type":"text","marks":[{"type":"em"}]},{"text":" for each option within the Drop Down menu.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Number","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Picker","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When an Input is assigned to the Picker Type, the User must also define what type of Picker it is. Almost all types of Record within PCR-360 can be accessed by a Picker","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Text","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"When a User runs a Custom Report, the related Parameters will be available to be set in the panel on the left side of the screen.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":27690,"__fileMimeType":"image/png","width":1280,"alt":"example Report","id":"e5013e37-0f17-4a4e-b007-167e370de58b","collection":"contentId-17242121","type":"file","__fileName":"Custom_Report_Parameters_Report_Preview_example.png","height":502}},{"type":"caption","content":[{"text":"example Report","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Template Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":24407,"__fileMimeType":"image/png","width":856,"alt":"Template Section","id":"9afcac3c-865c-4eae-8c61-ef4483cd5f78","collection":"contentId-17242121","type":"file","__fileName":"New_Custom_Report_Template_Form.png","height":635}},{"type":"caption","content":[{"text":"Template Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The Template Tab is where the bulk of the Report is made. The User can write HTML code here to access the information obtained in the Logic Tab, and format it into it's desired finished product. A User should be familiar with HTML programming and should first read the external documentation for ","type":"text"},{"text":"Smarty","type":"text","marks":[{"type":"link","attrs":{"href":"https://smarty-php.github.io/smarty/4.x/designers/language-basic-syntax/"}}]},{"text":" and ","type":"text"},{"text":"Bootstrap 4.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://getbootstrap.com/docs/4.0/getting-started/introduction/"}}]},{"text":" before attempting to develop the Template for a Report.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Options Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":21974,"__fileMimeType":"image/png","width":853,"alt":"Options Section","id":"e4415074-846a-42bc-bdc5-264b1eea3c30","collection":"contentId-17242121","type":"file","__fileName":"New_Custom_Report_Options_Form.png","height":636}},{"type":"caption","content":[{"text":"Options Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The Options Tab is used for creating the Report's Title (either a fixed Title, or generated based on information obtained when the Report was run, with a 100 character limit), as well as adding in additional Footer and other general CSS formatting. The Report's Footer is limited to 500 characters or less.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attachments Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":30284,"__fileMimeType":"image/png","width":858,"alt":"Attachments Section","id":"3c1ba3ec-0688-4bf5-9fc4-94dfda36ded6","collection":"contentId-17242121","type":"file","__fileName":"New_Custom_Report_Attachments_Form.png","height":639}},{"type":"caption","content":[{"text":"Attachments Section","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Before Files can be Uploaded to a Custom Report, the Custom Report must first be saved.","type":"text"}]},{"type":"paragraph","content":[{"text":"Unlike other Attachment Tabs within PCR-360, files Attached to a Custom Report are uploaded to the ","type":"text"},{"text":"/media/custom/","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00ff00"}}]},{"text":" directory on the Server. ","type":"text"},{"text":"This makes ALL Attachments to ANY Custom Report available to all other Custom Reports, as long as the User using the image to know the path to the file name.","type":"text","marks":[{"type":"em"}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":600,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":13885,"__fileMimeType":"image/png","width":506,"alt":"Manage Report Attachment form example","id":"0af84950-44e6-4323-bd98-4c1ad16221d3","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_14-55-16.png","height":202}},{"type":"caption","content":[{"text":"Manage Report Attachment form example","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Uploaded files can be set to have ","type":"text"},{"text":"Availability","type":"text","marks":[{"type":"em"}]},{"text":" to be displayed on other Report's Attachment Tabs by setting that File to ","type":"text"},{"text":"All Reports","type":"text","marks":[{"type":"em"}]},{"text":" when it is uploaded. Setting the File to be available for ","type":"text"},{"text":"Only this Report","type":"text","marks":[{"type":"em"}]},{"text":" will cause the File to not be displayed as such, even though it can still be accessed.","type":"text"}]},{"type":"paragraph","content":[{"text":"It should be warned, because all files are easily accessed using the same basic File Path, ","type":"text"},{"text":"Uploading a File with the same name as a previously uploaded File will overwrite that File on the Server","type":"text","marks":[{"type":"strong"}]},{"text":". Additionally, if a File is removed from the Attachment Tab, any other Reports that use that File will become broken, as the File will no longer exist on the Server.","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Note: ","type":"text","marks":[{"type":"strong"}]},{"text":"It is highly recommended to NOT attach JavaScript files to Custom Reports as that can be a serious security risk","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Batch Processing Tab","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":952,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":33389,"__fileMimeType":"image/png","width":952,"alt":"image-20241216-154309.png","id":"ddb36ad7-ded6-4133-8d9b-05a530dd21c9","collection":"contentId-17242121","type":"file","__fileName":"image-20241216-154309.png","height":710}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The Batch Processing Tab displays information about Scheduled Batches, and allows a User to ","type":"text"},{"type":"mediaInline","attrs":{"width":54,"alt":"image-20241216-154354.png","id":"81507e45-da2c-4a4c-8b7d-4604dcb79a08","collection":"contentId-17242121","type":"image","height":31}},{"text":" , ","type":"text"},{"type":"mediaInline","attrs":{"width":110,"alt":"Edit Selected","id":"be994dad-42bb-4d43-822a-21a450d3a7e9","collection":"contentId-17242121","type":"image","height":27}},{"text":" , and ","type":"text"},{"type":"mediaInline","attrs":{"width":127,"alt":"Delete Selected","id":"3a32dffc-bb89-4aaf-b170-ad4187ae6e91","collection":"contentId-17242121","type":"image","height":30}},{"text":" Batches. For more information on the Batch Process, please see the section of this article for ","type":"text"},{"text":"Automatically creating the Report","type":"text","marks":[{"type":"link","attrs":{"href":"#"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Updating an Existing Report","type":"text"}]},{"type":"paragraph","content":[{"text":"To edit a Custom Report, a User simply needs to select the desired Report from the Custom Reports grid and click on the [Edit Selected] button. This will open the Report and the User can change any Logic, Parameters, Options, Attachments Batches, or the Template as needed.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Linking a Custom Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Reports can be linked to ","type":"text"},{"text":"Data-Entry forms","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"(2024.1) The Data Entry Form","versionAtSave":"5"},"href":"https://pcr360.atlassian.net/wiki/spaces/pcr360wiki/pages/17244009"}}]},{"text":" or ","type":"text"},{"text":"Data Grids","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"(2024.1) Grid Toolbar","versionAtSave":"5"},"href":"https://pcr360.atlassian.net/wiki/spaces/pcr360wiki/pages/17244042"}}]},{"text":". When opening a Custom Report that has been linked a single parameter called “recid” is passed. To process this parameter the report requires that the “recid” parameter is added to the Parameters tab in the Report Builder.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Running a Custom Report","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Back Office generating the Report","type":"text"}]},{"type":"paragraph","content":[{"text":"Back office users can generate Custom Reports from multiple places in PCR-360: Admin, the Reporting menu, CustomerCenter, Form → Reports menus, and Grid → Reports menus.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Admin: Custom Reports","type":"text"}]},{"type":"paragraph","content":[{"text":"From the Custom Reports grid Users can click on [Open Report] to generate a Report.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":1483,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":24961,"__fileMimeType":"image/png","width":2057,"alt":"image-20241212-154522.png","id":"81689495-e76d-4360-a63d-daf69fe26f10","collection":"contentId-17242121","type":"file","__fileName":"image-20241212-154522.png","height":174}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"Reporting: Available Reports","type":"text"}]},{"type":"paragraph","content":[{"text":"Users can generate new Reports from the ","type":"text"},{"text":"Main > Reporting > Custom Reports > Available Reports","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":" menu option. However, when accessed from the Main menu, the Grid is limited based on the logged in User's assigned Roles, based on what Reports are assigned to those Roles.","type":"text"}]},{"type":"paragraph","content":[{"text":"To view a Report, a User must select the Report from the grid and click on [View Report]. For User convenience, a User can also [Bookmark Selected] Reports to access more quickly through the PCR-360 Footer.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"","alt":"Reporting Available Reports grid example","id":"3c6d9c15-ed7d-471e-8a5d-093ace8cf174","collection":"contentId-17242121","height":"171"}}}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Report Preview","type":"text"}]},{"type":"paragraph","content":[{"text":"On the Report Preview page the User will need to fill in any required parameters and then click on the [Open Report] button to open the report in a new tab. A preview of the report may be run by clicking the \"Refresh\" button after entering the required parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"When a Report is run, Users can share the Report through the using the functions provided.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1190.0,"localId":"aa364356-28ff-460d-aae9-0d450bbbacf7"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"align-start","width":75,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":553,"__fileMimeType":"image/png","width":69,"alt":"Copy Link","id":"b2012a72-50b5-4eaa-a915-7fb19c057599","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_12-0-18.png","height":34}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1069.0]},"content":[{"type":"paragraph","content":[{"text":"The [Copy Link] button will copy a link to the Report, including the parameters, to the User's clipboard so that they can share it as a Web URL.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"align-start","width":75,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":645,"__fileMimeType":"image/png","width":82,"alt":"Save a Copy","id":"be6f6e42-1689-48ec-94b0-b465d9114150","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_12-0-49.png","height":40}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1069.0]},"content":[{"type":"paragraph","content":[{"text":"The [Save a Copy] button will save the Report so that it becomes available from the ","type":"text"},{"text":"Saved Reports","type":"text","marks":[{"type":"strong"}]},{"text":" grid.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"mediaSingle","attrs":{"layout":"align-start","width":75,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":657,"__fileMimeType":"image/png","width":90,"alt":"Download PDF","id":"972c6468-48f8-4b15-8fbe-2a7ef5c09d6b","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_12-1-6.png","height":38}}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1069.0]},"content":[{"type":"paragraph","content":[{"text":"The [Download PDF] button will download a PDF Copy of the Report to the User's local system.","type":"text"},{"type":"hardBreak"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Saved Reports","type":"text"}]},{"type":"paragraph","content":[{"text":"Alternatively, Users can view previously saved Reports from the ","type":"text"},{"text":"Main > Reporting > Custom Reports > Saved Reports","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":" menu option.","type":"text"}]},{"type":"paragraph","content":[{"text":"From this grid, the User can click on [View Report] to open the saved Report directly or click on [Delete Selected] to delete the saved Report.","type":"text"}]},{"type":"paragraph","content":[{"text":"Admin Users can also click on [Bulk Assign] to have a Report display for other Users.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"full-width"},"content":[{"type":"media","attrs":{"__fileSize":32365,"__fileMimeType":"image/png","width":1280,"alt":"Reporting Saved Reports grid example","id":"c0377a22-a0bb-46a5-b08c-0774c6bda09d","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_11-54-47.png","height":192}},{"type":"caption","content":[{"text":"Reporting Saved Reports grid example","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CustomerCenter providing the Report","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":30444,"__fileMimeType":"image/png","width":1280,"alt":"Custom Reports in CustomerCenter","id":"b162dfdb-4f49-4542-b590-b960ae32a52d","collection":"contentId-17242121","type":"file","__fileName":"CustomerCenter_Custom_Reports_Page.png","height":317}},{"type":"caption","content":[{"text":"Custom Reports in CustomerCenter","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Custom Reports are available in ","type":"text"},{"text":"CustomerCenter","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://pcr360.atlassian.net/wiki/x/l5EQAQ"}}]},{"text":". Just like the ","type":"text"},{"text":"Main > Reporting > Custom Reports > Available Reports","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":" menu option, the page is limited based on the logged in User's assigned Roles, based on what Reports are assigned to those Roles.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Automatically running the Report","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"auto"},"legacyAnchorId":{"value":"id-(2024.1)CustomReports-auto"},"_parentId":{"value":"17242121"}},"macroMetadata":{"macroId":{"value":"b5d2cdaa-13e8-440b-80cd-4694f7d33316"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"a601d5bd-894f-4d1a-a06f-670066cb9281"}}]},{"type":"paragraph","content":[{"text":"From the Custom Reports grid, Users can open a Report, and click the ","type":"text"},{"type":"mediaInline","attrs":{"width":57,"alt":"image-20241212-154708.png","id":"112bc950-14c3-46a6-87e3-4d586e841e7c","collection":"contentId-17242121","type":"image","height":31}},{"text":" button on the “Batch Processing” tab of that report.","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":919,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":8976,"__fileMimeType":"image/png","width":919,"alt":"image-20241212-154620.png","id":"f5b96e36-1ab1-4254-8157-60f263213944","collection":"contentId-17242121","type":"file","__fileName":"image-20241212-154620.png","height":111}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":4},"content":[{"text":"Report Batch Process","type":"text"}]},{"type":"paragraph","content":[{"text":"The Report Batch Process allows an Admin User to apply SQL ","type":"text"},{"text":"Filters","type":"text","marks":[{"type":"em"}]},{"text":", define a ","type":"text"},{"text":"Notificatio","type":"text","marks":[{"type":"em"}]},{"text":"n Message when the Report Batch is generated, and set a specific ","type":"text"},{"text":"Schedule","type":"text","marks":[{"type":"em"}]},{"text":" for the Report to run automatically.","type":"text"}]},{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"mediaSingle","attrs":{"layout":"center","width":497,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":32501,"__fileMimeType":"image/png","width":784,"alt":"image-20241212-154322.png","id":"b0527d11-55d4-4b5e-877a-45026c403b85","collection":"contentId-17242121","type":"file","__fileName":"image-20241212-154322.png","height":723}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"When the Batch executes, each Record from the User defined SQL Filter Query will be fed into the Report's Logic as the parameters. Each unique row of the Filter Query will generate a particular Report. The CONTACTS_RECID of each record will determine which Contacts are assigned to the individual Reports.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"mediaSingle","attrs":{"layout":"center","width":497,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":24080,"__fileMimeType":"image/png","width":780,"alt":"image-20241212-154342.png","id":"ad2524c7-75d4-41b9-9f66-943736855b9d","collection":"contentId-17242121","type":"file","__fileName":"image-20241212-154342.png","height":721}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Users can define a custom Subject Line for an automatic notification, as well as provide a message for the Notification. Users can also opt to attach the PDF of the Report to the Notification automatically.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"mediaSingle","attrs":{"layout":"center","width":497,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":21444,"__fileMimeType":"image/png","width":781,"alt":"image-20241212-154405.png","id":"4e57ac6a-eacc-4bfc-bbe1-f8ae6fb4678e","collection":"contentId-17242121","type":"file","__fileName":"image-20241212-154405.png","height":723}}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Users can have a Batch run Immediately or set a Frequency for the Report to execute on, as well as set a date for when to run the Report next.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Frequency can be set for:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run Once","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Daily","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Weekdays","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Weekly","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Monthly","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Quarterly","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Yearly","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Example Custom Report: Invoice","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"example"},"legacyAnchorId":{"value":"id-(2024.1)CustomReports-example"},"_parentId":{"value":"17242121"}},"macroMetadata":{"macroId":{"value":"fab6d9d7-5541-4cef-86ba-ffd88709fb45"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"a97fff5d-c4c0-4141-8d0b-dd485f059608"}}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"__fileSize":41795,"__fileMimeType":"image/png","width":1120,"alt":"Sample Custom Invoice","id":"8a513d31-47b9-4bab-8a91-5c0894b7d784","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-10_8-29-10.png","height":670}},{"type":"caption","content":[{"text":"Sample Custom Invoice","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Below is an example of how Custom Reports can be used to generate a Custom Invoice.","type":"text"}]},{"type":"paragraph","content":[{"text":"Invoice - Logic","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Invoice - Logic","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"$invoice = $this->query(<< $params['invoice']]);\n$invoice = $invoice[0];\n\n$this->assign('invoice', $invoice);\n$this->assign('fmtBillDate', (new DateTime($invoice['BILL_DATE']))->format('M y'));\n$this->assign('gla', $invoice['ACCOUNTNUMBER']);\n$this->assign('invoiceTotal', number_format($invoice['BILLED_AMOUNT'], 2));\n$this->assign('invoiceDate', (new DateTime($invoice['INVOICE_DATE']))->format('m/d/Y'));\n\n$billingAddress = $this->query(<< $invoice['GLA_RECID']]);\n$billingAddress = $billingAddress[0];\n$this->assign('billingAddress', $billingAddress);\n\n$billingContact = $this->query(<< $invoice['GLA_RECID']]);\n$billingContact = $billingContact[0];\n$this->assign('billingContact', $billingContact);\n\n$bdTableSuffix = '_' . (new DateTime($invoice['BILL_DATE']))->format('ym');\n$tableExists = $this->query(\"SHOW TABLES LIKE 'BILL_DETAILS{$bdTableSuffix}'\");\n$this->debug($tableExists);\n$bdTable = \"BILL_DETAILS\" . (empty($tableExists) ? '' : $bdTableSuffix);\n$this->debug(<<query(<< $invoice['RECID']]);\n$this->assign('billDetails', $billDetails);","type":"text"}]},{"type":"paragraph","content":[{"text":"Invoice - Parameters","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":21920,"__fileMimeType":"image/png","width":853,"alt":"Parameters Example","id":"1b786c9d-393c-4701-b2b5-e1db7def845d","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_15-25-49.png","height":256}},{"type":"caption","content":[{"text":"Parameters Example","type":"text"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Invoice - Template","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"

\n \t

0000 Nowhere Street
\n \tNowhere Village, No State 00000

\n \t

To Attention:
\n Account Number: {$gla}
\n {$billingContact.FIRST_NAME} {$billingContact.LAST_NAME}
\n {$billingAddress.STREET_ADDRESS} {$billingAddress.ADDRESS2}
\n {$billingAddress.CITY}, {$billingAddress.STATE} {$billingAddress.ZIP_CODE}\n

\n \n \n \n \n \n

Account Number:	{$gla}
Invoice Number:	{$invoice.INV_NUMBER}
Invoice Period:	{$fmtBillDate}

\n\n\n\t\n \t\n \t\t\n \t\t\n \t\n \t\n \n \n \n \n\t\n\t\n \n \n \n \n \n \n \n \n

Invoice Date

Invoice Number

Invoice Amount

{$invoiceDate}

{$params.invoice}

${$invoiceTotal}

\n \n \n \n \n \n \n \n \n \n \n \t{foreach $billDetails as $bd}\n \n \n \n \n \n \n {foreachelse}\n \n {/foreach}\n \n

Charge Code	Charge Description	Owner	Cost
{$bd.CHRG_CATALOG_NAME\|escape}	{$bd.CHRG_CATALOG_DESCRIPTION\|escape}	{$bd.DEPT_HIERARCHY_PATH\|escape}	{$bd.FMT_COST\|escape}
No Transactions Found

\n \n

Total Amount Due:

${$invoiceTotal}

\n\n\n

Please include a copy of this invoice with payment or reference this invoice # on your check.

Amount Due - Upon Receipt

Remit To: Office of the Black Voild
\n 0000 Nowhere Street, Nowhere Village, No State 00000
\n \tState ID # XXXX00000 00
\n \tFor All Billing Inquiries: 555-555-5555
\n noWhere@voidMail.com\n

","type":"text"}]},{"type":"paragraph","content":[{"text":"Invoice - Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"__fileSize":14364,"__fileMimeType":"image/png","width":830,"alt":"Options Example","id":"46d92f3e-0a06-4955-9ab5-d5193d0f2bf8","collection":"contentId-17242121","type":"file","__fileName":"image-2023-11-3_15-26-40.png","height":450}},{"type":"caption","content":[{"text":"Options Example","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"children","parameters":{"macroParams":{"_parentId":{"value":"17242121"}},"macroMetadata":{"macroId":{"value":"ee7f5c0a-5ca7-4309-bbcd-cfabae15e51f"},"schemaVersion":{"value":"2"},"title":"Child pages"}},"localId":"2e1470cc-b18c-4fa7-8daa-7b9642c46755"}}],"version":1}

0000 Nowhere Street\n \tNowhere Village, No State 00000

Please include a copy of this invoice with payment or reference this invoice # on your check.

0000 Nowhere Street
\n \tNowhere Village, No State 00000

Browser not supported