Routines for miscapi.kb


APILogin

File Name

miscapi.kb

Syntax

APILogin(user: APILoginRecord

Parameters

User - defines login information for a remote user

Returns

INTEGER

Side Effects

None

Description

Determines if the request for log in should be granted to the requesting user.

Dialog Forms Called

None


AS_DoAsyncTivCmd

File Name

miscapi.kb

Syntax

AS_DoAsyncTivCmd(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Launches a TSD script process to wait on completion of a Command Line routine. This TSD script process captures the output (written to stdout) and sends it back to the application server for further processing.

Dialog Forms Called

None


AS_ExecuteCLI

File Name

miscapi.kb

Syntax

AS_ExecuteCLI(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Synchronously executes a command line and captures the output.

Dialog Forms Called

None


AS_FireAndForgetCLI

File Name

miscapi.kb

Syntax

AS_FireAndForgetCLI(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Asynchronously executes a command line (does not wait for the output).

Dialog Forms Called

None


AS_GetGMTBias

File Name

miscapi.kb

Syntax

AS_GetGMTBias(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Calculates the GMTBias for a client machine

Dialog Forms Called

None


AS_GetLocationTree

File Name

miscapi.kb

Syntax

AS_GetLocationTree(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Queries valuesfrom the BR_LOCATION view.

Dialog Forms Called

None


AS_GetOrgTree

File Name

miscapi.kb

Syntax

AS_GetOrgTree(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Gets the values from the BR_ORGANIZATION view for the API.

Dialog Forms Called

None


AS_GetSupportingOrgs

File Name

miscapi.kb

Syntax

AS_GetSupportingOrgs(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Gets a list of currently supported organizations based on the viewed table and the current organization.

Dialog Forms Called

None


AS_GetUserOrgs

File Name

miscapi.kb

Syntax

AS_GetUserOrgs(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Gets the organizations that a user can explicitly support.

Dialog Forms Called

None


AS_LockProblem

File Name

miscapi.kb

Syntax

AS_LockProblem(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Locks a problem with a user ID.

Dialog Forms Called

None


EW_CreateUser

File Name

miscapi.kb

Syntax

EW_CreateUser(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Creates a people record at the request of a new Web user.

Dialog Forms Called

None


EW_IncrementUsage

File Name

miscapi.kb

Syntax

EW_IncrementUsage(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Increments usage for a user and an action.

Dialog Forms Called

None


GenericSelectInto

File Name

miscapi.kb

Syntax

GenericSelectInto(TBNAme, ColList, WhereCondition, MetaData, Data: LIST OF STRING)

Parameters

TBName - table from which to select

ColList - columns to select, use '*' for all columns

WhereCondition - condition with which to query

MetaData - description of output

Data - output from select

Returns

Integer

Side Effects

None

Description

Queries a table based on a condition. Output column names are put in MetaData, and output rows are put in Data.

Dialog Forms Called

None


GetEWUserConfig

File Name

miscapi.kb

Syntax

GetEWUserConfig(MetaData, Data: LIST OF STRING)

Parameters

MetaData - description of message data

Data - actual value of message data

Returns

None

Side Effects

None

Description

Loads the configuration for an individual Web user.

Dialog Forms Called

None


GetGroupMemberships

File Name

miscapi.kb

Syntax

GetGroupMemberships(Group_ID: STRING)

Parameters

Group_ID - user for which to get users

Returns

List of String

Side Effects

None

Description

Gets the users that belong to a group.

Dialog Forms Called

None


GetGroups

File Name

miscapi.kb

Syntax

GetGroups(GroupContext: GroupRecord, MaxReturned: INTEGER)

Parameters

ProbContext - example by which to perform the query

MaxReturned - maximun number of groups to return

Returns

List of GroupRecord

Side Effects

None

Description

Performs a query by the example passed in using GroupContext.

Dialog Forms Called

None


GetLocations

File Name

miscapi.kb

Syntax

GetLocations(LocationContext: Locationrecord MaxReturned: INTEGER)

Parameters

LocationContext - example by which to perform the query

MaxReturned - maximun number of locations to return

Returns

LIST OF LocationRecord

Side Effects

None

Description

Performs a query by the example passed in using LocationContext.

Dialog Forms Called

None


GetPeople

File Name

miscapi.kb

Syntax

GetPeople(PeopleContext: PeopleRecord, MaxReturned: INTEGER)

Parameters

PeopleContect - example by which to perform the query

MaxReturned - maximun number of people to return

Returns

List of PeopleRecord

Side Effects

None

Description

Performs a query by the example passed in using PeopleContext.

Dialog Forms Called

None


GetSeverities

File Name

miscapi.kb

Syntax

GetSeverities

Parameters

None

Returns

List of SeverityLevelRecord

Side Effects

None

Description

Queries all severity levels in the system.

Dialog Forms Called

None


GetSingleColumnList

File Name

miscapi.kb

Syntax

GetSingleColumnList(TBName, ColName, Condition)

Parameters

TBName - table to inquire against

ColName - column from which to get data

Condition - condition to use in the select

Returns

List of string

Side Effects

None

Description

Queries a single column from a table, based on a condition.

Dialog Forms Called

None


GetUserMemberships

File Name

miscapi.kb

Syntax

GetUserMemberships(User_ID: STRING)

Parameters

User_ID - user for which to get groups.

Returns

List of string

Side Effects

None

Description

Gets the groups to which a user belongs.

Dialog Forms Called

None


GetUsers

File Name

miscapi.kb

Syntax

GetUsers(UserContext: UsersRecord, MaxReturned: INTEGER)

Parameters

UserContext - example by which to perform the query

MaxReturned - maximum number of users to return

Returns

List of UsersRecord

Side Effects

None

Description

Performs a query by the example passed in using UserContext.

Dialog Forms Called

None


QueryCallHistory

File Name

miscapi.kb

Syntax

QueryCallHistory(CallHistContext: CallHistoryRecord, MaxReturned: INTEGER)

Parameters

CallHistContext - Example by which to perform the query.

MaxReturned - maximum number of problems to return

Returns

LIST OF CallHistoryRecord

Side Effects

None

Description

Performs a query by the example passed in using CallHistContext.

Dialog Forms Called

None


QueryProblemHistory

File Name

miscapi.kb

Syntax

QueryProblems(ProbHistContext: ProblemHistoryRecord, MaxReturned: INTEGER)

Parameters

ProbHistContext - example by which to perform the query

MaxReturned - maximum number of problem histories to return

Returns

List of ProblemHistoryRecord

Side Effects

None

Description

Performs a query by the example passed in using ProbHistContext.

Dialog Forms Called

None


QueryProblems

File Name

miscapi.kb

Syntax

QueryProblems(ProbContext: ProblemRecord, MaxReturned: INTEGER)

Parameters

ProbContext - example by which to perform the query

MaxReturned - maximun number of problems to return

Returns

List of ProblemRecord

Side Effects

None

Description

Performs a query by the example passed in using ProbContext.

Dialog Forms Called

None


QueryProblemView

File Name

miscapi.kb

Syntax

QueryProblemView(ProbView: ProblemView)

Parameters

ProbView - example from which to to perform the query

Returns

List of ProblemView

Side Effects

None

Description

Performs a query by the example passed in using ProbView.

Dialog Forms Called

None


QueryWorkHistory

File Name

miscapi.kb

Syntax

QueryWorkHistory(WorkHistContext: WorkHistoryRecord, MaxReturned: INTEGER)

Parameters

WorkContext - example by which to perform the query

MaxReturned - maximun number of work histories to return

Returns

List of WorkHistoryRecord

Side Effects

None

Description

Performs a query by the example passed in using WorkHistContext.

Dialog Forms Called

None


ReplaceNDBSQLFormat

File Name

miscapi.kb

Syntax

ReplaceNDBSQLFormat(Data: LIST OF STRING)

Parameters

Data - a list of data values sent to the server

Returns

None

Side Effects

None

Description

A token is searched for in the data variable to determine if SQLFormatting needs to occur. If it does, this takes place now, and the data is ready for other work that needs to be done.

Dialog Forms Called

None