SimpleOne

https://docs.simpleone.ru
Admin
SimpleOne is a comprehensive B2B CRM and enterprise management platform with modules for customer...
Tokens:534,688
Snippets:8,158
Trust Score:8.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Telethon Library

Source: https://docs.simpleone.ru/itsm/itsm-telegram-bots/swarming-session

Run these commands on the command line to install or upgrade the Telethon library for Python.

```bash
python3 -m pip install --upgrade pip
```

```bash
python3 -m pip install --upgrade telethon
```

--------------------------------

### PHP Agent Configuration Example

Source: https://docs.simpleone.ru/platform/developer/integration/infrastructure-agent/php-agent

Example of the .env configuration file for the PHP infrastructure agent. Modify these values according to your instance settings.

```env
MID_API_USERNAME=admin
MID_API_PASSWORD=123456
MID_API_SERVERID=157237947616342741
MID_API_ENDPOINT=`https://instance.example.com/rest`
```

--------------------------------

### Example JSON Configuration for Opportunity Board

Source: https://docs.simpleone.ru/crm/board-configuration

This is an example of a JSON configuration for an opportunity board, demonstrating the structure for rows, WIP limits, included states, and excluded states.

```json
{
   "rows":{
      "WIP_limits":{},
      "included_state":[],
      "excluded_states":[
         "Support and post-sale",

```

--------------------------------

### KPI Rating Example Calculation

Source: https://docs.simpleone.ru/esm/performance/tfl/monitoring-cells

An example demonstrating the calculation of KPI rating using specific values for actual, minimum, and target values.

```plaintext
Ki = 60, Mi = 50, Ti = 80

max (0; min (1; 60-50)/(80-50))=33%
Ri = 33%
```

--------------------------------

### Balanced Scorecard Example Calculation

Source: https://docs.simpleone.ru/esm/performance/tfl/monitoring-cells

An example demonstrating the calculation of the balanced scorecard using specific weights and ratings for multiple KPIs.

```plaintext
W1 = 2, W2 = 1, W3 = 1
R1 = 33%, R2 = 100%, R3 = 0%

(33х2 + 100х1 + 0х1)/(2+1+1) = 41,5%
BS = 41,5%
```

--------------------------------

### API Action Script Example

Source: https://docs.simpleone.ru/platform/developer/integration/rest-api/scripted

This example demonstrates how to use the SimpleApiRequest and SimpleApiResponse classes within a script to process a request body and set a response body.

```APIDOC
## API Action Script

### Description
This script is executed when a REST request for the action is received. It utilizes the `SimpleApiRequest` and `SimpleApiResponse` classes to interact with the request and response objects.

### Script Example
```javascript
(function (request, response) {
    const reqBody = request.getBody();
    response.setBody({
        "body": JSON.stringify(reqBody),
        "count": 1
    });
})(SimpleApiRequest, SimpleApiResponse);
```

### Request URL Format
`{your_instance_url}/v1/api/{application_slug}/{module_path}/{version}/{action_path}`
Or without version:
`{your_instance_url}/v1/api/{application_slug}/{module_path}/{action_path}`

Requests without a version specified automatically use the last active version.
```

--------------------------------

### Start Subflow

Source: https://docs.simpleone.ru/platform/developer/api/server/simpleworkflow

Starts a subflow by executing activity. Returns null if there are no workflow versions created by the current user.

```javascript
;
(  
  (current, activity) => {  
    const wfActivitySubflow = new SimpleRecord('wf_activity_subflow');  
    wfActivitySubflow.get(activity.getValue('activity_id'));  
   
    const workflowManager = new SimpleWorkflow();  
    const subflowContext = workflowManager.startSubflow(activity, current, wfActivitySubflow.getValue('workflow_id'));  
    ss.info(subflowContext.state);
  }
)(current, activity);
```

--------------------------------

### start

Source: https://docs.simpleone.ru/platform/developer/api/server/simpleworkflow

Starts a workflow. This method is intended for workflows with the 'Condition type' set to 'Manual'.

```APIDOC
## start(current)

### Description
Use this method to start the workflow. The method only starts the workflows with the **Condition type** set to **Manual**.

### Parameters
#### Path Parameters
- **current** (SimpleRecord object) - Required - The current record associated with the workflow.

### Return
- **SimpleRecord object** - The method returns a SimpleRecord object of the **Workflow Context** (**wf_context**) table. This method returns _null_ in the following cases:
  * the new SimpleWorkflow object has been created without specifying the **workflowId** parameter.
  * there are no workflow versions created by the current user.

### Example
```javascript
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
const context = simpleWorkflow.start(current);
if (context.state === 'finished') {
    ss.info('Workflow finished!');
}
```
```

--------------------------------

### SAML Attribute Mapping Example

Source: https://docs.simpleone.ru/platform/admin/user-control/authorization/sso

This example demonstrates the correlation between the User field in SimpleOne and a custom attribute on the identity provider side for SAML responses. It shows how 'Login' in SimpleOne maps to 'SAM-Account-Name' in the SAML assertion.

```xml
<saml:Attribute FriendlyName="username" 
    Name="SAM-Account-Name" 
    NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
  <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:type="xs:string">ad.viewer</saml:AttributeValue>
</saml:Attribute>
```

--------------------------------

### s_go.open(url, target, callback)

Source: https://docs.simpleone.ru/platform/developer/api/client/simplego

Navigates to the specified URL. It's recommended to use relative paths for scalability. The target parameter can specify where to open the URL (e.g., '_blank' for a new window), and an optional callback function can be provided.

```APIDOC
## s_go.open(url, target, callback)

### Description
Use this method to go through the URL. It is not recommended to pass an absolute URL as a parameter value for this method, because it leads to scalability issues. Define the relative path.

### Parameters
#### Path Parameters
- **url** (String) - Mandatory - N
- **target** (String) - Optional - N
- **callback** (Function) - Optional - N

### Response
#### Success Response
- **Void** - This method does not return a value.

### Example
```javascript
s_go.open('/list/user');

s_go.open('/list/user', '_blank');

s_go.open('/record/task?field_parent_id=' + s_form.getUniqueValue(), '_blank', (newWindow) => {
  s_i18n.getMessage('Create a new subtask', (response) => {
    newWindow.s_widgets.getForm('Default').addInfoMessage(response, 5000);
  });
});
```
```

--------------------------------

### Example Filter Condition GET Parameter

Source: https://docs.simpleone.ru/platform/admin/auxiliary/condition-builder/filters

This is an example of a filter condition as it would appear in a GET parameter. Special symbols are URL-encoded.

```URL
/list/task?condition=(state%3D-2%5Epriority<3%5Eassigned_user%3D160114171110151)%5EORDERBYDESCpriority
```

--------------------------------

### Get Full Days from Duration

Source: https://docs.simpleone.ru/platform/developer/api/server/simpleduration

Extract the number of full days from a SimpleDuration object. For example, 2 days 23:59:59 will return 2.

```javascript
const duration = new SimpleDuration('02 01:30:00');
ss.info(duration.getDayPart());
// Info: 2
```

--------------------------------

### Simple Server Script Example for Wysiwyg Editor

Source: https://docs.simpleone.ru/platform/developer/api/widget/simpletags/common/wysiwygeditor

Initialize an empty wysiwygeditor model on the server with empty display and lexical JSON values.

```javascript
data.ww_model = JSON.parse('{"display_value":"","lexical_json_value":""}')  
```

--------------------------------

### Response for Reading Multiple Records

Source: https://docs.simpleone.ru/platform/developer/integration/rest-api/table-api

This is an example JSON response for a GET request to the Table API. It shows the status and the data array containing the requested records.

```JSON
{
    "status": "OK",
    "data": [
        {
            "number": "TSK0000006",
            "caller": 155931135900000001
        }
    ]
}
```

--------------------------------

### Conditional Item Management with SimpleStorage

Source: https://docs.simpleone.ru/platform/developer/api/client/simplestorage

This example demonstrates checking if an item exists, setting a field value, and updating the server if the item is not found. It also shows how to store an item.

```javascript
if (SimpleStorage.hasItem('portalLogo')) {
  s_widget.setFieldValue("HasLogo", true);
  s_widget.setFieldValue("logo", SimpleStorage.getItem("portalLogo"));
} else {
  await s_widget.serverUpdate();
  SimpleStorage.setItem('portalLogo', s_widget.getFieldValue("logo"));
}
```

--------------------------------

### Starts With Operator Examples

Source: https://docs.simpleone.ru/platform/admin/auxiliary/condition-builder/operators

Use the 'startswith' operator to filter records where a field's value begins with specific characters. This is applicable to various data types like Choice, Field Name, Reference, Record Class, Phone, String, Text, Translated Text, Conditions, and URL.

```javascript
current.addQuery('state', 'startswith' 'publish');
```

```javascript
current.addQuery('column_id', 'startswith' 'typ');
```

```javascript
current.addQuery('related_ticket', 'startswith' 'email');
```

```javascript
current.addQuery('sys_db_table_id', 'startswith' 'rule');
```

```javascript
current.addQuery('mobile_phone', 'startswith' '79');
```

```javascript
current.addQuery('name', 'startswith' 'iv');
```

```javascript
current.addQuery('description', 'startswith' 'default');
```

```javascript
current.addQuery('title', 'startswith' 'inc');
```

```javascript
current.addQuery('completion_conditions', 'startswith' 'stat');
```

```javascript
current.addQuery('website', 'startswith' 'simpl');
```

--------------------------------

### Conditions Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of condition operators for a Conditions field.

```plaintext
(active=true)

```

--------------------------------

### Choice Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of a string value for a Choice field.

```plaintext
Changed

```

--------------------------------

### Create Table Snapshots Script

Source: https://docs.simpleone.ru/platform/developer/vcs/applications/export-import

Run this script to create snapshots of all versioned tables for migration purposes. Ensure the local pack for the application is set as current before execution.

```javascript
const table = new SimpleRecord('sys_db_table');
table.addQuery('is_vcs_enabled', true);
table.addQuery('sys_id', '!=', '999999999999999998'); // exclude REM
table.selectAttributes('name');
table.query();
while (table.next()) {
    const vcs = new SimpleVcs();
    const versionCount = vcs.createTableSnapshot(table.name);
    if (versionCount > 0) {
        ss.info(`${table.name.padStart(80, " ")}: ${versionCount} versions  created`);
    }
}

```

--------------------------------

### True/False Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of a boolean value for a True/False field.

```plaintext
true

```

--------------------------------

### Color Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of a color value in a 7-symbol RGB format.

```plaintext
#db3e00

```

--------------------------------

### Configure List Widget

Source: https://docs.simpleone.ru/esm/announcements/announcement-list

Follow these recommendations when filling in attribute values for the listitems widget. Use this example as a pattern.

```html
<listitems 
  class="linkStyles" 
  tableName="announcement" 
  condition="" 
  listView="AnnounceView" 
  choiceConditionName="announcement_type" 
  dateConditionName="sys_created_at" 
  perPage="5" 
  displayColumnNumber="2" 
></listitems> 

```

--------------------------------

### Heapselect URL Configuration Example

Source: https://docs.simpleone.ru/platform/admin/auxiliary/heapselect

This URL structure is used to configure the heapselect tool. It includes parameters for table name, filtering conditions, script includes for record selection and application, display values, and form view.

```URL
<your_instance_URL>/<page_name>/<table_name>?condition=<conditional_expression>  
    &selected_ids_script_id=<script_returning_sys_ids>  
    &script_id=<script_applied>  
    &display_value=<column_name>  
    &title=<some_text>  
    &field_name=<field_value>  
    &form_view=<form_view_name>  

```

--------------------------------

### SimpleSystem

Source: https://docs.simpleone.ru/platform/developer/api/server

Get information about the system, current user, and more.

```APIDOC
## SimpleSystem

### Description
Get information about the system, current user, and more.

### Methods
(Methods not specified in source)
```

--------------------------------

### SimplePreference

Source: https://docs.simpleone.ru/platform/developer/api/client

Manage the Preferences menu.

```APIDOC
## SimplePreference

### Description
Manage the Preferences menu.

### Method
Not applicable (Client-side API class/method)

### Endpoint
Not applicable (Client-side API class/method)

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

--------------------------------

### Manually Start Workflow

Source: https://docs.simpleone.ru/platform/developer/business-logic/workflows/create

Use this method to manually start a workflow by providing its ID and the current record context.

```javascript
new SimpleWorkflow('159491114038814558').start(current); // workflowID  
```

--------------------------------

### Quick Import Result Log Example

Source: https://docs.simpleone.ru/platform/admin/data-import-export/quick-import

This message format appears in the Main Log table after a quick import process, detailing the outcome of the import for a specific file.

```text
Import result for knowledge_base_category.json  
Total: 55  
Inserted: 45  
Updated: 10  
Skipped: 0  

```

--------------------------------

### Get Display Value of SimpleTime

Source: https://docs.simpleone.ru/platform/developer/api/server/simpletime

Get the time in the 'H:i:s' format. This method returns the time in the 'H:i:s' format.

```javascript
const reportTime = new SimpleTime('12:00:00');
ss.info(reportTime.getDisplayValue());
//Info: 12:00:00
```

--------------------------------

### Basic Tooltip Example

Source: https://docs.simpleone.ru/platform/developer/api/widget/simpletags/common/tooltip

Use this snippet to display a tooltip with custom content and placement. The tooltip appears when the element is clicked.

```html
<tooltip  
  placing="top"  
  content="The project code is added to all project task numbers"  
  >
  <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
    <path fill-rule="evenodd" clip-rule="evenodd" d="M12 3C7.02944 3 3 7.02944 3 12C3 16.9706 7.02944 21 12 21C16.9706 21 21 16.9706 21 12C21 7.02944 16.9706 3 12 3ZM1 12C1 5.92487 5.92487 1 12 1C18.0751 1 23 5.92487 23 12C23 18.0751 18.0751 23 12 23C5.92487 23 1 18.0751 1 12Z" fill="#2E3238"/>
    <path fill-rule="evenodd" clip-rule="evenodd" d="M12.2581 8.02432C11.7926 7.94447 11.3138 8.03195 10.9066 8.27127C10.4994 8.51058 10.1901 8.88629 10.0333 9.33184C9.85006 9.85283 9.27915 10.1266 8.75816 9.94333C8.23717 9.76006 7.96339 9.18915 8.14667 8.66816C8.46014 7.77705 9.07887 7.02563 9.89327 6.547C10.7077 6.06837 11.6652 5.89341 12.5962 6.05311C13.5273 6.2128 14.3718 6.69686 14.9801 7.41953C15.5883 8.14205 15.9213 9.05648 15.92 10.0009C15.9197 11.0711 15.3569 11.889 14.7751 12.4464C14.1931 13.004 13.5031 13.3909 13.0159 13.6243C12.977 13.6429 12.9487 13.6696 12.933 13.6926C12.9257 13.7033 12.9225 13.7113 12.9211 13.7154C12.92 13.719 12.92 13.7207 12.92 13.7207V14C12.92 14.5523 12.4723 15 11.92 15C11.3677 15 10.92 14.5523 10.92 14V13.7208C10.92 12.8509 11.4686 12.1479 12.1518 11.8206C12.5483 11.6307 13.0263 11.3522 13.3915 11.0023C13.7567 10.6523 13.92 10.321 13.92 10L13.92 9.99851C13.9207 9.52619 13.7542 9.06886 13.4501 8.70753C13.1459 8.34619 12.7236 8.10417 12.2581 8.02432Z" fill="#2E3238"/>
    <path d="M13 17C13 17.5523 12.5523 18 12 18C11.4477 18 11 17.5523 11 17C11 16.4477 11.4477 16 12 16C12.5523 16 13 16.4477 13 17Z" fill="#2E3238"/>
  </svg>
</tooltip>
```

--------------------------------

### SimpleGo

Source: https://docs.simpleone.ru/platform/developer/api/client

Perform URL transitions.

```APIDOC
## SimpleGo

### Description
Perform URL transitions.

### Method
Not applicable (Client-side API class/method)

### Endpoint
Not applicable (Client-side API class/method)

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

--------------------------------

### Recommended vs. Not Recommended Client Scripting

Source: https://docs.simpleone.ru/platform/developer/widgets/scripts

Demonstrates the recommended way to update widget content using s_widget.addTemplate() instead of directly manipulating the DOM with innerHTML, which is not recommended.

```javascript
// Not Recommended  
document.querySelector(".article-body").innerHTML = s_widget.getFieldValue('body');  
// Recommended  
s_widget.addTemplate('body', s_widget.getFieldValue('body'));  
```

--------------------------------

### SimpleVcs

Source: https://docs.simpleone.ru/platform/developer/api/server

Use the SimpleOne version control system.

```APIDOC
## SimpleVcs

### Description
Use the SimpleOne version control system.

### Methods
(Methods not specified in source)
```

--------------------------------

### Daysofweek Widget Example

Source: https://docs.simpleone.ru/platform/developer/api/widget/simpletags/common/daysofweek

This example demonstrates how to use the daysofweek tag with common attributes like model, label, isMandatory, isVisible, readOnly, and value.

```html
<daysofweek 
    model="data.daysofweek" 
    label="Days of the week" 
    isMandatory="true" 
    isVisible="true" 
    readOnly="false" 
    value="28"
></daysofweek>
```

--------------------------------

### WYSIWYG Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of how WYSIWYG field content is structured in JSON format, including display value and lexical JSON value.

```json
{
    "display_value": "1234",
    "lexical_json_value": {
        "root": {
            "children": [{
                    "children": [{
                            "detail": 0,
                            "format": 0,
                            "mode": "normal",
                            "style": "",
                            "text": "1234",
                            "type": "text",
                            "version": 1
                        }
                    ],
                    "direction": null,
                    "format": "",
                    "indent": 0,
                    "type": "paragraph",
                    "version": 1,
                    "textFormat": 0,
                    "textStyle": ""
                }
            ],
            "direction": null,
            "format": "",
            "indent": 0,
            "type": "root",
            "version": 1
        }
    }
}

```

--------------------------------

### Open Quick Import Modal

Source: https://docs.simpleone.ru/platform/developer/api/client/simplelist

Use this method to trigger the opening of a modal window for performing a quick import. This action does not return any value.

```javascript
s_list.runQuickImport();

```

--------------------------------

### Integer Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of content for an Integer field. Only numbers are allowed, with a range of -2147483648 to +2147483647. Digit group separators can be enabled.

```plaintext
1211345967  
```

--------------------------------

### Configure SimpleSubscription Widget Options

Source: https://docs.simpleone.ru/platform/developer/widgets/available/simplesubscription

Use this JSON to configure the SimpleSubscription widget's appearance and behavior. Set max height, enable compact view, and specify portal display.

```json
    {
        "height": 200,
        "compact": true,
        "isPortal": false
  
    }
```

--------------------------------

### JSON Export Data Format Example

Source: https://docs.simpleone.ru/platform/admin/data-import-export/quick-export

This is an example of an incident record exported in JSON format. It shows the structure and fields typically included in such exports.

```json
{
    "itsm_incident": [
        {
            "sys_created_by": 155931135900000001,
            "caller": 155931135900000001,
            "sla_due": null,
            "comments": null,
            "sys_created_at": "2020-09-07 08:43:02",
            "due_date": null,
            "impact": "1",
            "parent_id": null,
            "priority": "1",
            "state": "-2",
            "sys_updated_at": "2020-09-07 08:43:25",
            "sys_updated_by": 155931135900000001,
            "urgency": "1",
            "closed_by": null,
            "contact": null,
            "screenshot": null,
            "subject": "test",
            "active": true,
            "additional_comments": null,
            "attention_required": true,
            "company": null,
            "display_name": "INC0000322 test",
            "sys_id": 159946818218525099,
            "watcher_list": null,
            "assigned_user": 157416146011669937,
            "description": "",
            "number": "INC0000322",
            "assignment_group": 157417569011449935,
            "opened_by": null,
            "escalation": null,
            "closed_at": null,
            "opened_at": "2020-09-07 08:43:01",
            "subcategory": null,
            "master_incident": null,
            "infrastructure_incident": false,
            "resubmission": null,
            "category": null,
            "reject_count": null,
            "chronology": "",
            "knowledge": false,
            "major_incident": false,
            "slave_incidents": "",
            "copy_cis_to_originators": false,
            "agent_satisfaction": null,
            "actual_end_datetime": null,
            "planned_start_datetime": null,
            "resolved_at": null,
            "caused_by_changes": "",
            "level_of_dependency": null,
            "solved_by_changes": "",
            "service_satisfaction": null,
            "contact_type": "10",
            "related_cis": "157477515313727442",
            "closure_notes": "",
            "complete_originators": false,
            "related_incidents": null,
            "related_problems": "",
            "planned_end_datetime": null,
            "related_articles": "",
            "resolved_by": null,
            "actual_start_datetime": null,
            "has_breached": false,
            "related_inquiry": null,
            "closure_code": null,
            "known_error": null,
            "rererer": null,
            "nenenenenen": null,
            "steps_to_reproduce": "",
            "short_description": null,
            "work_notes": null,
            "wf_executing_activity": null,
            "service": 157416651911910348,
            "sys_db_table_id": 156950677111866258,
            "followers_list": ""
        }
    ]
}
```

--------------------------------

### Configure ListItems Widget

Source: https://docs.simpleone.ru/esm/service-portal/record-list

This example shows how to configure the listItems widget to display a list of records, including table name, filtering conditions, and view settings.

```html
<listitems   
  class="linkStyles"   
  tableName="itsm_request"   
  condition="(stateNOT IN10@7)"   
  listView="SP"   
  itemPage="record"   
  itemView="SP View Only"   
  choiceConditionName="state"   
  dateConditionName="sys_updated_at"   
  perPage="10"   
  displayColumnNumber="2"  
></listitems>  

```

--------------------------------

### JSON Field Content Example

Source: https://docs.simpleone.ru/platform/admin/data-structure/columns/types

Example of content for a JSON field. Data is stored in JSON format and validated as a String type containing JSON-structured values.

```json
{"name": "White", "color": "#ffffff", "policy": "Open", "sys_id": 158462172516422349, "application_id": 155931135900000002, "sys_created_at": "2020-03-19 12:42:05", "sys_created_by": 155931135900000001, "sys_updated_at": "2020-03-19 12:42:05", "sys_updated_by": 155931135900000001}
```

--------------------------------

### MID Script Example

Source: https://docs.simpleone.ru/platform/developer/integration/infrastructure-agent/go-agent

Example of a MID Script definition that includes variables for data exchange. The 'title' variable is defined and then written to the host, along with another parameter.

```powershell
$title='Title:\n';Write-Host($title);Write-Host($param1);
```

--------------------------------

### Configure Summary Widget Options

Source: https://docs.simpleone.ru/platform/developer/widgets/available/summary

Specify widget parameters in JSON format. Ensure the 'Configure the value of the widget options' field is populated, otherwise the widget will not be displayed.

```json
{
    "tableId": "",
    "isPortal": true,
    "viewName": "",
    "columnName": "item",
    "columnType": "Document ID",
    "widgetName": "Summary",
    "isShowEmptyField": true,
    "isShowRemAttribute": true
}
```

--------------------------------

### Hardcoded Messaging Example

Source: https://docs.simpleone.ru/platform/developer/automation/server-scripts/recommendations

This example demonstrates hardcoding messages based on user language. It is generally less preferred than using source messages for better maintainability and localization.

```javascript
if (ss.getUser().language_id.language === 'en') {
    ss.addInfoMessage('The protocol was send on email');
} else {
    ss.addInfoMessage('Протокол был отправлен на почту');
}
```
Tokens:
Raw