Public

Help Us Help You!

Help Us Help You!

Dear Customer,

You're looking to create a case because you've encountered a technical issue, would like a request to be completed, or have some other information you would like to receive. You would like to have your case completed as quickly as possible and so would we! While we can't always guarantee things will be resolved quickly depending on the nature of an issue, there are some things you can do to help move things along proactively!

We've compiled some common requests for details that our Support team often asks for below with respect to each product Khoros offers, as well as some tips on things you can do to help focus the team's efforts on the right things. If you could provide this information when creating your case that would help move the request along, as it will eliminate some back and forth and allow our team to move forward and ask more targeted questions if more information is needed on top of what was already provided (sometimes this may be necessary). Some of this information may not always be relevant or available (e.g.: if you want to enable a new Community feature we probably won't need a HAR file), but please try to provide as much as you can!

Care

Care is a single page web application which allows a lot of social media integrations. We have put up a list of scenarios with a set of information that the support team might require to investigate that scenario.

Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.

If the issue is regarding content(post) not ingesting into the Care application then it would be helpful to provide us with the following links: 

  1. Native links of the original posts
  2. Screenshots to the native posts

If the issue is regarding user unable to login, then it would be important provide the following information:

  1. Users email address
  2. Screenshots of the error while attempting to login
  3. How many users are unable to login, is it specific to a set of users or all users?

If the issue is that the content is ingesting with a delay then you can provide us with the following information

  1. Conversation ids where the delay was noticed.
          2. The Social media handle name.
          3. Is the delay in ingestion experienced for all the conversations from       that specific social media handle or different social media handle.

If the issue is regarding conversations falling in an incorrect work queue, then
you can provide us with the following information:

  1. Conversation ids that were incorrectly routed.
  2. Name of the work queue where the conversation should have been routed.
  3. Were any recent changes done to the work queues or the tags?
  4. If there were changes done then what were those changes.

        If the issue is related to user permissions and that some of the roles aren’t reflecting even after saving the user profile, please provide us with the following information:

  1. User email address.
  2. Screenshot of the error if any error pops up.
  3. How many other users are seeing a similar issue?
  4. Are the user permissions managed via any identity provider or do they login via SSO?

If care app appears to be slow, the following information would be absolutely necessary and important

  1. How many users are experiencing slowness is it specific to a group of users?
  2. If it is specific to a group of users are they located in the same geographic location.
  3. Is there a specific screen in the care application where the slowness is being experienced or it is with the overall application?
  4. Is the behaviour consistent across different browsers too?
  5. Do you use any VPN to access the application?
  6. Were there any recent changes done to the network on your end?
  7. What exactly happens when you experience slowness on the application.

Back to top

Community

The Community application is large and complex, carrying a number of different features and configuration options, as well as numerous avenues for customization. Here are some things to consider both while you are filing a case for anything Community related or perhaps while trying to review an issue on your own prior to creating a case:

Technical issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Please also bear in mind that some communities are customized to add configuration options or pages that may not be present on any other community, so including steps to reach the page(s) you were looking at or how you obtained a certain piece of output can be very helpful!
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to submit a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • When possible, please try to confirm if an issue occurs on all of your environments (stage, production, preproduction) as well. We understand that not all issues can be tested everywhere for a variety of reasons, but it is helpful to know what you see on all of your environments for comparison purposes.
  • Please include full URLs to the page(s) you would like us to pay attention to. The more specific the URL is, the better. You may already have these URLs open while creating your case as well and it is likely it will take less time to copy and paste them in the field for URLs than it would for someone from the Support team to track it down on their own.
    • This also helps ensure the team is looking at the right instance(s), which can be especially important if you have more than one instance or refer to your communities in a different way than the Khoros team does internally. For example, "dev" is a common reference to stage instances among customers, but internally, we don't have any customer environments that are referred to as "dev", so this can cause confusion that can be solved by linking to the specific instance(s) you would like us to focus on.
  • Please try to provide timestamps wherever possible. The log files for the Community application are very large and contain a lot of information about various things that happen on an individual community, so having something to focus on is extremely helpful. Please remember to include the timezone for any timestamps you provide. One person's 1 pm is another person's 1 am, so leaving out the timezone could lead to any results being off by several hours for a task where even a couple of seconds could make a difference.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar and taskbar with the clock visible). If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file is often helpful. Please see this article for more information on HAR files and steps to generate them. For any HAR files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please try to give a meaningful name to any files you attach to a case. It is much easier to tell at a glance what "board-with-error.png" is for than it is when the filename is something along the lines of "image1.png". This becomes increasingly appreciated and helpful as more files are attached over time.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted. Having some sample users to look at can be useful for comparison purposes and for looking information up in our logs. Please try to provide a link to the user's profile, as this will help reduce confusion and ensure that we're looking at the right user (example of a profile URL: https://community.khoros.com/t5/user/viewprofilepage/user-id/1)
  • Please consider things that may have changed recently, both on and off of the community. For example, if a deployment using Self Publish was recently carried out and something no longer works correctly, this is both helpful for the Support team and for you to consider as well as something to look into on your end. Along the same lines, changes off of the community can be relevant as well. For example, if your community uses SSO and your SSO team makes a change, that may be relevant if SSO suddenly stops working. Having information like this from the start helps focus the team's efforts.
    • Some other specific things that may be worth considering depending on the issue you are facing (but not limited to) are Community Admin panel changes, DNS changes your to community's hostname, deployments carried out by Khoros teams that you are aware of (e.g.: Services engagements, new features, upgrades), and changes to your authentication workflow (either on your side or on the Community side).
  • Please try to include when the issue started if you have an idea of when something last worked differently. This is similar to the previous point in that you will generally have more experience with what you need and want your specific community to do, so knowing when something last worked differently can be extremely helpful in tracking down what may be causing an issue even if you aren't aware of any specific changes that might have been made.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • For connectivity and performance issues, please consider trying to reproduce the issue on a different network (e.g.: if you normally use a corporate VPN, try turning it off or using your cell phone). This can help rule out network issues as a cause of any issues you run into. Please note that in cases where a specific network has an issue, it is likely the team will recommend reaching out to the network owner, so you may want to consider doing this proactively as well.
  • For any API calls you are using (either manually or through custom code/automation), please provide the full API call exactly as it is being made. You can scrub any session key information, but please try to keep the exact call intact and include any headers or query parameters you are using.
    • In cases where you are using code to make the API call, please consider sharing that source code as well. The Support team generally cannot debug your custom code, but it can be helpful for us to get an idea of what it is doing and where.
  • For display issues or script errors, the Support team will typically try to test an issue by changing the skin the page is using to an out of the box (OOTB) skin to try and narrow down the scope of the issue. This may be something you want to try on your own as well. This can be accomplished by going to the Admin Panel -> Display -> Skins -> Select one of the OOTB skins (White UI or Responsive Peak) and save changes. If you are going to do this, we recommend doing so on stage or in a private area on your community, as the OOTB skins will look very different from your branded skin and this could cause confusion for your end users.
    • In cases where changing the skin appears to resolve the problem, the Support team may ask you to reach out to your internal teams to look into the issue. You may want to consider doing that proactively as well in order to review any changes that may have been made.

Requests to enable features or for information:

  • For any requests to enable features, if you happen to have the documentation available to point to that would be appreciated! We understand if you don't have it onhand when creating a case, but if you do happen to have it open, it helps ensure that everyone is looking at the same thing.
  • Though not often as relevant to these types of cases, filling out the "Steps to reproduce", "Expected behavior", and "Actual behavior" fields can still be very helpful in ensuring that the team focuses their efforts on what it is you're interested in.

Back to top

Marketing

Technical Issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to schedule or save a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar). This will provide more details as to where you are in the platform. If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file and console logs are often helpful. Please see this article for more information on HAR files/console logs and steps to generate them. For any files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted.
  • Please include details on how this impacts your daily workflow. Whether the issue is intermittent or happening all the time. Is this preventing you from completing a task. If so, is there a deadline you need to complete this by?
  • For access related issues please review the Admin FAQ. If you are unsure who your admin is, support can look up your admin who can provide you with the appropriate access.

