404
+ +Page not found
+ + +'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Saviynt Community Connectors
+ + +
+
+
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/js/html5shiv.min.js b/docs/js/html5shiv.min.js
new file mode 100644
index 0000000..1a01c94
--- /dev/null
+++ b/docs/js/html5shiv.min.js
@@ -0,0 +1,4 @@
+/**
+* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
+*/
+!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ RingCentral Connector for Saviynt
+Preface
+This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and RingCentral.
+Audience
+This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with RingCentral.
+Introduction
+RingCentral is a cloud-based communications and collaboration platform that offers a wide range of services, including cloud phone systems, video conferencing, team messaging, and contact center solutions. It is designed to enable businesses of all sizes to communicate and collaborate effectively across various channels, helping to streamline workflows and enhance productivity.
+RingCentral aims to be an all-in-one communication and collaboration platform, helping businesses move away from traditional phone systems and on-premises hardware in favor of a more flexible, scalable, and cloud-based solution. It caters to various industries and organizations, from small businesses to large enterprises. However, keep in mind that specific features and offerings may evolve over time, so it's always best to visit their official website for the most up-to-date information.
+The RingCentral connector enables you to seamlessly integrate with RingCentral to manage user lifecycle .
+For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors.
+Note: This guide provides information about using the RingCentral REST connector using SCIM API for performing operations listed in the Supported Features.
+Supported Features
+The RingCentral integration supports the following features:
+| RingCentral Object | +EIC Object | +Full Import | +Incremental Import | +Lifecycle Management | +Access Management | +
|---|---|---|---|---|---|
| Users | +Accounts | +Yes | +No | +Support for creating, updating, enabling, disabling, and removing accounts | +Not applicable | +
Supported Software Versions
+| Software | +Version | +
|---|---|
| EIC | +Release v4.5 and later | +
Understanding the Integration between EIC and RingCentral
+You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration:
+-
+
- The Complete Service Management platform RingCentral combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. +
- Objects are imported as entitlement types into EIC. +
- Security System represents the connection between EIC and the target application.
-
+
- It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. +
- It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. +
+ - Endpoint is an instance of an application within the context of a security system.
-
+
- It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. +
- It is mandatory to create an endpoint after creating the security system. You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System. +
+ - Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the SCIM APIs. For more information about creating a connection, see Creating a Connection. +
- Job Scheduler is a software component that executes a job based on the configured schedule to perform import or provisioning operations from EIC. When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the configured connector. If you want to instantly provision requests for completing the tasks without running the provisioning job, you must enable Instant Provisioning at the security system level and the Instant Provisioning Tasks global configuration. For more information about the jobs used by the connectors in the RingCentral integration. +
Integration Architecture
+EIC uses a REST connection for integrating with RingCentral for importing data and for performing provisioning and deprovisioning tasks.
+The following diagram illustrates the integration architecture and communication with the target application.
+
Setting Up the Integration
+Prerequisites
+Perform the following steps to Generate & Setup token authentication
+-
+
- Log in to the RingCentral portal using administrator credentials. +
- click on the "Admin" menu located in the top, horizontal menu. +
- Select "API access tokens" towards the bottom of the left hand menu. +
- You should see a list of access tokens if any have been provisioned. Select the token, or click the "+" button to create a new one. +
- Finally, enter a label/description for your token, and select an Agent on which the token will act on behalf of. Make sure the token is "enabled" and click "Save." +
- You can revoke the tokens at any time from the RingCentral user interface. +
Creating a Connection
+Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection.
+Understanding the Configuration Parameters
+While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application, predefined correlation rules, and provisioning jobs and import jobs.
+Configuration Parameters for Account and Access Import
+The connector uses the following parameters for creating a connection and for importing account and access from the target application:
+Connection Parameters
+.....
+Importing Connection Package
+connection package helps you build the connection with pre-defined JSONs, this can be used if your tenant does not already have out of the box connection templates available. Here are the steps to import the RingCentral connection package.
+-
+
- Download the connection package. +
- Navigate to Admin → Transport → select Import Package. +
- Browse the downloaded package and Import. +
- Navigate to Admin → Connections → Select “RingCentral” Connection. +
- Edit the connection with your RingCentral tenant details. +
Creating a Security System
+The security system represents the connection between EIC and the target application. For more information on creating a security system, see Creating a Security System.
+Creating an Endpoint for the Security System
+Endpoint refers to the target application used to provision accounts and entitlements (access). For more information on creating an endpoint, see Creating Endpoints.
+Using the RingCentral Integration
+You can use the RingCentral integration for performing import and provisioning operations after configuring it to meet your requirements.
+Guidelines for Using the Integration
+You must apply the following guidelines for configuring import:
+-
+
- Run account import before running the access import. +
- Map all RingCentral attributes to EIC account attributes using ImportAccountEntJSON. +
You must apply the following guidelines for configuring provisioning:
+-
+
- Use Java ternary operators if you want to add conditions in the provisioning parameters. You can use Java operations to tweak any attributes by using if-else conditions, substrings, or operators in the JSON for provisioning. +
Configuring Import Operations
+-
+
- Full account import: When configuring the connection for the first time, first perform full import to import all existing accounts from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted accounts are also identified and marked as suspended from import service. +
- Full Access import: When configuring the connection for the first time, first perform full import to import all existing access from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted entitlements are also identified and marked as inactive. +
The import jobs are automatically created in EIC after you create a connection for the RingCentral integration. For more information about creating jobs, see Data Jobs.
+Importing Accounts and Accesses
+You must import accounts after the users are available in EIC.
+To import accounts:
+-
+
- Specify the connection and import parameters. For more information, see Account and Access import.
Note: Ensure that the connection type is selected as REST.
+ - Configure the Application Data Import (Single Threaded) job to import accounts and access. For more information, see Data Jobs. +
Configuring Provisioning and Deprovisioning
+Provisioning is automatically enabled when a connection is configured. For detailed information about performing provisioning tasks, see Access Request System.
+To provision objects to the target application:
+-
+
- pecify the connection and provisioning parameters. For more information, see Configuration Parameters for Provisioning.
Note: Ensure that the connection type is selected as REST.
+ - Configure the Provisioning job (WSRETRY). For more information, see Provisioning Jobs. +
When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the connector.
+Troubleshooting
+To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors.
+To troubleshoot common problems or obtain answers for frequently asked questions for REST connectors, see the REST Connector Guide.
+Note: Ensure that you record the token expiry duration during the initial token generation. The connection may fail, if the token is not refreshed.
+ +
+
+
+
+ « Previous
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/ringcentral/ringcentral.go b/docs/ringcentral/ringcentral.go
new file mode 100644
index 0000000..f825465
--- /dev/null
+++ b/docs/ringcentral/ringcentral.go
@@ -0,0 +1,97 @@
+package ringcentral
+
+import (
+ "net/http"
+
+ saviyntconnectors "github.com/grokify/saviynt-connectors"
+)
+
+func ObjectSummary() saviyntconnectors.ObjectSummary {
+ return saviyntconnectors.ObjectSummary{
+ Objects: saviyntconnectors.Objects{
+ Connection: []string{"RingCentral"},
+ },
+ Information: saviyntconnectors.ObjectSummaryInformation{
+ GUID: "eef8d967-386b-4834-b2a8-2eaa624302fb",
+ ExportedBy: "admin",
+ ExportedOn: "2023-07-26 07:08:44",
+ System: "scrum-exchange.saviyntcloud.com",
+ TransferOwners: "0",
+ TransferUsers: "0",
+ },
+ }
+}
+
+func Connection() saviyntconnectors.ConnectionMap {
+ ra := saviyntconnectors.RequestsAttribute{
+ Name: "CreateAccountJSON",
+ Requests: saviyntconnectors.Requests{
+ AccountIdPath: "call1.message.id",
+ ResponseColsToPropsMap: map[string]string{
+ "name": "call1.message.userName~#~char",
+ },
+ Calls: []saviyntconnectors.Call{
+ {
+ Name: "call1",
+ Connection: "acctAuth",
+ URL: "https://platform.devtest.ringcentral.com/scim/v2/Users",
+ HTTPMethod: http.MethodPost,
+ HTTPParams: "{\"active\":true,\"name\":{\"familyName\":\"${user.lastname}\",\"givenName\":\"${user.firstname}\"},\"emails\":[{\"type\":\"work\",\"value\":\"${user.email}\"}],\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"${user.username}\"}",
+ HTTPHeaders: map[string]string{
+ "authorization": "${access_token}",
+ "Accept": "application/json",
+ },
+ HTTPContentType: "application/json",
+ SuccessResponses: saviyntconnectors.Responses{
+ StatusCodes: []uint{200, 201},
+ },
+ },
+ },
+ },
+ }
+ ea, err := ra.ExtendedAttr()
+ if err != nil {
+ panic(err)
+ }
+
+ extAttrs := saviyntconnectors.ExternalAttrs{
+ {
+ AttributeName: "ConnectionJSON",
+ EncryptedAttributeValue: "F094T0v6WHOpHcSzOqzN/G0EOXMVamwB8u2E9ttQNJNH/uqcgtvsw9t4/JqDJeCqQsdihkRCJpZn9bLHAwEt1khfhJ57qiyRImlt7xYaAw8R3gKwlb5P5Pls/NpXrJCJEOIIKBqZmra7c/8I5jIPpwDMQA72hCb7+NjiIMbsrgAdpeFAoP6/433ACaPmQ86SoWaZO2mA0+TKvsTYHtVp6K9yHo/Z1fKuWU+vJl7Lxa32+Kz/u5eUMFbVq8zOMQr90/02BPk1s1lKjq1MxsJ7FL18zFq3rzaC2M0icHhhGcz804Dz7klQFnwn58kFix0ThAV8SuLnAi8W4nCINNWsbdbnJomLGY2IQzoogWU7i8lvx1a5VS38MNppSyGQaXnHgO7sdnGs7JHDenJ1Hh25Dz8C1uMfEs7aonK83W+hdAQIi2usFnc5i5z1+9pmhbhkkfQAIuEECtSBCuDyIiOVkpthljbmF+IiIIyYgfSfnv91wCLSwL6NUH/kqcuI870Rwc/WV6bFGGJT3NYaPlf1gvNAfLfBkfrV/eGDAnZX33jK9+vfJDTfYnOgjVztRS21Tr1w3FJNogJjZuRclkjk0ZjoUHZOu9cpoah88ByFN6idLJN51r4kSAMoz+RxnsdfHSuuZKsk3AJmpldcy4QLKV+JnLVy24OSJZC9t4tTfWdKhJUibFN0A3qHMM+o3xhehOeaKooW1q3+FdbZLieB4Q==",
+ },
+ ea,
+ {
+ AttributeName: "DisableAccountJSON",
+ EncryptedAttributeValue: "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://platform.devtest.ringcentral.com/scim/v2/Users/${account.accountID}\",\r\n \"httpMethod\": \"PATCH\",\r\n \"httpParams\": \"{\\\"schemas\\\":[\\\"urn:ietf:params:scim:api:messages:2.0:PatchOp\\\"],\\\"Operations\\\":[{\\\"op\\\":\\\"replace\\\",\\\"path\\\":\\\"active\\\",\\\"value\\\":\\\"false\\\"}]}\",\r\n \"httpHeaders\": {\r\n \"authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201\r\n ]\r\n }\r\n }\r\n ]\r\n}",
+ },
+ {
+ AttributeName: "EnableAccountJSON",
+ EncryptedAttributeValue: "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://platform.devtest.ringcentral.com/scim/v2/Users/${account.accountID}\",\r\n \"httpMethod\": \"PATCH\",\r\n \"httpParams\": \"{\\\"schemas\\\":[\\\"urn:ietf:params:scim:api:messages:2.0:PatchOp\\\"],\\\"Operations\\\":[{\\\"op\\\":\\\"replace\\\",\\\"path\\\":\\\"active\\\",\\\"value\\\":\\\"true\\\"}]}\",\r\n \"httpHeaders\": {\r\n \"authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201\r\n ]\r\n }\r\n }\r\n ]\r\n}",
+ },
+ {
+ AttributeName: "ImportAccountEntJSON",
+ EncryptedAttributeValue: "{\r\n \"accountParams\": {\r\n \"connection\": \"acctAuth\",\r\n \"processingType\": \"SequentialAndIterative\",\r\n \"statusAndThresholdConfig\": {\r\n \"statusColumn\": \"customproperty10\",\r\n \"active\": [\r\n \"true\"\r\n ],\r\n \"deleteLinks\": true,\r\n \"accountThresholdValue\": 1000,\r\n \"correlateInactiveAccounts\": false,\r\n \"inactivateAccountsNotInFile\": true,\r\n \"deleteAccEntForActiveAccounts\": true\r\n },\r\n \"call\": {\r\n \"call1\": {\r\n \"callOrder\": 0,\r\n \"stageNumber\": 0,\r\n \"http\": {\r\n \"url\": \"https://platform.devtest.ringcentral.com/scim/v2/Users?filter=&startIndex=1&count=3\",\r\n \"httpHeaders\": {\r\n \"authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"httpMethod\": \"GET\"\r\n },\r\n \"listField\": \"Resources\",\r\n \"keyField\": \"accountID\",\r\n \"colsToPropsMap\": {\r\n \"accountID\": \"id~#~char\",\r\n \"name\": \"userName~#~char\",\r\n \"displayName\": \"emails.value~#~char\",\r\n \"customproperty1\": \"name.familyName~#~char\",\r\n \"customproperty2\": \"name.givenName~#~char\",\r\n \"customproperty3\": \"meta.resourceType~#~char\",\r\n \"customproperty4\": \"meta.created~#~char\",\r\n \"customproperty5\": \"meta.lastModified~#~char\",\r\n \"customproperty6\": \"meta.location~#~char\",\r\n \"customproperty7\": \"schemas~#~char\",\r\n \"customproperty8\": \"emails.type~#~char\",\r\n \"customproperty9\": \"emails.value~#~char\",\r\n \"customproperty10\": \"active~#~char\",\r\n \"customproperty11\": \"addresses.streetAddress~#~char\",\r\n \"customproperty12\": \"addresses.locality~#~char\",\r\n \"customproperty13\": \"addresses.region~#~char\",\r\n \"customproperty14\": \"addresses.postalCode~#~char\",\r\n \"customproperty15\": \"addresses.country~#~char\",\r\n \"customproperty16\": \"addresses.type~#~char\",\r\n \"customproperty17\": \"phoneNumbers.value~#~char\",\r\n \"customproperty18\": \"phoneNumbers.type~#~char\"\r\n }\r\n }\r\n },\r\n \"page\": {\r\n \"pageSizeParam\": \"count\",\r\n \"pageSize\": 20,\r\n \"pageRecordCount\": \"itemsPerPage\",\r\n \"pageNumberParam\": \"page\",\r\n \"totalCountPath\": \"completeResponseMap.meta.totalResults\",\r\n \"firstPageNumber\": 1\r\n }\r\n }\r\n}",
+ },
+ {
+ AttributeName: "RemoveAccountJSON",
+ EncryptedAttributeValue: "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://platform.devtest.ringcentral.com/scim/v2/Users/${account.accountID}\",\r\n \"httpMethod\": \"DELETE\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201,\r\n 204\r\n ]\r\n }\r\n }\r\n ]\r\n}",
+ },
+ {
+ AttributeName: "UpdateAccountJSON",
+ EncryptedAttributeValue: "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://platform.devtest.ringcentral.com/scim/v2/Users/${account.accountID}\",\r\n \"httpMethod\": \"PUT\",\r\n \"httpParams\": \"{\\\"active\\\":true,\\\"name\\\":{\\\"familyName\\\":\\\"${user.lastname}\\\",\\\"givenName\\\":\\\"${user.firstname}\\\"},\\\"emails\\\":[{\\\"type\\\":\\\"work\\\",\\\"value\\\":\\\"${user.email}\\\"}],\\\"schemas\\\":[\\\"urn:ietf:params:scim:schemas:core:2.0:User\\\"],\\\"userName\\\":\\\"${user.username}\\\"}\",\r\n \"httpHeaders\": {\r\n \"authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201\r\n ]\r\n }\r\n }\r\n ]\r\n}",
+ },
+ }
+ return saviyntconnectors.ConnectionMap{
+ "RingCentral": saviyntconnectors.Connection{
+ ConnectionDescription: "RingCentral",
+ ConnectionName: "RingCentral",
+ Connectorms: false,
+ ExternalConnectionType: "REST",
+ Status: 1,
+ StatusForEnableDisable: 1,
+ TemplateMandatoryData: "DwitEostW3Z60d/A6Ua4sw==",
+ TemplateName: "Ringcentral",
+ ExternalAttrs: extAttrs.Inflate(),
+ },
+ }
+}
diff --git a/docs/ringcentral/saviynt-ringcentral-diagram.png b/docs/ringcentral/saviynt-ringcentral-diagram.png
new file mode 100644
index 0000000..5245c28
Binary files /dev/null and b/docs/ringcentral/saviynt-ringcentral-diagram.png differ
diff --git a/docs/search.html b/docs/search.html
new file mode 100644
index 0000000..3a07f38
--- /dev/null
+++ b/docs/search.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Search Results
+ + + +
+ Searching...
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/search/lunr.js b/docs/search/lunr.js
new file mode 100644
index 0000000..6aa370f
--- /dev/null
+++ b/docs/search/lunr.js
@@ -0,0 +1,3475 @@
+/**
+ * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
+ * Copyright (C) 2020 Oliver Nightingale
+ * @license MIT
+ */
+
+;(function(){
+
+/**
+ * A convenience function for configuring and constructing
+ * a new lunr Index.
+ *
+ * A lunr.Builder instance is created and the pipeline setup
+ * with a trimmer, stop word filter and stemmer.
+ *
+ * This builder object is yielded to the configuration function
+ * that is passed as a parameter, allowing the list of fields
+ * and other builder parameters to be customised.
+ *
+ * All documents _must_ be added within the passed config function.
+ *
+ * @example
+ * var idx = lunr(function () {
+ * this.field('title')
+ * this.field('body')
+ * this.ref('id')
+ *
+ * documents.forEach(function (doc) {
+ * this.add(doc)
+ * }, this)
+ * })
+ *
+ * @see {@link lunr.Builder}
+ * @see {@link lunr.Pipeline}
+ * @see {@link lunr.trimmer}
+ * @see {@link lunr.stopWordFilter}
+ * @see {@link lunr.stemmer}
+ * @namespace {function} lunr
+ */
+var lunr = function (config) {
+ var builder = new lunr.Builder
+
+ builder.pipeline.add(
+ lunr.trimmer,
+ lunr.stopWordFilter,
+ lunr.stemmer
+ )
+
+ builder.searchPipeline.add(
+ lunr.stemmer
+ )
+
+ config.call(builder, builder)
+ return builder.build()
+}
+
+lunr.version = "2.3.9"
+/*!
+ * lunr.utils
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A namespace containing utils for the rest of the lunr library
+ * @namespace lunr.utils
+ */
+lunr.utils = {}
+
+/**
+ * Print a warning message to the console.
+ *
+ * @param {String} message The message to be printed.
+ * @memberOf lunr.utils
+ * @function
+ */
+lunr.utils.warn = (function (global) {
+ /* eslint-disable no-console */
+ return function (message) {
+ if (global.console && console.warn) {
+ console.warn(message)
+ }
+ }
+ /* eslint-enable no-console */
+})(this)
+
+/**
+ * Convert an object to a string.
+ *
+ * In the case of `null` and `undefined` the function returns
+ * the empty string, in all other cases the result of calling
+ * `toString` on the passed object is returned.
+ *
+ * @param {Any} obj The object to convert to a string.
+ * @return {String} string representation of the passed object.
+ * @memberOf lunr.utils
+ */
+lunr.utils.asString = function (obj) {
+ if (obj === void 0 || obj === null) {
+ return ""
+ } else {
+ return obj.toString()
+ }
+}
+
+/**
+ * Clones an object.
+ *
+ * Will create a copy of an existing object such that any mutations
+ * on the copy cannot affect the original.
+ *
+ * Only shallow objects are supported, passing a nested object to this
+ * function will cause a TypeError.
+ *
+ * Objects with primitives, and arrays of primitives are supported.
+ *
+ * @param {Object} obj The object to clone.
+ * @return {Object} a clone of the passed object.
+ * @throws {TypeError} when a nested object is passed.
+ * @memberOf Utils
+ */
+lunr.utils.clone = function (obj) {
+ if (obj === null || obj === undefined) {
+ return obj
+ }
+
+ var clone = Object.create(null),
+ keys = Object.keys(obj)
+
+ for (var i = 0; i < keys.length; i++) {
+ var key = keys[i],
+ val = obj[key]
+
+ if (Array.isArray(val)) {
+ clone[key] = val.slice()
+ continue
+ }
+
+ if (typeof val === 'string' ||
+ typeof val === 'number' ||
+ typeof val === 'boolean') {
+ clone[key] = val
+ continue
+ }
+
+ throw new TypeError("clone is not deep and does not support nested objects")
+ }
+
+ return clone
+}
+lunr.FieldRef = function (docRef, fieldName, stringValue) {
+ this.docRef = docRef
+ this.fieldName = fieldName
+ this._stringValue = stringValue
+}
+
+lunr.FieldRef.joiner = "/"
+
+lunr.FieldRef.fromString = function (s) {
+ var n = s.indexOf(lunr.FieldRef.joiner)
+
+ if (n === -1) {
+ throw "malformed field ref string"
+ }
+
+ var fieldRef = s.slice(0, n),
+ docRef = s.slice(n + 1)
+
+ return new lunr.FieldRef (docRef, fieldRef, s)
+}
+
+lunr.FieldRef.prototype.toString = function () {
+ if (this._stringValue == undefined) {
+ this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef
+ }
+
+ return this._stringValue
+}
+/*!
+ * lunr.Set
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A lunr set.
+ *
+ * @constructor
+ */
+lunr.Set = function (elements) {
+ this.elements = Object.create(null)
+
+ if (elements) {
+ this.length = elements.length
+
+ for (var i = 0; i < this.length; i++) {
+ this.elements[elements[i]] = true
+ }
+ } else {
+ this.length = 0
+ }
+}
+
+/**
+ * A complete set that contains all elements.
+ *
+ * @static
+ * @readonly
+ * @type {lunr.Set}
+ */
+lunr.Set.complete = {
+ intersect: function (other) {
+ return other
+ },
+
+ union: function () {
+ return this
+ },
+
+ contains: function () {
+ return true
+ }
+}
+
+/**
+ * An empty set that contains no elements.
+ *
+ * @static
+ * @readonly
+ * @type {lunr.Set}
+ */
+lunr.Set.empty = {
+ intersect: function () {
+ return this
+ },
+
+ union: function (other) {
+ return other
+ },
+
+ contains: function () {
+ return false
+ }
+}
+
+/**
+ * Returns true if this set contains the specified object.
+ *
+ * @param {object} object - Object whose presence in this set is to be tested.
+ * @returns {boolean} - True if this set contains the specified object.
+ */
+lunr.Set.prototype.contains = function (object) {
+ return !!this.elements[object]
+}
+
+/**
+ * Returns a new set containing only the elements that are present in both
+ * this set and the specified set.
+ *
+ * @param {lunr.Set} other - set to intersect with this set.
+ * @returns {lunr.Set} a new set that is the intersection of this and the specified set.
+ */
+
+lunr.Set.prototype.intersect = function (other) {
+ var a, b, elements, intersection = []
+
+ if (other === lunr.Set.complete) {
+ return this
+ }
+
+ if (other === lunr.Set.empty) {
+ return other
+ }
+
+ if (this.length < other.length) {
+ a = this
+ b = other
+ } else {
+ a = other
+ b = this
+ }
+
+ elements = Object.keys(a.elements)
+
+ for (var i = 0; i < elements.length; i++) {
+ var element = elements[i]
+ if (element in b.elements) {
+ intersection.push(element)
+ }
+ }
+
+ return new lunr.Set (intersection)
+}
+
+/**
+ * Returns a new set combining the elements of this and the specified set.
+ *
+ * @param {lunr.Set} other - set to union with this set.
+ * @return {lunr.Set} a new set that is the union of this and the specified set.
+ */
+
+lunr.Set.prototype.union = function (other) {
+ if (other === lunr.Set.complete) {
+ return lunr.Set.complete
+ }
+
+ if (other === lunr.Set.empty) {
+ return this
+ }
+
+ return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))
+}
+/**
+ * A function to calculate the inverse document frequency for
+ * a posting. This is shared between the builder and the index
+ *
+ * @private
+ * @param {object} posting - The posting for a given term
+ * @param {number} documentCount - The total number of documents.
+ */
+lunr.idf = function (posting, documentCount) {
+ var documentsWithTerm = 0
+
+ for (var fieldName in posting) {
+ if (fieldName == '_index') continue // Ignore the term index, its not a field
+ documentsWithTerm += Object.keys(posting[fieldName]).length
+ }
+
+ var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)
+
+ return Math.log(1 + Math.abs(x))
+}
+
+/**
+ * A token wraps a string representation of a token
+ * as it is passed through the text processing pipeline.
+ *
+ * @constructor
+ * @param {string} [str=''] - The string token being wrapped.
+ * @param {object} [metadata={}] - Metadata associated with this token.
+ */
+lunr.Token = function (str, metadata) {
+ this.str = str || ""
+ this.metadata = metadata || {}
+}
+
+/**
+ * Returns the token string that is being wrapped by this object.
+ *
+ * @returns {string}
+ */
+lunr.Token.prototype.toString = function () {
+ return this.str
+}
+
+/**
+ * A token update function is used when updating or optionally
+ * when cloning a token.
+ *
+ * @callback lunr.Token~updateFunction
+ * @param {string} str - The string representation of the token.
+ * @param {Object} metadata - All metadata associated with this token.
+ */
+
+/**
+ * Applies the given function to the wrapped string token.
+ *
+ * @example
+ * token.update(function (str, metadata) {
+ * return str.toUpperCase()
+ * })
+ *
+ * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.
+ * @returns {lunr.Token}
+ */
+lunr.Token.prototype.update = function (fn) {
+ this.str = fn(this.str, this.metadata)
+ return this
+}
+
+/**
+ * Creates a clone of this token. Optionally a function can be
+ * applied to the cloned token.
+ *
+ * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.
+ * @returns {lunr.Token}
+ */
+lunr.Token.prototype.clone = function (fn) {
+ fn = fn || function (s) { return s }
+ return new lunr.Token (fn(this.str, this.metadata), this.metadata)
+}
+/*!
+ * lunr.tokenizer
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A function for splitting a string into tokens ready to be inserted into
+ * the search index. Uses `lunr.tokenizer.separator` to split strings, change
+ * the value of this property to change how strings are split into tokens.
+ *
+ * This tokenizer will convert its parameter to a string by calling `toString` and
+ * then will split this string on the character in `lunr.tokenizer.separator`.
+ * Arrays will have their elements converted to strings and wrapped in a lunr.Token.
+ *
+ * Optional metadata can be passed to the tokenizer, this metadata will be cloned and
+ * added as metadata to every token that is created from the object to be tokenized.
+ *
+ * @static
+ * @param {?(string|object|object[])} obj - The object to convert into tokens
+ * @param {?object} metadata - Optional metadata to associate with every token
+ * @returns {lunr.Token[]}
+ * @see {@link lunr.Pipeline}
+ */
+lunr.tokenizer = function (obj, metadata) {
+ if (obj == null || obj == undefined) {
+ return []
+ }
+
+ if (Array.isArray(obj)) {
+ return obj.map(function (t) {
+ return new lunr.Token(
+ lunr.utils.asString(t).toLowerCase(),
+ lunr.utils.clone(metadata)
+ )
+ })
+ }
+
+ var str = obj.toString().toLowerCase(),
+ len = str.length,
+ tokens = []
+
+ for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {
+ var char = str.charAt(sliceEnd),
+ sliceLength = sliceEnd - sliceStart
+
+ if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {
+
+ if (sliceLength > 0) {
+ var tokenMetadata = lunr.utils.clone(metadata) || {}
+ tokenMetadata["position"] = [sliceStart, sliceLength]
+ tokenMetadata["index"] = tokens.length
+
+ tokens.push(
+ new lunr.Token (
+ str.slice(sliceStart, sliceEnd),
+ tokenMetadata
+ )
+ )
+ }
+
+ sliceStart = sliceEnd + 1
+ }
+
+ }
+
+ return tokens
+}
+
+/**
+ * The separator used to split a string into tokens. Override this property to change the behaviour of
+ * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.
+ *
+ * @static
+ * @see lunr.tokenizer
+ */
+lunr.tokenizer.separator = /[\s\-]+/
+/*!
+ * lunr.Pipeline
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.Pipelines maintain an ordered list of functions to be applied to all
+ * tokens in documents entering the search index and queries being ran against
+ * the index.
+ *
+ * An instance of lunr.Index created with the lunr shortcut will contain a
+ * pipeline with a stop word filter and an English language stemmer. Extra
+ * functions can be added before or after either of these functions or these
+ * default functions can be removed.
+ *
+ * When run the pipeline will call each function in turn, passing a token, the
+ * index of that token in the original list of all tokens and finally a list of
+ * all the original tokens.
+ *
+ * The output of functions in the pipeline will be passed to the next function
+ * in the pipeline. To exclude a token from entering the index the function
+ * should return undefined, the rest of the pipeline will not be called with
+ * this token.
+ *
+ * For serialisation of pipelines to work, all functions used in an instance of
+ * a pipeline should be registered with lunr.Pipeline. Registered functions can
+ * then be loaded. If trying to load a serialised pipeline that uses functions
+ * that are not registered an error will be thrown.
+ *
+ * If not planning on serialising the pipeline then registering pipeline functions
+ * is not necessary.
+ *
+ * @constructor
+ */
+lunr.Pipeline = function () {
+ this._stack = []
+}
+
+lunr.Pipeline.registeredFunctions = Object.create(null)
+
+/**
+ * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token
+ * string as well as all known metadata. A pipeline function can mutate the token string
+ * or mutate (or add) metadata for a given token.
+ *
+ * A pipeline function can indicate that the passed token should be discarded by returning
+ * null, undefined or an empty string. This token will not be passed to any downstream pipeline
+ * functions and will not be added to the index.
+ *
+ * Multiple tokens can be returned by returning an array of tokens. Each token will be passed
+ * to any downstream pipeline functions and all will returned tokens will be added to the index.
+ *
+ * Any number of pipeline functions may be chained together using a lunr.Pipeline.
+ *
+ * @interface lunr.PipelineFunction
+ * @param {lunr.Token} token - A token from the document being processed.
+ * @param {number} i - The index of this token in the complete list of tokens for this document/field.
+ * @param {lunr.Token[]} tokens - All tokens for this document/field.
+ * @returns {(?lunr.Token|lunr.Token[])}
+ */
+
+/**
+ * Register a function with the pipeline.
+ *
+ * Functions that are used in the pipeline should be registered if the pipeline
+ * needs to be serialised, or a serialised pipeline needs to be loaded.
+ *
+ * Registering a function does not add it to a pipeline, functions must still be
+ * added to instances of the pipeline for them to be used when running a pipeline.
+ *
+ * @param {lunr.PipelineFunction} fn - The function to check for.
+ * @param {String} label - The label to register this function with
+ */
+lunr.Pipeline.registerFunction = function (fn, label) {
+ if (label in this.registeredFunctions) {
+ lunr.utils.warn('Overwriting existing registered function: ' + label)
+ }
+
+ fn.label = label
+ lunr.Pipeline.registeredFunctions[fn.label] = fn
+}
+
+/**
+ * Warns if the function is not registered as a Pipeline function.
+ *
+ * @param {lunr.PipelineFunction} fn - The function to check for.
+ * @private
+ */
+lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {
+ var isRegistered = fn.label && (fn.label in this.registeredFunctions)
+
+ if (!isRegistered) {
+ lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn)
+ }
+}
+
+/**
+ * Loads a previously serialised pipeline.
+ *
+ * All functions to be loaded must already be registered with lunr.Pipeline.
+ * If any function from the serialised data has not been registered then an
+ * error will be thrown.
+ *
+ * @param {Object} serialised - The serialised pipeline to load.
+ * @returns {lunr.Pipeline}
+ */
+lunr.Pipeline.load = function (serialised) {
+ var pipeline = new lunr.Pipeline
+
+ serialised.forEach(function (fnName) {
+ var fn = lunr.Pipeline.registeredFunctions[fnName]
+
+ if (fn) {
+ pipeline.add(fn)
+ } else {
+ throw new Error('Cannot load unregistered function: ' + fnName)
+ }
+ })
+
+ return pipeline
+}
+
+/**
+ * Adds new functions to the end of the pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.
+ */
+lunr.Pipeline.prototype.add = function () {
+ var fns = Array.prototype.slice.call(arguments)
+
+ fns.forEach(function (fn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(fn)
+ this._stack.push(fn)
+ }, this)
+}
+
+/**
+ * Adds a single function after a function that already exists in the
+ * pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.
+ * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.
+ */
+lunr.Pipeline.prototype.after = function (existingFn, newFn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(newFn)
+
+ var pos = this._stack.indexOf(existingFn)
+ if (pos == -1) {
+ throw new Error('Cannot find existingFn')
+ }
+
+ pos = pos + 1
+ this._stack.splice(pos, 0, newFn)
+}
+
+/**
+ * Adds a single function before a function that already exists in the
+ * pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.
+ * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.
+ */
+lunr.Pipeline.prototype.before = function (existingFn, newFn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(newFn)
+
+ var pos = this._stack.indexOf(existingFn)
+ if (pos == -1) {
+ throw new Error('Cannot find existingFn')
+ }
+
+ this._stack.splice(pos, 0, newFn)
+}
+
+/**
+ * Removes a function from the pipeline.
+ *
+ * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.
+ */
+lunr.Pipeline.prototype.remove = function (fn) {
+ var pos = this._stack.indexOf(fn)
+ if (pos == -1) {
+ return
+ }
+
+ this._stack.splice(pos, 1)
+}
+
+/**
+ * Runs the current list of functions that make up the pipeline against the
+ * passed tokens.
+ *
+ * @param {Array} tokens The tokens to run through the pipeline.
+ * @returns {Array}
+ */
+lunr.Pipeline.prototype.run = function (tokens) {
+ var stackLength = this._stack.length
+
+ for (var i = 0; i < stackLength; i++) {
+ var fn = this._stack[i]
+ var memo = []
+
+ for (var j = 0; j < tokens.length; j++) {
+ var result = fn(tokens[j], j, tokens)
+
+ if (result === null || result === void 0 || result === '') continue
+
+ if (Array.isArray(result)) {
+ for (var k = 0; k < result.length; k++) {
+ memo.push(result[k])
+ }
+ } else {
+ memo.push(result)
+ }
+ }
+
+ tokens = memo
+ }
+
+ return tokens
+}
+
+/**
+ * Convenience method for passing a string through a pipeline and getting
+ * strings out. This method takes care of wrapping the passed string in a
+ * token and mapping the resulting tokens back to strings.
+ *
+ * @param {string} str - The string to pass through the pipeline.
+ * @param {?object} metadata - Optional metadata to associate with the token
+ * passed to the pipeline.
+ * @returns {string[]}
+ */
+lunr.Pipeline.prototype.runString = function (str, metadata) {
+ var token = new lunr.Token (str, metadata)
+
+ return this.run([token]).map(function (t) {
+ return t.toString()
+ })
+}
+
+/**
+ * Resets the pipeline by removing any existing processors.
+ *
+ */
+lunr.Pipeline.prototype.reset = function () {
+ this._stack = []
+}
+
+/**
+ * Returns a representation of the pipeline ready for serialisation.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @returns {Array}
+ */
+lunr.Pipeline.prototype.toJSON = function () {
+ return this._stack.map(function (fn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(fn)
+
+ return fn.label
+ })
+}
+/*!
+ * lunr.Vector
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A vector is used to construct the vector space of documents and queries. These
+ * vectors support operations to determine the similarity between two documents or
+ * a document and a query.
+ *
+ * Normally no parameters are required for initializing a vector, but in the case of
+ * loading a previously dumped vector the raw elements can be provided to the constructor.
+ *
+ * For performance reasons vectors are implemented with a flat array, where an elements
+ * index is immediately followed by its value. E.g. [index, value, index, value]. This
+ * allows the underlying array to be as sparse as possible and still offer decent
+ * performance when being used for vector calculations.
+ *
+ * @constructor
+ * @param {Number[]} [elements] - The flat list of element index and element value pairs.
+ */
+lunr.Vector = function (elements) {
+ this._magnitude = 0
+ this.elements = elements || []
+}
+
+
+/**
+ * Calculates the position within the vector to insert a given index.
+ *
+ * This is used internally by insert and upsert. If there are duplicate indexes then
+ * the position is returned as if the value for that index were to be updated, but it
+ * is the callers responsibility to check whether there is a duplicate at that index
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.positionForIndex = function (index) {
+ // For an empty vector the tuple can be inserted at the beginning
+ if (this.elements.length == 0) {
+ return 0
+ }
+
+ var start = 0,
+ end = this.elements.length / 2,
+ sliceLength = end - start,
+ pivotPoint = Math.floor(sliceLength / 2),
+ pivotIndex = this.elements[pivotPoint * 2]
+
+ while (sliceLength > 1) {
+ if (pivotIndex < index) {
+ start = pivotPoint
+ }
+
+ if (pivotIndex > index) {
+ end = pivotPoint
+ }
+
+ if (pivotIndex == index) {
+ break
+ }
+
+ sliceLength = end - start
+ pivotPoint = start + Math.floor(sliceLength / 2)
+ pivotIndex = this.elements[pivotPoint * 2]
+ }
+
+ if (pivotIndex == index) {
+ return pivotPoint * 2
+ }
+
+ if (pivotIndex > index) {
+ return pivotPoint * 2
+ }
+
+ if (pivotIndex < index) {
+ return (pivotPoint + 1) * 2
+ }
+}
+
+/**
+ * Inserts an element at an index within the vector.
+ *
+ * Does not allow duplicates, will throw an error if there is already an entry
+ * for this index.
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @param {Number} val - The value to be inserted into the vector.
+ */
+lunr.Vector.prototype.insert = function (insertIdx, val) {
+ this.upsert(insertIdx, val, function () {
+ throw "duplicate index"
+ })
+}
+
+/**
+ * Inserts or updates an existing index within the vector.
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @param {Number} val - The value to be inserted into the vector.
+ * @param {function} fn - A function that is called for updates, the existing value and the
+ * requested value are passed as arguments
+ */
+lunr.Vector.prototype.upsert = function (insertIdx, val, fn) {
+ this._magnitude = 0
+ var position = this.positionForIndex(insertIdx)
+
+ if (this.elements[position] == insertIdx) {
+ this.elements[position + 1] = fn(this.elements[position + 1], val)
+ } else {
+ this.elements.splice(position, 0, insertIdx, val)
+ }
+}
+
+/**
+ * Calculates the magnitude of this vector.
+ *
+ * @returns {Number}
+ */
+lunr.Vector.prototype.magnitude = function () {
+ if (this._magnitude) return this._magnitude
+
+ var sumOfSquares = 0,
+ elementsLength = this.elements.length
+
+ for (var i = 1; i < elementsLength; i += 2) {
+ var val = this.elements[i]
+ sumOfSquares += val * val
+ }
+
+ return this._magnitude = Math.sqrt(sumOfSquares)
+}
+
+/**
+ * Calculates the dot product of this vector and another vector.
+ *
+ * @param {lunr.Vector} otherVector - The vector to compute the dot product with.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.dot = function (otherVector) {
+ var dotProduct = 0,
+ a = this.elements, b = otherVector.elements,
+ aLen = a.length, bLen = b.length,
+ aVal = 0, bVal = 0,
+ i = 0, j = 0
+
+ while (i < aLen && j < bLen) {
+ aVal = a[i], bVal = b[j]
+ if (aVal < bVal) {
+ i += 2
+ } else if (aVal > bVal) {
+ j += 2
+ } else if (aVal == bVal) {
+ dotProduct += a[i + 1] * b[j + 1]
+ i += 2
+ j += 2
+ }
+ }
+
+ return dotProduct
+}
+
+/**
+ * Calculates the similarity between this vector and another vector.
+ *
+ * @param {lunr.Vector} otherVector - The other vector to calculate the
+ * similarity with.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.similarity = function (otherVector) {
+ return this.dot(otherVector) / this.magnitude() || 0
+}
+
+/**
+ * Converts the vector to an array of the elements within the vector.
+ *
+ * @returns {Number[]}
+ */
+lunr.Vector.prototype.toArray = function () {
+ var output = new Array (this.elements.length / 2)
+
+ for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {
+ output[j] = this.elements[i]
+ }
+
+ return output
+}
+
+/**
+ * A JSON serializable representation of the vector.
+ *
+ * @returns {Number[]}
+ */
+lunr.Vector.prototype.toJSON = function () {
+ return this.elements
+}
+/* eslint-disable */
+/*!
+ * lunr.stemmer
+ * Copyright (C) 2020 Oliver Nightingale
+ * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
+ */
+
+/**
+ * lunr.stemmer is an english language stemmer, this is a JavaScript
+ * implementation of the PorterStemmer taken from http://tartarus.org/~martin
+ *
+ * @static
+ * @implements {lunr.PipelineFunction}
+ * @param {lunr.Token} token - The string to stem
+ * @returns {lunr.Token}
+ * @see {@link lunr.Pipeline}
+ * @function
+ */
+lunr.stemmer = (function(){
+ var step2list = {
+ "ational" : "ate",
+ "tional" : "tion",
+ "enci" : "ence",
+ "anci" : "ance",
+ "izer" : "ize",
+ "bli" : "ble",
+ "alli" : "al",
+ "entli" : "ent",
+ "eli" : "e",
+ "ousli" : "ous",
+ "ization" : "ize",
+ "ation" : "ate",
+ "ator" : "ate",
+ "alism" : "al",
+ "iveness" : "ive",
+ "fulness" : "ful",
+ "ousness" : "ous",
+ "aliti" : "al",
+ "iviti" : "ive",
+ "biliti" : "ble",
+ "logi" : "log"
+ },
+
+ step3list = {
+ "icate" : "ic",
+ "ative" : "",
+ "alize" : "al",
+ "iciti" : "ic",
+ "ical" : "ic",
+ "ful" : "",
+ "ness" : ""
+ },
+
+ c = "[^aeiou]", // consonant
+ v = "[aeiouy]", // vowel
+ C = c + "[^aeiouy]*", // consonant sequence
+ V = v + "[aeiou]*", // vowel sequence
+
+ mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0
+ meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1
+ mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1
+ s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ var re_mgr0 = new RegExp(mgr0);
+ var re_mgr1 = new RegExp(mgr1);
+ var re_meq1 = new RegExp(meq1);
+ var re_s_v = new RegExp(s_v);
+
+ var re_1a = /^(.+?)(ss|i)es$/;
+ var re2_1a = /^(.+?)([^s])s$/;
+ var re_1b = /^(.+?)eed$/;
+ var re2_1b = /^(.+?)(ed|ing)$/;
+ var re_1b_2 = /.$/;
+ var re2_1b_2 = /(at|bl|iz)$/;
+ var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$");
+ var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+
+ var re_1c = /^(.+?[^aeiou])y$/;
+ var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+
+ var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+
+ var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ var re2_4 = /^(.+?)(s|t)(ion)$/;
+
+ var re_5 = /^(.+?)e$/;
+ var re_5_1 = /ll$/;
+ var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+
+ var porterStemmer = function porterStemmer(w) {
+ var stem,
+ suffix,
+ firstch,
+ re,
+ re2,
+ re3,
+ re4;
+
+ if (w.length < 3) { return w; }
+
+ firstch = w.substr(0,1);
+ if (firstch == "y") {
+ w = firstch.toUpperCase() + w.substr(1);
+ }
+
+ // Step 1a
+ re = re_1a
+ re2 = re2_1a;
+
+ if (re.test(w)) { w = w.replace(re,"$1$2"); }
+ else if (re2.test(w)) { w = w.replace(re2,"$1$2"); }
+
+ // Step 1b
+ re = re_1b;
+ re2 = re2_1b;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = re_mgr0;
+ if (re.test(fp[1])) {
+ re = re_1b_2;
+ w = w.replace(re,"");
+ }
+ } else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = re_s_v;
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = re2_1b_2;
+ re3 = re3_1b_2;
+ re4 = re4_1b_2;
+ if (re2.test(w)) { w = w + "e"; }
+ else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); }
+ else if (re4.test(w)) { w = w + "e"; }
+ }
+ }
+
+ // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)
+ re = re_1c;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = re_2;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = re_mgr0;
+ if (re.test(stem)) {
+ w = stem + step2list[suffix];
+ }
+ }
+
+ // Step 3
+ re = re_3;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = re_mgr0;
+ if (re.test(stem)) {
+ w = stem + step3list[suffix];
+ }
+ }
+
+ // Step 4
+ re = re_4;
+ re2 = re2_4;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = re_mgr1;
+ if (re.test(stem)) {
+ w = stem;
+ }
+ } else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = re_mgr1;
+ if (re2.test(stem)) {
+ w = stem;
+ }
+ }
+
+ // Step 5
+ re = re_5;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = re_mgr1;
+ re2 = re_meq1;
+ re3 = re3_5;
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {
+ w = stem;
+ }
+ }
+
+ re = re_5_1;
+ re2 = re_mgr1;
+ if (re.test(w) && re2.test(w)) {
+ re = re_1b_2;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+
+ if (firstch == "y") {
+ w = firstch.toLowerCase() + w.substr(1);
+ }
+
+ return w;
+ };
+
+ return function (token) {
+ return token.update(porterStemmer);
+ }
+})();
+
+lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')
+/*!
+ * lunr.stopWordFilter
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.generateStopWordFilter builds a stopWordFilter function from the provided
+ * list of stop words.
+ *
+ * The built in lunr.stopWordFilter is built using this generator and can be used
+ * to generate custom stopWordFilters for applications or non English languages.
+ *
+ * @function
+ * @param {Array} token The token to pass through the filter
+ * @returns {lunr.PipelineFunction}
+ * @see lunr.Pipeline
+ * @see lunr.stopWordFilter
+ */
+lunr.generateStopWordFilter = function (stopWords) {
+ var words = stopWords.reduce(function (memo, stopWord) {
+ memo[stopWord] = stopWord
+ return memo
+ }, {})
+
+ return function (token) {
+ if (token && words[token.toString()] !== token.toString()) return token
+ }
+}
+
+/**
+ * lunr.stopWordFilter is an English language stop word list filter, any words
+ * contained in the list will not be passed through the filter.
+ *
+ * This is intended to be used in the Pipeline. If the token does not pass the
+ * filter then undefined will be returned.
+ *
+ * @function
+ * @implements {lunr.PipelineFunction}
+ * @params {lunr.Token} token - A token to check for being a stop word.
+ * @returns {lunr.Token}
+ * @see {@link lunr.Pipeline}
+ */
+lunr.stopWordFilter = lunr.generateStopWordFilter([
+ 'a',
+ 'able',
+ 'about',
+ 'across',
+ 'after',
+ 'all',
+ 'almost',
+ 'also',
+ 'am',
+ 'among',
+ 'an',
+ 'and',
+ 'any',
+ 'are',
+ 'as',
+ 'at',
+ 'be',
+ 'because',
+ 'been',
+ 'but',
+ 'by',
+ 'can',
+ 'cannot',
+ 'could',
+ 'dear',
+ 'did',
+ 'do',
+ 'does',
+ 'either',
+ 'else',
+ 'ever',
+ 'every',
+ 'for',
+ 'from',
+ 'get',
+ 'got',
+ 'had',
+ 'has',
+ 'have',
+ 'he',
+ 'her',
+ 'hers',
+ 'him',
+ 'his',
+ 'how',
+ 'however',
+ 'i',
+ 'if',
+ 'in',
+ 'into',
+ 'is',
+ 'it',
+ 'its',
+ 'just',
+ 'least',
+ 'let',
+ 'like',
+ 'likely',
+ 'may',
+ 'me',
+ 'might',
+ 'most',
+ 'must',
+ 'my',
+ 'neither',
+ 'no',
+ 'nor',
+ 'not',
+ 'of',
+ 'off',
+ 'often',
+ 'on',
+ 'only',
+ 'or',
+ 'other',
+ 'our',
+ 'own',
+ 'rather',
+ 'said',
+ 'say',
+ 'says',
+ 'she',
+ 'should',
+ 'since',
+ 'so',
+ 'some',
+ 'than',
+ 'that',
+ 'the',
+ 'their',
+ 'them',
+ 'then',
+ 'there',
+ 'these',
+ 'they',
+ 'this',
+ 'tis',
+ 'to',
+ 'too',
+ 'twas',
+ 'us',
+ 'wants',
+ 'was',
+ 'we',
+ 'were',
+ 'what',
+ 'when',
+ 'where',
+ 'which',
+ 'while',
+ 'who',
+ 'whom',
+ 'why',
+ 'will',
+ 'with',
+ 'would',
+ 'yet',
+ 'you',
+ 'your'
+])
+
+lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')
+/*!
+ * lunr.trimmer
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.trimmer is a pipeline function for trimming non word
+ * characters from the beginning and end of tokens before they
+ * enter the index.
+ *
+ * This implementation may not work correctly for non latin
+ * characters and should either be removed or adapted for use
+ * with languages with non-latin characters.
+ *
+ * @static
+ * @implements {lunr.PipelineFunction}
+ * @param {lunr.Token} token The token to pass through the filter
+ * @returns {lunr.Token}
+ * @see lunr.Pipeline
+ */
+lunr.trimmer = function (token) {
+ return token.update(function (s) {
+ return s.replace(/^\W+/, '').replace(/\W+$/, '')
+ })
+}
+
+lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')
+/*!
+ * lunr.TokenSet
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A token set is used to store the unique list of all tokens
+ * within an index. Token sets are also used to represent an
+ * incoming query to the index, this query token set and index
+ * token set are then intersected to find which tokens to look
+ * up in the inverted index.
+ *
+ * A token set can hold multiple tokens, as in the case of the
+ * index token set, or it can hold a single token as in the
+ * case of a simple query token set.
+ *
+ * Additionally token sets are used to perform wildcard matching.
+ * Leading, contained and trailing wildcards are supported, and
+ * from this edit distance matching can also be provided.
+ *
+ * Token sets are implemented as a minimal finite state automata,
+ * where both common prefixes and suffixes are shared between tokens.
+ * This helps to reduce the space used for storing the token set.
+ *
+ * @constructor
+ */
+lunr.TokenSet = function () {
+ this.final = false
+ this.edges = {}
+ this.id = lunr.TokenSet._nextId
+ lunr.TokenSet._nextId += 1
+}
+
+/**
+ * Keeps track of the next, auto increment, identifier to assign
+ * to a new tokenSet.
+ *
+ * TokenSets require a unique identifier to be correctly minimised.
+ *
+ * @private
+ */
+lunr.TokenSet._nextId = 1
+
+/**
+ * Creates a TokenSet instance from the given sorted array of words.
+ *
+ * @param {String[]} arr - A sorted array of strings to create the set from.
+ * @returns {lunr.TokenSet}
+ * @throws Will throw an error if the input array is not sorted.
+ */
+lunr.TokenSet.fromArray = function (arr) {
+ var builder = new lunr.TokenSet.Builder
+
+ for (var i = 0, len = arr.length; i < len; i++) {
+ builder.insert(arr[i])
+ }
+
+ builder.finish()
+ return builder.root
+}
+
+/**
+ * Creates a token set from a query clause.
+ *
+ * @private
+ * @param {Object} clause - A single clause from lunr.Query.
+ * @param {string} clause.term - The query clause term.
+ * @param {number} [clause.editDistance] - The optional edit distance for the term.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.fromClause = function (clause) {
+ if ('editDistance' in clause) {
+ return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)
+ } else {
+ return lunr.TokenSet.fromString(clause.term)
+ }
+}
+
+/**
+ * Creates a token set representing a single string with a specified
+ * edit distance.
+ *
+ * Insertions, deletions, substitutions and transpositions are each
+ * treated as an edit distance of 1.
+ *
+ * Increasing the allowed edit distance will have a dramatic impact
+ * on the performance of both creating and intersecting these TokenSets.
+ * It is advised to keep the edit distance less than 3.
+ *
+ * @param {string} str - The string to create the token set from.
+ * @param {number} editDistance - The allowed edit distance to match.
+ * @returns {lunr.Vector}
+ */
+lunr.TokenSet.fromFuzzyString = function (str, editDistance) {
+ var root = new lunr.TokenSet
+
+ var stack = [{
+ node: root,
+ editsRemaining: editDistance,
+ str: str
+ }]
+
+ while (stack.length) {
+ var frame = stack.pop()
+
+ // no edit
+ if (frame.str.length > 0) {
+ var char = frame.str.charAt(0),
+ noEditNode
+
+ if (char in frame.node.edges) {
+ noEditNode = frame.node.edges[char]
+ } else {
+ noEditNode = new lunr.TokenSet
+ frame.node.edges[char] = noEditNode
+ }
+
+ if (frame.str.length == 1) {
+ noEditNode.final = true
+ }
+
+ stack.push({
+ node: noEditNode,
+ editsRemaining: frame.editsRemaining,
+ str: frame.str.slice(1)
+ })
+ }
+
+ if (frame.editsRemaining == 0) {
+ continue
+ }
+
+ // insertion
+ if ("*" in frame.node.edges) {
+ var insertionNode = frame.node.edges["*"]
+ } else {
+ var insertionNode = new lunr.TokenSet
+ frame.node.edges["*"] = insertionNode
+ }
+
+ if (frame.str.length == 0) {
+ insertionNode.final = true
+ }
+
+ stack.push({
+ node: insertionNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str
+ })
+
+ // deletion
+ // can only do a deletion if we have enough edits remaining
+ // and if there are characters left to delete in the string
+ if (frame.str.length > 1) {
+ stack.push({
+ node: frame.node,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str.slice(1)
+ })
+ }
+
+ // deletion
+ // just removing the last character from the str
+ if (frame.str.length == 1) {
+ frame.node.final = true
+ }
+
+ // substitution
+ // can only do a substitution if we have enough edits remaining
+ // and if there are characters left to substitute
+ if (frame.str.length >= 1) {
+ if ("*" in frame.node.edges) {
+ var substitutionNode = frame.node.edges["*"]
+ } else {
+ var substitutionNode = new lunr.TokenSet
+ frame.node.edges["*"] = substitutionNode
+ }
+
+ if (frame.str.length == 1) {
+ substitutionNode.final = true
+ }
+
+ stack.push({
+ node: substitutionNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str.slice(1)
+ })
+ }
+
+ // transposition
+ // can only do a transposition if there are edits remaining
+ // and there are enough characters to transpose
+ if (frame.str.length > 1) {
+ var charA = frame.str.charAt(0),
+ charB = frame.str.charAt(1),
+ transposeNode
+
+ if (charB in frame.node.edges) {
+ transposeNode = frame.node.edges[charB]
+ } else {
+ transposeNode = new lunr.TokenSet
+ frame.node.edges[charB] = transposeNode
+ }
+
+ if (frame.str.length == 1) {
+ transposeNode.final = true
+ }
+
+ stack.push({
+ node: transposeNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: charA + frame.str.slice(2)
+ })
+ }
+ }
+
+ return root
+}
+
+/**
+ * Creates a TokenSet from a string.
+ *
+ * The string may contain one or more wildcard characters (*)
+ * that will allow wildcard matching when intersecting with
+ * another TokenSet.
+ *
+ * @param {string} str - The string to create a TokenSet from.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.fromString = function (str) {
+ var node = new lunr.TokenSet,
+ root = node
+
+ /*
+ * Iterates through all characters within the passed string
+ * appending a node for each character.
+ *
+ * When a wildcard character is found then a self
+ * referencing edge is introduced to continually match
+ * any number of any characters.
+ */
+ for (var i = 0, len = str.length; i < len; i++) {
+ var char = str[i],
+ final = (i == len - 1)
+
+ if (char == "*") {
+ node.edges[char] = node
+ node.final = final
+
+ } else {
+ var next = new lunr.TokenSet
+ next.final = final
+
+ node.edges[char] = next
+ node = next
+ }
+ }
+
+ return root
+}
+
+/**
+ * Converts this TokenSet into an array of strings
+ * contained within the TokenSet.
+ *
+ * This is not intended to be used on a TokenSet that
+ * contains wildcards, in these cases the results are
+ * undefined and are likely to cause an infinite loop.
+ *
+ * @returns {string[]}
+ */
+lunr.TokenSet.prototype.toArray = function () {
+ var words = []
+
+ var stack = [{
+ prefix: "",
+ node: this
+ }]
+
+ while (stack.length) {
+ var frame = stack.pop(),
+ edges = Object.keys(frame.node.edges),
+ len = edges.length
+
+ if (frame.node.final) {
+ /* In Safari, at this point the prefix is sometimes corrupted, see:
+ * https://github.com/olivernn/lunr.js/issues/279 Calling any
+ * String.prototype method forces Safari to "cast" this string to what
+ * it's supposed to be, fixing the bug. */
+ frame.prefix.charAt(0)
+ words.push(frame.prefix)
+ }
+
+ for (var i = 0; i < len; i++) {
+ var edge = edges[i]
+
+ stack.push({
+ prefix: frame.prefix.concat(edge),
+ node: frame.node.edges[edge]
+ })
+ }
+ }
+
+ return words
+}
+
+/**
+ * Generates a string representation of a TokenSet.
+ *
+ * This is intended to allow TokenSets to be used as keys
+ * in objects, largely to aid the construction and minimisation
+ * of a TokenSet. As such it is not designed to be a human
+ * friendly representation of the TokenSet.
+ *
+ * @returns {string}
+ */
+lunr.TokenSet.prototype.toString = function () {
+ // NOTE: Using Object.keys here as this.edges is very likely
+ // to enter 'hash-mode' with many keys being added
+ //
+ // avoiding a for-in loop here as it leads to the function
+ // being de-optimised (at least in V8). From some simple
+ // benchmarks the performance is comparable, but allowing
+ // V8 to optimize may mean easy performance wins in the future.
+
+ if (this._str) {
+ return this._str
+ }
+
+ var str = this.final ? '1' : '0',
+ labels = Object.keys(this.edges).sort(),
+ len = labels.length
+
+ for (var i = 0; i < len; i++) {
+ var label = labels[i],
+ node = this.edges[label]
+
+ str = str + label + node.id
+ }
+
+ return str
+}
+
+/**
+ * Returns a new TokenSet that is the intersection of
+ * this TokenSet and the passed TokenSet.
+ *
+ * This intersection will take into account any wildcards
+ * contained within the TokenSet.
+ *
+ * @param {lunr.TokenSet} b - An other TokenSet to intersect with.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.prototype.intersect = function (b) {
+ var output = new lunr.TokenSet,
+ frame = undefined
+
+ var stack = [{
+ qNode: b,
+ output: output,
+ node: this
+ }]
+
+ while (stack.length) {
+ frame = stack.pop()
+
+ // NOTE: As with the #toString method, we are using
+ // Object.keys and a for loop instead of a for-in loop
+ // as both of these objects enter 'hash' mode, causing
+ // the function to be de-optimised in V8
+ var qEdges = Object.keys(frame.qNode.edges),
+ qLen = qEdges.length,
+ nEdges = Object.keys(frame.node.edges),
+ nLen = nEdges.length
+
+ for (var q = 0; q < qLen; q++) {
+ var qEdge = qEdges[q]
+
+ for (var n = 0; n < nLen; n++) {
+ var nEdge = nEdges[n]
+
+ if (nEdge == qEdge || qEdge == '*') {
+ var node = frame.node.edges[nEdge],
+ qNode = frame.qNode.edges[qEdge],
+ final = node.final && qNode.final,
+ next = undefined
+
+ if (nEdge in frame.output.edges) {
+ // an edge already exists for this character
+ // no need to create a new node, just set the finality
+ // bit unless this node is already final
+ next = frame.output.edges[nEdge]
+ next.final = next.final || final
+
+ } else {
+ // no edge exists yet, must create one
+ // set the finality bit and insert it
+ // into the output
+ next = new lunr.TokenSet
+ next.final = final
+ frame.output.edges[nEdge] = next
+ }
+
+ stack.push({
+ qNode: qNode,
+ output: next,
+ node: node
+ })
+ }
+ }
+ }
+ }
+
+ return output
+}
+lunr.TokenSet.Builder = function () {
+ this.previousWord = ""
+ this.root = new lunr.TokenSet
+ this.uncheckedNodes = []
+ this.minimizedNodes = {}
+}
+
+lunr.TokenSet.Builder.prototype.insert = function (word) {
+ var node,
+ commonPrefix = 0
+
+ if (word < this.previousWord) {
+ throw new Error ("Out of order word insertion")
+ }
+
+ for (var i = 0; i < word.length && i < this.previousWord.length; i++) {
+ if (word[i] != this.previousWord[i]) break
+ commonPrefix++
+ }
+
+ this.minimize(commonPrefix)
+
+ if (this.uncheckedNodes.length == 0) {
+ node = this.root
+ } else {
+ node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child
+ }
+
+ for (var i = commonPrefix; i < word.length; i++) {
+ var nextNode = new lunr.TokenSet,
+ char = word[i]
+
+ node.edges[char] = nextNode
+
+ this.uncheckedNodes.push({
+ parent: node,
+ char: char,
+ child: nextNode
+ })
+
+ node = nextNode
+ }
+
+ node.final = true
+ this.previousWord = word
+}
+
+lunr.TokenSet.Builder.prototype.finish = function () {
+ this.minimize(0)
+}
+
+lunr.TokenSet.Builder.prototype.minimize = function (downTo) {
+ for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {
+ var node = this.uncheckedNodes[i],
+ childKey = node.child.toString()
+
+ if (childKey in this.minimizedNodes) {
+ node.parent.edges[node.char] = this.minimizedNodes[childKey]
+ } else {
+ // Cache the key for this node since
+ // we know it can't change anymore
+ node.child._str = childKey
+
+ this.minimizedNodes[childKey] = node.child
+ }
+
+ this.uncheckedNodes.pop()
+ }
+}
+/*!
+ * lunr.Index
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * An index contains the built index of all documents and provides a query interface
+ * to the index.
+ *
+ * Usually instances of lunr.Index will not be created using this constructor, instead
+ * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be
+ * used to load previously built and serialized indexes.
+ *
+ * @constructor
+ * @param {Object} attrs - The attributes of the built search index.
+ * @param {Object} attrs.invertedIndex - An index of term/field to document reference.
+ * @param {Object' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/docs/search/search_index.json b/docs/search/search_index.json new file mode 100644 index 0000000..c310281 --- /dev/null +++ b/docs/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Saviynt Community Connectors RingCentral Signal Sciences","title":"Home"},{"location":"#saviynt-community-connectors","text":"RingCentral Signal Sciences","title":"Saviynt Community Connectors"},{"location":"ringcentral/","text":"RingCentral Connector for Saviynt Preface This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and RingCentral. Audience This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with RingCentral. Introduction RingCentral is a cloud-based communications and collaboration platform that offers a wide range of services, including cloud phone systems, video conferencing, team messaging, and contact center solutions. It is designed to enable businesses of all sizes to communicate and collaborate effectively across various channels, helping to streamline workflows and enhance productivity. RingCentral aims to be an all-in-one communication and collaboration platform, helping businesses move away from traditional phone systems and on-premises hardware in favor of a more flexible, scalable, and cloud-based solution. It caters to various industries and organizations, from small businesses to large enterprises. However, keep in mind that specific features and offerings may evolve over time, so it's always best to visit their official website for the most up-to-date information. The RingCentral connector enables you to seamlessly integrate with RingCentral to manage user lifecycle . For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors . Note: This guide provides information about using the RingCentral REST connector using SCIM API for performing operations listed in the Supported Features. Supported Features The RingCentral integration supports the following features: RingCentral Object EIC Object Full Import Incremental Import Lifecycle Management Access Management Users Accounts Yes No Support for creating, updating, enabling, disabling, and removing accounts Not applicable Supported Software Versions Software Version EIC Release v4.5 and later Understanding the Integration between EIC and RingCentral You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration: The Complete Service Management platform RingCentral combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. Objects are imported as entitlement types into EIC. Security System represents the connection between EIC and the target application. It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. Endpoint is an instance of an application within the context of a security system. It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. It is mandatory to create an endpoint after creating the security system. You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System. Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the SCIM APIs. For more information about creating a connection, see Creating a Connection. Job Scheduler is a software component that executes a job based on the configured schedule to perform import or provisioning operations from EIC. When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the configured connector. If you want to instantly provision requests for completing the tasks without running the provisioning job, you must enable Instant Provisioning at the security system level and the Instant Provisioning Tasks global configuration. For more information about the jobs used by the connectors in the RingCentral integration. Integration Architecture EIC uses a REST connection for integrating with RingCentral for importing data and for performing provisioning and deprovisioning tasks. The following diagram illustrates the integration architecture and communication with the target application. Setting Up the Integration Prerequisites Perform the following steps to Generate & Setup token authentication Log in to the RingCentral portal using administrator credentials. click on the \"Admin\" menu located in the top, horizontal menu. Select \"API access tokens\" towards the bottom of the left hand menu. You should see a list of access tokens if any have been provisioned. Select the token, or click the \"+\" button to create a new one. Finally, enter a label/description for your token, and select an Agent on which the token will act on behalf of. Make sure the token is \"enabled\" and click \"Save.\" You can revoke the tokens at any time from the RingCentral user interface. Creating a Connection Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection. Understanding the Configuration Parameters While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application, predefined correlation rules, and provisioning jobs and import jobs. Configuration Parameters for Account and Access Import The connector uses the following parameters for creating a connection and for importing account and access from the target application: Connection Parameters ..... Importing Connection Package connection package helps you build the connection with pre-defined JSONs, this can be used if your tenant does not already have out of the box connection templates available. Here are the steps to import the RingCentral connection package. Download the connection package. Navigate to Admin \u2192 Transport \u2192 select Import Package. Browse the downloaded package and Import. Navigate to Admin \u2192 Connections \u2192 Select \u201cRingCentral\u201d Connection. Edit the connection with your RingCentral tenant details. Creating a Security System The security system represents the connection between EIC and the target application. For more information on creating a security system, see Creating a Security System. Creating an Endpoint for the Security System Endpoint refers to the target application used to provision accounts and entitlements (access). For more information on creating an endpoint, see Creating Endpoints. Using the RingCentral Integration You can use the RingCentral integration for performing import and provisioning operations after configuring it to meet your requirements. Guidelines for Using the Integration You must apply the following guidelines for configuring import: Run account import before running the access import. Map all RingCentral attributes to EIC account attributes using ImportAccountEntJSON. You must apply the following guidelines for configuring provisioning: Use Java ternary operators if you want to add conditions in the provisioning parameters. You can use Java operations to tweak any attributes by using if-else conditions, substrings, or operators in the JSON for provisioning. Configuring Import Operations Full account import: When configuring the connection for the first time, first perform full import to import all existing accounts from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted accounts are also identified and marked as suspended from import service. Full Access import: When configuring the connection for the first time, first perform full import to import all existing access from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted entitlements are also identified and marked as inactive. The import jobs are automatically created in EIC after you create a connection for the RingCentral integration. For more information about creating jobs, see Data Jobs. Importing Accounts and Accesses You must import accounts after the users are available in EIC. To import accounts: Specify the connection and import parameters. For more information, see Account and Access import. Note: Ensure that the connection type is selected as REST. Configure the Application Data Import (Single Threaded) job to import accounts and access. For more information, see Data Jobs. Configuring Provisioning and Deprovisioning Provisioning is automatically enabled when a connection is configured. For detailed information about performing provisioning tasks, see Access Request System. To provision objects to the target application: pecify the connection and provisioning parameters. For more information, see Configuration Parameters for Provisioning. Note: Ensure that the connection type is selected as REST. Configure the Provisioning job (WSRETRY). For more information, see Provisioning Jobs. When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the connector. Troubleshooting To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors. To troubleshoot common problems or obtain answers for frequently asked questions for REST connectors, see the REST Connector Guide. Note: Ensure that you record the token expiry duration during the initial token generation. The connection may fail, if the token is not refreshed.","title":"RingCentral"},{"location":"ringcentral/#ringcentral-connector-for-saviynt","text":"","title":"RingCentral Connector for Saviynt"},{"location":"ringcentral/#preface","text":"This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and RingCentral.","title":"Preface"},{"location":"ringcentral/#audience","text":"This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with RingCentral.","title":"Audience"},{"location":"ringcentral/#introduction","text":"RingCentral is a cloud-based communications and collaboration platform that offers a wide range of services, including cloud phone systems, video conferencing, team messaging, and contact center solutions. It is designed to enable businesses of all sizes to communicate and collaborate effectively across various channels, helping to streamline workflows and enhance productivity. RingCentral aims to be an all-in-one communication and collaboration platform, helping businesses move away from traditional phone systems and on-premises hardware in favor of a more flexible, scalable, and cloud-based solution. It caters to various industries and organizations, from small businesses to large enterprises. However, keep in mind that specific features and offerings may evolve over time, so it's always best to visit their official website for the most up-to-date information. The RingCentral connector enables you to seamlessly integrate with RingCentral to manage user lifecycle . For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors . Note: This guide provides information about using the RingCentral REST connector using SCIM API for performing operations listed in the Supported Features.","title":"Introduction"},{"location":"ringcentral/#supported-features","text":"The RingCentral integration supports the following features: RingCentral Object EIC Object Full Import Incremental Import Lifecycle Management Access Management Users Accounts Yes No Support for creating, updating, enabling, disabling, and removing accounts Not applicable","title":"Supported Features"},{"location":"ringcentral/#supported-software-versions","text":"Software Version EIC Release v4.5 and later","title":"Supported Software Versions"},{"location":"ringcentral/#understanding-the-integration-between-eic-and-ringcentral","text":"You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration: The Complete Service Management platform RingCentral combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. Objects are imported as entitlement types into EIC. Security System represents the connection between EIC and the target application. It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. Endpoint is an instance of an application within the context of a security system. It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. It is mandatory to create an endpoint after creating the security system. You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System. Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the SCIM APIs. For more information about creating a connection, see Creating a Connection. Job Scheduler is a software component that executes a job based on the configured schedule to perform import or provisioning operations from EIC. When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the configured connector. If you want to instantly provision requests for completing the tasks without running the provisioning job, you must enable Instant Provisioning at the security system level and the Instant Provisioning Tasks global configuration. For more information about the jobs used by the connectors in the RingCentral integration.","title":"Understanding the Integration between EIC and RingCentral"},{"location":"ringcentral/#integration-architecture","text":"EIC uses a REST connection for integrating with RingCentral for importing data and for performing provisioning and deprovisioning tasks. The following diagram illustrates the integration architecture and communication with the target application.","title":"Integration Architecture"},{"location":"ringcentral/#setting-up-the-integration","text":"","title":"Setting Up the Integration"},{"location":"ringcentral/#prerequisites","text":"Perform the following steps to Generate & Setup token authentication Log in to the RingCentral portal using administrator credentials. click on the \"Admin\" menu located in the top, horizontal menu. Select \"API access tokens\" towards the bottom of the left hand menu. You should see a list of access tokens if any have been provisioned. Select the token, or click the \"+\" button to create a new one. Finally, enter a label/description for your token, and select an Agent on which the token will act on behalf of. Make sure the token is \"enabled\" and click \"Save.\" You can revoke the tokens at any time from the RingCentral user interface.","title":"Prerequisites"},{"location":"ringcentral/#creating-a-connection","text":"Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection.","title":"Creating a Connection"},{"location":"ringcentral/#understanding-the-configuration-parameters","text":"While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application, predefined correlation rules, and provisioning jobs and import jobs.","title":"Understanding the Configuration Parameters"},{"location":"ringcentral/#configuration-parameters-for-account-and-access-import","text":"The connector uses the following parameters for creating a connection and for importing account and access from the target application:","title":"Configuration Parameters for Account and Access Import"},{"location":"ringcentral/#connection-parameters","text":".....","title":"Connection Parameters"},{"location":"ringcentral/#importing-connection-package","text":"connection package helps you build the connection with pre-defined JSONs, this can be used if your tenant does not already have out of the box connection templates available. Here are the steps to import the RingCentral connection package. Download the connection package. Navigate to Admin \u2192 Transport \u2192 select Import Package. Browse the downloaded package and Import. Navigate to Admin \u2192 Connections \u2192 Select \u201cRingCentral\u201d Connection. Edit the connection with your RingCentral tenant details.","title":"Importing Connection Package"},{"location":"ringcentral/#creating-a-security-system","text":"The security system represents the connection between EIC and the target application. For more information on creating a security system, see Creating a Security System.","title":"Creating a Security System"},{"location":"ringcentral/#creating-an-endpoint-for-the-security-system","text":"Endpoint refers to the target application used to provision accounts and entitlements (access). For more information on creating an endpoint, see Creating Endpoints.","title":"Creating an Endpoint for the Security System"},{"location":"ringcentral/#using-the-ringcentral-integration","text":"You can use the RingCentral integration for performing import and provisioning operations after configuring it to meet your requirements.","title":"Using the RingCentral Integration"},{"location":"ringcentral/#guidelines-for-using-the-integration","text":"You must apply the following guidelines for configuring import: Run account import before running the access import. Map all RingCentral attributes to EIC account attributes using ImportAccountEntJSON. You must apply the following guidelines for configuring provisioning: Use Java ternary operators if you want to add conditions in the provisioning parameters. You can use Java operations to tweak any attributes by using if-else conditions, substrings, or operators in the JSON for provisioning.","title":"Guidelines for Using the Integration"},{"location":"ringcentral/#configuring-import-operations","text":"Full account import: When configuring the connection for the first time, first perform full import to import all existing accounts from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted accounts are also identified and marked as suspended from import service. Full Access import: When configuring the connection for the first time, first perform full import to import all existing access from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted entitlements are also identified and marked as inactive. The import jobs are automatically created in EIC after you create a connection for the RingCentral integration. For more information about creating jobs, see Data Jobs.","title":"Configuring Import Operations"},{"location":"ringcentral/#importing-accounts-and-accesses","text":"You must import accounts after the users are available in EIC. To import accounts: Specify the connection and import parameters. For more information, see Account and Access import. Note: Ensure that the connection type is selected as REST. Configure the Application Data Import (Single Threaded) job to import accounts and access. For more information, see Data Jobs.","title":"Importing Accounts and Accesses"},{"location":"ringcentral/#configuring-provisioning-and-deprovisioning","text":"Provisioning is automatically enabled when a connection is configured. For detailed information about performing provisioning tasks, see Access Request System. To provision objects to the target application: pecify the connection and provisioning parameters. For more information, see Configuration Parameters for Provisioning. Note: Ensure that the connection type is selected as REST. Configure the Provisioning job (WSRETRY). For more information, see Provisioning Jobs. When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the connector.","title":"Configuring Provisioning and Deprovisioning"},{"location":"ringcentral/#troubleshooting","text":"To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors. To troubleshoot common problems or obtain answers for frequently asked questions for REST connectors, see the REST Connector Guide. Note: Ensure that you record the token expiry duration during the initial token generation. The connection may fail, if the token is not refreshed.","title":"Troubleshooting"},{"location":"signalsciences/","text":"Signal Sciences Connector for Saviynt Preface This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Signal Sciences . Audience This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with Signal Sciences . Introduction Signal Sciences was a cybersecurity company that specialized in web application and API security. The company provided a cloud-native web application firewall (WAF) and runtime application self-protection (RASP) solution designed to protect web applications and APIs from various threats, including web application attacks and OWASP Top Ten vulnerabilities. Signal Sciences platform offered real-time threat protection, visibility, and security analytics, helping organizations defend against web application attacks, such as SQL injection, cross-site scripting (XSS), and more. The company aimed to provide security teams with the tools and insights needed to protect their applications and APIs in modern, dynamic, and cloud-native environments. The Signal Sciences connector enables you to seamlessly integrate with Signal Sciences to manage user lifecycle and govern access to their Sites. For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors . Note: This guide provides information about using the Signal Sciences REST connector using REST API for performing operations listed in the Supported Features. Supported Features The Signal Sciences integration supports the following features: Incremental Import Lifecycle Management Add or Remove Access Signal Sciences Object EIC Object Full Import Incremental Import Lifecycle Management Access Management Users Accounts Yes No Support for creating, updating, and removing accounts Not applicable Sites Sites Yes No Not applicable Support for adding and removing site members Supported Software Versions Software Version EIC Release v4.5 and later Understanding the Integration between EIC and Signal Sciences You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration: The Complete Service Management platform Signal Sciences combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. Objects are imported as entitlement types into EIC. Security System represents the connection between EIC and the target application. It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. Endpoint is an instance of an application within the context of a security system. It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. It is mandatory to create an endpoint after creating the security system. You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System. Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the REST APIs. For more information about creating a connection, see Creating a Connection.","title":"Signal Sciences Connector for Saviynt"},{"location":"signalsciences/#signal-sciences-connector-for-saviynt","text":"","title":"Signal Sciences Connector for Saviynt"},{"location":"signalsciences/#preface","text":"This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Signal Sciences .","title":"Preface"},{"location":"signalsciences/#audience","text":"This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with Signal Sciences .","title":"Audience"},{"location":"signalsciences/#introduction","text":"Signal Sciences was a cybersecurity company that specialized in web application and API security. The company provided a cloud-native web application firewall (WAF) and runtime application self-protection (RASP) solution designed to protect web applications and APIs from various threats, including web application attacks and OWASP Top Ten vulnerabilities. Signal Sciences platform offered real-time threat protection, visibility, and security analytics, helping organizations defend against web application attacks, such as SQL injection, cross-site scripting (XSS), and more. The company aimed to provide security teams with the tools and insights needed to protect their applications and APIs in modern, dynamic, and cloud-native environments. The Signal Sciences connector enables you to seamlessly integrate with Signal Sciences to manage user lifecycle and govern access to their Sites. For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors . Note: This guide provides information about using the Signal Sciences REST connector using REST API for performing operations listed in the Supported Features.","title":"Introduction"},{"location":"signalsciences/#supported-features","text":"The Signal Sciences integration supports the following features: Incremental Import Lifecycle Management Add or Remove Access Signal Sciences Object EIC Object Full Import Incremental Import Lifecycle Management Access Management Users Accounts Yes No Support for creating, updating, and removing accounts Not applicable Sites Sites Yes No Not applicable Support for adding and removing site members","title":"Supported Features"},{"location":"signalsciences/#supported-software-versions","text":"Software Version EIC Release v4.5 and later","title":"Supported Software Versions"},{"location":"signalsciences/#understanding-the-integration-between-eic-and-signal-sciences","text":"You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration: The Complete Service Management platform Signal Sciences combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. Objects are imported as entitlement types into EIC. Security System represents the connection between EIC and the target application. It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. Endpoint is an instance of an application within the context of a security system. It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. It is mandatory to create an endpoint after creating the security system. You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System. Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the REST APIs. For more information about creating a connection, see Creating a Connection.","title":"Understanding the Integration between EIC and Signal Sciences"}]} \ No newline at end of file diff --git a/docs/search/worker.js b/docs/search/worker.js new file mode 100644 index 0000000..8628dbc --- /dev/null +++ b/docs/search/worker.js @@ -0,0 +1,133 @@ +var base_path = 'function' === typeof importScripts ? '.' : '/search/'; +var allowSearch = false; +var index; +var documents = {}; +var lang = ['en']; +var data; + +function getScript(script, callback) { + console.log('Loading script: ' + script); + $.getScript(base_path + script).done(function () { + callback(); + }).fail(function (jqxhr, settings, exception) { + console.log('Error: ' + exception); + }); +} + +function getScriptsInOrder(scripts, callback) { + if (scripts.length === 0) { + callback(); + return; + } + getScript(scripts[0], function() { + getScriptsInOrder(scripts.slice(1), callback); + }); +} + +function loadScripts(urls, callback) { + if( 'function' === typeof importScripts ) { + importScripts.apply(null, urls); + callback(); + } else { + getScriptsInOrder(urls, callback); + } +} + +function onJSONLoaded () { + data = JSON.parse(this.responseText); + var scriptsToLoad = ['lunr.js']; + if (data.config && data.config.lang && data.config.lang.length) { + lang = data.config.lang; + } + if (lang.length > 1 || lang[0] !== "en") { + scriptsToLoad.push('lunr.stemmer.support.js'); + if (lang.length > 1) { + scriptsToLoad.push('lunr.multi.js'); + } + if (lang.includes("ja") || lang.includes("jp")) { + scriptsToLoad.push('tinyseg.js'); + } + for (var i=0; i < lang.length; i++) { + if (lang[i] != 'en') { + scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); + } + } + } + loadScripts(scriptsToLoad, onScriptsLoaded); +} + +function onScriptsLoaded () { + console.log('All search scripts loaded, building Lunr index...'); + if (data.config && data.config.separator && data.config.separator.length) { + lunr.tokenizer.separator = new RegExp(data.config.separator); + } + + if (data.index) { + index = lunr.Index.load(data.index); + data.docs.forEach(function (doc) { + documents[doc.location] = doc; + }); + console.log('Lunr pre-built index loaded, search ready'); + } else { + index = lunr(function () { + if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { + this.use(lunr[lang[0]]); + } else if (lang.length > 1) { + this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility + } + this.field('title'); + this.field('text'); + this.ref('location'); + + for (var i=0; i < data.docs.length; i++) { + var doc = data.docs[i]; + this.add(doc); + documents[doc.location] = doc; + } + }); + console.log('Lunr index built, search ready'); + } + allowSearch = true; + postMessage({config: data.config}); + postMessage({allowSearch: allowSearch}); +} + +function init () { + var oReq = new XMLHttpRequest(); + oReq.addEventListener("load", onJSONLoaded); + var index_path = base_path + '/search_index.json'; + if( 'function' === typeof importScripts ){ + index_path = 'search_index.json'; + } + oReq.open("GET", index_path); + oReq.send(); +} + +function search (query) { + if (!allowSearch) { + console.error('Assets for search still loading'); + return; + } + + var resultDocuments = []; + var results = index.search(query); + for (var i=0; i < results.length; i++){ + var result = results[i]; + doc = documents[result.ref]; + doc.summary = doc.text.substring(0, 200); + resultDocuments.push(doc); + } + return resultDocuments; +} + +if( 'function' === typeof importScripts ) { + onmessage = function (e) { + if (e.data.init) { + init(); + } else if (e.data.query) { + postMessage({ results: search(e.data.query) }); + } else { + console.error("Worker - Unrecognized message: " + e); + } + }; +} diff --git a/docs/signalsciences/Connection_2023-08-25_04-41-27(UTC).json b/docs/signalsciences/Connection_2023-08-25_04-41-27(UTC).json new file mode 100644 index 0000000..fa26e0f --- /dev/null +++ b/docs/signalsciences/Connection_2023-08-25_04-41-27(UTC).json @@ -0,0 +1,165 @@ +{ + "Signal_Sciences": { + "connectionname": "Signal_Sciences", + "sslCertificateId": null, + "msconnectorversion": null, + "connectorms": false, + "statusForEnableDisable": 1, + "vaultCredentialConnection": null, + "sslCertificate": null, + "vaultConfig": null, + "templateMandatoryData": "h2R6jYBzyoHd1QAXG7+z4LSf2W5Yr94nzyDLpILqTZF/C7E1cfrmDl1doWiFZ5+K", + "credentialChangeConfig": null, + "externalconnectiontype": "REST", + "templateName": "Signal_Sciences", + "connectorType": null, + "connectiondescription": "", + "status": 1, + "EXTERNAL_ATTR": [ + { + "encryptedattributevalue": "F094T0v6WHOpHcSzOqzN/G0EOXMVamwB8u2E9ttQNJNH/uqcgtvsw9t4/JqDJeCqQsdihkRCJpZn9bLHAwEt1khfhJ57qiyRImlt7xYaAw8R3gKwlb5P5Pls/NpXrJCJ3fWcwm7suTm3GoNQ+WWugs9WQBhG3HfINvzDWkpgt+8M8MOKmVIOOuMk008L5Dj40aTfaf1cSId2f9lUiHNQXgvn3fxB0V21DO6MSRFLqJv+/CHrPcVoc5ERicpdewWG2aKX5tvma8zw7mkbUxffFFe3/PXLPYP9nqogeYoqkW/tNeb+w9CrGunqSLV6wNApBvkOeaFXuNc8PtSu6X6kdeg6jEpNXP+ZEX5aOwGHQRmPhcHaaGr3py9jQlwIQ8U9QoOK8F6/OxXdGCgKeAWaWpRyCF485RvvKZyb56/rRGqmLz4AXthebN1YxEs8YYUBn5vh5d2jQf+dmIy1NOvTky6CAjzvXMVVeOLGyEHmqAI48WpDMpQ6i1XpZzBmLwdpV9HLIxjlpyOIHJjYdRR9IWySxVVH3ia+fwe+LKCcdiKg64ti4Uyt/7B5ksDlJUCYWXNxM81XFdMX8BqZHSf5iTrOebj5dtWoXSE1X/O0r4zOVwRqGdgRAHbIVKr9lwHBteH+zdekX02CFiQU/GsC1aTLbvuh3DmYGo3kBNeUjOXgc5G8DfWv/joPskPGqNvGvVxkQ6ro9NxM8v+qQw/l/A==", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "ConnectionJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "ImportUserJSON", + "credentialSaveStatus": false + }, + { + "formdata": null, + "encryptedattributevalue": "{\r\n \"accountParams\": {\r\n \"connection\": \"acctAuth\",\r\n \"processingType\": \"SequentialAndIterative\",\r\n \"statusAndThresholdConfig\": {\r\n \"statusColumn\": \"customproperty5\",\r\n \"status\": [\r\n \"active\"\r\n ],\r\n \"deleteLinks\": true,\r\n \"accountThresholdValue\": 1000,\r\n \"correlateInactiveAccounts\": false,\r\n \"inactivateAccountsNotInFile\": true,\r\n \"deleteAccEntForActiveAccounts\": true\r\n },\r\n \"call\": {\r\n \"call1\": {\r\n \"callOrder\": 0,\r\n \"stageNumber\": 0,\r\n \"http\": {\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/users\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"httpMethod\": \"GET\"\r\n },\r\n \"listField\": \"data\",\r\n \"keyField\": \"accountID\",\r\n \"colsToPropsMap\": {\r\n \"accountID\": \"email~#~char\",\r\n \"name\": \"name~#~char\",\r\n \"displayName\": \"email~#~char\",\r\n \"customproperty1\": \"announcements~#~char\",\r\n \"customproperty2\": \"defaultDashboards~#~char\",\r\n \"customproperty3\": \"memberships~#~char\",\r\n \"customproperty4\": \"role~#~char\",\r\n \"customproperty5\": \"status~#~char\",\r\n \"customproperty6\": \"mfaEnabled~#~char\",\r\n \"customproperty7\": \"authStatus~#~char\",\r\n \"customproperty8\": \"created~#~char\"\r\n }\r\n }\r\n }\r\n },\r\n \"entitlementParams\": {\r\n \"connection\": \"acctAuth\",\r\n \"processingType\": \"SequentialAndIterative\",\r\n \"entTypes\": {\r\n \"Site\": {\r\n \"entTypeOrder\": 0,\r\n \"entTypeLabels\": {},\r\n \"call\": {\r\n \"call1\": {\r\n \"connection\": \"acctAuth\",\r\n \"callOrder\": 0,\r\n \"stageNumber\": 0,\r\n \"http\": {\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/sites\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"httpMethod\": \"GET\"\r\n },\r\n \"listField\": \"data\",\r\n \"keyField\": \"entitlementID\",\r\n \"colsToPropsMap\": {\r\n \"entitlementID\": \"name~#~char\",\r\n \"entitlement_value\": \"displayName~#~char\",\r\n \"customproperty1\": \"agentLevel~#~char\",\r\n \"customproperty2\": \"blockHTTPCode~#~char\",\r\n \"customproperty3\": \"blockDurationSeconds~#~char\",\r\n \"customproperty4\": \"created~#~char\",\r\n \"customproperty5\": \"whitelist.uri~#~char\",\r\n \"customproperty6\": \"blacklist.uri~#~char\",\r\n \"customproperty7\": \"events.uri~#~char\",\r\n \"customproperty8\": \"requests.uri~#~char\",\r\n \"customproperty9\": \"redactions.uri~#~char\",\r\n \"customproperty10\": \"suspiciousIPs.uri~#~char\",\r\n \"customproperty11\": \"monitors.uri~#~char\",\r\n \"customproperty12\": \"integrations.uri~#~char\",\r\n\r\n \"customproperty13\": \"headerLinks.uri~#~char\",\r\n \"customproperty14\": \"agents.uri~#~char\",\r\n \"customproperty15\": \"alerts.uri~#~char\",\r\n \"customproperty16\": \"members.uri~#~char\"\r\n },\r\n \"disableDeletedEntitlements\": true\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"acctEntParams\": {\r\n \"connection\": \"acctAuth\",\r\n \"entTypes\": {\r\n \"Site\": {\r\n \"call\": {\r\n \"call1\": {\r\n \"callOrder\": 0,\r\n \"stageNumber\": 0,\r\n \"processingType\": \"httpEntToAcct\",\r\n \"http\": {\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\"\r\n },\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/sites/${id}/members\",\r\n \"httpContentType\": \"application/json\",\r\n \"httpMethod\": \"GET\"\r\n },\r\n \"listField\": \"data\",\r\n \"entKeyField\": \"entitlementID\",\r\n \"acctIdPath\": \"user.email\",\r\n \"acctKeyField\": \"accountID\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n}", + "credentialSaveStatus": false, + "attributename": "ImportAccountEntJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "STATUS_THRESHOLD_CONFIG" + }, + { + "encryptedattributevalue": "{\r\n \"accountIdPath\": \"call1.message.email\",\r\n \"responseColsToPropsMap\": {\r\n \"name\": \"call1.message.name~#~char\"\r\n },\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/users/${user.email}/invite\",\r\n \"httpMethod\": \"POST\",\r\n \"httpParams\": \"{\\\"role\\\":\\\"${user.customproperty4}\\\",\\\"memberships\\\":{\\\"data\\\":[{\\\"site\\\":{\\\"name\\\":\\\"staging\\\"}}]}}\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201\r\n ]\r\n }\r\n }\r\n ]\r\n}", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "CreateAccountJSON" + }, + { + "formdata": null, + "attributename": "UpdateAccountJSON", + "credentialSaveStatus": false, + "encryptedattributevalue": "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/users/${account.accountID}\",\r\n \"httpMethod\": \"PATCH\",\r\n \"httpParams\": \"{\\\"role\\\":\\\"${user.customproperty4}\\\",\\\"memberships\\\":{\\\"data\\\":[{\\\"site\\\":{\\\"name\\\":\\\"staging\\\"}}]}}\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201,\r\n 204\r\n ]\r\n }\r\n }\r\n ]\r\n}" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "EnableAccountJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "DisableAccountJSON" + }, + { + "formdata": null, + "encryptedattributevalue": "{\r\n \"call\": [\r\n {\r\n \"name\": \"Site\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \" https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/sites/${entitlementValue.entitlementID}/members\",\r\n \"httpMethod\": \"POST\",\r\n \"httpParams\": \"{\\\"members\\\":[\\\"${account.accountID}\\\"]}\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201\r\n ]\r\n }\r\n }\r\n ]\r\n}", + "credentialSaveStatus": false, + "attributename": "AddAccessJSON" + }, + { + "formdata": null, + "credentialSaveStatus": false, + "attributename": "RemoveAccessJSON", + "encryptedattributevalue": "{\r\n \"call\": [\r\n {\r\n \"name\": \"Site\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/sites/${entitlementValue.entitlementID}/members/${account.accountID}\",\r\n \"httpMethod\": \"DELETE\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201,\r\n 204\r\n ]\r\n }\r\n }\r\n ]\r\n}" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "UpdateUserJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "ChangePassJSON", + "credentialSaveStatus": false + }, + { + "formdata": null, + "attributename": "RemoveAccountJSON", + "encryptedattributevalue": "{\r\n \"call\": [\r\n {\r\n \"name\": \"call1\",\r\n \"connection\": \"acctAuth\",\r\n \"url\": \"https://dashboard.signalsciences.net/api/v0/corps/@CORPNAME@/users/${account.accountID}\",\r\n \"httpMethod\": \"DELETE\",\r\n \"httpHeaders\": {\r\n \"Authorization\": \"${access_token}\",\r\n \"Accept\": \"application/json\"\r\n },\r\n \"httpContentType\": \"application/json\",\r\n \"successResponses\": {\r\n \"statusCode\": [\r\n 200,\r\n 201,\r\n 204\r\n ]\r\n }\r\n }\r\n ]\r\n}", + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "TicketStatusJSON" + }, + { + "attributename": "CreateTicketJSON", + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "ENDPOINTS_FILTER", + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "PasswdPolicyJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "ConfigJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "AddFFIDAccessJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "RemoveFFIDAccessJSON" + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "MODIFYUSERDATAJSON", + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "SendOtpJSON", + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "attributename": "ValidateOtpJSON", + "credentialSaveStatus": false + }, + { + "encryptedattributevalue": "", + "formdata": null, + "credentialSaveStatus": false, + "attributename": "PAM_CONFIG" + } + ] + } +} \ No newline at end of file diff --git a/docs/signalsciences/ObjectSummary_2023-08-25_04-41-27(UTC).json b/docs/signalsciences/ObjectSummary_2023-08-25_04-41-27(UTC).json new file mode 100644 index 0000000..6675cdd --- /dev/null +++ b/docs/signalsciences/ObjectSummary_2023-08-25_04-41-27(UTC).json @@ -0,0 +1,15 @@ +{ + "Objects": { + "connection": [ + "Signal_Sciences" + ] + }, + "Information": { + "GUID": "95af5d93-1675-40d0-99fc-e08bc6f15cb9", + "Exported By": "admin", + "Exported On": "2023-08-25 04:41:26", + "System": "scrum-exchange.saviyntcloud.com", + "TransferOwners": "0", + "TransferUsers": "0" + } +} \ No newline at end of file diff --git a/docs/signalsciences/index.html b/docs/signalsciences/index.html new file mode 100644 index 0000000..67d71d5 --- /dev/null +++ b/docs/signalsciences/index.html @@ -0,0 +1,195 @@ + + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Signal Sciences Connector for Saviynt
+Preface
+This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Signal Sciences .
+Audience
+This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with Signal Sciences .
+Introduction
+Signal Sciences was a cybersecurity company that specialized in web application and API security. The company provided a cloud-native web application firewall (WAF) and runtime application self-protection (RASP) solution designed to protect web applications and APIs from various threats, including web application attacks and OWASP Top Ten vulnerabilities.
+Signal Sciences platform offered real-time threat protection, visibility, and security analytics, helping organizations defend against web application attacks, such as SQL injection, cross-site scripting (XSS), and more. The company aimed to provide security teams with the tools and insights needed to protect their applications and APIs in modern, dynamic, and cloud-native environments.
+The Signal Sciences connector enables you to seamlessly integrate with Signal Sciences to manage user lifecycle and govern access to their Sites.
+For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors.
+Note: This guide provides information about using the Signal Sciences REST connector using REST API for performing operations listed in the Supported Features.
+Supported Features
+The Signal Sciences integration supports the following features:
+-
+
- Incremental Import +
- Lifecycle Management +
- Add or Remove Access +
| Signal Sciences Object | +EIC Object | +Full Import | +Incremental Import | +Lifecycle Management | +Access Management | +
|---|---|---|---|---|---|
| Users | +Accounts | +Yes | +No | +Support for creating, updating, and removing accounts | +Not applicable | +
| Sites | +Sites | +Yes | +No | +Not applicable | +Support for adding and removing site members | +
Supported Software Versions
+| Software | +Version | +
|---|---|
| EIC | +Release v4.5 and later | +
Understanding the Integration between EIC and Signal Sciences
+You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration:
+-
+
- The Complete Service Management platform Signal Sciences combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity. +
- Objects are imported as entitlement types into EIC. +
- Security System represents the connection between EIC and the target application.
-
+
- It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository. +
- It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System. +
+ - Endpoint is an instance of an application within the context of a security system.
-
+
- It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements. +
- It is mandatory to create an endpoint after creating the security system.
You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System.
+
+ - Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the REST APIs. For more information about creating a connection, see Creating a Connection. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
new file mode 100644
index 0000000..e1d26e8
--- /dev/null
+++ b/docs/sitemap.xml
@@ -0,0 +1,18 @@
+
+