Orcamate Documentation
Contents
- 1.1 Contents
- 2 Setup
- 3 Administration
- 3.1 UC Log Collection – On Demand
- 3.1.1 Trace Levels
- 3.2 UC Log Collection – Scheduled
- 3.3 PRT upload
- 3.4 Manual Query
- 3.4.1 AXL SQL Query
- 3.4.2 RIS Query
- 3.4.3 LDAP Query
- 3.4.4 EM Query
- 3.5 UC status
- 3.5.1 CUCM
- 3.5.1.1 Alerts
- 3.5.1.2 Trunks
- 3.5.1.3 Devices and Device Pools
- 3.5.1.4 Database
- 3.5.1.5 Services
- 3.5.1.6 Certificates
- 3.5.2 Expressway
- 3.5.2.1 Alarms
- 3.5.2.2 Connector Status
- 3.5.1 CUCM
- 3.6 Fault Finder
- 3.6.1 Alternate Syslog Search
- 3.6.2 Call Logs
- 3.6.3 Expressway Call Logs
- 3.7 CDR
- 3.8 DNA Visualizer
- 3.1 UC Log Collection – On Demand
- 4 Yarndoor
Setup
To set up Orcamate Engineer Toolkit, Open Yarnman Administration App, then select Services
Select ‘+Add Service’, then from Drop Down, select ‘Engineer App’
Enter Service Name (or accept prepopulated), select Node/Arm and required Authentication Policy, optionally select Associated Customer, Then select ‘Submit’
Next, select Services again, then select Proxy from screen
From Proxy Configuration screen top right corner, select ‘Service Routing’
Then again from top right corner of Proxy Routing screen select ‘Add Yarnapp’ → Engineer App, followed by Submit
Orcamate Engineer App has now been added and may be selected from Yarnman Administrator Drop Down top right corner
Administration
UC Log Collection – On Demand
Supported systems
CUCM
IMP
UCXN
Select the cluster*, time period and services
*Clusters need to be configured, this is performed under Administration App -> Clusters
Trace Levels
To check Trace Levels of CUCM services, select 'Check Trace Levels' button
UC Log Collection – Scheduled
The scheduled log collection push logs to an SFTP server*
Set the start and end time
How often the schedule is run
Cluster
Interface(s)
Services
Log duration on UC app
SFTP interface
SFTP path files are stored in <customer>/<cluster>/<interface>/<time period>
*SFTP server is added as interface under Administration App -> Interfaces
PRT upload
Problem report files can be uploaded to the engineer toolkit for both phones and Jabber if the upload URL is configured on the device in CUCM
These may also be configured to be pushed to SFTP
PRT files from CUCM devices can be pushed to Yarnman and viewed in Orcamate Engineer App under PRT. PRT upload to server from end device is supported on CUCM end devices Jabber, 78XX and 88XX phones
PRT Configuration
Under Yarnman Administration -> Services
Add Service Prattler
Configure Prattler – defining Node or Arm, API Port to bind and optionally SFTP interface and storage path for PRT Files on SFTP server
There is a now a configurable max size and max space for PRT - when an upload request starts the prattler service checks how much space is being used for PRT in couch tasks if there is not 2 x max file size it will delete the 2 oldest tasks - it does not delete old files on SFTP – this must be done with logrotate
In additional customer codes can be added for customer separation
CUCM Endpoint configuration
Open CUCM Admin page - > Device -> Phone
Select phone endpoint (note above on supported endpoints)
For CSF (Jabber)
Select End Device to be configured End Device CSF… for Jabber or SEPXXX… for Phone endpoint
On CSF
Scroll Down to Desktop Client Settings – under Problem Report Server URL – define URL to Yarnman server
On 78XX or 88XX series phone device – Problem Report Server URL is defined under Product Specific Configuration Layout – ‘Customer support upload URL’
Process to Upload and Collect PRT
Phone Problem Report initiate process found here
Jabber Problem Report initiate process found here
For Windows Client
https://help.webex.com/en-us/WBX63144/How-Do-I-Generate-a-Cisco-Jabber-for-Windows-Error-Log
Process to Collect Log File
Open Engineer App -> PRT Files
Select Problem Log to view