Specific to Marketing:

  • For Calendar posts or Ads provide
    • Message ID. To locate the message ID click on the post to open the side pane then click on the basics tab under Khoros ID copy the message:xxxxxxx.
    • The name of the initiative the post/ad is in
    • If the post includes media provide the original image/video file
  • For Inbox items provide
    • A screenshot of the item
    • The name of the stream/collection or topic queue the item is in
    • The name of the initiative the item is in
  • For Analytics provide
    • A full page screenshot of the dashboard. Include the date ranges and any filters that are applied.
    • Attach data exports
  • For Mobile provide
    • The name of the app,
    • Device information (Android or iOS)
    • Which OS version you are on
    • Mobile app version. If you are not on the latest version of the app you may need to delete and re-download the app.
  • For API provide
    • Curl. This should include the token and the request/body being made.
    • Text or screenshot of errors returned

Specific to Intelligence:

  • Provide a direct link to the search/topic or a full page screenshot that includes the search name.

Specific to Experiences:

  • Provide a direct link to the stream, visualization or space in the platform.

Back to top

As mentioned earlier, we may still need to ask for additional information depending on the nature of the case. However, by providing any of the above information when you can, we can hopefully move your case towards a satisfactory resolution quickly!

We hope you have found the above information useful and we appreciate you sticking with us until the end of this article! As always, please don't hesitate to reach out and let us know if you have any questions or concerns!

