How can I customize remediation pages for a group?

This feature is available on MetaAccess console version 1.3.3+

MetaAccess now empowers administrators to fully customize the remediation page with the organization's own brand, text can be set for each device group individually. This powerful feature further enhances the end user experience for meeting the strong demands of localization.

What can I customize on remediation pages?

MetaAccess now empowers administrators to fully customize the remediation page with the organization's own brand, text, and color can be set for each device group individually. This powerful feature further enhances the end user experience for meeting the strong demands of localization.

The below screenshot and table show you how to customize color, text, and logo for each section on the remediation page

images/download/attachments/35730614/image2019-3-2_11-24-14.png

images/download/attachments/35730614/image2019-3-21_15-24-17.png

Table 1: instructions to customize text, logo, and color for the remediation page

Section

Description

File

What parameters do I need to update in the rebranding package?

Text/Logo

Color

1

Logo

logo.png

Replace the logo.png file in the rebranding package with your organization logo

 

2

Title

content.json

texts.<remediation_code>.title

For example: texts.com_100.title

See the detailed explanation for each remediation code in the Table 2

colors.r_issued_title: color of the title when a device has issues based on a configured policy

colors.r_good.title : color of the title when a device has no issues based on a configured policy

3

Sub-title

content.json

texts.<remediation_code>.sub_title

For example: texts.com_100.sub_title

See the detailed explanation for each remediation code in the Table 2

 

4

Device information

content.json

texts.device_info

 

5

Description

content.json

texts.<remediation_code>.detail

For example: texts.av.detail

See the detailed explanation for each remediation code in the Table 2

 

6

Total issues found

content.json

texts.issues_found_text

colors.r_summary

7

Issue summary

content.json

texts.<issue_code>.summary

For example: texts.av-001.summary

See the detailed explanation for issue code in the Table 3

colors.r_summary

8

Text of "What went wrong?" section

content.json

texts.what_went_wrong

 

9

Issue details

content.json

texts.<issue_code>.what_wrong

For example: texts.av-001.what_wrong

See the detailed explanation for issue code in the Table 3

Detailed text for issues of categories is presented with the %health status% variable

  • Anti-malware issues: texts.anti-malware.av-xxx

  • Encryption issues: texts.encryption.ec-xxx

  • Patch management issues: texts.patch-management.vl-xx

  • User Authentication: texts.user-authentication.ua-xxx

 

10

Text of "Why does it matter?" section

content.json

texts.why_does_it_matter

 

11

Issue explanation

content.json

texts.<issue_code>.why_it_matter

For example: texts.av-001.why_it_matter

See the detailed explanation for issue code in the Table 3

 

12

Text of "How do I fix this?" section

content.json

texts.how_do_i_fix

 

13

Instructions to fix an issue

content.json

texts.<issue_code>.remediation

For example: texts.av-001.remediation

See the detailed explanation for issue code in the Table 3

 

14

Button

content.json

contact.active:

  • 1: show the button

  • 0: hide the button

contact.link : this can be an email or a webpage URL.

  • if this parameter is an email, when a user clicks on the button, an email will be sent to the configured email.

  • if this parameter is an URL, when a user clicks on the button, the system will open that URL to the user.

contact.text : text for the button

If the button's action is send an email. The system will show a notice to an end-user

  • Success: texts.contact-it.success

  • Server failed to send email: texts.contact-it.error

  • Couldn't contact server: texts.contact-it.netword-error

  • the device becomes compliant and has no issues when a user clicks the button: texts.contact-it.compliant-device

If the access control feature is enabled on your account:

Notification to a user when the user clicks the button:

  • In case, a user logs into an cloud application and get blocked, the application was deleted when the user clicks the button: texts.contact-it.deleted-application

  • In case, a user logs into an cloud application and get blocked, the device is allowed to access the application based on access rules when the user clicks the button: texts.contact-it.able-to-access-application-1

  • In case, a user logs into an cloud application and get blocked, the device is temporary allowed to access the application when the user clicks the button: texts.contact-it.able-to-access-application-1

A download button will be shown to allow a user to download an installer when a device is blocked because it has not installed OPSWAT agent. This button text will be configured as below:

  • texts.download_text

  • texts.for_windows_7

  • texts.for_mac

  • text.download_installer_for_others

colors.r_contact_bg

colors.r_contact_text

15

Page title

content.json

texts.page_title

 

16

Temporary Access

content.json

Only applicable if the access control feature is enabled

Temporary Access title: texts.temporary_access

Details: texts.bypass-application

 

images/s/en_GB/7201/e9483755159fbecaf5aef9b1eebd094ee4430d2f/_/images/icons/emoticons/warning.png Notes:

  • Don't alternate filenames in the default package

  • Don't alternate field names in the content.json file

  • content.json file must be saved in UTF-8 format

  • Don't delete variable, for example %app_name%, in json file

  • the zip file should contain both logo.png and content.json file in the root folder.

Table 2: Remediation code in content.json file

Remediation Code

Use Case

Notes

com_100

Only applicable if the access control feature is enabled

The remediation page is shown when a user accesses a specific application/service and gets blocked and the device has issues

 

com_101

Only applicable if the access control feature is enabled

