a!sblInvokeWriter() Function

Connector Functions

Function

a!sblInvokeWriter( scsExternalSystemKey, usePerUserCredentials, hostname, port, enterpriseApp, appManager, language, businessService, method, parameters )

Invokes the method that will result in a modification to data in Siebel.

See also: Writer, bind().

Parameters

Keyword	Type	Description
`scsExternalSystemKey`	Text	The key from the Third Party Credentials admin console page that corresponds to the set of credentials that should be used to authenticate.
`usePerUserCredentials`	Boolean	If `true` the credentials set in the Third-Party Credentials settings page by the current user running the expression will be used. If `false` the site-wide credential values will be used.
`hostname`	Text	The application server host of the SAP server (ASHOST). The value can be an IP address, a fully-qualified domain name, or SAP's router string format. For example, `"/H/sap_router/W/password/H/app_host/S/service_port"`.
`port`	Number (Integer)	The port the Siebel server is listening on. For example, `2321`.
`enterpriseApp`	Text	The enterprise application of the target system. For example, `"SBA_82"`.
`appManager`	Text	The active application manager of the target system. For example, `"SSEObjMgr_enu"`.
`language`	Text	The target system language. For example, `"enu"`.
`businessService`	Text	The name of the Siebel Business Service on which to invoke the method.
`method`	Text	The name of the method to invoke.
`parameters`	Any Type	The input parameters for the method, given as a dictionary where the parameter names are the dictionary field names and the parameter values are give as the dictionary field values.

Returns

Writer

This function returns a writer and must be used with the bind() function.

Examples

Copy and paste an example into an Appian Expression Editor to experiment with it.

Invoke a function to make a change on Siebel

When the user clicks on the buttons, this interface calls a function that performs a write on Siebel. In this case, the invoked method, "Update", appends the account ID to the account name for the account whose ID is passed by this interface. Since this is an invokeWriter, it does not return a result to Appian, and a separate query must be performed to view the results of this action.

=load(
  local!sblInvokeWriter: bind(
    null,
    a!sblInvokeWriter(
      scsExternalSystemKey: cons!SBL_SCS_KEY,
      usePerUserCredentials: true,
      hostname: cons!SBL_HOSTNAME,
      port: cons!SBL_PORT,
      enterpriseApp: cons!SBL_APP,
      appManager: cons!SBL_APP_MANAGER,
      language: cons!SBL_LANGUAGE,
      businessService: "UpdateAccount",
      method: "Update",
      parameters: _
    )
  ),
  {
      a!textField(
        instructions: "businessService: UpdateAccount, method: Update, AccId: 1-5J1C",
        readOnly: true,
        value: "Invoke Writer Response"
      ),
      a!buttonArrayLayout(
        buttons: {
          a!buttonWidget(
            label: "Invoke",
            value: { AccId: "1-5J1C" },
            saveInto: local!sblInvokeWriter
          )
        }
      )
  }
)

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Partially compatible	Can be used with offline mobile if it is loaded at the top of the form.
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Open in Github Built: Thu, Apr 18, 2024 (09:37:52 PM)

a!sblInvokeWriter() Function