Parameters for the IBMConnections function
The integration between Netcool/Impact and IBM Connections uses a new policy action function that is called the IBMConnections function. The IBMConnections function can be used within any policy to connect to the IBM Connections Server and to perform an action on the IBM Connections Server. The function accepts two input parameters, the Action Option parameter and the Impact Object parameter.
Action Option Parameter
The Action Option parameter accepts one of the following action entries, which are case insensitive. Some action entries require property information that is case-sensitive.
In the content of an IBM Connections
forum, topic, or reply, you can use HTML formatting tags br, b,
and a. For more information about the supported HTML
tags, see http://www-03.ibm.com/software/products/en/conn.
- CREATEFORUM
- Creates a forum.
- Enter the following property information that is case-sensitive.
The tags must be created before they pass to a variable name.
- props.ForumTitle=title;
- props.ForumContent=full text of the body;
- props.ForumTags=List_Of_Tags; Is optional, the object must be a Netcool/Impact object.
- Tags=NewObject();
- Tags.Tag1=some tag;
- Tags.Tag2=some tag2; Is optional if want more than one tag.
- CREATETOPIC
- Creates a topic.
- Enter the following property information that is case-sensitive:
- props.TopicTitle=title;
- props.TopicContent=full text of the body;
- props.ForumId=forum id: Where the forum id is an ID and not a forum name.
- DELETEFORUM
- Deletes the forum name that was created by the logged in user and any topic or reply belonging to it.
- Enter the following property information that is case-sensitive:
- props.ForumId=forumId; Or props.ForumId=forumTitle;
- props.FirstMatchOnly=true; Or props.FirstMatchOnly=false; The props.FirstMatchOnly property deletes the first matching forum or matching topic that it finds, or else it deletes any matching forum or matching topic and its default value is true.
- DELETEPUBLICFORUM
- Deletes the given public forum name and any topic or reply belonging to it.
- Enter the following property information that is case-sensitive:
- props.ForumId=forumId; Or props.ForumId=forumTitle;
- props.FirstMatchOnly=true; Or props.FirstMatchOnly=false;The props.FirstMatchOnly property deletes the first matching forum or matching topic that it finds, or else it deletes any matching forum or matching topic and its default value is true.
- DELETEREPLY
- Deletes a topic reply in the topic in the forum id.
- Enter the following property information that is case-sensitive:
- props.ForumId=forumId; Where the forumId is an ID and not a title.
- props.TopicTitle=title; Or props.TopicTitle=id;
- props.ReplyTitle=replytitle; Or props.ReplyTitle=replyid;
- props.FirstMatchOnly=true; Or props.FirstMatchOnly=false;The props.FirstMatchOnly property deletes the first matching forum or matching topic that it finds, or else it deletes any matching forum or matching topic and its default value is true.
- DELETETOPIC
- Deletes a topic in the forum id.
- Enter the following property information that is case-sensitive:
- props.ForumId=forumId; Where the forumId is an ID and not a title.
- props.TopicTitle=title; Or props.TopicTitle=id;
- props.FirstMatchOnly=true; Or props.FirstMatchOnly=false;The props.FirstMatchOnly property deletes the first matching forum or matching topic that it finds, or else it deletes any matching forum or matching topic and its default value is true.
- GETCOMMUNITYFORUMID
- Gets the ID of the community that is created by the logged in user
- Enter the following property information that is case-sensitive:
- props.CommunityName=Community name;
- props.ForumName=forum name;
- GETFORUMTOPICS
- Gets list of topics for the forum id
- Enter the following property information that is case-sensitive:
- props.ForumId=forum id;
- GETMYCOMMUNITYID
- Gets the ID of the community for the logged in user
- Enter the following property information that is case-sensitive:
- props.CommunityName=Community name;
- GETMYFORUMID
- Gets the ID of the forum that is created by the logged in user.
- Enter the following property information that is case-sensitive:
- props.ForumName=actual forum name that is created by the logged in user
- GETMYFORUMS
- Gets all the forums for the logged in user
- GETPUBLICCOMMUNITYID
- Gets the ID of the given public community ID
- Enter the following property information that is case-sensitive:
- props.CommunityName=Community name;
- GETPUBLICFORUMID
- Gets the ID of the given public forum name
- Enter the following property information that is case-sensitive:
- props.ForumName=actual public forum name
- GETPUBLICFORUMS
- Gets list of all public forums
- GETTOPICREPLIES
- Gets list of replies for a topic
- Enter the following property information that is case-sensitive:
- props.TopicId=topic id; Where topic id must be the topic id not the topic name.
- REPLYTOTOPIC
- Creates a reply to an existing topic
- Enter the following property information that is case-sensitive:
- props.TopicId=topic id; Where topic id is a topic ID not a topic name
- props.ReplyTitle=title;
- props.ReplyContent=full text of the body;
Impact Object Parameter
The Impact Object parameter accepts the following property information. The authentication, and connection property information is mandatory.- props = NewObject();
- props.Protocol=https;
- props.Host=IBM Connections Server Host/IP;
- props.Port=_PORT_;
- props.Username=userName;
- props.Password=password; The password can be encrypted by using either the Netcool/Impact nci_crypt tool or the policy function Encrypt(). If the password is encrypted, you must use the property props.DecryptPassword=true;