Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Service Manager

Develop > SMIS > Overview

Overview

Service Manager Integration Suite (SMIS) is a platform that provides centralized management of integration instances, which fall into two categories:

Schedule-based: runs as a schedule in the background.
UI-based: Can be only invoked in the user interface (UI).

SMIS is also a plug-in-based development platform that enables you to complete the following tasks:

Reuse common functions and resolves conflicts across integrations
Customize a default controller to suit the workflow of your integrations
Use JavaScript to develop integration templates

An integration must be registered as a template so that it can be added to SMIS. To register an integration as a template, the integration must be developed by following the Service Provider Interface (SPI) provided by SMIS.

The functional block diagram of SMIS and a sample integration are shown in the following figure.

SMIS SPI

SMIS provides the following SPI components.

Manager SPI

The following table describes the functions used to develop a manager.

Manager SPI
Function	Parameter	Return	Description
appendTasks			Directs the source adapter to retrieve records, converts these records into tasks, and calls the task manager to push these tasks into the task queue.
preProcess	task	Boolean	Prepares the destObj and actions. If it returns false, the task will be ignored and removed.
process	task	Boolean	Returns true or false when the task is or is not processed successfully.
postProcess	task		Performs postprocessing after the task is processed.
getDestObj		Object	SCFile or Object.
getAction		String	Returns a customized action defined by the manager. Can be any value (for example: Insert/Update/Delete).
isScheduleBased		Boolean	Indicates whether the integration is schedule-based or not.
finalize			Performs finalization actions.
initParams			Initializes parameters when the instance is first added. Use `this.configItem.setConfigParameterValue` (<parameter_name>, <value>) to set parameter values.

Adapter SPI

The following table describes the functions used to develop source and destination adapters.

Adapter SPI
Function	Parameter	Return	Description
getRecords		Array	Retrieves records from external sources, and returns them to the manager.
sendRecord			Sends out the record according to the action. For example, `sendRecord (data, “delete”)`.
	Record	Object	JavaScript object that contains the result data to send.
	Action	String	Customized action. For example, “insert”, “update”, or “delete”.
getFields		Array	Returns an array of field names, types, and descriptions. The field information will be used for mapping.

Mapping SPI

The following table describes the functions provided by the mapping function in SMIS.

Mapping SPI
Function	Parameter	Return	Description
validate		boolean	Validates the input values.
	inRecord	Object	Input field values.
	direction	String	Mapping direction.
getOutRecord		Object	Gets outRecord by inRecord according to field mapping and value mapping (not including callback).
	inRecord	Object	Input field values.
	direction	String	Mapping direction.
setFieldValues			The final processing step of mapping, which sets the mapped value to destObject.
	inRecord	Object	Input field values.
	outRecord	Object	The object of getOutRecord.
	destObject	Object	The final object of the mapping result.
	smisContext	Object	The container that contains context values.
	direction	String	Mapping direction.

TaskManager SPI

The following table describes the functions provided by the task manager in SMIS.

TaskManager SPI
Function	Parameter	Return	description
readTasks		Array	Reads tasks by instance ID.
readTasks	intId	String	Instance ID.
removeTask+		Object	Removes the task if it is processed successfully.
removeTask+	task	Object	Task object.
setFieldValues			The final processing step of mapping, which sets the mapped value to destObject.
updateTask		Object	Updates the task if it is processed unsuccessfully.
updateTask	task	Object	Task object.

Development procedure

Developing integrations with the SMIS SPI involves different steps for schedule-based and UI-based integrations.

Schedule-based integrations

To develop a schedule-based integration, perform the following tasks:

Initialize global variables.
Develop an endpoint adapter and a Service Manager adapter.
Develop a manager.
Develop a custom controller.
SMIS provides a default controller. Determine if the default workflow suits the integration. If not, develop a custom controller.
Register the integration as a template.
Export the integration template into an unload file.