OCM_2

Access can be enabled for the steps/tabs in the Role Based Access Management module for a particular role in the Other Applications tab.

Note: If access to a step/tab is disabled, the step is non-editable or read-only.

If all the steps have ‘Included’ as false in the Access Configuration, then the steps are removed from the User onboarding solution.

Access must be enabled for the Personal Info step for the create operation to be successful.

If access is disabled for the Personal Info step, then record creation is not possible.

Add the below keys to AccessConfiguration's OtherApplications->ChannelData section.

To remove/hide any steps, set the "Included" value to false.

The IsRoleBasedStepAccessEnabled key defined in User Onboarding Json will enable this feature for the entire solution.

If the value of IsRoleBasedStepAccessEnabled is false, step/tab access is not validated.

Issue Cause:

As recommended by Burpsuite security scan, we initially validate the file extension. Since file extensions can be easily altered, and it may not effectively block potentially harmful files.

To overcome this, we also validate uploaded files by checking their file extension signature to see if it matches the signature of an executable file (MZ). But csv or txt file doesn't have extension signature, hence we are using the content of the file to validate it.

If an uploaded CSV file begins with the characters 'M' or 'Z' in its first two characters, the validation identifies it as an executable file, leading to the rejection of the file.

Issue Resolution:

1. Upload CSV files in UTF-8 format, as they have a different file extension signature and won't be identified as an executable file.

2. Ensure that CSV files uploaded have their first two characters different from 'M' and 'Z' to avoid false rejection.

Issue description:

The Export Scheduler Service fails to start when the IsSecure key is set to true, and an exception of type "Internal.Cryptography.CryptoThrowHelper+WindowsCryptographicException" is encountered.

Troubleshooting steps:

To troubleshoot this issue, you can follow these steps:

1. Check Configuration: Ensure that the certificate path and password that are configured are in the correct fields in the configuration file. Specifically, make sure to set the Certificate Path and Certificate Password in the following configuration keys:

2. Certificate Issues:

• Certificate Issuer: Ensure that the certificate you are using is issued to the domain of the server where the service is running.
• Certificate Existence: Check that the certificate file (.pfx) exists at the specified "CertificatePath" location. Ensure that the path is accurate and accessible by the service.
• Certificate Validity: Verify that the certificate file is valid and has not expired.
• Certificate Password: Double-check that the password provided in the "CertificatePassword" configuration key matches the actual password used to protect the certificate. Ensure there are no leading or trailing spaces or typos in the password.

You may get further help from the OCMExportScheduler_DeploymentGuide section "Creating a certificate and enabling the HTTPS settings to use the certificate".

Issue Cause:

The Export Scheduler service cannot obtain the certificate if the Certificate Path and Certificate Password are set using the "tmc.conf.EXPORTSCHEDULERCertificatePassword" and "tmc.conf.EXPORTSCHEDULERCertificatePath" keys, which are the connector keys in the template.json file. These keys are used when there are multiple instances of the service and are meant for use in High Availability (HA) and shouldn't be used to configure the Primary Service certificate. This results in an "Internal.Cryptography.CryptoThrowHelper+WindowsCryptographicException" exception.

Issue Resolution:

It is essential to configure the Certificate Path and Certificate Password within the configuration file's appropriate keys. The secure binding of the certificate to the primary Export Scheduler service is made possible by these keys. So, it is necessary that the 'Certificate Path' and 'Certificate Password' are precisely specified in the following configuration keys:

For fax report hierarchy is implemented as below

• We need to link the Org Unit to Fax Line in the OCM's Fax Line Config module.
• Enable the ModuleHierachy key in the configuration.
• The user who is accessing the report should have one org. unit that is linked to an email account.

For campaign report hierarchy is implemented as below

• In TCamp while creating campaign we need to link the Org Unit List to the campaign
• Enable the ModuleHierachy key in the configuration.
• The user who is accessing the report should have one org. unit that is linked to an email account.

This implementation is available since OCM version 4.1.12.30

For email report hierarchy is implemented as below

• Since all emails will be tagged with the mail account name, we need to link the Org Unit List to the mail account in the OCM's Email Account Configuration module.
• Enable the ModuleHierachy key in the configuration.
• The user who is accessing the report should have one org. unit that is linked to an email account.

This implementation is available since OCM version 4.1.3.15

• Any number of TMAC Channels can be configured to an agent using Agent Setting Module. However, these channels are also Configurable.
• To display skill names in OCM we need to provide proper “Operator” & “OperatorValue” for the given channels.
• New Channels can be added in ~/OCM/Configurations/Admin Modules/AgentSettingChannelCount.json.