The remediation page is shown when a user accesses a specific application/service and gets blocked and the device has no issues

This happens when an admin configures a sensitive threshhold to consider a device become compliant greater than 1.

com_200

Only applicable if the access control feature is enabled

The remediation page is shown from the agent's tray icon or the device details on the console

 

com_201

Only applicable if the access control feature is enabled

The remediation page is shown from the agent's tray icon or the device details on the console

 

com_202

Device has issues.

The remediation page is shown from the agent's tray icon or the device details on the console

 

com_203

Device has no issues.

The remediation page is shown from the agent's tray icon or the device details on the console

 

com_300

Only applicable if the access control feature is enabled

Device has no issues

Device is granted access temporary to applications.

The remediation page is shown to remind users how long they can temporary access to applications

 

com_301

Only applicable if the access control feature is enabled

Device has issues

Device is granted access temporary to applications.

The remediation page is shown to remind users how long they can temporary access to applications

 

Table 3: Device Issue Codes in content.json file

code

Case

CF-003

Only applicable if the access control feature is enabled

A user accesses to an application and get blocked because IdP certificate is expired or invalid

AG-001

Only applicable if the access control feature is enabled

A user accesses to an application and get blocked because the device has not installed the OPSWAT agent

AG-002

Device has not reported compliance data yet/has not been checked in last X hours

AG-003

The agent version installed on the device is less/greater than X

AG-004

Only applicable if the access control feature is enabled

A user accesses to an application and get blocked because the agent installed on the device is reporting to another account

AG-005

Only applicable if the access control feature is enabled

A user accesses to an application and get blocked because the OPSWAT agent is temporarily deleted on the cloud based on the Lost Device feature.

AV-001

No approved anti-malware products are installed

AV-002

Approved anti-malware products are installed but no products pass anti-malware policies.

Detailed issues are specified in texts.anti-malware

EC-001

No approved Encryption products are installed

EC-002

Approved encryption products are installed but no products pass encryption policies.

Detailed issues are specified in texts.encryption

UA-001

User Authentication

Detailed issues are specified in texts.user-authentication

IP-001

Threat Detection - Threats detected by MetaDefender

IR-001

Threat Detection - Repeated threats detected from local anti-malware software logs

IC-001

Infections - Suspicious IP Connections

AF-001

Anti-phishing issues

BK-001

No backup applications are installed

BK-002

Backup issues

FW-001

Firewall issues

PM-001

No patch management application installed

PM-002

Patch Management issues

Detailed issues are specified in texts.patch-management

OS-001

Operating system version running on the device is not approved.

OS-002

The device doesn't join a domain

OS-003

The device has not rebooted for a long time

HR-001

Hard Drive issues

PUA-001

Unwanted applications

SH-001

Only applicable for mobile devices

Device does not have screen lock and passcode

SH-002

Only applicable for mobile devices

The device is jailbroken.

SH-003

Only applicable for mobile devices

The device is rooted.

SH-004

Only applicable for mobile devices

Device's internal storage is not encrypted

Sh-005

Only applicable for mobile devices

Device is running an out-of-date operating system

GP-001

Only applicable if the access control feature is enabled

The device is blocked because the device belongs to a specific group

AP-001

Only applicable if the access control feature is enabled

The device is blocked because the device accesses to a specific application

DR-001

Only applicable if the access control feature is enabled

The device is blocked by a default access rule because the device doesn't meet any access rules

DR-002

Device is non-compliant because it doesn't meet any compliant rules in a policy

GC-001

a custom script returns failed

VE-01

Vulnerability score is greater than or equal to N

DR-003

Only applicable if the access control feature is enabled

The device is blocked because administrators don't allow specific operating system to access applications

How can I create a rebranding package for remediation pages?

To create a customized rebranding package for remediation pages for your account, you can follow below steps

1. Log into MetaAccess console

2. Prepare a customized rebranding package for remediation pages

3. Navigate to the Settings > Rebranding page

4. Click ADD NEW PACKAGE

images/download/attachments/35730614/image2019-3-2_10-45-54.png

5. Fill in package name, description if you wish and upload your customized package or select a default package in the language you desire. You can preview how a remediation page looks like with the current settings.

6. Click ADD button to create a new rebranding package and enter your PIN for confirmation.

How can I preview the remediation page with a rebranding package?

To preview remediation pages with a rebranding package, you can follow below steps

1. Log into MetaAccess console

2. Navigate to the Settings > Rebranding page

3. Select a rebranding package you would like to preview

4. Select a page you want to preview and click PREVIEW IN NEW TAB. A remediation page with a fake data will be shown in a new tab

images/download/attachments/35730614/image2019-3-23_9-24-34.png

How can I customize remediation pages for a group?

To apply a customized rebranding package to remediation pages for you, you can follow below steps

  1. Log into MetaAccess console

  2. Prepare a customized rebranding package for remediation pages

  3. Create a customized rebranding package on your account.

  4. Navigate to the Inventory > Groups page

  5. Select a group you desire to apply the customized rebranding package

  6. Select an existing rebranding package to assign to the group and enter your PIN to apply your changes.

images/download/attachments/35730614/image2019-3-2_10-41-37.png


This article was last updated on 2019-03-23
TT