Sincerely,

The Khoros Support Team

Labels (1)

Help Us Help You!

Dear Customer,

You're looking to create a case because you've encountered a technical issue, would like a request to be completed, or have some other information you would like to receive. You would like to have your case completed as quickly as possible and so would we! While we can't always guarantee things will be resolved quickly depending on the nature of an issue, there are some things you can do to help move things along proactively!

We've compiled some common requests for details that our Support team often asks for below with respect to each product Khoros offers, as well as some tips on things you can do to help focus the team's efforts on the right things. If you could provide this information when creating your case that would help move the request along, as it will eliminate some back and forth and allow our team to move forward and ask more targeted questions if more information is needed on top of what was already provided (sometimes this may be necessary). Some of this information may not always be relevant or available (e.g.: if you want to enable a new Community feature we probably won't need a HAR file), but please try to provide as much as you can!

Care

Care is a single page web application which allows a lot of social media integrations. We have put up a list of scenarios with a set of information that the support team might require to investigate that scenario.

Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.

If the issue is regarding content(post) not ingesting into the Care application then it would be helpful to provide us with the following links: 

  1. Native links of the original posts
  2. Screenshots to the native posts

If the issue is regarding user unable to login, then it would be important provide the following information:

  1. Users email address
  2. Screenshots of the error while attempting to login
  3. How many users are unable to login, is it specific to a set of users or all users?

If the issue is that the content is ingesting with a delay then you can provide us with the following information

  1. Conversation ids where the delay was noticed.
          2. The Social media handle name.
          3. Is the delay in ingestion experienced for all the conversations from       that specific social media handle or different social media handle.

If the issue is regarding conversations falling in an incorrect work queue, then
you can provide us with the following information:

  1. Conversation ids that were incorrectly routed.
  2. Name of the work queue where the conversation should have been routed.
  3. Were any recent changes done to the work queues or the tags?
  4. If there were changes done then what were those changes.

        If the issue is related to user permissions and that some of the roles aren’t reflecting even after saving the user profile, please provide us with the following information:

  1. User email address.
  2. Screenshot of the error if any error pops up.
  3. How many other users are seeing a similar issue?
  4. Are the user permissions managed via any identity provider or do they login via SSO?

If care app appears to be slow, the following information would be absolutely necessary and important

  1. How many users are experiencing slowness is it specific to a group of users?
  2. If it is specific to a group of users are they located in the same geographic location.
  3. Is there a specific screen in the care application where the slowness is being experienced or it is with the overall application?
  4. Is the behaviour consistent across different browsers too?
  5. Do you use any VPN to access the application?
  6. Were there any recent changes done to the network on your end?
  7. What exactly happens when you experience slowness on the application.

Back to top

Community

The Community application is large and complex, carrying a number of different features and configuration options, as well as numerous avenues for customization. Here are some things to consider both while you are filing a case for anything Community related or perhaps while trying to review an issue on your own prior to creating a case:

Technical issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Please also bear in mind that some communities are customized to add configuration options or pages that may not be present on any other community, so including steps to reach the page(s) you were looking at or how you obtained a certain piece of output can be very helpful!
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to submit a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • When possible, please try to confirm if an issue occurs on all of your environments (stage, production, preproduction) as well. We understand that not all issues can be tested everywhere for a variety of reasons, but it is helpful to know what you see on all of your environments for comparison purposes.
  • Please include full URLs to the page(s) you would like us to pay attention to. The more specific the URL is, the better. You may already have these URLs open while creating your case as well and it is likely it will take less time to copy and paste them in the field for URLs than it would for someone from the Support team to track it down on their own.
    • This also helps ensure the team is looking at the right instance(s), which can be especially important if you have more than one instance or refer to your communities in a different way than the Khoros team does internally. For example, "dev" is a common reference to stage instances among customers, but internally, we don't have any customer environments that are referred to as "dev", so this can cause confusion that can be solved by linking to the specific instance(s) you would like us to focus on.
  • Please try to provide timestamps wherever possible. The log files for the Community application are very large and contain a lot of information about various things that happen on an individual community, so having something to focus on is extremely helpful. Please remember to include the timezone for any timestamps you provide. One person's 1 pm is another person's 1 am, so leaving out the timezone could lead to any results being off by several hours for a task where even a couple of seconds could make a difference.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar and taskbar with the clock visible). If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file is often helpful. Please see this article for more information on HAR files and steps to generate them. For any HAR files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please try to give a meaningful name to any files you attach to a case. It is much easier to tell at a glance what "board-with-error.png" is for than it is when the filename is something along the lines of "image1.png". This becomes increasingly appreciated and helpful as more files are attached over time.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted. Having some sample users to look at can be useful for comparison purposes and for looking information up in our logs. Please try to provide a link to the user's profile, as this will help reduce confusion and ensure that we're looking at the right user (example of a profile URL: https://community.khoros.com/t5/user/viewprofilepage/user-id/1)
  • Please consider things that may have changed recently, both on and off of the community. For example, if a deployment using Self Publish was recently carried out and something no longer works correctly, this is both helpful for the Support team and for you to consider as well as something to look into on your end. Along the same lines, changes off of the community can be relevant as well. For example, if your community uses SSO and your SSO team makes a change, that may be relevant if SSO suddenly stops working. Having information like this from the start helps focus the team's efforts.
    • Some other specific things that may be worth considering depending on the issue you are facing (but not limited to) are Community Admin panel changes, DNS changes your to community's hostname, deployments carried out by Khoros teams that you are aware of (e.g.: Services engagements, new features, upgrades), and changes to your authentication workflow (either on your side or on the Community side).
  • Please try to include when the issue started if you have an idea of when something last worked differently. This is similar to the previous point in that you will generally have more experience with what you need and want your specific community to do, so knowing when something last worked differently can be extremely helpful in tracking down what may be causing an issue even if you aren't aware of any specific changes that might have been made.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • For connectivity and performance issues, please consider trying to reproduce the issue on a different network (e.g.: if you normally use a corporate VPN, try turning it off or using your cell phone). This can help rule out network issues as a cause of any issues you run into. Please note that in cases where a specific network has an issue, it is likely the team will recommend reaching out to the network owner, so you may want to consider doing this proactively as well.
  • For any API calls you are using (either manually or through custom code/automation), please provide the full API call exactly as it is being made. You can scrub any session key information, but please try to keep the exact call intact and include any headers or query parameters you are using.
    • In cases where you are using code to make the API call, please consider sharing that source code as well. The Support team generally cannot debug your custom code, but it can be helpful for us to get an idea of what it is doing and where.
  • For display issues or script errors, the Support team will typically try to test an issue by changing the skin the page is using to an out of the box (OOTB) skin to try and narrow down the scope of the issue. This may be something you want to try on your own as well. This can be accomplished by going to the Admin Panel -> Display -> Skins -> Select one of the OOTB skins (White UI or Responsive Peak) and save changes. If you are going to do this, we recommend doing so on stage or in a private area on your community, as the OOTB skins will look very different from your branded skin and this could cause confusion for your end users.
    • In cases where changing the skin appears to resolve the problem, the Support team may ask you to reach out to your internal teams to look into the issue. You may want to consider doing that proactively as well in order to review any changes that may have been made.

Requests to enable features or for information:

  • For any requests to enable features, if you happen to have the documentation available to point to that would be appreciated! We understand if you don't have it onhand when creating a case, but if you do happen to have it open, it helps ensure that everyone is looking at the same thing.
  • Though not often as relevant to these types of cases, filling out the "Steps to reproduce", "Expected behavior", and "Actual behavior" fields can still be very helpful in ensuring that the team focuses their efforts on what it is you're interested in.

Back to top

Marketing

Technical Issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to schedule or save a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar). This will provide more details as to where you are in the platform. If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file and console logs are often helpful. Please see this article for more information on HAR files/console logs and steps to generate them. For any files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted.
  • Please include details on how this impacts your daily workflow. Whether the issue is intermittent or happening all the time. Is this preventing you from completing a task. If so, is there a deadline you need to complete this by?
  • For access related issues please review the Admin FAQ. If you are unsure who your admin is, support can look up your admin who can provide you with the appropriate access.