To add the new categories in Attribute module can be done using ~/OCM/Configurations/Admin Modules/AttributeCategories.json file as shown below.

• Module Hierarchy is used to filter records in OCM Admin pages based on set org. unit.
• Module Hierarchy can be enabled/ disabled in appsettings.json.

// ModuleHierachy is used to filter records in OCM Admin pages based on set org. unit(true/false)//

"ModuleHierachy": "false"

IVR Introductory Module without Module Hierarchy.

IVR Introductory Module with Module Hierarchy.

• To enable/ disable Maker Checker Functionality, just make the Key “MakerChecker” in JSON Configurations to true or false.
• The JSON Configuration of a module can be found in path ~/OCM/Configurations/Admin Modules/module_name.json.

• To enable/ disable Validate Checker Wav Files For Approval Functionality, just make the Key “ValidateCheckerWavFilesForApproval” in appsettings.json to true or false.

TUserSessionManager is a component to maintain logged in user session handles timeout and provide the same for any application for authentication purposes.

Step 1: Create the service using Command Prompt as Administrator with below command:

sc create service_name binPath=” full path of TUserSessionManager.exe”

Eg: sc create TetherfiUserSessionManager binPath=” D:\Tetherfi\Apps\ TUserSessionManager.exe”

Step 2: Do the below config file changes to include endpoints for the different user session manager servers in the connector section of appsettings.json file which is present in OCM:

Step 3: In order to enable UserSessionManager service set IsSessionManagerEnabled to “1” and LoginType to “custom” in appsettings.json file.

UserSessionManagerServerCount indicates number of user session manager server configured.

OCMTimeoutPopupTime indicates the number of seconds to display OCM Timeout popup.

Find TetherfiUserSessionManager Service Deployment guide and Design Document in below SVN paths:

https://docs.tetherfi.com/documentation/tetherfi-user-session-manager-deployment-guide/

https://docs.tetherfi.com/documentation/tusersessionmanagerdesigndocument/

• Report Hierarchy is Report Filter Type that can be used to set report filter based on values team/teamsupervisor/na.

• Report Filter Type can be changed in appsettings.json.

      //Report Filter Type will be used to set report filter based on these values team/teamsupervisor/na

    "ReportFilterType": "na"

Issue Description:

The Custom Admin Modules and Reports doesn't load and give 404 -ERROR OCCURED! Page not found error in the UI.

Issue Cause:

If the "IsCustomEnabled" key is disabled in appsettings.json and the Custom DLLs are missed in the Deployed path then the Custom Admin Modules and Reports doesn't load.

Issue Resolution:

1. To enable/ disable Custom Admin Modules and Reports, enable the Key “IsCustomEnabled” in appsettings.json to 1 (enabled)

2. Add all the Custom Release to the deployed path.

1.  To enable/ disable Custom Admin Modules and Reports, enable the Key “IsCustomEnabled” in appsettings.json to 1 (enabled) or 0 (disabled).

2. Add all the Custom Release to the deployed path.

3. If “IsCustomEnabled” is not enabled and Custom DLL’s are not present then the user interface displays a 404 error for the loaded Custom Module or Report.

To enable or disable the Upload Calling List button in Slot Scheduler enable the key in
~/OCM/Configurations/Admin Modules/SlotScheduler.json file as shown below.

Configure new external dashboard with other OCM dashboard’s can be done using AccessConfiguration.json under Dashboards section in ChannelData .

• Channel data includes Name, FunctionalityName, Channel, Icon, and Included. For External Dashboard we need to add EmbededExtDashboard , Url, and QueryParam.
• EmbededExtDashboard is set to true if the dashboard will load externally from an url.
• QueryParam will have ParamName, ParamValue, QueryStringEncryption, and UrlEncode.
• Query string can be sent to the iframe url and encoding / encrypting can be done.
• Make sure that the URL provided for external dashboard should be from same origin and secure http connection otherwise browser will not display the web view.

For example, OCM is hosted in https://dice.tetherfi/OCM then the Url should be https://dice.tetherfi/EXTERNAL_DASHBOARD.

Configuration of external application load inside OCM can be done using AccessConfiguration.json.

