Remedy - AR System Server - How to use the API driver program

Version 6
    Share This:

    This document contains official content from the BMC Software Knowledge Base. It is automatically updated when the knowledge article is modified.


    PRODUCT:

    Remedy AR System Server


    COMPONENT:

    Remedy AR System Server


    APPLIES TO:

    BMC Remedy AR System Server



    PROBLEM:

     

    How does the API driver program work?

     


    SOLUTION:

     

     

       Default location of the Driver is:
    Unix - /api/src/driver directory
    NT - ..\Arserver\API\driver directory
    When running driver first you need to type:

    1. at the Command: prompt, type (to login): log
    2. enter your user name and password (NOTE: YOUR PASSWORD WILL NOT BE ENCRYPTED!!!)
    3. language (hit enter and take the default, unless you're not using C)
    4. enter the server name
    5. at the Command: prompt type (to initialize your session): init

    ....you should see something like this:

    Command: log
    Control record:
    User name () : Demo
    Password () :
    Language () :
    Server () : copine

    Command: init
    INITIALIZATION


    ARInitialization results
    ReturnCode: OK
    Status List : 0 items

    Command:

    Now you can enter any of the commands listed that appear upon starting the driver program (type h or ? for help) (type either e or q to quit).

    sample output from driver:

    {copine:/d2/452/api/src/driver:9} ./driver


    AR System API Driver

    Container Schema Char Menu Schema Field
    ---------- ------ --------- ------------ ------
    get (gco) get (gs) get (gc) get (gsf)
    set (sco) set (ss) set (sc) set (ssf)
    create (cco) create (cs) create (cc) create (csf)
    delete (dco) delete (ds) delete (dc) delete (dsf) (dmsf)
    getlist(glco) getlist(gls) getlist(glc) getlist (glsf)
    expand (ec) get mult (gmsf)

    Active Link Filter Escalation Entry
    ----------- ------ ---------- ----- ------
    get (gal) get (gf) get (ges) get (ge) (gme)
    set (sal) set (sf) set (ses) set (se)
    create (cal) create (cf) create (ces) create (ce)
    delete (dal) delete (df) delete (des) delete (de)
    getlist(glal) getlist(glf) getlist(gles) getlist (gle)
    getlistw/f(glewf)
    merge (me)
    VUI Misc Lists Thread stats (stat)
    --- ---------- ------
    get (gv) server(svr) launch (lt)
    set (sv) group (glg) launch waiting (lwt)
    create (cv) user (glu) release waiting (rwt)
    delete (dv) sql (glsql) sleep timer (st)
    getlist(glsv) random sleep timer(rst)
    msec sleep timer (msst)

    Init/Term Control/Logging Info Misc Misc
    --------- --------------- ---- ---- ----
    init (init) record (rec) get svr (gsi) ver user (ver) get file (gfl)

    term (term) stop rec (srec) set svr (ssi) export (exp) set file (sfl)

    help (h, ?) open out (oout) get FT (gft) import (imp) get BLOB (geb)

    exit (e, q) close out(cout) set FT (sft) exec proc(proc) get errmsg (gem)

    login (log) execute (ex) get stat(gss) load qual(lqs) set logging(slog)
    bgn loop (bl) set port (ssp) close conn (cnc)

    end loop (el) signal (sig) valid cache(vfc)


    Command: log
    Control record:
    User name () : Demo
    Password () :
    Language () :
    Server () : copine

    Command: init
    INITIALIZATION

    ARInitialization results
    ReturnCode: OK
    Status List : 0 items

    Command: gsf
    GET FIELD
    Schema name: #jane
    Field id (1): 536870915

    ARGetField results
    ReturnCode: OK
    Field name: Date/Time Field
    Field mapping:
    Field type: REGULAR
    Datatype: 7
    Field option: 2
    Field create mode: 2
    Value: NULL
    Permission List : 5 items
    Permission Struct:
    Group id: 0
    Permissions: VIEW
    Permission Struct:
    Group id: 3
    Permissions: CHANGE
    Permission Struct:
    Group id: 4
    Permissions: CHANGE
    Permission Struct:
    Group id: 7
    Permissions: CHANGE
    Permission Struct:
    Group id: 10
    Permissions: VIEW
    Field Limit Struct: NO LIMITS
    Display Instance List : 1 items
    Common Prop List : 0 items
    Display Instance : #0 for VUI 536870912
    Instance Prop List : 16 items
    Prop Struct: LABEL
    Value: (char) Date/Time Field
    Prop Struct: BBOX
    Value: (coordlist) 2 items
    x: 3600, y: 24100
    x: 28012, y: 26200
    Prop Struct: VISIBLE
    Value: (enumerated) 1
    Prop Struct: ENABLE
    Value: (enumerated) 2
    Prop Struct: ROWS
    Value: (ulong) 1
    Prop Struct: COLS
    Value: (ulong) 20
    Prop Struct: LABEL POS SECTOR
    Value: (bitmask) 16
    Prop Struct: LABEL POS JUSTIFY
    Value: (enumerated) 4
    Prop Struct: LABEL POS ALIGN
    Value: (enumerated) 1
    Prop Struct: Z ORDER
    Value: (ulong) 2147483650
    Prop Struct: TAB ORDER
    Value: (ulong) 4294967295
    Prop Struct: DISPLAY PARENT
    Value: (ulong) 0
    Prop Struct: LABEL BBOX
    Value: (coordlist) 2 items
    x: 0, y: 400
    x: 8550, y: 2100
    Prop Struct: BBOX
    Value: (coordlist) 2 items
    x: 9112, y: 0
    x: 21487, y: 2100
    Prop Struct: MENU BBOX
    Value: (ulong) 20
    Prop Struct: LABEL POS SECTOR
    Value: (bitmask) 16
    Prop Struct: LABEL POS JUSTIFY
    Value: (enumerated) 4
    Prop Struct: LABEL POS ALIGN
    Value: (enumerated) 1
    Prop Struct: Z ORDER
    Value: (ulong) 2147483650
    Prop Struct: TAB ORDER
    Value: (ulong) 4294967295
    Prop Struct: DISPLAY PARENT
    Value: (ulong) 0
    Prop Struct: LABEL BBOX
    Value: (coordlist) 2 items
    x: 0, y: 400
    x: 8550, y: 2100
    Prop Struct: BBOX
    Value: (coordlist) 2 items
    x: 9112, y: 0
    x: 21487, y: 2100
    Prop Struct: MENU BBOX
    Value: (coordlist) 2 items
    x: 0, y: 0
    x: 0, y: 0
    Prop Struct: EXPAND BBOX
    Value: (coordlist) 2 items
    x: 22050, y: 0
    x: 24412, y: 2100
    Help text:
    Last update time: 991333466
    Owner: Demo
    Last changed: Demo
    Change Diary: 0 diary entries
    Status List : 0 items

    Command: e
    {copine:/d2/452/api/src/driver:10}

     


    Article Number:

    000298826


    Article Type:

    Solutions to a Product Problem



      Looking for additional information?    Search BMC Support  or  Browse Knowledge Articles