Gaman



GamanGamanCVP DocumentationCopyright (C) 2019 Gaman SP z o.oPermission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".Document historyDatePersonVersion no.Description2019-01-31Gaman Team1.0First version of the document2019-08-07Gaman Team1.1Add Gaman CRC directory with Luhn algorithm implementationTable of Contents TOC \o "1-3" \h \z \u Table of Contents PAGEREF _Toc16065414 \h 2Propose PAGEREF _Toc16065415 \h 3Compatibility PAGEREF _Toc16065416 \h 3Package installation in CVP Call Studio PAGEREF _Toc16065417 \h 4Directory: Gaman CRC PAGEREF _Toc16065418 \h 7Luhn Calculate Check Digit PAGEREF _Toc16065419 \h 7Luhn Check - Mod 10 Algorithm PAGEREF _Toc16065420 \h 7Directory: Gaman Integer PAGEREF _Toc16065421 \h 9To Integer PAGEREF _Toc16065422 \h 9Directory: Gaman List PAGEREF _Toc16065423 \h 10Get Array List Entry PAGEREF _Toc16065424 \h 10Get Array List Length PAGEREF _Toc16065425 \h 10Directory: Gaman Text PAGEREF _Toc16065426 \h 12Get Length PAGEREF _Toc16065427 \h 12Is Empty ? PAGEREF _Toc16065428 \h 12Left PAGEREF _Toc16065429 \h 13Replace String PAGEREF _Toc16065430 \h 13Right PAGEREF _Toc16065431 \h 14Set Empty PAGEREF _Toc16065432 \h 15Substring PAGEREF _Toc16065433 \h 15To String PAGEREF _Toc16065434 \h 16Trim PAGEREF _Toc16065435 \h 17Additional information PAGEREF _Toc16065436 \h 18Contact information PAGEREF _Toc16065437 \h 18ProposeGamanCVP is a set of CVP custom blocks that may help to develop CVP Call Studio script. It contains functions that can help you deal with Integer, List and Text objects within CVP project.Document contains information about input and output parameters (element and session variables set under custom block). It also contains information about possible exit states and conditions when they are triggered. CompatibilityGamanCVP package was build with Java JDK 7 (1.7.0_80) and tested with CVP releases 11.0, 11.5 and 11.6 (default deployment, where Java version wasn’t change). If you use a different Java version, probably you will need to recompile library to supported version. Gaman Team – based on individual requests – can prepare package for you – please contact support@gaman-. Package installation in CVP Call StudioBefore GamanCVP Custom Elements will be available in CVP Call Studio they need to be installed and added to CVP Script Project. Please follow the steps to enable GamanCVP package in your project.IMPORTANTThe following procedure describes how to attach GamanCVP library to a project. If you want to us this package for multiple project you need to go through the procedure multiple times (for each project)Procedure:Chose one of the possible paths:If you create a new project from scratch, start the procedure from step 2.If you have an existing project, start the procedure from step 7. Before that get the path to CVP Project Directory to which the package will be attached. Run CVP Call Studio applicationIn the main menu select File > New > Call Studio Project. New window will be presented.On the first window fill the Project Name and select project files Location. Before moving to the next tab write down the Location path. It will be needed later. If you want to leave all the parameters in Default, click Finish. If additional configuration is needed, click Next button. From the Package installation perspective parameters visible in the next window are optional. Once done, click Finish.Default location for the test project “GamanTest” is: C:\Cisco\CallStudio\eclipse\workspace\GamanTest CVP Call Studio will create a new project. Ensure that the project is visible on the project list.Close CVP Call Studio.Using Windows Explorer Navigate to the project directory, in this example: C:\Cisco\CallStudio\eclipse\workspace\GamanTestForm the project directory, open \deploy\java\application\lib directory. Copy GamanCVP.jar file to this folder.Open CVP Call StudioOn the project list seek for the Project (GamanTest) and click on the Project Name.Navigate to Element’s tab and search for the Local Elements directory. Expand it. New Gaman directories should appearGamanCVP package is ready for usage. Directory: Gaman CRCLuhn Calculate Check DigitAvailable since version 1.1“Luhn Calculate Check Digit” is a Custom CVP Element that calculates value of the CRC digit based on the Luhn algorithm. Result is put into data element variables. Input value should be a string build only with digits.Example:If the input string is “37828224631000” the calculated CRC check digit will be “5”“Luhn Calculate Check Digit” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionNumber string (input)1.1String value that contains a number string for which CRC digit will be calculated.Element Variables Variable maneVersionDescriptioncheck digit1.1Value of the calculated CRC digit. The value will only available if the exit state is “done”.number with check digit1.1Value of the entered number suffixed with calculated CRC digit. The value will only available if the exit state is “done”.error1.1Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.Exit statesExit maneVersionDescriptiondone1.1Exit used when “Luhn Calculate Check Digit” operation was successfulerror1.1Exit used when “Luhn Calculate Check Digit” operation failed. In this state element variable “error” is populated with the exception message.Luhn Check - Mod 10 AlgorithmAvailable since version 1.1“Luhn Check - Mod 10 Algorithm” is a Custom CVP Element that validates the number string using Luhn mod 10 algorithm. Based on the validation result proper output is selected. Input value should be a string build only with digits.“Luhn Check - Mod 10 Algorithm” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionNumber string (input)1.1String value that contains a number string that will be checked using Luhn Mod 10 Algorithm.Element Variables Variable maneVersionDescriptionerror1.1Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.Exit statesExit maneVersionDescriptioncrc ok1.1Exit used when “Luhn Check – Mod 10 Algorithm” operation was successful, and the calculated value of CRC is valid.crc error1.1Exit used when “Luhn Check – Mod 10 Algorithm” operation was successful, and the calculated value of CRC is invalid.error1.1Exit used when “Luhn Check – Mod 10 Algorithm” operation failed. In this state element variable “error” is populated with the exception message.Directory: Gaman IntegerTo IntegerAvailable since version 1.0“To Integer” is a Custom CVP Element that converts string to its integer representation. In CVP Script numbers are in the format X.X – number can contain fractional part. Sometimes there is a need to use only integer part of the number. In those situations, “To Integer” element fills the gap. Example:If the input string is “2.0” the output of the element will be “2”“To Integer” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value that will be converted to integer.Output (output)1.0Session variable name that will store integer value of input variable.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “To Integer” conversion was successfulerror1.0Exit used when “To Integer” conversion failed. In this state element variable “error” is populated with the exception message.Directory: Gaman ListGet Array List EntryAvailable since version 1.0“Get Array List Entry” is a Custom CVP Element that pulls the indexed element from the ArrayList and puts it as a CVP session object. Entry can be a simple variable (String, Int) or a complex object. Java equivalent for this function is ArrayList.get(int index).Important:Gaman team recommends that “Get Array List Entry” element is used with conjunction to “Get Array List Length”. In the Call Studio script first check the length of the ArrayList using “Get Array List Length”. If the index is in the range of the length the request list element using “Get Array List Entry”. In other case provide alternate treatment to call.“Get Array List Entry” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionArray List Object (input)1.0Session variable name that stores ArrayList object.Index (input)1.0Integer value that is the index of the element that needs to be pulled from ArrayList.Array List Item (output)1.0Session variable name to store Array List Item in CVP session.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.Exit statesExit maneVersionDescriptiondata_ok1.0Exit used when “Get Array List Entry” was able to successfully get the ArrayList object form provided listdata_error1.0Exit used when “Get Array List Entry” encountered an error. In this state element variable “error” is populated with the exception message.Get Array List LengthAvailable since version 1.0“Get Array List Length” is a Custom CVP Element that gets the length of the ArrayList. Java equivalent for this function is ArrayList.size().“Get Array List Length” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionArray List Object (input)1.0Session variable name that stores ArrayList object.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.length1.0Length of the ArrayListExit statesExit maneVersionDescriptionok1.0Exit used when “Get Array List Length” was able to successfully determinate the length of the ArrayList objecterror1.0Exit used when “Get Array List Length” encountered an error. In this state element variable “error” is populated with the exception message.Directory: Gaman TextGet LengthAvailable since version 1.0“Left” is a Custom CVP Element that measures length of the provided string. This information can be used to perform other operations on the string.“Get Length” Custom Element extends Action Element.SettingsSetting maneVersionDescriptionString (input)1.0String value for which the length was requested.Element Variables Variable maneVersionDescriptionlength1.0Length of the string. If the string value is null, length will be set to 0.Exit statesN/AIs Empty ?Available since version 1.0“Is Empty ?” is a Custom CVP Element that is used to checked if the provided string value is empty or not.“Is Empty ?” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value that will be checked if it's empty.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.Exit statesExit maneVersionDescriptionempty1.0Exit used when “Is Empty ?” detects that the input string was empty or it was null.error1.0Exit used when “Is Empty ?” operation failed. In this state element variable “error” is populated with the exception message.not_empty1.0Exit used when “Is Empty ?” detects that the input string is not empty (contains characters).LeftAvailable since version 1.0“Left” is a Custom CVP Element that is used to cut n-left characters from source string. Function requires one parameter to work: number of left n characters.Example:If the input string is (without quotes): “Gaman Test 1234” the output of the left operation with parameters: left=3 would be “Gam”with parameters: left=6 would be “Gaman ”“Left” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value for which the left n-character will be taken.Left n-characters (input)1.0Integer value of the left n-characters to substring.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.output1.0Text generated after collecting left n-characters taken from source string. Value populated only when the “done” exit state is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “Left” operation was successfulerror1.0Exit used when “Left” operation failed. In this state element variable “error” is populated with the exception message.Replace StringAvailable since version 1.0“Replace String” is a Custom CVP Element that is used to replace part of the string in source string. Java equivalent for this function is replace(). Function requires to parameters to work: search string and replacement string.Example:If the input string is (without quotes): “Gaman Test 1234” the output of the replace operation with parameters: search string=”ama”, replacement string=”11” would be “Ga11n Test 1234”.with parameters: search string=”Test”, replacement string=”” would be “Gaman 1234”“Replace String” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value for which the replacement will take place.Search String (input)1.0Search string value, a text that will be replace by replacement string.Replace String (input)1.0Replacement string value, a substitution text that will replace the search string.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.output1.0Text generated after replacement operation, performed on the string passed as a setting parameter. Value populated only when the “done” exit state is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “Replace” operation was successfulerror1.0Exit used when “Replace” operation failed. In this state element variable “error” is populated with the exception message.RightAvailable since version 1.0“Right” is a Custom CVP Element that is used to cut n-right characters from source string. Function requires one parameter to work: number of right n characters.Example:If the input string is (without quotes): “Gaman Test 1234” the output of the right operation with parameters: right=3 would be “234”with parameters: right=6 would be “t 1234”“Right” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value for which the right n-character will be taken.Right n-characters (input)1.0Integer value of the right n-characters to substring.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.output1.0Text generated after collecting right n-characters taken from source string. Value populated only when the “done” exit state is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “Right” operation was successfulerror1.0Exit used when “Right” operation failed. In this state element variable “error” is populated with the exception message.Set EmptyAvailable since version 1.0“Set Empty” is a Custom CVP Element that sets empty value to CVP session variable. In general, CVP Call Studio doesn’t allow to set the ““ value.“Set Empty” Custom Element extends Action Element.SettingsSetting maneVersionDescriptionSession Variable Name (input)1.0Session variable name for which the empty value will be set.Element Variables N/AExit statesN/ASubstringAvailable since version 1.0“Substring” is a Custom CVP Element that is used to cut part of the string from source string. Java equivalent for this function is substring(). Function requires to parameters to work: beginning index and the length of the string.Example:If the input string is (without quotes): “Gaman Test 1234” the output of the substring operation with parameters: begin index=0, length=3 would be “Gam”.with parameters: begin index=3, length=4 would be “an T” “Substring” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionString (input)1.0String value for which the substring will take place.Begin Index (input)1.0Integer value that indicates the start position of the substring.Length (input)1.0Integer value that indicates the length (in characters) of the substring.Element Variables Variable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.output1.0Part of the text returned by substring operation performed on the string passed as a setting parameter. Value populated only when the “done” exit state is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “Substring” operation was successfulerror1.0Exit used when “Substring” operation failed. In this state element variable “error” is populated with the exception message.To StringAvailable since version 1.0“To String” is a Custom CVP Element that converts object to its string representation. Java equivalent for this function is toString().“To String” Custom Element extends Decision Element.SettingsSetting maneVersionDescriptionObject (input)1.0Session variable name that contains object which will be converted to stringElement VariablesVariable maneVersionDescriptionerror1.0Exception message captured during processing call content within a block. Value populated only when the “error” exit is triggered.output1.0String representation of the object passed as a setting parameter. Value populated only when the “done” exit state is triggered.Exit statesExit maneVersionDescriptiondone1.0Exit used when “To String” operation was successfulerror1.0Exit used when “To String” operation failed. In this state element variable “error” is populated with the exception message.TrimAvailable since version 1.0“Trim” is a Custom CVP Element that trims (removes spaces if front and at the end of string) string value for the session variable. Java equivalent for this function is trim.Example:If the input string is (without quotes): “ Gaman Test 1234 “ the output of the trim operation will be “Gaman Test 1234” – leading and trailing spaces will be removed.“Trim” Custom Element extends Action Element.SettingsSetting maneVersionDescriptionSession Variable Name (input)1.0Session variable name for which the trim operation will be performed. Element VariablesN/AExit statesN/AAdditional informationIf you have a CVP project and need assistance with CVP Call Studio feel free to contact us using one of the emails provided in the Contact Information section.We can help you with:Create Custom CVP Elements for your scripts including integration with external systems using custom made API’sBuild CVP scripts, using best Cisco practice and our experience gathered from past projectsTest prepared solutions, including preparation of UAT test scenariosDeploy scripts in the UC infrastructure Maintain the solution making small changes and adjustments based on the customer needs Gaman Team will be happy to assist and support you in any CVP related project.Contact informationIf the library was useful for you, or you have an idea how we can improve the library, or you found a bug you can reach us using one of the email addresses. Email addresses General, Sales mailbox (info@gaman-)Support mailbox (support@gaman-) ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download