• Channel data includes Name, FunctionalityName, Channel, Icon, and Included. For External Application Load we need to add Url, LoadFromIframe and QueryParam.
• QueryParam will have ParamName, ParamValue, QueryStringEncryption, and UrlEncode.
• If LoadFromIframe is true inside channel data config, then normal flow of OCM is changed. Instead of rendering the OCM View, it will be redirected to the IframeController and iframe src is loaded inside the IframeView.cshtml. If LoadFromIframe is false, page will be redirected to the specific url.
• Query string can be sent from iframe controller and encoding / encrypting can be done.
• All existing flow will remain; these changes will work only if the config is enabled.
• Make sure that the URL provided for external app load should be from same origin and secure http connection otherwise browser will not display the web view.

For example, OCM is hosted in https://dice.tetherfi/OCM then the Url should be https://dice.tetherfi/EXTERNAL_APP.

To Hide/Display Add Profile Org.Unit to Roles button in Role Based Access Management one can do so using ~OCM\Configurations\Admin Modules\RoleManagement.json file as shown below.

Change the below settings in  ~/OCM/Configurations /AccessConfiguration.json file as shown below in order to Display/Hide the tabs from Role Based Access Management.

To add a new level of hierarchy in the Organizational Structure, use the ~/OCM/Configurations/Admin Modules/AgentHierarchy.json file, as illustrated below.

To enable or disable import features button in Agent settings module it can be done using
~/OCM/Configurations/Admin Modules/AgentSetting.json file as shown below.

IW Interpreter configuration can be done based on channels using ~/OCM/Configurations/Interpreter/InterpreterConfig.json file as shown below.

• Report Hierarchy is Report Filter Type that can be used to set report filter based on values team/teamsupervisor/na.

• Report Filter Type can be changed in appsettings.json.

  //Report Filter Type will be used to set report filter based on these values team/teamsupervisor/na //

  "ReportFilterType": "na"

OCM has exposed some API endpoints which can be used by external applications. To access secure OCM Web API consumer should have api-key which can be generated using client key (site key).

All the client key configured in apiclientkeyregistry.json

To enable Swagger in appsettings.json check true for EnableSwagger

SaveAction can be configured in ~OCM\Configurations\Admin Modules\ IvrCallBackAnnouncement.json as shown below.

SaveAction can be configured in ~OCM\Configurations\Admin Modules\ IvrIntroductoryMessageAnnouncement.json as shown below.

SaveAction can be configured in ~OCM\Configurations\Admin Modules\ IvrPhraseConfiguration.json as shown below.

SaveAction can be configured in ~OCM\Configurations\Admin Modules\ IvrBranchManagement.json as shown below.

SaveAction can be configured in ~OCM\Configurations\Admin Modules\IvrHostValueMapping.json as shown below.

To add the new feature in TMC Access Management can be done using ~/OCM/Configurations/Admin Modules/TMCAccessManagement.json file as shown below.

To add the default values for theme, screen, widget and to enable or disable the tabs in Template module can be done using ~/OCM/Configurations/Admin Modules/AgentTemplateDefaultValue.json file as shown below.

To get the features in Template Feature tab, go to ~/OCM/Configurations/Admin Modules/AgentSettingChannelCount.json file and add “FeatureType” : 1 in “AgentFeature” property as shown in the below screenshot.

To add or remove the Entity Name from the Self Service config can be done using ~/OCM/Configurations/Admin Modules/IVRConfigValues.json as shown below.

To hide the EntityName from the DropDown, we need to remove the block of that EntityName from the Json file. For example if we don’t need Skill EntityName in the module then we need to remove below mentioned block from the json file.

To add or remove the Action from Profanity Words can be done using ~/OCM/Configurations/Admin Modules/OpaqueData.json file as shown below.

• To deploy User Activation webpage, refer User enrollment and self-onboarding Deploying steps.
• Activation link sent to user through email using EMM or SMTP. In case of EMM, the mailbox id from which email is sent to user should be configured in Email Account Config module as shown below.

• Template for Activation mail should be added to email template module with “SelfOnboadEmailTemplate” as template name.

To send activation link to the user, below configuration keys need to be added in appsettings.json file.

• Using User onboarding module, supervisor can enroll the users. For more details refer this

         https://tetherfi-pte-ltd.atlassian.net/l/c/nVp6W8iD

• To know more about OCM API.

• OCM Admin Modules are configurable. The fields in the module can be changed or hidden.
• The fields can be hidden by making “Hidden” key as true in Admin Modules Configuration.
• The Admin Module configuration is ~/OCM/Configurations/Admin Modules/Module_name.json.

• All the admin modules / Reports / Dashboards are categorized into different channels in OCM.
• These channels are configurable in ~/OCM/Configurations/AccessConfiguration.json.