Leverage the Mobile Device Extension for ad rms

Troubleshooting the Mobile Device Extension

The section provides troubleshooting information for the Mobile Device Extension if needed your own (Azure-based) test lab environment.

Turning on logging

If you run into some specifics issues when testing of the Mobile Device Extension, you can turn on logging and then check the mobile device logs in the AD RMS database.

To turn on logging of the rights management server ADRMS1, proceed with the following steps:

1. 
   Open a remote desktop connection on the ADRMS1 computer as LITWARE369\AzureAdmin with “pass@word1” as password.
   
2. 
   Open an elevated Windows PowerShell command prompt, and run the following command to import this time the AdRmsAdmin set of Windows PowerShell cmdlets:
   

PS C:\Users\AzureAdmin.LITWARE369> Import-Module AdRmsAdmin

PS C:\Users\AzureAdmin.LITWARE369>

3. 
   Run the following command to create a Windows PowerShell drive that represents the cluster hosted by the local computer:
   

PS C:\Users\AzureAdmin.LITWARE369> New-PSDrive -Name AdrmsCluster -PsProvider AdRmsAdmin -Root https://localhost

PS C:\Users\AzureAdmin.LITWARE369>
At this stage, we can now set properties on objects in the drive namespace AdrmsCluster:\ that represent the configuration settings.

4. 
   Run the following command to turn on logging:
   

PS C:\Users\AzureAdmin.LITWARE369> Set-ItemProperty -Path AdrmsCluster:\ -Name IsLoggingEnabled -Value $true

PS C:\Users\AzureAdmin.LITWARE369>
Note To turn off logging, you simply need to rerun the above command with a value of $false. 

5. 
   Close the Windows PowerShell command prompt.
   

At this stage, any call to the Mobile Device Extension are logged in the Mobile Device Extension logs to help you in troubleshooting the issue if any, and resolve it.

If you are still stumped, please join the user group AskIPTeam on Yammer at http://www.yammer.com/AskIPTeam and search/request for troubleshooting information pertaining to the same issue you face with.

Analyzing the Mobile Device Extension logs

The Mobile Device Extension provides the following two tables to help investigate and troubleshoot client issues:

1. 
   The Client Debug Log (ClientDebugLog) table.
   
2. 
   The Client Performance Log (Client Performance Log) table.
   

The next two sections provide a description of these tables.

Understanding the Client Debug Log table

The Client Debug Log (ClientDebugLog) table in the AD RMS database contains as its name indicates the debug logs in order to investigate client issues.

The following table provides the field definitions.

Field name	Data type	Description	Example value
Id	uniqueidentifier	GUID of the trace entry. This helps in troubleshooting client issues.	201724F-270D-430E-AFD2-0BB26F896C05
UserId	nvarchar	User who made the request. Their user email address is used to identify the user.	[e-mail]
ClientTimeStamp	datetime	UTC Date and Time in 24H format the trace entry was written.	2014-07-08 23:19:45.000
Message	nvarchar	Free form text that contains the message for the trace entry.	getAuthInfo: authInfo:{mAuthServerUrl:https://adfs.litware369.com/adfs/oauth2/authorize}{mResource:api.rms.rest.com}{mScope:null}
ThreadId	int	Identifier that can tie the set of operations that are happening the same thread.	5021
TraceLevel	nchar	Type of the message of the trace entry. Supported types are Error Warning Info Verbose	Info
ClientCorrelationId	uniqueidentifier	GUID that is common between the RMS client and the server for a given request. This helps in troubleshooting client issues. If the trace entry is not a call to the server, this is empty.	00000000-0000-0000-0000-000000000000
ClientScenarioId	uniqueidentifier	GUID that identifies the client scenario the trace entry was written under. A client scenario cover zero or more call to the server.	6BD8AF07-AE25-41D9-AAA2-6641BFF2A1A2
CreateTime	datetime	UTC Date and Time in 24H format when the call was served. The source is the local clock on the server that served the call.	2014-07-08 23:19:48.803
FullClientInformation	nvarchar	Client side information including the device environment (platform OS and model), the RMS SDK version, the RMS-enlightened application	DevicePlatform=Android;DeviceModel=Samsung ABC;SDKVersion=4.0;AppName=SampleApp.exe;AppPublisherId=123

Understanding the Client Performance Log table

The Client Performance Log table in the AD RMS database contains as its name indicates the performance logs in order to help understand the experience that the end users are having when using their mobile device(s) with RMS-enlightened applications.

The following table provides the field definitions.

Field name	Data type	Description	Example value
Id	uniqueidentifier	GUID of the trace entry. This helps in troubleshooting client issues.	19A56FFA-7386-4C87-BEAA-2765627E2EDD
UserId	nvarchar	User who made the request. Their user email address is used to identify the user.	[e-mail]
ClientTimeStamp	datetime	UTC date and time in 24H format the trace entry was written.	2014-06-27 07:11:28.000
OperationName	nvarchar	Name of the operation. Operations serve two purposes. Operations can represent client scenarios, which cover zero or more calls to the server (like Consume or Protect), and they can represent a specific call to the server. In the case it represents a specific call to the server, the ClientCorrelationId field is set. In the case it represents a client scenario, the ClientCorrelationId is empty (See below). In both cases, the ClientScenarioId field is set.	GetServiceDiscoveryURLs
Latency	bigint	Time it took to complete the operation in milliseconds.	142
ClientCorrelationId	uniqueidentifier	GUID that is common between RMS client and server for a given call. This helps in troubleshooting client issues. If the trace entry is not a call to the server, this is empty.	B079C03D-FD9A-4CE3-BA16-4C8745491854
ClientScenarioId	uniqueidentifier	GUID that identifies the client scenario the trace entry was written under. A client scenario cover zero or more call to the server.	6BD8AF07-AE25-41D9-AAA2-6641BFF2A1A2
FullClientInformation	nvarchar	Client side information including the device environment (platform OS and model), the RMS SDK version, the RMS-enlightened application	DevicePlatform=Android;DeviceModel=Samsung ABC;SDKVersion=4.0;AppName=SampleApp.exe;AppPublisherId=123
NetworkType	nvarchar	Placeholder for future network information for the RMS client. This is empty.
CreateTime	Datetime	UTC Date and Time in 24H format when the call was served. The source is the local clock on the server that served the call.	2014-06-27 07:11:18.280

This concludes the guided tour of the Mobile Device Extension for AD RMS.