Specific to Marketing:

  • For Calendar posts or Ads provide
    • Message ID. To locate the message ID click on the post to open the side pane then click on the basics tab under Khoros ID copy the message:xxxxxxx.
    • The name of the initiative the post/ad is in
    • If the post includes media provide the original image/video file
  • For Inbox items provide
    • A screenshot of the item
    • The name of the stream/collection or topic queue the item is in
    • The name of the initiative the item is in
  • For Analytics provide
    • A full page screenshot of the dashboard. Include the date ranges and any filters that are applied.
    • Attach data exports
  • For Mobile provide
    • The name of the app,
    • Device information (Android or iOS)
    • Which OS version you are on
    • Mobile app version. If you are not on the latest version of the app you may need to delete and re-download the app.
  • For API provide
    • Curl. This should include the token and the request/body being made.
    • Text or screenshot of errors returned

Specific to Intelligence:

  • Provide a direct link to the search/topic or a full page screenshot that includes the search name.

Specific to Experiences:

  • Provide a direct link to the stream, visualization or space in the platform.

Back to top

As mentioned earlier, we may still need to ask for additional information depending on the nature of the case. However, by providing any of the above information when you can, we can hopefully move your case towards a satisfactory resolution quickly!

We hope you have found the above information useful and we appreciate you sticking with us until the end of this article! As always, please don't hesitate to reach out and let us know if you have any questions or concerns!

