Troubleshooting Server Call Issues in Accolade Office Extensions
To successfully return data in reports created using Accolade Office Extensions, the add-in contacts the server to retrieve data and provide it to the client. To more easily identify and troubleshoot issues that arise in reports specifically around these service calls, you can access a diagnostics page in the application that provides visibility into the service calls the add-in surfaces to the client.
If enabled, a logs file is generated containing various service calls when a user interacts with the add-in. See Setting Custom Excel Report Template Properties for information on enabling the output logs and setting the directory. Use the logs file in conjunction with the Accolade Office Extensions diagnostics page to execute service calls the add-in makes to the client. Input objects from the logs file to the diagnostics page to return specified data.
To view and troubleshoot service calls:
- Retrieve the logs file generated when Accolade Office Extensions is used.
- From the System menu, click Diagnostics > Accolade Office Extensions.
- Execute a call listed below by inputting a value from the logs file where necessary and clicking Execute.
| Service Calls | Description | Input Value |
|---|---|---|
|
Return Report Data |
Returns report columns and data available to the user interacting with the report.  Example
Input: two reporting columns - project name and project class. { "CacheId":null,"Columns": [ { "ColumnOrder":1,"ColumnSetId":0,"ColumnType":1,"DataType":6,"DateMask":"","DateMaskId":0,"ListValues":null,"AggregateType":0,"DecimalPlaces":null,"DisplayName":"Project Name","OriginalDisplayName":null,"Id":1,"UniqueGroupId":0,"SortAscending":true,"SortOrder":0,"SystemName":"Project Name","Invalid":false }, { "ColumnOrder":2,"ColumnSetId":0,"ColumnType":1,"DataType":4,"DateMask":"","DateMaskId":0,"ListValues":null,"AggregateType":0,"DecimalPlaces":null,"DisplayName":"Project Class","OriginalDisplayName":null,"Id":230,"UniqueGroupId":0,"SortAscending":true,"SortOrder":0,"SystemName":"Project Class","Invalid":false } ], "Filters": [ { "ColumnType":1,"ColumnSystemName":"Project Name","Invalid":false,"DataType":6,"FilterType":1,"FilterValue":null,"FilterValues": [ { "MatchType":1,"DisplayValues":["test"],"Values":["test"] } ], "Id":1,"ReportId":0,"PromptOnRefresh":false,"UniqueGroupId":0}, { "ColumnType":1,"ColumnSystemName":"Project Class","Invalid":false,"DataType":4,"FilterType":1,"FilterValue":null,"FilterValues": [ { "MatchType":1,"DisplayValues":null,"Values":null}],"Id":230,"ReportId":0,"PromptOnRefresh":false,"UniqueGroupId":0 } ], "Page":0,"PageSize":0,"SubjectId":1,"ProjectId":0,"OverrideProjectFiltering":true } Returned Value: [ { "a1": "test", "a2": "Idea Class" } ] |
JSON object containing report columns |
|
Return SQL Statement |
Returns the SQL statement from the logs directory. Example
Input: two reporting columns - project name and project class. { "CacheId":null,"Columns": [ { "ColumnOrder":1,"ColumnSetId":0,"ColumnType":1,"DataType":6,"DateMask":"","DateMaskId":0,"ListValues":null,"AggregateType":0,"DecimalPlaces":null,"DisplayName":"Project Name","OriginalDisplayName":null,"Id":1,"UniqueGroupId":0,"SortAscending":true,"SortOrder":0,"SystemName":"Project Name","Invalid":false }, { "ColumnOrder":2,"ColumnSetId":0,"ColumnType":1,"DataType":4,"DateMask":"","DateMaskId":0,"ListValues":null,"AggregateType":0,"DecimalPlaces":null,"DisplayName":"Project Class","OriginalDisplayName":null,"Id":230,"UniqueGroupId":0,"SortAscending":true,"SortOrder":0,"SystemName":"Project Class","Invalid":false } ], "Filters": [ { "ColumnType":1,"ColumnSystemName":"Project Name","Invalid":false,"DataType":6,"FilterType":1,"FilterValue":null,"FilterValues": [ { "MatchType":1,"DisplayValues":["test"],"Values":["test"] } ], "Id":1,"ReportId":0,"PromptOnRefresh":false,"UniqueGroupId":0}, { "ColumnType":1,"ColumnSystemName":"Project Class","Invalid":false,"DataType":4,"FilterType":1,"FilterValue":null,"FilterValues": [ { "MatchType":1,"DisplayValues":null,"Values":null}],"Id":230,"ReportId":0,"PromptOnRefresh":false,"UniqueGroupId":0 } ], "Page":0,"PageSize":0,"SubjectId":1,"ProjectId":0,"OverrideProjectFiltering":true } Returned Value: "Select TOP 50000 ISNULL(TW_Projects.ProjectName, '[EMPTY]') as 'a1', ISNULL(TW_Projects.ProjectClass, '[EMPTY]') as 'a2' From RPT_TW_Projects TW_Projects with (NOLOCK) INNER JOIN RPT_TW_Projects TP0 WITH (NOLOCK) ON TP0.ProjectID = TW_Projects.ProjectID AND TP0.Visible = 1 INNER JOIN #ProjectUserAccess UA0 ON TP0.ProjectID = UA0.ProjectID Where (ISNULL(TW_Projects.ProjectName, '[EMPTY]') = N'test')" |
SQL statement from the client side logs file |
|
Return Configuration Values |
Returns the system name and display name of process model configuration components such as deliverables, quick grids, and gates. This includes all configuration items in the parameters section in the main Accolade website. |
|
|
Return Date Masks |
Returns the date formats and system names users set as part of their user profile and date formats set on the individual report. |
|
|
Return List Values |
Returns the list values for the input columns. Example
Input: [{"SubjectId":1,"ColumnId":230,"ColumnType":1,"ListValues":null}] Returned Value: [ { "SubjectId": 1, "ColumnId": 230, "ColumnType": 1, "ListValues": [ { "DisplayName": "[Empty]", "SystemName": "[Empty]" }, { "DisplayName": "ACC Portfolio", "SystemName": "Portfolio" }, { "DisplayName": "Gated IPD", "SystemName": "GatedIPD" }, { "DisplayName": "IPD", "SystemName": "IPD" }, { "DisplayName": "AD", "SystemName": "AD" }, { "DisplayName": "AD_No_Interface", "SystemName": "AD_No_Interface" } ] } ] |
JSON object for a reporting column |
|
Return Metadata Codes |
Returns metadata codes that correspond to the given integer. 1 - strings 3, 5 - number codes 2 - date codes Example
Input: 1 Returned value: [ { "Id": 2, "Name": "ProjectID", "DisplayName": "Project ID", "Index": null }, { "Id": 3, "Name": "ProjectName", "DisplayName": "Project Name", "Index": null }, { "Id": 5, "Name": "ProjectAccessGroup", "DisplayName": "Project Access Group", "Index": null } ] |
An integer value between 1 and 7 |
|
Return Metric Names |
Returns metric names that correspond to the given integer. 1, 4, 5, 6 - string - based metrics (strings, lists, multi-select lists, long strings) 2 - number metric names 3 - date metric names |
An integer value between 1 and 7 |
|
Return Images |
Returns image information used to generate project thumbnails in reports. Example
Input: [ { "DocumentId":3158,"DocumentTypeId":3,"FileName":"3158-1-2012-04-10-08-50-56","Version":1 }, { "DocumentId":1604,"DocumentTypeId":3,"FileName":"1604-1-2011-08-23-14-48-00","Version":1 }, { "DocumentId":6785,"DocumentTypeId":3,"FileName":"6785-1-2012-08-08-08-17-20","Version":1 } ] Returned value: { "3158-1":{"DisplayHeight":80,"DisplayWidth":80,"FileName":"3158-1-2012-04-10-08-50-56.Jpeg","AccessKey":"390b6788-8ab0-4c38-bf41-cc6a21d838e5","DocumentTypeId":3,"DocumentId":3158},"1604-1":{"DisplayHeight":80,"DisplayWidth":80,"FileName":"1604-1-2011-08-23-14-48-00.JPG","AccessKey":"7216ea81-7aee-4bdd-a443-2e8c8d0cfaea","DocumentTypeId":3,"DocumentId":1604 }, "6785-1": { "DisplayHeight":80,"DisplayWidth":80,"FileName":"6785-1-2012-08-08-08-17-20.Jpeg","AccessKey":"0c6c909b-802e-473c-b2e1-a9f37ee3ae81","DocumentTypeId":3,"DocumentId":6785 } |
JSON object for an image |
|
Return Parameter Value |
Returns parameter values for the input system parameter keys. Example
Input: {"SystemDelimiter"} Returned Value: | |
System parameter value |
|
Return Reporting Subjects |
Returns all reporting subjects including field codes. |
|
|
Return Reporting Columns For Subject |
Returns reporting columns for the given subject ID. |
Subject ID returned from previous call |
|
Return User Data |
Returns the user ID and Accolade Office Extensions user role for the user interacting with the report. |
|