Versions Compared

Old Version 63

changes.mady.by.user David Backeberg

Saved on

compared with

New Version Current

changes.mady.by.user David Backeberg

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

  • add() provides a netid, nodename, other arguments to create a node
  • delete() provide a nodename, tell NetAdmin to delete the record
  • getBilling() provide a netid, receive whether or not PTAEO required
  • getNodeList() provide a netid, receive a list containing zero or more nodename(s) that are associated with that netid
  • getNodeDetails() provide a nodename, receive the details for that nodename
  • update() provide a nodename, provide arguments to change on the node

Table of Contents

WSDL details

Kazi has provided a WSDL conforming to the SPEC defined here: 

add()

Arguments for add:
netid of owner
nodename (needs to be unique, and NOT exist already in the system)
client category (DS,MW,WS). This field is called "Policy Group" on the netAdmin API.

charge code (charge_cd which comes back in a response to getBilling())
Client OS (Windows, Mac, Unix)
interval (backup time, or never)
PTAEO, passed as five separate strings

...

Add method needs to return an error code indicating whether or not the add request was accepted, and for errors should indicate the problem with the data.

What is a policy_group? Can we have some examples? A policy group is the same thing as a Client Category: DS,MW,WS

PTAEO details

PTAEO consists of five strings:

...

Arguments for delete:
nodename (needs to be unique, and exist)
datestamp for date to delete, formatted as Oracle date (31-JAN-2013). This is awkward for ServiceNow, but native for NetBill. Furthermore, ServiceNow already has a method that formats months in this way for previous Oracle interactions.

Note

Existing Oracle New ServiceNow API: FUNCTION expireCBAccount expireCBAccountViaSN (a_node_name    IN VARCHAR2,   a_expire_date  IN DATEVARCHAR2)New ServiceNow API: FUNCTION expireCBAccountViaSN (a_node_name    IN VARCHAR2,   a_expire_date  IN DATE)  RETURN NUMBER  RETURN NUMBER

 

a_expire_date input expected format:MM/DD/YYYY

0 success

-10 cb node does not exist

-n database error occurred

...

Note

We have a view for this. ViewName:smart.YUSTART_CB_DETAILS_V

select node_name from smart.yustart_cb_details_v where owning_netid=?      This returns all nodes one owner netid owns. To filter node list by status,

select node_name from smart.yustart_cb_details_v where owning_netid=? and status_cd=? status_cd can be 'A'-Active, 'RA'-Request Active,'RL'-Request Lock (still active),'L'-Locked(inactive),'RD'-Request Delete (inactive),'D'-Deleted

Note


Need to know the exact flags to set. We want only Active nodes, We only want to query active nodes, so we will set status_cd='A'
We only want back a list of nodenames. 

Note

Need to know the exact flags to set. We want only Active nodes, owned by the netid. What is the flag we should set for status_cd? 'A'.


Info

If you want a list of active nodes, use "status_cd in ('A', 'RL').

For the purposes of later calling the update() and delete() method we will want to do a getNodeList against just the 'A' status_cd nodes.

RL is locked, and you cannot make a change on it. 

RA has not been created yet, so you can't perform any action on it.

L, RD and D are already closed, so you can't take further action on them.

...

Note

Existing oracle API:

PROCEDURE getCBDetail (a_node_name      IN VARCHAR2,
         a_parent_netid    OUT VARCHAR2,
       a_owning_netid     OUT VARCHAR2,
       a_status_cd        OUT VARCHAR2,
       a_policy_group_cd    OUT VARCHAR2,
       a_policy_group_desc     OUT VARCHAR2,
       a_time_slot_cd     OUT VARCHAR2,
       a_time_slot_desc       OUT VARCHAR2,
       a_early_late_option     OUT VARCHAR2,
       a_os_cd         OUT VARCHAR2,
       a_os_desc      OUT VARCHAR2,
       a_usage       OUT NUMBER,
       a_agreement_cd        OUT NUMBER,
       a_agreement_desc       OUT VARCHAR2,
       a_debit_project       OUT VARCHAR2,
       a_debit_task        OUT VARCHAR2,
       a_debit_award     OUT VARCHAR2,
       a_debit_org        OUT VARCHAR2,
       a_requested_date       OUT DATE,
       a_created_date     OUT DATE,
       a_requested_end_date    OUT DATE,
       a_end_date      OUT DATE,
       a_requested_delete_date OUT DATE,
       a_delete_date     OUT DATE,
       a_last_verified_date    OUT DATE,
       a_pin       OUT VARCHAR2);


NEW METHOD

PROCEDURE getCBNodeDetailViaSN (a_node_name      IN VARCHAR2,
                a_policy_group_cd    OUT VARCHAR2,
       a_time_slot_cd     OUT VARCHAR2,
       a_os_cd         OUT VARCHAR2,
       a_debit_project       OUT VARCHAR2,
       a_debit_task        OUT VARCHAR2,
       a_debit_award     OUT VARCHAR2,
       a_debit_org        OUT VARCHAR2,
);

RETURNS number

0 success

-2 nodename is invalid 

update()

Arguments for update:
charge_code (gathered from a previous call to getSrvcChargeInfo() )
nodename (needs to be unique, and already exist)

...