Sincerely,

The Khoros Support Team

Labels (1)
Last Reviewed:
08-23-2021 23:45 PM

Help Us Help You!

Dear Customer,

You're looking to create a case because you've encountered a technical issue, would like a request to be completed, or have some other information you would like to receive. You would like to have your case completed as quickly as possible and so would we! While we can't always guarantee things will be resolved quickly depending on the nature of an issue, there are some things you can do to help move things along proactively!

We've compiled some common requests for details that our Support team often asks for below with respect to each product Khoros offers, as well as some tips on things you can do to help focus the team's efforts on the right things. If you could provide this information when creating your case that would help move the request along, as it will eliminate some back and forth and allow our team to move forward and ask more targeted questions if more information is needed on top of what was already provided (sometimes this may be necessary). Some of this information may not always be relevant or available (e.g.: if you want to enable a new Community feature we probably won't need a HAR file), but please try to provide as much as you can!

Care

Care is a single page web application which allows a lot of social media integrations. We have put up a list of scenarios with a set of information that the support team might require to investigate that scenario.

Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.

If the issue is regarding content(post) not ingesting into the Care application then it would be helpful to provide us with the following links: 

  1. Native links of the original posts
  2. Screenshots to the native posts

If the issue is regarding user unable to login, then it would be important provide the following information:

  1. Users email address
  2. Screenshots of the error while attempting to login
  3. How many users are unable to login, is it specific to a set of users or all users?

If the issue is that the content is ingesting with a delay then you can provide us with the following information

  1. Conversation ids where the delay was noticed.
          2. The Social media handle name.
          3. Is the delay in ingestion experienced for all the conversations from       that specific social media handle or different social media handle.

If the issue is regarding conversations falling in an incorrect work queue, then
you can provide us with the following information:

  1. Conversation ids that were incorrectly routed.
  2. Name of the work queue where the conversation should have been routed.
  3. Were any recent changes done to the work queues or the tags?
  4. If there were changes done then what were those changes.

        If the issue is related to user permissions and that some of the roles aren’t reflecting even after saving the user profile, please provide us with the following information:

  1. User email address.
  2. Screenshot of the error if any error pops up.
  3. How many other users are seeing a similar issue?
  4. Are the user permissions managed via any identity provider or do they login via SSO?

If care app appears to be slow, the following information would be absolutely necessary and important

  1. How many users are experiencing slowness is it specific to a group of users?
  2. If it is specific to a group of users are they located in the same geographic location.
  3. Is there a specific screen in the care application where the slowness is being experienced or it is with the overall application?
  4. Is the behaviour consistent across different browsers too?
  5. Do you use any VPN to access the application?
  6. Were there any recent changes done to the network on your end?
  7. What exactly happens when you experience slowness on the application.

Back to top

Community

The Community application is large and complex, carrying a number of different features and configuration options, as well as numerous avenues for customization. Here are some things to consider both while you are filing a case for anything Community related or perhaps while trying to review an issue on your own prior to creating a case:

Technical issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Please also bear in mind that some communities are customized to add configuration options or pages that may not be present on any other community, so including steps to reach the page(s) you were looking at or how you obtained a certain piece of output can be very helpful!
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to submit a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • When possible, please try to confirm if an issue occurs on all of your environments (stage, production, preproduction) as well. We understand that not all issues can be tested everywhere for a variety of reasons, but it is helpful to know what you see on all of your environments for comparison purposes.
  • Please include full URLs to the page(s) you would like us to pay attention to. The more specific the URL is, the better. You may already have these URLs open while creating your case as well and it is likely it will take less time to copy and paste them in the field for URLs than it would for someone from the Support team to track it down on their own.
    • This also helps ensure the team is looking at the right instance(s), which can be especially important if you have more than one instance or refer to your communities in a different way than the Khoros team does internally. For example, "dev" is a common reference to stage instances among customers, but internally, we don't have any customer environments that are referred to as "dev", so this can cause confusion that can be solved by linking to the specific instance(s) you would like us to focus on.
  • Please try to provide timestamps wherever possible. The log files for the Community application are very large and contain a lot of information about various things that happen on an individual community, so having something to focus on is extremely helpful. Please remember to include the timezone for any timestamps you provide. One person's 1 pm is another person's 1 am, so leaving out the timezone could lead to any results being off by several hours for a task where even a couple of seconds could make a difference.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar and taskbar with the clock visible). If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file is often helpful. Please see this article for more information on HAR files and steps to generate them. For any HAR files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please try to give a meaningful name to any files you attach to a case. It is much easier to tell at a glance what "board-with-error.png" is for than it is when the filename is something along the lines of "image1.png". This becomes increasingly appreciated and helpful as more files are attached over time.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted. Having some sample users to look at can be useful for comparison purposes and for looking information up in our logs. Please try to provide a link to the user's profile, as this will help reduce confusion and ensure that we're looking at the right user (example of a profile URL: https://community.khoros.com/t5/user/viewprofilepage/user-id/1)
  • Please consider things that may have changed recently, both on and off of the community. For example, if a deployment using Self Publish was recently carried out and something no longer works correctly, this is both helpful for the Support team and for you to consider as well as something to look into on your end. Along the same lines, changes off of the community can be relevant as well. For example, if your community uses SSO and your SSO team makes a change, that may be relevant if SSO suddenly stops working. Having information like this from the start helps focus the team's efforts.
    • Some other specific things that may be worth considering depending on the issue you are facing (but not limited to) are Community Admin panel changes, DNS changes your to community's hostname, deployments carried out by Khoros teams that you are aware of (e.g.: Services engagements, new features, upgrades), and changes to your authentication workflow (either on your side or on the Community side).
  • Please try to include when the issue started if you have an idea of when something last worked differently. This is similar to the previous point in that you will generally have more experience with what you need and want your specific community to do, so knowing when something last worked differently can be extremely helpful in tracking down what may be causing an issue even if you aren't aware of any specific changes that might have been made.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • For connectivity and performance issues, please consider trying to reproduce the issue on a different network (e.g.: if you normally use a corporate VPN, try turning it off or using your cell phone). This can help rule out network issues as a cause of any issues you run into. Please note that in cases where a specific network has an issue, it is likely the team will recommend reaching out to the network owner, so you may want to consider doing this proactively as well.
  • For any API calls you are using (either manually or through custom code/automation), please provide the full API call exactly as it is being made. You can scrub any session key information, but please try to keep the exact call intact and include any headers or query parameters you are using.
    • In cases where you are using code to make the API call, please consider sharing that source code as well. The Support team generally cannot debug your custom code, but it can be helpful for us to get an idea of what it is doing and where.
  • For display issues or script errors, the Support team will typically try to test an issue by changing the skin the page is using to an out of the box (OOTB) skin to try and narrow down the scope of the issue. This may be something you want to try on your own as well. This can be accomplished by going to the Admin Panel -> Display -> Skins -> Select one of the OOTB skins (White UI or Responsive Peak) and save changes. If you are going to do this, we recommend doing so on stage or in a private area on your community, as the OOTB skins will look very different from your branded skin and this could cause confusion for your end users.
    • In cases where changing the skin appears to resolve the problem, the Support team may ask you to reach out to your internal teams to look into the issue. You may want to consider doing that proactively as well in order to review any changes that may have been made.

Requests to enable features or for information:

  • For any requests to enable features, if you happen to have the documentation available to point to that would be appreciated! We understand if you don't have it onhand when creating a case, but if you do happen to have it open, it helps ensure that everyone is looking at the same thing.
  • Though not often as relevant to these types of cases, filling out the "Steps to reproduce", "Expected behavior", and "Actual behavior" fields can still be very helpful in ensuring that the team focuses their efforts on what it is you're interested in.

Back to top

Marketing

Technical Issues:

  • Please be thorough while describing the issue you are facing. The clearer you are, the easier it will be for the Support team to step through the issue in the same way that you are. This includes filling out the "Steps to reproduce", "Expected Behavior", and "Actual Behavior" fields in detail. Including the steps you took can be very helpful.
    • For example, if you are getting an error while trying to post, we would prefer that you describe the behavior as something like "When I try to schedule or save a post I receive an error with this text: texthere" as opposed to something like "When I try to submit a post it doesn't work". From a backend perspective, "doesn't work" could mean a number of different things, so being as descriptive as possible in all fields will give the team a better picture of what is happening and allow them to focus their efforts.
  • Screenshots and videos are also very helpful when trying to communicate an issue! For any screenshots or videos you provide, please try to include the full screen (including the address bar). This will provide more details as to where you are in the platform. If you need to draw focus to a specific part of the page, please consider using a highlighter or other drawing tools rather than cropping the image.
  • For technical issues where a problem occurs, a HAR file and console logs are often helpful. Please see this article for more information on HAR files/console logs and steps to generate them. For any files you provide, please try to start capturing traffic from start to finish - that is, start capturing traffic before you attempt to reproduce the issue and continue to capture traffic until the issue has been reproduced.
  • Please consider trying to reproduce any issues you encounter in a separate browser or using a private/incognito browsing session or on a different device if one is available. Some issues are specific to individual browsers, operating systems, or may be caused by add-ons/programs specific to your computer, so taking this step can help rule things like that out.
  • Please try to reference specific users that the Support team can look at for any issues that occur, even if all users may be impacted.
  • Please include details on how this impacts your daily workflow. Whether the issue is intermittent or happening all the time. Is this preventing you from completing a task. If so, is there a deadline you need to complete this by?
  • For access related issues please review the Admin FAQ. If you are unsure who your admin is, support can look up your admin who can provide you with the appropriate access.

Specific to Marketing:

  • For Calendar posts or Ads provide
    • Message ID. To locate the message ID click on the post to open the side pane then click on the basics tab under Khoros ID copy the message:xxxxxxx.
    • The name of the initiative the post/ad is in
    • If the post includes media provide the original image/video file
  • For Inbox items provide
    • A screenshot of the item
    • The name of the stream/collection or topic queue the item is in
    • The name of the initiative the item is in
  • For Analytics provide
    • A full page screenshot of the dashboard. Include the date ranges and any filters that are applied.
    • Attach data exports
  • For Mobile provide
    • The name of the app,
    • Device information (Android or iOS)
    • Which OS version you are on
    • Mobile app version. If you are not on the latest version of the app you may need to delete and re-download the app.
  • For API provide
    • Curl. This should include the token and the request/body being made.
    • Text or screenshot of errors returned

Specific to Intelligence:

  • Provide a direct link to the search/topic or a full page screenshot that includes the search name.

Specific to Experiences:

  • Provide a direct link to the stream, visualization or space in the platform.

Back to top

As mentioned earlier, we may still need to ask for additional information depending on the nature of the case. However, by providing any of the above information when you can, we can hopefully move your case towards a satisfactory resolution quickly!

We hope you have found the above information useful and we appreciate you sticking with us until the end of this article! As always, please don't hesitate to reach out and let us know if you have any questions or concerns!

Sincerely,

The Khoros Support Team

Labels (1)
Version history
Last update:
‎08-12-2021 10:54 AM
Updated by:
Contributors